Skip to content

Commit 07dea1e

Browse files
committed
chore: remove the global::shutdown_tracer_provider function
this should no longer be in the spec, making consistent with logs and metrics
1 parent e0159ad commit 07dea1e

File tree

17 files changed

+71
-69
lines changed

17 files changed

+71
-69
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@ fn main() {
8383
});
8484

8585
// Shutdown trace pipeline
86-
global::shutdown_tracer_provider();
86+
provider.shutdown().expect("TracerProvider should shutdown successfully")
8787
}
8888
```
8989

examples/tracing-grpc/src/client.rs

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,23 @@
11
use hello_world::greeter_client::GreeterClient;
22
use hello_world::HelloRequest;
33
use opentelemetry::{global, propagation::Injector};
4-
use opentelemetry_sdk::{
5-
propagation::TraceContextPropagator, runtime::Tokio, trace::TracerProvider,
6-
};
4+
use opentelemetry_sdk::{propagation::TraceContextPropagator, runtime::Tokio, trace as sdktrace};
75
use opentelemetry_stdout::SpanExporter;
86

97
use opentelemetry::{
108
trace::{SpanKind, TraceContextExt, Tracer},
119
Context, KeyValue,
1210
};
1311

14-
fn init_tracer() {
12+
fn init_tracer() -> sdktrace::TracerProvider {
1513
global::set_text_map_propagator(TraceContextPropagator::new());
1614
// Install stdout exporter pipeline to be able to retrieve the collected spans.
17-
let provider = TracerProvider::builder()
15+
let provider = sdktrace::TracerProvider::builder()
1816
.with_batch_exporter(SpanExporter::default(), Tokio)
1917
.build();
2018

21-
global::set_tracer_provider(provider);
19+
global::set_tracer_provider(provider.clone());
20+
provider
2221
}
2322

2423
struct MetadataMap<'a>(&'a mut tonic::metadata::MetadataMap);
@@ -75,9 +74,10 @@ async fn greet() -> Result<(), Box<dyn std::error::Error + Send + Sync + 'static
7574

7675
#[tokio::main]
7776
async fn main() -> Result<(), Box<dyn std::error::Error + Send + Sync + 'static>> {
78-
init_tracer();
77+
let provider = init_tracer();
7978
greet().await?;
80-
opentelemetry::global::shutdown_tracer_provider();
79+
80+
provider.shutdown()?;
8181

8282
Ok(())
8383
}

examples/tracing-grpc/src/server.rs

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,14 +11,15 @@ use opentelemetry_sdk::{
1111
use opentelemetry_stdout::SpanExporter;
1212
use tonic::{transport::Server, Request, Response, Status};
1313

14-
fn init_tracer() {
14+
fn init_tracer() -> TracerProvider {
1515
global::set_text_map_propagator(TraceContextPropagator::new());
1616
// Install stdout exporter pipeline to be able to retrieve the collected spans.
1717
let provider = TracerProvider::builder()
1818
.with_batch_exporter(SpanExporter::default(), Tokio)
1919
.build();
2020

21-
global::set_tracer_provider(provider);
21+
global::set_tracer_provider(provider.clone());
22+
provider
2223
}
2324

2425
#[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 {
8283

8384
#[tokio::main]
8485
async fn main() -> Result<(), Box<dyn std::error::Error + Send + Sync + 'static>> {
85-
init_tracer();
86+
let provider = init_tracer();
8687

8788
let addr = "[::1]:50051".parse()?;
8889
let greeter = MyGreeter::default();
@@ -92,7 +93,7 @@ async fn main() -> Result<(), Box<dyn std::error::Error + Send + Sync + 'static>
9293
.serve(addr)
9394
.await?;
9495

95-
opentelemetry::global::shutdown_tracer_provider();
96+
provider.shutdown()?;
9697

9798
Ok(())
9899
}

examples/tracing-jaeger/src/main.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
use opentelemetry::global::shutdown_tracer_provider;
21
use opentelemetry::{
32
global,
43
trace::{TraceContextExt, TraceError, Tracer},
@@ -43,6 +42,7 @@ async fn main() -> Result<(), Box<dyn Error + Send + Sync + 'static>> {
4342
});
4443
});
4544

46-
shutdown_tracer_provider();
45+
tracer_provider.shutdown()?;
46+
4747
Ok(())
4848
}

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -156,7 +156,7 @@ async fn main() -> Result<(), Box<dyn Error + Send + Sync + 'static>> {
156156

157157
info!(target: "my-target", "hello from {}. My price is {}", "apple", 1.99);
158158

159-
global::shutdown_tracer_provider();
159+
tracer_provider.shutdown()?;
160160
logger_provider.shutdown()?;
161161
meter_provider.shutdown()?;
162162

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

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -139,8 +139,7 @@ async fn main() -> Result<(), Box<dyn Error + Send + Sync + 'static>> {
139139
});
140140

141141
info!(name: "my-event", target: "my-target", "hello from {}. My price is {}", "apple", 1.99);
142-
143-
global::shutdown_tracer_provider();
142+
tracer_provider.shutdown()?;
144143
meter_provider.shutdown()?;
145144
logger_provider.shutdown()?;
146145

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

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@
22

33
use integration_test_runner::trace_asserter::{read_spans_from_json, TraceAsserter};
44
use opentelemetry::global;
5-
use opentelemetry::global::shutdown_tracer_provider;
65
use opentelemetry::trace::TraceError;
76
use opentelemetry::{
87
trace::{TraceContextExt, Tracer},
@@ -53,7 +52,7 @@ pub async fn traces() -> Result<(), Box<dyn Error + Send + Sync + 'static>> {
5352
});
5453
});
5554

56-
shutdown_tracer_provider();
55+
tracer_provider.shutdown()?;
5756

5857
Ok(())
5958
}

opentelemetry-otlp/tests/smoke.rs

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
use futures_util::StreamExt;
22
use opentelemetry::global;
3-
use opentelemetry::global::shutdown_tracer_provider;
43
use opentelemetry::trace::{Span, SpanKind, Tracer};
54
use opentelemetry_otlp::{WithExportConfig, WithTonicConfig};
65
use opentelemetry_proto::tonic::collector::trace::v1::{
@@ -105,7 +104,7 @@ async fn smoke_tracer() {
105104
)
106105
.build();
107106

108-
global::set_tracer_provider(tracer_provider);
107+
global::set_tracer_provider(tracer_provider.clone());
109108

110109
let tracer = global::tracer("smoke");
111110

@@ -117,7 +116,9 @@ async fn smoke_tracer() {
117116
span.add_event("my-test-event", vec![]);
118117
span.end();
119118

120-
shutdown_tracer_provider();
119+
tracer_provider
120+
.shutdown()
121+
.expect("tracer_provider should shutdown successfully");
121122
}
122123

123124
println!("Waiting for request...");

opentelemetry-sdk/src/lib.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@
3030
//! });
3131
//!
3232
//! // Shutdown trace pipeline
33-
//! global::shutdown_tracer_provider();
33+
//! provider.shutdown().expect("TracerProvider should shutdown successfully")
3434
//! # }
3535
//! }
3636
//! # }

opentelemetry-sdk/src/trace/provider.rs

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -219,10 +219,8 @@ impl TracerProvider {
219219
///
220220
/// // create more spans..
221221
///
222-
/// // dropping provider and shutting down global provider ensure all
223-
/// // remaining spans are exported
222+
/// // dropping provider ensures all remaining spans are exported
224223
/// drop(provider);
225-
/// global::shutdown_tracer_provider();
226224
/// }
227225
/// ```
228226
pub fn force_flush(&self) -> Vec<TraceResult<()>> {

0 commit comments

Comments
 (0)