Struct TracerProvider

pub struct TracerProvider { /* private fields */ }

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

impl SdkTracerProvider

pub fn builder() -> TracerProviderBuilder

Create a new SdkTracerProvider builder.

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);
}

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

pub fn shutdown(&self) -> Result<(), OTelSdkError>

shutdown with default timeout

Trait Implementations

impl Clone for SdkTracerProvider

fn clone(&self) -> SdkTracerProvider

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SdkTracerProvider

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Default for SdkTracerProvider

fn default() -> SdkTracerProvider

Returns the “default value” for a type.

impl TracerProvider for SdkTracerProvider

type Tracer = SdkTracer

This implementation of TracerProvider produces Tracer instances.

fn tracer( &self, name: impl Into<Cow<'static, str>>, ) -> <SdkTracerProvider as TracerProvider>::Tracer

Returns a new tracer with the given name.

fn tracer_with_scope( &self, scope: InstrumentationScope, ) -> <SdkTracerProvider as TracerProvider>::Tracer

Returns a new versioned tracer with the given instrumentation scope.