Fix handling of baggage when retrieving current span #8567
Merged
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
Signed-off-by: Tim Quinn <tim.quinn@oracle.com>
…ence so changes to the span are reflected in the context's baggage
oracle-contributor-agreement
bot
added
the
OCA Verified
tomas-langer
approved these changes
Mar 27, 2024
| @@ -100,7 +107,12 @@ public Scope activate() { | |||
| public Span baggage(String key, String value) { | |||
| Objects.requireNonNull(key, "baggage key cannot be null"); | |||
| Objects.requireNonNull(value, "baggage value cannot be null"); | |||
| baggage.baggage(key, value); | |||
| if (baggage instanceof MutableOpenTelemetryBaggage mutableBaggage) { | |||
There was a problem hiding this comment.
Is there maybe a way to switch to mutable baggage here and make it work, or is this a limitation of the open telemetry API?
If we have this check + exception, then an application that works fine with other tracing provider may fail with oTel
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.
Description
Resolves #8548
OpenTelemetry separates baggage from spans and stores them separately in the OTel context. In contrast, the Helidon tracing API treats baggage as a characteristic of a span.
Earlier PRs fixed a problem in which Helidon failed to store the baggage associated with a span correctly in the OTel context. This PR fixes a problem in reconstituting the correct current span from what is in the OTel context, making sure the new reconstituted span draws from both the OTel span in the context and the OTel baggage in the context.
The central fix is in
OpenTelemetryTracerProviderand itscurrentSpanmethod (which now delegates toactiveSpanso the Jaeger code can also use it). TheSpanconstructed forcurrentSpan/activeSpannow holds a reference to the OTelBaggageinstance from the OtelContext.Normally, that baggage will be our writeable baggage implementation of OTel's
Baggageinterface. That implementation allows the HelidonSpanwrapper around the OTel span to permit updates to its baggage. By storing a reference to that baggage in the reconstituted span, changes to the baggage via the baggage methods on the reconstitutedSpanwill write through to the baggage that is stored in the context.But, it's possible that immutable Otel baggage might be in the OTel context when the current span is reconstructed. The Helidon
OpenTelemetrySpanmethod for updating baggage therefore must now check to see if its baggage is writeable or not and act accordingly.The PR also contains new tests for OTel and Jaeger (which relies on the OTel implementation internally).
Documentation
Bug fix; no doc changes.