Struct TracerProvider

pub struct TracerProvider { /* private fields */ }

Creator and registry of named Tracer 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 TracerProvider

pub fn builder() -> Builder

Create a new TracerProvider builder.

pub fn force_flush(&self) -> Vec<Result<(), TraceError>>

Force flush all remaining spans in span processors and return results.

Examples

use opentelemetry::global;
use opentelemetry_sdk::trace::TracerProvider;

fn init_tracing() -> TracerProvider {
    let provider = TracerProvider::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
    for result in provider.force_flush() {
        if let Err(err) = result {
            // .. handle flush error
        }
    }

    // create more spans..

    // dropping provider and shutting down global provider ensure all
    // remaining spans are exported
    drop(provider);
    global::shutdown_tracer_provider();
}

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

Shuts down the current TracerProvider.

Note that shut down doesn’t means the TracerProvider has dropped

Trait Implementations

impl Clone for TracerProvider

fn clone(&self) -> TracerProvider

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TracerProvider

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

Formats the value using the given formatter.

impl Default for TracerProvider

fn default() -> TracerProvider

Returns the “default value” for a type.

impl TracerProvider for TracerProvider

type Tracer = Tracer

This implementation of TracerProvider produces Tracer instances.

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

Returns a new tracer with the given name.

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

Returns a new versioned tracer with the given instrumentation scope.