Crate tracing_opentelemetry_extra

Tracing OpenTelemetry Extra

Reference: This crate is mainly organized based on the official tracing-opentelemetry OTLP example.

This crate provides enhanced OpenTelemetry integration for tracing applications. It’s based on the tracing-opentelemetry examples and provides a clean, easy-to-use API for setting up OpenTelemetry tracing and metrics.

Features

• Easy OpenTelemetry initialization with OTLP exporter
• Configurable sampling and resource attributes
• Automatic cleanup with guard pattern
• Support for both tracing and metrics

Examples

Basic usage with manual setup:

use opentelemetry::KeyValue;
use tracing_opentelemetry_extra::{get_resource, init_tracer_provider, init_env_filter, init_tracing_subscriber, init_meter_provider};
use tracing::Level;

#[tokio::main]
async fn main() -> anyhow::Result<()> {
    // Create resource with service name and attributes
    let resource = get_resource(
        "my-service",
        &[
            KeyValue::new("environment", "production"),
            KeyValue::new("version", "1.0.0"),
        ],
    );

    // Initialize providers
    let tracer_provider = init_tracer_provider(&resource, 1.0)?;
    let meter_provider = init_meter_provider(&resource, 30)?;

    // initialize tracing subscriber with otel layers
    let _guard = init_tracing_subscriber(
        "my-service",
        init_env_filter(&Level::INFO),
        vec![Box::new(tracing_subscriber::fmt::layer())],
        tracer_provider,
        meter_provider,
    )?;
    // Your application code here...

    // Cleanup is handled automatically when the guard is dropped
    Ok(())
}

Re-exports

pub use opentelemetry;

pub use opentelemetry_sdk;

pub use tracing_opentelemetry;

Structs

OtelGuard

A guard that holds the tracer provider and ensures proper cleanup

Functions

get_resource

Creates a resource with the given service name and attributes.

init_meter_provider

Initializes a meter provider for OpenTelemetry metrics.

init_tracer_provider

Initializes a tracer provider for OpenTelemetry tracing.