#open-telemetry #axum #tracing #tracing-layer

axum-tracing-opentelemetry

Middlewares and tools to integrate axum + tracing + opentelemetry

44 releases (23 breaking)

0.28.0 Mar 31, 2025
0.25.0 Jan 2, 2025
0.24.1 Nov 24, 2024
0.19.0 Jun 30, 2024
0.2.1 Jun 11, 2022

#233 in Debugging

Download history 84927/week @ 2024-12-17 24157/week @ 2024-12-24 45102/week @ 2024-12-31 140626/week @ 2025-01-07 137896/week @ 2025-01-14 154193/week @ 2025-01-21 191097/week @ 2025-01-28 186902/week @ 2025-02-04 206757/week @ 2025-02-11 138319/week @ 2025-02-18 101458/week @ 2025-02-25 483385/week @ 2025-03-04 372895/week @ 2025-03-11 783402/week @ 2025-03-18 593906/week @ 2025-03-25 259380/week @ 2025-04-01

2,062,912 downloads per month
Used in 13 crates (12 directly)

CC0 license

50KB
722 lines

axum-tracing-opentelemetry

crates license crate version

Project Status: Active – The project has reached a stable, usable state and is being actively developed.

Middlewares to integrate axum + tracing + opentelemetry.

  • Read OpenTelemetry header from incoming request
  • Start a new trace if no trace found in the incoming request
  • Trace is attached into tracing'span
  • OpenTelemetry Span is created on close of the tracing's span (behavior from [tracing-opentelemetry])

For examples, you can look at the examples folder.

//...
use axum_tracing_opentelemetry::opentelemetry_tracing_layer;

#[tokio::main]
async fn main() -> Result<(), axum::BoxError> {
    // very opinionated init of tracing, look at the source to make your own
    let _guard = init_tracing_opentelemetry::tracing_subscriber_ext::init_subscribers()?;

    let app = app();
    // run it
    let addr = &"0.0.0.0:3000".parse::<SocketAddr>()?;
    tracing::warn!("listening on {}", addr);
    let listener = tokio::net::TcpListener::bind(addr).await?;
    axum::serve(listener, app.into_make_service()).await?;
    Ok(())
}

fn app() -> Router {
    Router::new()
        .route("/", get(index)) // request processed inside span
        // include trace context as header into the response
        .layer(OtelInResponseLayer::default())
        //start OpenTelemetry trace on incoming request
        .layer(OtelAxumLayer::default())
        .route("/health", get(health)) // request processed without span / trace
}

For more info about how to initialize, you can look at crate init-tracing-opentelemetry or tracing-opentelemetry.

Changelog - History

CHANGELOG.md

Dependencies

~8.5MB
~151K SLoC