Struct OtelGuard 

pub struct OtelGuard { /* private fields */ }

Guard that manages OpenTelemetry provider lifecycle.

When this guard is dropped, it automatically flushes and shuts down all configured providers. This ensures telemetry is exported before the application exits or the execution environment freezes.

Example

use opentelemetry_configuration::{OtelSdkBuilder, SdkError};

fn main() -> Result<(), SdkError> {
    let _guard = OtelSdkBuilder::new()
        .service_name("my-lambda")
        .build()?;

    tracing::info!("Application running");

    // On drop, all providers are flushed and shut down
    Ok(())
}

Implementations

impl OtelGuard

pub fn tracer_provider(&self) -> Option<&SdkTracerProvider>

Returns the tracer provider if configured.

pub fn meter_provider(&self) -> Option<&SdkMeterProvider>

Returns the meter provider if configured.

pub fn logger_provider(&self) -> Option<&SdkLoggerProvider>

Returns the logger provider if configured.

pub fn flush(&self)

Flushes all configured providers.

This method is called automatically on drop, but can be called manually if you need to ensure telemetry is exported at a specific point.

Flush errors are logged via tracing::warn! with target otel_lifecycle. To see these warnings, enable the target in your RUST_LOG filter: RUST_LOG=otel_lifecycle=warn

pub fn shutdown(self) -> Result<(), SdkError>

Shuts down all configured providers.

This consumes the guard and shuts down all providers immediately. Any further attempts to use the providers will fail.

Errors

Returns the first error encountered during shutdown.

Trait Implementations

impl Drop for OtelGuard

fn drop(&mut self)

Executes the destructor for this type.