chore: remove the global::shutdown_tracer_provider function (#2369)

Author: pitoniak32

README.md

@@ -83,7 +83,7 @@ fn main() {
     });
 
     // Shutdown trace pipeline
-    global::shutdown_tracer_provider();
+    provider.shutdown().expect("TracerProvider should shutdown successfully")
 }
 ```
 

examples/tracing-grpc/src/client.rs

@@ -1,24 +1,23 @@
 use hello_world::greeter_client::GreeterClient;
 use hello_world::HelloRequest;
 use opentelemetry::{global, propagation::Injector};
-use opentelemetry_sdk::{
-    propagation::TraceContextPropagator, runtime::Tokio, trace::TracerProvider,
-};
+use opentelemetry_sdk::{propagation::TraceContextPropagator, runtime::Tokio, trace as sdktrace};
 use opentelemetry_stdout::SpanExporter;
 
 use opentelemetry::{
     trace::{SpanKind, TraceContextExt, Tracer},
     Context, KeyValue,
 };
 
-fn init_tracer() {
+fn init_tracer() -> sdktrace::TracerProvider {
     global::set_text_map_propagator(TraceContextPropagator::new());
     // Install stdout exporter pipeline to be able to retrieve the collected spans.
-    let provider = TracerProvider::builder()
+    let provider = sdktrace::TracerProvider::builder()
         .with_batch_exporter(SpanExporter::default(), Tokio)
         .build();
 
-    global::set_tracer_provider(provider);
+    global::set_tracer_provider(provider.clone());
+    provider
 }
 
 struct MetadataMap<'a>(&'a mut tonic::metadata::MetadataMap);
@@ -75,9 +74,10 @@ async fn greet() -> Result<(), Box<dyn std::error::Error + Send + Sync + 'static
 
 #[tokio::main]
 async fn main() -> Result<(), Box<dyn std::error::Error + Send + Sync + 'static>> {
-    init_tracer();
+    let provider = init_tracer();
     greet().await?;
-    opentelemetry::global::shutdown_tracer_provider();
+
+    provider.shutdown()?;
 
     Ok(())
 }

examples/tracing-grpc/src/server.rs

@@ -11,14 +11,15 @@ use opentelemetry_sdk::{
 use opentelemetry_stdout::SpanExporter;
 use tonic::{transport::Server, Request, Response, Status};
 
-fn init_tracer() {
+fn init_tracer() -> TracerProvider {
     global::set_text_map_propagator(TraceContextPropagator::new());
     // Install stdout exporter pipeline to be able to retrieve the collected spans.
     let provider = TracerProvider::builder()
         .with_batch_exporter(SpanExporter::default(), Tokio)
         .build();
 
-    global::set_tracer_provider(provider);
+    global::set_tracer_provider(provider.clone());
+    provider
 }
 
 #[allow(clippy::derive_partial_eq_without_eq)] // tonic don't derive Eq for generated types. We shouldn't manually change it.
@@ -82,7 +83,7 @@ impl Greeter for MyGreeter {
 
 #[tokio::main]
 async fn main() -> Result<(), Box<dyn std::error::Error + Send + Sync + 'static>> {
-    init_tracer();
+    let provider = init_tracer();
 
     let addr = "[::1]:50051".parse()?;
     let greeter = MyGreeter::default();
@@ -92,7 +93,7 @@ async fn main() -> Result<(), Box<dyn std::error::Error + Send + Sync + 'static>
         .serve(addr)
         .await?;
 
-    opentelemetry::global::shutdown_tracer_provider();
+    provider.shutdown()?;
 
     Ok(())
 }

examples/tracing-jaeger/src/main.rs

@@ -1,4 +1,3 @@
-use opentelemetry::global::shutdown_tracer_provider;
 use opentelemetry::{
     global,
     trace::{TraceContextExt, TraceError, Tracer},
@@ -43,6 +42,7 @@ async fn main() -> Result<(), Box<dyn Error + Send + Sync + 'static>> {
         });
     });
 
-    shutdown_tracer_provider();
+    tracer_provider.shutdown()?;
+
     Ok(())
 }

opentelemetry-otlp/examples/basic-otlp-http/src/main.rs

@@ -156,7 +156,7 @@ async fn main() -> Result<(), Box<dyn Error + Send + Sync + 'static>> {
 
     info!(target: "my-target", "hello from {}. My price is {}", "apple", 1.99);
 
-    global::shutdown_tracer_provider();
+    tracer_provider.shutdown()?;
     logger_provider.shutdown()?;
     meter_provider.shutdown()?;
 

opentelemetry-otlp/examples/basic-otlp/src/main.rs

@@ -139,8 +139,7 @@ async fn main() -> Result<(), Box<dyn Error + Send + Sync + 'static>> {
     });
 
     info!(name: "my-event", target: "my-target", "hello from {}. My price is {}", "apple", 1.99);
-
-    global::shutdown_tracer_provider();
+    tracer_provider.shutdown()?;
     meter_provider.shutdown()?;
     logger_provider.shutdown()?;
 

opentelemetry-otlp/tests/integration_test/tests/traces.rs

@@ -2,7 +2,6 @@
 
 use integration_test_runner::trace_asserter::{read_spans_from_json, TraceAsserter};
 use opentelemetry::global;
-use opentelemetry::global::shutdown_tracer_provider;
 use opentelemetry::trace::TraceError;
 use opentelemetry::{
     trace::{TraceContextExt, Tracer},
@@ -65,7 +64,7 @@ pub async fn traces() -> Result<(), Box<dyn Error + Send + Sync + 'static>> {
         });
     });
 
-    shutdown_tracer_provider();
+    tracer_provider.shutdown()?;
 
     Ok(())
 }

opentelemetry-otlp/tests/smoke.rs

@@ -1,6 +1,5 @@
 use futures_util::StreamExt;
 use opentelemetry::global;
-use opentelemetry::global::shutdown_tracer_provider;
 use opentelemetry::trace::{Span, SpanKind, Tracer};
 use opentelemetry_otlp::{WithExportConfig, WithTonicConfig};
 use opentelemetry_proto::tonic::collector::trace::v1::{
@@ -105,7 +104,7 @@ async fn smoke_tracer() {
             )
             .build();
 
-        global::set_tracer_provider(tracer_provider);
+        global::set_tracer_provider(tracer_provider.clone());
 
         let tracer = global::tracer("smoke");
 
@@ -117,7 +116,9 @@ async fn smoke_tracer() {
         span.add_event("my-test-event", vec![]);
         span.end();
 
-        shutdown_tracer_provider();
+        tracer_provider
+            .shutdown()
+            .expect("tracer_provider should shutdown successfully");
     }
 
     println!("Waiting for request...");

opentelemetry-sdk/CHANGELOG.md

@@ -9,6 +9,7 @@
     transparent change.
     [#2338](https://github.com/open-telemetry/opentelemetry-rust/pull/2338)
   - `ResourceDetector.detect()` no longer supports timeout option.
+  - `opentelemetry::global::shutdown_tracer_provider()` Removed from the API, should now use `tracer_provider.shutdown()` see [#2369](https://github.com/open-telemetry/opentelemetry-rust/pull/2369) for a migration example. "Tracer provider" is cheaply cloneable, so users are encouraged to set a clone of it as the global (ex: `global::set_tracer_provider(provider.clone()))`, so that instrumentations and other components can obtain tracers from `global::tracer()`. The tracer_provider must be kept around to call shutdown on it at the end of application (ex: `tracer_provider.shutdown()`)
 
 ## 0.27.1
 

opentelemetry-sdk/src/lib.rs

@@ -30,7 +30,7 @@
 //!     });
 //!
 //!     // Shutdown trace pipeline
-//!     global::shutdown_tracer_provider();
+//!     provider.shutdown().expect("TracerProvider should shutdown successfully")
 //!     # }
 //! }
 //! # }