Support b3 (zipkin) OpenTelemetry trace propagation headers #28
Conversation
This file contains 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
sordina
approved these changes
Apr 17, 2024
CHANGELOG.md
Outdated
Comment on lines
3
to
4
| ## 4.5.0 | ||
| - Support b3 (zipkin) OpenTelemetry trace propagation headers ([#28](https://github.com/hasura/ndc-sdk-typescript/pull/28)) |
There was a problem hiding this comment.
Neat, might be good to link to the impl or spec for this format.
Comment on lines
+57
to
+60
| // This logs the parent span ID in the pino logs, useful for debugging propagation. | ||
| // parentSpanId is an internal property, hence the cast to any, because I can't | ||
| // seem to find a way to get at it through a supported API 😭 | ||
| record["parent_span_id"] = (span as any).parentSpanId; |
Comment on lines
+64
to
+71
| textMapPropagator: new CompositePropagator({ | ||
| propagators: [ | ||
| new W3CTraceContextPropagator(), | ||
| new W3CBaggagePropagator(), | ||
| new B3Propagator(), | ||
| new B3Propagator({ injectEncoding: B3InjectEncoding.MULTI_HEADER }), | ||
| ] | ||
| }), |
There was a problem hiding this comment.
How is the active propagator selected again?
There was a problem hiding this comment.
They're not "selected", they are run in sequence and effectively mutate the tracing context, so the last one wins.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This PR adds support for the b3 (zipkin) OpenTelemetry trace propagation headers. The old default was
tracecontextandbaggage, now we've extended that withb3andb3-multiby manually configuring the propagators ininstrumentation.ts.Propagators are run in order and each contributes to the trace context. This means if multiple tracing header formats are provided in the request, the last configured propagator for the appropriate formats wins.
In addition:
This PR makes a similar change to the one in the Rust SDK.