Struct tracing_actix_web::TracingLogger [−][src]
pub struct TracingLogger<RootSpan: RootSpanBuilder> { /* fields omitted */ }
Expand description
TracingLogger
is a middleware to capture structured diagnostic when processing an HTTP request.
Check the crate-level documentation for an in-depth introduction.
TracingLogger
is designed as a drop-in replacement of actix-web
’s Logger
.
Usage
Register TracingLogger
as a middleware for your application using .wrap
on App
.
In this example we add a tracing::Subscriber
to output structured logs to the console.
use actix_web::middleware::Logger; use actix_web::App; use tracing::{Subscriber, subscriber::set_global_default}; use tracing_actix_web::TracingLogger; use tracing_log::LogTracer; use tracing_bunyan_formatter::{BunyanFormattingLayer, JsonStorageLayer}; use tracing_subscriber::{layer::SubscriberExt, EnvFilter, Registry}; /// Compose multiple layers into a `tracing`'s subscriber. pub fn get_subscriber( name: String, env_filter: String ) -> impl Subscriber + Send + Sync { let env_filter = EnvFilter::try_from_default_env() .unwrap_or(EnvFilter::new(env_filter)); let formatting_layer = BunyanFormattingLayer::new( name.into(), std::io::stdout ); Registry::default() .with(env_filter) .with(JsonStorageLayer) .with(formatting_layer) } /// Register a subscriber as global default to process span data. /// /// It should only be called once! pub fn init_subscriber(subscriber: impl Subscriber + Send + Sync) { LogTracer::init().expect("Failed to set logger"); set_global_default(subscriber).expect("Failed to set subscriber"); } fn main() { let subscriber = get_subscriber("app".into(), "info".into()); init_subscriber(subscriber); let app = App::new().wrap(TracingLogger::default()); }
Implementations
Trait Implementations
impl<S, B, RootSpan> Transform<S, ServiceRequest> for TracingLogger<RootSpan> where
S: Service<ServiceRequest, Response = ServiceResponse<B>, Error = Error>,
S::Future: 'static,
B: 'static,
RootSpan: RootSpanBuilder,
impl<S, B, RootSpan> Transform<S, ServiceRequest> for TracingLogger<RootSpan> where
S: Service<ServiceRequest, Response = ServiceResponse<B>, Error = Error>,
S::Future: 'static,
B: 'static,
RootSpan: RootSpanBuilder,
type Response = ServiceResponse<B>
type Response = ServiceResponse<B>
Responses produced by the service.
type Transform = TracingLoggerMiddleware<S, RootSpan>
type Transform = TracingLoggerMiddleware<S, RootSpan>
The TransformService
value created by this factory
Creates and returns a new Transform component, asynchronously
Auto Trait Implementations
impl<RootSpan> RefUnwindSafe for TracingLogger<RootSpan> where
RootSpan: RefUnwindSafe,
impl<RootSpan> Send for TracingLogger<RootSpan> where
RootSpan: Send,
impl<RootSpan> Sync for TracingLogger<RootSpan> where
RootSpan: Sync,
impl<RootSpan> Unpin for TracingLogger<RootSpan> where
RootSpan: Unpin,
impl<RootSpan> UnwindSafe for TracingLogger<RootSpan> where
RootSpan: UnwindSafe,
Blanket Implementations
Mutably borrows from an owned value. Read more
Instruments this type with the provided Span
, returning an
Instrumented
wrapper. Read more
Instruments this type with the provided Span
, returning an
Instrumented
wrapper. Read more
type Output = T
type Output = T
Should always be Self
pub fn vzip(self) -> V
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more