tracing-actix-web provides [TracingLogger], a middleware to collect telemetry data from applications built on top of the [actix-web] framework.
Add tracing-actix-web to your dependencies:
```toml [dependencies]
tracing-actix-web = "0.7" tracing = "0.1" actix-web = "4" ```
tracing-actix-web exposes three feature flags:
opentelemetry_0_13: attach OpenTelemetry's context to the root span using opentelemetry 0.13;opentelemetry_0_14: same as above but using opentelemetry 0.14;opentelemetry_0_15: same as above but using opentelemetry 0.15;opentelemetry_0_16: same as above but using opentelemetry 0.16;opentelemetry_0_17: same as above but using opentelemetry 0.17;opentelemetry_0_18: same as above but using opentelemetry 0.18;emit_event_on_error: emit a [tracing] event when request processing fails with an error (enabled by default).```rust,compilefail use actixweb::{App, web, HttpServer}; use tracingactixweb::TracingLogger;
fn main() {
// Init your tracing subscriber here!
let server = HttpServer::new(|| {
App::new()
// Mount `TracingLogger` as a middleware
.wrap(TracingLogger::default())
.service( /* */ )
});
} ```
Check out the examples on GitHub to get a taste of how [TracingLogger] can be used to observe and monitor your
application.
tracing: who art thou?[TracingLogger] is built on top of [tracing], a modern instrumentation framework with
a vibrant ecosystem.
tracing-actix-web's documentation provides a crash course in how to use [tracing] to instrument an actix-web application.
If you want to learn more check out "Are we observable yet?" -
it provides an in-depth introduction to the crate and the problems it solves within the bigger picture of observability.
A [tracing::Span] has a beginning and an end. It can include one or more child spans to represent sub-unit
of works within a larger task.
When your application receives a request, [TracingLogger] creates a new span - we call it the [root span].
All the spans created while processing the request will be children of the root span.
[tracing] empowers us to attach structured properties to a span as a collection of key-value pairs.
Those properties can then be queried in a variety of tools (e.g. ElasticSearch, Honeycomb, DataDog) to
understand what is happening in your system.
RootSpanBuilder]Troubleshooting becomes much easier when the root span has a rich context - e.g. you can understand most of what happened when processing the request just by looking at the properties attached to the corresponding root span.
You might have heard of this technique as the canonical log line pattern, popularised by Stripe. It is more recently discussed in terms of high-cardinality events by Honeycomb and other vendors in the observability space.
[TracingLogger] gives you a chance to use the very same pattern: you can customise the properties attached
to the root span in order to capture the context relevant to your specific domain.
[TracingLogger::default] is equivalent to:
```rust use tracingactixweb::{TracingLogger, DefaultRootSpanBuilder};
// Two ways to initialise TracingLogger with the default root span builder
let default = TracingLogger::default();
let another_way = TracingLogger::
We are delegating the construction of the root span to [DefaultRootSpanBuilder].
[DefaultRootSpanBuilder] captures, out of the box, several dimensions that are usually relevant when looking at an HTTP
API: method, version, route, etc. - check out its documentation for an extensive list.
You can customise the root span by providing your own implementation of the [RootSpanBuilder] trait.
Let's imagine, for example, that our system cares about a client identifier embedded inside an authorization header.
We could add a client_id property to the root span using a custom builder, DomainRootSpanBuilder:
```rust use actixweb::body::MessageBody; use actixweb::dev::{ServiceResponse, ServiceRequest}; use actixweb::Error; use tracingactix_web::{TracingLogger, DefaultRootSpanBuilder, RootSpanBuilder}; use tracing::Span;
pub struct DomainRootSpanBuilder;
impl RootSpanBuilder for DomainRootSpanBuilder { fn onrequeststart(request: &ServiceRequest) -> Span { let clientid: &str = todo!("Somehow extract it from the authorization header"); tracing::infospan!("Request", client_id) }
fn on_request_end<B: MessageBody>(_span: Span, _outcome: &Result<ServiceResponse<B>, Error>) {}
}
let custom_middleware = TracingLogger::
There is an issue, though: client_id is the only property we are capturing.
With DomainRootSpanBuilder, as it is, we do not get any of that useful HTTP-related information provided by
[DefaultRootSpanBuilder].
We can do better!
```rust use actixweb::body::MessageBody; use actixweb::dev::{ServiceResponse, ServiceRequest}; use actixweb::Error; use tracingactix_web::{TracingLogger, DefaultRootSpanBuilder, RootSpanBuilder}; use tracing::Span;
pub struct DomainRootSpanBuilder;
impl RootSpanBuilder for DomainRootSpanBuilder { fn onrequeststart(request: &ServiceRequest) -> Span { let clientid: &str = todo!("Somehow extract it from the authorization header"); tracingactixweb::rootspan!(request, client_id) }
fn on_request_end<B: MessageBody>(span: Span, outcome: &Result<ServiceResponse<B>, Error>) {
DefaultRootSpanBuilder::on_request_end(span, outcome);
}
}
let custom_middleware = TracingLogger::
[root_span!] is a macro provided by tracing-actix-web: it creates a new span by combining all the HTTP properties tracked
by [DefaultRootSpanBuilder] with the custom ones you specify when calling it (e.g. client_id in our example).
We need to use a macro because tracing requires all the properties attached to a span to be declared upfront, when the span is created.
You cannot add new ones afterwards. This makes it extremely fast, but it pushes us to reach for macros when we need some level of
composition.
[root_span!] exposes more or less the same knob you can find on tracing's span! macro. You can, for example, customise
the span level:
```rust use actixweb::body::MessageBody; use actixweb::dev::{ServiceResponse, ServiceRequest}; use actixweb::Error; use tracingactix_web::{TracingLogger, DefaultRootSpanBuilder, RootSpanBuilder, Level}; use tracing::Span;
pub struct CustomLevelRootSpanBuilder;
impl RootSpanBuilder for CustomLevelRootSpanBuilder { fn onrequeststart(request: &ServiceRequest) -> Span { let level = if request.path() == "/healthcheck" { Level::DEBUG } else { Level::INFO }; tracingactixweb::rootspan!(level = level, request) }
fn on_request_end<B: MessageBody>(span: Span, outcome: &Result<ServiceResponse<B>, Error>) {
DefaultRootSpanBuilder::on_request_end(span, outcome);
}
}
let custom_middleware = TracingLogger::
RootSpan] extractorIt often happens that not all information about a task is known upfront, encoded in the incoming request.
You can use the [RootSpan] extractor to grab the root span in your handlers and attach more information
to your root span as it becomes available:
```rust use actixweb::body::MessageBody; use actixweb::dev::{ServiceResponse, ServiceRequest}; use actixweb::{Error, HttpResponse}; use tracingactixweb::{RootSpan, DefaultRootSpanBuilder, RootSpanBuilder}; use tracing::Span; use actixweb::get; use tracingactixweb::RequestId; use uuid::Uuid;
async fn handler(rootspan: RootSpan) -> HttpResponse { let applicationid: &str = todo!("Some domain logic"); // Record the property value against the root span rootspan.record("applicationid", &application_id);
// [...]
# todo!()
}
pub struct DomainRootSpanBuilder;
impl RootSpanBuilder for DomainRootSpanBuilder {
fn onrequeststart(request: &ServiceRequest) -> Span {
let clientid: &str = todo!("Somehow extract it from the authorization header");
// All fields you want to capture must be declared upfront.
// If you don't know the value (yet), use tracing's Empty
tracingactixweb::rootspan!(
request,
clientid, applicationid = tracing::field::Empty
)
}
fn on_request_end<B: MessageBody>(span: Span, response: &Result<ServiceResponse<B>, Error>) {
DefaultRootSpanBuilder::on_request_end(span, response);
}
} ```
tracing-actix-web generates a unique identifier for each incoming request, the request id.
You can extract the request id using the [RequestId] extractor:
```rust use actixweb::get; use tracingactix_web::RequestId; use uuid::Uuid;
async fn index(requestid: RequestId) -> String { format!("{}", requestid) } ```
The request id is meant to identify all operations related to a particular request within the boundary of your API.
If you need to trace a request across multiple services (e.g. in a microservice architecture), you want to look at the trace_id field - see the next section on OpenTelemetry for more details.
To fulfill a request you often have to perform additional I/O operations - e.g. calls to other REST or gRPC APIs, database queries, etc.
Distributed tracing is the standard approach to trace a single request across the entirety of your stack.
tracing-actix-web provides support for distributed tracing by supporting the OpenTelemetry standard.
tracing-actix-web follows OpenTelemetry's semantic convention
for field names.
Furthermore, it provides an opentelemetry_0_17 feature flag to automatically performs trace propagation: it tries to extract the OpenTelemetry context out of the headers of incoming requests and, when it finds one, it sets it as the remote context for the current root span. The context is then propagated to your downstream dependencies if your HTTP or gRPC clients are OpenTelemetry-aware - e.g. using reqwest-middleware and reqwest-tracing if you are using reqwest as your HTTP client.
You can then find all logs for the same request across all the services it touched by looking for the trace_id, automatically logged by tracing-actix-web.
If you add tracing-opentelemetry::OpenTelemetryLayer
in your tracing::Subscriber you will be able to export the root span (and all its children) as OpenTelemetry spans.
Check out the relevant example in the GitHub repository for reference.
Licensed under either of Apache License, Version 2.0 or MIT license at your option.
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in tracing-actix-web by you, as defined in the Apache-2.0 license, shall be
dual licensed as above, without any additional terms or conditions.