Fix OpenTelemetry context propagation and duplication issues #25012
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
ghost
added
the
|
API changes have been detected in API changes - String PARENT_SPAN_KEY = "parent-span";
+ @Deprecated String PARENT_SPAN_KEY = "parent-span";
+ String TRACE_CONTEXT_KEY = "trace-context"; |
|
API changes have been detected in API changes - String PARENT_SPAN_KEY = "parent-span";
+ @Deprecated String PARENT_SPAN_KEY = "parent-span";
+ String PARENT_TRACE_CONTEXT_KEY = "trace-context"; |
lmolkova
requested review from
alzimmermsft,
anuchandy,
JonathanGiles,
mssfang,
pallavit,
samvaity,
srnagar,
trask and
vcolin7
as code owners
lmolkova
force-pushed
the
fix-context-prop-2
branch
from
4404cbe
to
27a6cda
Compare
lmolkova
force-pushed
the
fix-context-prop-2
branch
from
27a6cda
to
d304bb9
Compare
trask
reviewed
Oct 26, 2021
...pentelemetry/src/main/java/com/azure/core/tracing/opentelemetry/OpenTelemetryHttpPolicy.java
Outdated
Show resolved
Hide resolved
...pentelemetry/src/main/java/com/azure/core/tracing/opentelemetry/OpenTelemetryHttpPolicy.java
Outdated
Show resolved
Hide resolved
...pentelemetry/src/main/java/com/azure/core/tracing/opentelemetry/OpenTelemetryHttpPolicy.java
Outdated
Show resolved
Hide resolved
...pentelemetry/src/main/java/com/azure/core/tracing/opentelemetry/OpenTelemetryHttpPolicy.java
Show resolved
Hide resolved
...ng-opentelemetry/src/main/java/com/azure/core/tracing/opentelemetry/OpenTelemetryTracer.java
Show resolved
Hide resolved
sdk/core/azure-core/src/samples/java/com/azure/core/util/ContextJavaDocCodeSnippets.java
Outdated
Show resolved
Hide resolved
sdk/core/azure-core/src/samples/java/com/azure/core/util/tracing/TracerJavaDocCodeSnippets.java
Show resolved
Hide resolved
thank you! |
trask
reviewed
Oct 26, 2021
...ng-opentelemetry/src/main/java/com/azure/core/tracing/opentelemetry/OpenTelemetryTracer.java
Outdated
Show resolved
Hide resolved
trask
approved these changes
Oct 27, 2021
Comment on lines
+31
to
+35
| Class<?> agentContextStorageClass = Class.forName("io.opentelemetry.javaagent.instrumentation.opentelemetryapi.context.AgentContextStorage"); | ||
| Class<?> agentContextClass = Class.forName("io.opentelemetry.javaagent.shaded.io.opentelemetry.context.Context"); | ||
| Class<?> spanKeyClass = Class.forName("io.opentelemetry.javaagent.shaded.instrumentation.api.instrumenter.SpanKey"); | ||
| Class<?> bridgingClass = Class.forName("io.opentelemetry.javaagent.instrumentation.opentelemetryapi.trace.Bridging"); | ||
| Class<?> agentSpanClass = Class.forName("io.opentelemetry.javaagent.shaded.io.opentelemetry.api.trace.Span"); |
There was a problem hiding this comment.
i'll add a test in the agent to make sure we don't accidentally break this from the agent side (the good news is that since we inject this from the agent we can coordinate)
|
API changes have been detected in API changes - String PARENT_SPAN_KEY = "parent-span";
+ @Deprecated String PARENT_SPAN_KEY = "parent-span";
+ String PARENT_TRACE_CONTEXT_KEY = "trace-context"; |
samvaity
reviewed
Oct 27, 2021
| .addData(spanImplContext, "<user-current-span-context>"); | ||
| Context updatedProcessContext = tracer.start("azure.eventhubs.process", processContext, | ||
| Context updatedProcessContext = tracer.start("EventHubs.process", processContext, |
There was a problem hiding this comment.
will this change be true for Http calls too?
There was a problem hiding this comment.
http spans still take parent context from the same context key. At the same time, they are always children of API-calls spans created by Tracer impl, so context passed by users is a grandparent for them and it never directly affects them.
samvaity
approved these changes
Oct 27, 2021
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.
Fixes #24281, #22272
We now pass trace context in the
com.azure.util.Contextinstead of span: passing span in the context is not correct: context can contain more things (span + baggage + any in-process instrumentation markers). It also leads to potentially wrong context usage in HTTP tracing policy and minor test issues in Pass the tracing context (instead of span) via the Azure Core Context #24281.TODO: Need to figure out how it could work with Support HTTP based Azure SDK service tracing by Spring Sleuth implementation #24192. UPDATE: Discussed and agreed on PARENT_TRACE_CONTEXTWe now propagate implicit context and it works with OTel reactor instrumentation (but could be even better - will work with OTel to fix it)
We now register HTTP span to suppress any further client spans created by the agent (which is the goal of this PR - [BUG] HTTP spans have wrong parent in ApplicationInsights #22272). It's done through reflection, but the long-term solution needs more baking (Instrumentation layers and suppressing duplicates open-telemetry/oteps#172).
Before:
After:
Agent (1.6.2 or 1.7.0)
Application Insights (3.2.1) feels great too