-
Notifications
You must be signed in to change notification settings - Fork 167
Fix baggage header merging and networkContext propagation in TracingURLSessionHandler #2683
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
Valpertui
wants to merge
5
commits into
develop
Choose a base branch
from
valpertui/fix/missing-baggage-merge-in-tracing
base: develop
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
3b4f3a1
Move BaggageHeaderMerger from DatadogRUM to DatadogInternal
Valpertui 9350eae
Add baggage header merging and use networkContext in TracingURLSessio…
Valpertui 5b516c3
Add changelog entry for baggage header merging fix
Valpertui e2fe8e8
Fix trailing newline lint violations in BaggageHeaderMerger files
Valpertui 86d019d
Fix tests
Valpertui File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
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
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
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
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
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
When a request already has W3C
traceparent/tracestateset by the caller, this branch still setshasSetAnyHeader = trueafter merging (or adding)baggage. That causesmodify()to return aTraceContext, whichNetworkInstrumentationFeatureregisters and later uses to build spans. The outgoing request keeps the caller’s original trace headers, so the span created from the returnedTraceContextcan end up on a different trace ID than the actual request, breaking distributed trace correlation whenever the app supplies its own trace headers but expects the SDK to only merge baggage. Consider tracking “trace header injected” separately from “baggage injected,” or avoid returningTraceContextwhen only baggage was modified.Useful? React with 👍 / 👎.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I believe this is normal that there is a trace context returned if we inject any header.
But currently if at least 1 header doesn't get overwritten because it's already there (eg
traceparent), we will propagate a traceContext withtraceIDandspanIDset back to the SDK. While the network request sent will not contain those specific traceID/spanID, breaking distributed tracing in an unexpected way.Sure it looks like a developer mistake to fix. But we need to remember that those header fields could also be set automatically by other integrations like Datadog.
Should we keep the current behavior? Should we revamp it ?