42 releases (22 breaking)

new 0.26.0 Feb 16, 2025
0.24.2 Jan 2, 2025
0.24.1 Nov 24, 2024
0.19.0 Jun 30, 2024
0.2.1 Jun 11, 2022

#234 in Debugging

Download history 52079/week @ 2024-10-27 48570/week @ 2024-11-03 61310/week @ 2024-11-10 77594/week @ 2024-11-17 46668/week @ 2024-11-24 79180/week @ 2024-12-01 93324/week @ 2024-12-08 103973/week @ 2024-12-15 19405/week @ 2024-12-22 41996/week @ 2024-12-29 117719/week @ 2025-01-05 150806/week @ 2025-01-12 147169/week @ 2025-01-19 178860/week @ 2025-01-26 192742/week @ 2025-02-02 217205/week @ 2025-02-09

748,820 downloads per month
Used in 10 crates (9 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
~149K SLoC