Skip to content

docs(otlp): Restructure OTLP page to elevate propagateTraceparent#16264

Merged
jaffrepaul merged 8 commits intomasterfrom
docs/elevate-propagateTraceparent
Feb 5, 2026
Merged

docs(otlp): Restructure OTLP page to elevate propagateTraceparent#16264
jaffrepaul merged 8 commits intomasterfrom
docs/elevate-propagateTraceparent

Conversation

@jaffrepaul
Copy link
Contributor

@jaffrepaul jaffrepaul commented Feb 4, 2026

Restructures the OTLP concepts section to better highlight the propagateTraceparent & OTLP Integration options for users with Sentry + OTel backend setups.

Changes:

Information Architecture

  • Splits the monolithic OTLP index page into focused subpages:
    • sentry-with-otel.mdx - Linking Sentry SDKs with OTel (propagateTraceparent, OTLP Integration)
    • otlp-traces.mdx - Direct OTLP trace ingestion
    • otlp-logs.mdx - Direct OTLP log ingestion
  • Adds scenario table at the top of index with deep links to relevant sections
  • Adds distributed trace diagram to visualize Sentry + OTel linking

Content Updates

  • Reorders page sections to prioritize common use cases:
    1. Linking Sentry and OTLP Traces (propagateTraceparent)
    2. OTLP Integration (same service)
    3. Sending OpenTelemetry Data (OTel-only backend)
  • Simplifies language by using "OTel" instead of "OpenTelemetry" in body text
  • Streamlines setup instructions with clearer deep links to project settings
  • Adds Node.js (coming soon) placeholder to OTLP Integration section
  • Clarifies that Sentry does not support OTLP metrics upfront

The goal is to make it easier for users to find the right solution for their setup, with Sentry SDK integration options more visible.

@vercel
Copy link

vercel bot commented Feb 4, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
sentry-docs Ready Ready Preview, Comment Feb 5, 2026 9:25pm
1 Skipped Deployment
Project Deployment Actions Updated (UTC)
develop-docs Ignored Ignored Preview Feb 5, 2026 9:25pm

Request Review

@jaffrepaul jaffrepaul marked this pull request as ready for review February 5, 2026 01:06

If you're using OTel without a Sentry SDK, you can send traces directly to Sentry's OTLP endpoint. You can find your endpoint URL and auth key in [Project settings > Client Keys (DSN)](https://sentry.io/orgredirect/organizations/:orgslug/settings/projects/).

## Known Limitations
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Small nit, but I think it’d be better to move “Known Limitations” to the bottom of the page and bring “Configuration” above the fold, since that’s what most users are looking for.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good call. Updated in 37decf0

Copy link
Contributor

@coolguyzone coolguyzone left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See my comment, but overall looks good to me! Thanks for cleaning this up 🏄‍♂️

@jaffrepaul jaffrepaul merged commit 93c27d2 into master Feb 5, 2026
14 checks passed
@jaffrepaul jaffrepaul deleted the docs/elevate-propagateTraceparent branch February 5, 2026 21:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants