Middlewares and tools to integrate axum + tracing + opentelemetry.
For examples, you can look at:
```rust //... use axumtracingopentelemetry::opentelemetrytracinglayer;
fn inittracing() { use axumtracingopentelemetry::{ makeresource, otlp, //stdio, };
let otel_rsrc = make_resource(env!("CARGO_PKG_NAME"), env!("CARGO_PKG_VERSION"));
let otel_tracer = otlp::init_tracer(otel_rsrc, otlp::identity).expect("setup of Tracer");
// let otel_tracer =
// stdio::init_tracer(otel_rsrc, stdio::identity, stdio::WriteNoWhere::default())
// .expect("setup of Tracer");
let otel_layer = tracing_opentelemetry::layer().with_tracer(otel_tracer);
let subscriber = tracing_subscriber::registry()
//...
.with(otel_layer);
tracing::subscriber::set_global_default(subscriber).unwrap();
}
async fn main() -> Result<(), Box
fn app() -> Router {
// build our application with a route
Router::new()
.route("/", get(health)) // request processed inside span
// opentelemetrytracinglayer setup TraceLayer, that is provided by tower-http so you have to add that as a dependency.
.layer(opentelemetrytracinglayer())
.route("/health", get(health)) // request processed without span / trace
}
async fn shutdownsignal() { //... opentelemetry::global::shutdowntracer_provider(); } ```
To retrieve the current trace_id (eg to add it into error message (as header or attributes))
rust
let trace_id = axum_tracing_opentelemetry::find_current_trace_id();
json!({ "error" : "xxxxxx", "trace_id": trace_id})
To also inject the trace id into the response (could be useful for debugging) uses the layer response_with_trace_layer
rust
// build our application with a route
Router::new()
...
// include trace context as header into the response
.layer(response_with_trace_layer())
examples/otlpIn a terminal, run
sh
❯ cd examples/otlp
❯ cargo run
Finished dev [unoptimized + debuginfo] target(s) in 0.06s
Running `target/debug/examples-otlp`
{"timestamp":" 0.007110513s","level":"WARN","fields":{"message":"listening on 0.0.0.0:3003"},"target":"examples_oltp"}
{"timestamp":" 0.007163973s","level":"INFO","fields":{"message":"try to call `curl -i http://127.0.0.1:3003/` (with trace)"},"target":"examples_oltp"}
{"timestamp":" 0.007181296s","level":"INFO","fields":{"message":"try to call `curl -i http://127.0.0.1:3003/heatlh` (with NO trace)"},"target":"examples_oltp"}
...
Into an other terminal, call the / (endpoint with opentelemetry_tracing_layer and response_with_trace_layer)
```sh ❯ curl -i http://127.0.0.1:3003/ HTTP/1.1 200 OK content-type: application/json content-length: 50 traceparent: 00-b2611246a58fd7ea623d2264c5a1e226-b2c9b811f2f424af-01 tracestate: date: Wed, 28 Dec 2022 17:04:59 GMT
{"mytraceid":"b2611246a58fd7ea623d2264c5a1e226"} ```
call the /health (endpoint with NO layer)
```sh ❯ curl -i http://127.0.0.1:3003/health HTTP/1.1 200 OK content-type: application/json content-length: 15 date: Wed, 28 Dec 2022 17:14:07 GMT
{"status":"UP"} ```
|axum|axum-tracing-opentelemetry| |----|--------------------------| |0.6 | latest - 0.6 | |0.5 | 0.1 - 0.5 |
response_with_trace_layer to have traceparent injected into responseOTEL_EXPORTER_OTLP_TRACES_ENDPOINT, OTEL_EXPORTER_OTLP_ENDPOINT, OTEL_EXPORTER_OTLP_TRACES_PROTOCOL, OTEL_EXPORTER_OTLP_PROTOCOL/dev/null) to allow to have trace_id
and the opentelemetry span & metadata on log and http response (without collector)