pub struct TracerProvider { /* private fields */ }
Expand description
Creator and registry of named SdkTracer
instances.
TracerProvider
is a container holding pointers to SpanProcessor
and other components.
Cloning a TracerProvider
instance and dropping it will not stop span processing. To stop span processing, users
must either call the shutdown
method explicitly or allow the last reference to the TracerProvider
to be dropped. When the last reference is dropped, the shutdown process will be automatically triggered
to ensure proper cleanup.
Implementations§
Source§impl SdkTracerProvider
impl SdkTracerProvider
Sourcepub fn builder() -> TracerProviderBuilder
pub fn builder() -> TracerProviderBuilder
Create a new SdkTracerProvider
builder.
Sourcepub fn force_flush(&self) -> Result<(), OTelSdkError>
pub fn force_flush(&self) -> Result<(), OTelSdkError>
Force flush all remaining spans in span processors and return results.
§Examples
use opentelemetry::global;
use opentelemetry_sdk::trace::SdkTracerProvider;
fn init_tracing() -> SdkTracerProvider {
let provider = SdkTracerProvider::default();
// Set provider to be used as global tracer provider
let _ = global::set_tracer_provider(provider.clone());
provider
}
fn main() {
let provider = init_tracing();
// create spans..
// force all spans to flush
if let Err(err) = provider.force_flush() {
// .. handle flush error
}
// create more spans..
// dropping provider ensures all remaining spans are exported
drop(provider);
}
Sourcepub fn shutdown_with_timeout(
&self,
timeout: Duration,
) -> Result<(), OTelSdkError>
pub fn shutdown_with_timeout( &self, timeout: Duration, ) -> Result<(), OTelSdkError>
Shuts down the current TracerProvider
.
Note that shut down doesn’t means the TracerProvider has dropped
Sourcepub fn shutdown(&self) -> Result<(), OTelSdkError>
pub fn shutdown(&self) -> Result<(), OTelSdkError>
shutdown with default timeout
Trait Implementations§
Source§impl Clone for SdkTracerProvider
impl Clone for SdkTracerProvider
Source§fn clone(&self) -> SdkTracerProvider
fn clone(&self) -> SdkTracerProvider
Returns a duplicate of the value. Read more
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source
. Read moreSource§impl Debug for SdkTracerProvider
impl Debug for SdkTracerProvider
Source§impl Default for SdkTracerProvider
impl Default for SdkTracerProvider
Source§fn default() -> SdkTracerProvider
fn default() -> SdkTracerProvider
Returns the “default value” for a type. Read more
Source§impl TracerProvider for SdkTracerProvider
impl TracerProvider for SdkTracerProvider
Source§fn tracer(
&self,
name: impl Into<Cow<'static, str>>,
) -> <SdkTracerProvider as TracerProvider>::Tracer
fn tracer( &self, name: impl Into<Cow<'static, str>>, ) -> <SdkTracerProvider as TracerProvider>::Tracer
Returns a new tracer with the given name. Read more
Source§fn tracer_with_scope(
&self,
scope: InstrumentationScope,
) -> <SdkTracerProvider as TracerProvider>::Tracer
fn tracer_with_scope( &self, scope: InstrumentationScope, ) -> <SdkTracerProvider as TracerProvider>::Tracer
Returns a new versioned tracer with the given instrumentation scope. Read more
Auto Trait Implementations§
impl Freeze for SdkTracerProvider
impl !RefUnwindSafe for SdkTracerProvider
impl Send for SdkTracerProvider
impl Sync for SdkTracerProvider
impl Unpin for SdkTracerProvider
impl !UnwindSafe for SdkTracerProvider
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> FutureExt for T
impl<T> FutureExt for T
Source§fn with_context(self, otel_cx: Context) -> WithContext<Self>
fn with_context(self, otel_cx: Context) -> WithContext<Self>
Source§fn with_current_context(self) -> WithContext<Self>
fn with_current_context(self) -> WithContext<Self>
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoRequest<T> for T
impl<T> IntoRequest<T> for T
Source§fn into_request(self) -> Request<T>
fn into_request(self) -> Request<T>
Wrap the input message
T
in a tonic::Request
Source§impl<S, T, P> ObjectSafeTracerProvider for P
impl<S, T, P> ObjectSafeTracerProvider for P
Source§fn boxed_tracer(
&self,
scope: InstrumentationScope,
) -> Box<dyn ObjectSafeTracer + Send + Sync>
fn boxed_tracer( &self, scope: InstrumentationScope, ) -> Box<dyn ObjectSafeTracer + Send + Sync>
Return a versioned boxed tracer