docs(otlp): Add tail-based sampling warning for propagateTraceparent#18278
Open
dingsdax wants to merge 3 commits into
Open
docs(otlp): Add tail-based sampling warning for propagateTraceparent#18278dingsdax wants to merge 3 commits into
dingsdax wants to merge 3 commits into
Conversation
When propagateTraceparent is enabled, the frontend SDK's sampling decision propagates via the traceparent header. OTel backends using the default parentbased_* sampler honor that decision, silently bypassing collector tail-based sampling. Add a warning Alert to the Sentry with OTel concepts page explaining this interaction and recommending OTEL_TRACES_SAMPLER=always_on as the fix. Add a cross-reference note to the propagateTraceparent SdkOption block across all 8 platform options pages (JS, Android, Java, React Native, Flutter, Go, Apple, Native) via a shared include partial. Co-Authored-By: Claude <noreply@anthropic.com>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
DESCRIBE YOUR PR
When
propagateTraceparentis enabled, the frontend SDK's sampling decision is encoded in the W3Ctraceparentheader. If the OTel backend uses aparentbased_*sampler (the default), it honors that decision and silently bypasses the collector's tail-based sampler. This is a subtle gotcha that customers hit without understanding why.This PR:
<Alert level="warning">block to the Sentry with OTel concepts page explaining the interaction and recommendingOTEL_TRACES_SAMPLER=always_onas the fixpropagateTraceparent<SdkOption>block across all 8 platform options pages (JS, Android, Java, React Native, Flutter, Go, Apple, Native) via a shared include partial (includes/platforms/configuration/options/propagate-traceparent-tail-sampling.mdx)IS YOUR CHANGE URGENT?
Help us prioritize incoming PRs by letting us know when the change needs to go live.
SLA
Thanks in advance for your help!
PRE-MERGE CHECKLIST
Make sure you've checked the following before merging your changes: