Skip to content
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

[PAPAY-1395]: Explicitely shutdown the tracer provider #113

Merged
merged 3 commits into from
Sep 12, 2024
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,7 @@ serde_json = "^1.0"
# dates
chrono = {version = "^0.4", default-features = false, features = ["serde", "clock"]}
url = "2.5.0"
once_cell = "1.19.0"

[dev-dependencies]
actix-web = "4.0.1"
Expand Down
2 changes: 1 addition & 1 deletion src/subscriber.rs
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ pub struct Uninstall;
impl Drop for Uninstall {
fn drop(&mut self) {
#[cfg(feature = "traces")]
opentelemetry::global::shutdown_tracer_provider();
crate::telemetry::shutdown_tracer_provider();
}
}
/// Information about the current app context like name or environment
Expand Down
31 changes: 30 additions & 1 deletion src/telemetry.rs
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
use once_cell::sync::Lazy;
use opentelemetry::global;
use opentelemetry::trace::TracerProvider;
use opentelemetry::KeyValue;
Expand All @@ -6,6 +7,8 @@ use opentelemetry_sdk::{
trace::{self, Tracer},
Resource,
};
use std::mem;
use std::sync::Mutex;

use crate::SubscriberConfig;

Expand Down Expand Up @@ -64,14 +67,40 @@ pub fn configure<T>(config: &SubscriberConfig<T>) -> Tracer {
.install_batch(runtime)
.expect("Failed to configure the OpenTelemetry tracer provider");

global::set_tracer_provider(tracer_provider.clone());
set_tracer_provider(tracer_provider.clone());

tracer_provider
.tracer_builder("prima-tracing")
.with_version(env!("CARGO_PKG_VERSION"))
.build()
}

// Consider to remove this wrapper when https://github.com/open-telemetry/opentelemetry-rust/issues/1961 is resolved
static TRACER_PROVIDER: Lazy<Mutex<Option<trace::TracerProvider>>> = Lazy::new(Default::default);

fn set_tracer_provider(new_provider: trace::TracerProvider) {
global::set_tracer_provider(new_provider.clone());

let mut tracer_provider = TRACER_PROVIDER
.lock()
.expect("OpenTelemetry tracer provider mutex poisoned");
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What about gracefully handle the poison error recovering the old state?

Copy link
Contributor Author

@enerdgumen enerdgumen Sep 11, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It can be poisoned if another thread panicked while it has the mutex locked. But this lock is used only 2 times, at startup and at shutdown.

At startup should not be possible to have a poisoned lock, because noone kept the lock before. At shutdown, it can be poisoned only if the startup panicked (precisely, if mem::replace(&mut *tracer_provider, Some(new_provider)) panicked). But in this case shutdown_tracer_provider will not be called.

So, this seems a good case to use expect, like done by opentelemetry::global::set_tracer_provider...

_ = mem::replace(&mut *tracer_provider, Some(new_provider));
}

pub(crate) fn shutdown_tracer_provider() {
global::shutdown_tracer_provider();

let tracer_provider = TRACER_PROVIDER
.lock()
.expect("OpenTelemetry tracer provider mutex poisoned")
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same here

.take()
.expect("OpenTelemetry tracer provider is missing, cannot shutdown");

if let Err(err) = tracer_provider.shutdown() {
eprintln!("Failed to shutdown the OpenTelemetry tracer provider: {err:?}");
}
}

#[cfg(test)]
mod test {
use super::*;
Expand Down