Struct TracerProvider

pub struct TracerProvider { /* private fields */ }

Available on crate feature trace only.

Creator and registry of named Tracer instances.

TracerProvider is lightweight container holding pointers to SpanProcessor and other components. Cloning and dropping them will not stop the span processing. To stop span processing, users must either call shutdown method explicitly, or drop every clone of TracerProvider.

Implementations

impl TracerProvider

pub fn builder() -> Builder

Create a new TracerProvider builder.

pub fn force_flush(&self) -> Vec<TraceResult<()>>

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) -> TraceResult<()>

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

Formats the value using the given formatter.

impl Default for TracerProvider

fn default() -> Self

Returns the “default value” for a type.

impl TracerProvider for TracerProvider

type Tracer = Tracer

This implementation of TracerProvider produces Tracer instances.

fn versioned_tracer( &self, name: impl Into<Cow<'static, str>>, version: Option<impl Into<Cow<'static, str>>>, schema_url: Option<impl Into<Cow<'static, str>>>, attributes: Option<Vec<KeyValue>>, ) -> Self::Tracer

👎Deprecated since 0.23.0: Please use tracer_builder() instead

Create a new versioned Tracer instance.

fn library_tracer(&self, library: Arc<InstrumentationLibrary>) -> Self::Tracer

Returns a new versioned tracer with the given instrumentation library.

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

Returns a new tracer with the given name.

fn tracer_builder( &self, name: impl Into<Cow<'static, str>>, ) -> TracerBuilder<'_, Self>

Returns a new builder for creating a Tracer instance