Fix the example installing OpenTelemetryLayer into a global subscriber
#175
+109
−12
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
Shutting down the tracer provider via the opentelemetry::global API has not worked since opentelemetry 0.24 when the batch processor is in use: buffered traces were not exported. It's not necessary to install the global provider for the tracing integration, as tracing has its own way to manage the global subscriber. Instead, manage the instance in the scope guard the same way as the meter provider instance, and call the shutdown method on it when the guard is dropped.
Make sure that an SDK TracerProvider set up with a batch exporter flushes all buffered spans on shutdown.
In the opentelemetry-otlp example, add a comment explaining how filtering should prevent reentrancy into the globally installed tracing layer from the opentelemetry stack where any dependencies might themselves use tracing.
Have you discussed this regression upstream? |
It has been discussed in open-telemetry/opentelemetry-rust#1961. |
This illustrates the problem with opentelemetry::global that prevents proper use of the batched TracerProvider when installed as the global provider, flushing it at the end of the program also with the global API.
djc
approved these changes
Oct 16, 2024
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 #159
Motivation
Use of
global::shutdown_tracer_providerhas regressed since opentelemetry 0.23.Solution
Change the opentelemtry-otlp example to call
shutdownon theTracingProvideravailable in scope.Also added an integration test to verify the export behavior is as expected.