-
Notifications
You must be signed in to change notification settings - Fork 598
Replace once_cell::Lazy with std::sync::OnceLock for global Initialization in OpenTelemetry API crate
#2326
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
Merged
cijothomas
merged 8 commits into
open-telemetry:main
from
lalitb:otel-api-dependencies-cleanup
Nov 23, 2024
Merged
Changes from all commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
01975a7
initial commit
lalitb f994761
Merge branch 'main' into otel-api-dependencies-cleanup
lalitb bd845e2
fix baggage variable names
lalitb ec5b368
avoid temp var
lalitb 821315e
Merge branch 'main' into otel-api-dependencies-cleanup
lalitb aea8a1a
make thiserror optional
lalitb ce0c77c
Merge branch 'main' into otel-api-dependencies-cleanup
lalitb 00a9626
Merge branch 'main' into otel-api-dependencies-cleanup
cijothomas 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,19 +1,29 @@ | ||
| use crate::propagation::TextMapPropagator; | ||
| use crate::trace::noop::NoopTextMapPropagator; | ||
| use once_cell::sync::Lazy; | ||
| use std::sync::RwLock; | ||
| use std::sync::{OnceLock, RwLock}; | ||
|
|
||
| /// The current global `TextMapPropagator` propagator. | ||
| static GLOBAL_TEXT_MAP_PROPAGATOR: Lazy<RwLock<Box<dyn TextMapPropagator + Send + Sync>>> = | ||
| Lazy::new(|| RwLock::new(Box::new(NoopTextMapPropagator::new()))); | ||
| static GLOBAL_TEXT_MAP_PROPAGATOR: OnceLock<RwLock<Box<dyn TextMapPropagator + Send + Sync>>> = | ||
| OnceLock::new(); | ||
|
|
||
| /// The global default `TextMapPropagator` propagator. | ||
| static DEFAULT_TEXT_MAP_PROPAGATOR: Lazy<NoopTextMapPropagator> = | ||
| Lazy::new(NoopTextMapPropagator::new); | ||
| static DEFAULT_TEXT_MAP_PROPAGATOR: OnceLock<NoopTextMapPropagator> = OnceLock::new(); | ||
|
|
||
| /// Ensures the `GLOBAL_TEXT_MAP_PROPAGATOR` is initialized with a `NoopTextMapPropagator`. | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. nit: For each of these methods, we could use a comment similar to what we have for Baggage: /// Returns the default baggage, ensuring it is initialized only once.
So, something like: |
||
| #[inline] | ||
| fn global_text_map_propagator() -> &'static RwLock<Box<dyn TextMapPropagator + Send + Sync>> { | ||
| GLOBAL_TEXT_MAP_PROPAGATOR.get_or_init(|| RwLock::new(Box::new(NoopTextMapPropagator::new()))) | ||
| } | ||
|
|
||
| /// Ensures the `DEFAULT_TEXT_MAP_PROPAGATOR` is initialized. | ||
| #[inline] | ||
| fn default_text_map_propagator() -> &'static NoopTextMapPropagator { | ||
| DEFAULT_TEXT_MAP_PROPAGATOR.get_or_init(NoopTextMapPropagator::new) | ||
| } | ||
|
|
||
| /// Sets the given [`TextMapPropagator`] propagator as the current global propagator. | ||
| pub fn set_text_map_propagator<P: TextMapPropagator + Send + Sync + 'static>(propagator: P) { | ||
| let _lock = GLOBAL_TEXT_MAP_PROPAGATOR | ||
| let _lock = global_text_map_propagator() | ||
| .write() | ||
| .map(|mut global_propagator| *global_propagator = Box::new(propagator)); | ||
| } | ||
|
|
@@ -23,8 +33,11 @@ | |
| where | ||
| F: FnMut(&dyn TextMapPropagator) -> T, | ||
| { | ||
| GLOBAL_TEXT_MAP_PROPAGATOR | ||
| global_text_map_propagator() | ||
| .read() | ||
| .map(|propagator| f(&**propagator)) | ||
| .unwrap_or_else(|_| f(&*DEFAULT_TEXT_MAP_PROPAGATOR as &dyn TextMapPropagator)) | ||
| .unwrap_or_else(|_| { | ||
| let default_propagator = default_text_map_propagator(); | ||
| f(default_propagator as &dyn TextMapPropagator) | ||
| }) | ||
| } | ||
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.
Uh oh!
There was an error while loading. Please reload this page.