Repository navigation
docs(dotnet): Update OTLP propagation docs for SDK 7.0.0 - #19924
jamescrosswell wants to merge 4 commits into
Conversation
sentry-dotnet 7.0.0 stops AddSentryOtlpExporter from installing SentryPropagator and removes the defaultTextMapPropagator parameter (getsentry/sentry-dotnet#5319). Describe what gets propagated by default, how to add SentryPropagator for services that rely on sentry-trace, and when PropagateTraceparent helps. Raise the OpenTelemetry floor to 1.12.0. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
1 Skipped Deployment
|
UseOtlp() stops the SDK creating transactions, so TracesSampleRate and TracesSampler are never read, and the OTLP exporter installs no OpenTelemetry sampler. Replace the "do not set TracesSampleRate" note with a Sampling section that points at the TracerProvider's sampler. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
|
The plan checks client errors on the changed page, overall error volume, and pageload duration. An issue escalates when the changed page emits errors or error volume leaves the measured band. Services: Mention PlanWhat changedThe live .NET OTLP page now documents SDK 7.0.0 propagator behavior. AddSentryOtlpExporter no longer installs SentryPropagator and no longer accepts defaultTextMapPropagator. The page shows a CompositeTextMapPropagator snippet for readers who still need sentry-trace headers. sentry-docs must deploy before this change is live. RiskNew MDX can throw in Alert, code tabs, or PlatformLink during render. That failure hits this page first. A shared code-tab failure can also break other pages. Wrong text can make readers drop sentry-trace propagation after they upgrade. Intended effectThis change is documentation text. Telemetry cannot show that the new wording is live. Absent means the page still shows the old Planned Removal warning. Do not treat missing page views as absent intended effect. Regression watchWatch client failures on this page first. Then watch docs-wide error volume and pageload duration on the shared renderer.
Not observablePage-level pageload duration is not separable. Almost all pages share transaction |
|
PR looks good! We should probably keep it as a Draft until the v7.0.0 to avoid any premature merge risk. |
I've left it ready for review as a way to track what's actually complete vs still needs work on all the docs PRs we're planning for v7. I've added an alert warning at the to of the description instead - I think just you and me, we should be able to avoid merging anything by accident. |
Warning
Do not merge before sentry-dotnet 7.0.0 is released (planned 2026-11-30).
DESCRIBE YOUR PR
Updates the .NET OTLP page for sentry-dotnet 7.0.0. From 7.0.0,
AddSentryOtlpExporterno longer installsSentryPropagator, and thedefaultTextMapPropagatorparameter is gone from it and fromUseOtlp(getsentry/sentry-dotnet#5319).SentryPropagatorbullet and the "Planned Removal" alert with a Trace Propagation section. It covers what gets propagated by default, how to addSentryPropagatorfor services that rely onsentry-trace, and whenPropagateTraceparenthelps. A short note covers the pre-7.0.0 behavior.defaultTextMapPropagatoroption.TracesSampleRatewith a Sampling section. WithUseOtlp()the SDK creates no transactions, soTracesSampleRateandTracesSamplerare never read, and the OTLP exporter installs no OpenTelemetry sampler. Sampling is configured on theTracerProvider. This is true for 6.x as well.Closes getsentry/sentry-dotnet#5546
Notes for review
Where the page differs from the issue, it follows the source on sentry-dotnet's
version7branch:PropagateTraceparentdoesn't help the OTLP service itself. OpenTelemetry's default propagator (W3C trace context plus baggage, which the OTel SDK installs) and the .NET runtime already sendtraceparent. OTel's HttpClient instrumentation also overwrites anytraceparentthatSentryHttpMessageHandleradds first. A local run against aversion7build sent identical headers with and without the option. The page recommends it for the Sentry-traced services that call the OTLP service, as/concepts/otlp/sentry-with-otel/already does.sentry-tracedoesn't disappear completely.UseOtlp()stopsSentryHttpMessageHandlerfrom creating spans, but its header propagation still runs (SentryMessageHandler.PropagateTraceHeaders). Sentry adds the handler toIHttpClientFactoryclients when it's set up through DI. Other requests only carrysentry-traceif the app configuresSentryPropagator.SentryPropagatoris still public inSentry.OpenTelemetry.Exporteronversion7, so the snippet doesn't need the deprecatedSentry.OpenTelemetrypackage. It derives fromBaggagePropagator, which is why the composite doesn't list that one separately. The snippet compiles against theversion7build with OpenTelemetry 1.12.0.IS YOUR CHANGE URGENT?
Help us prioritize incoming PRs by letting us know when the change needs to go live.
Select exactly one option. For deadlines, replace
YYYY-MM-DDwith the due date. You can update this information later by editing the PR description.SLA
Thanks in advance for your help!
PRE-MERGE CHECKLIST
Make sure you've checked the following before merging your changes:
🤖 Generated with Claude Code