Struct apalis_core::layers::tracing::TraceLayer

pub struct TraceLayer<MakeSpan = DefaultMakeSpan, OnRequest = DefaultOnRequest, OnResponse = DefaultOnResponse, OnFailure = DefaultOnFailure> { /* private fields */ }

Available on crate feature trace only.

Layer that adds high level tracing to a Job.

See the module docs for more details.

Implementations

impl TraceLayer

pub fn new() -> Self

Create a new TraceLayer.

impl<MakeSpan, OnRequest, OnResponse, OnFailure> TraceLayer<MakeSpan, OnRequest, OnResponse, OnFailure>

pub fn on_request<NewOnRequest>(
    self,
    new_on_request: NewOnRequest
) -> TraceLayer<MakeSpan, NewOnRequest, OnResponse, OnFailure>

Customize what to do when a request is received.

NewOnRequest is expected to implement OnRequest.

pub fn on_response<NewOnResponse>(
    self,
    new_on_response: NewOnResponse
) -> TraceLayer<MakeSpan, OnRequest, NewOnResponse, OnFailure>

Customize what to do when a response has been produced.

NewOnResponse is expected to implement OnResponse.

pub fn on_failure<NewOnFailure>(
    self,
    new_on_failure: NewOnFailure
) -> TraceLayer<MakeSpan, OnRequest, OnResponse, NewOnFailure>

Customize what to do when a response has been classified as a failure.

NewOnFailure is expected to implement OnFailure.

pub fn make_span_with<NewMakeSpan>(
    self,
    new_make_span: NewMakeSpan
) -> TraceLayer<NewMakeSpan, OnRequest, OnResponse, OnFailure>

Customize how to make Spans that all request handling will be wrapped in.

NewMakeSpan is expected to implement MakeSpan.

Trait Implementations

impl<MakeSpan: Clone, OnRequest: Clone, OnResponse: Clone, OnFailure: Clone> Clone for TraceLayer<MakeSpan, OnRequest, OnResponse, OnFailure>

fn clone(&self) -> TraceLayer<MakeSpan, OnRequest, OnResponse, OnFailure>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<MakeSpan: Debug, OnRequest: Debug, OnResponse: Debug, OnFailure: Debug> Debug for TraceLayer<MakeSpan, OnRequest, OnResponse, OnFailure>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for TraceLayer

fn default() -> Self

Returns the “default value” for a type.

impl<S, MakeSpan, OnRequest, OnResponse, OnFailure> Layer<S> for TraceLayer<MakeSpan, OnRequest, OnResponse, OnFailure>where
    MakeSpan: Clone,
    OnRequest: Clone,
    OnResponse: Clone,
    OnFailure: Clone,

type Service = Trace<S, MakeSpan, OnRequest, OnResponse, OnFailure>

The wrapped service

fn layer(&self, inner: S) -> Self::Service

Wrap the given service with the middleware, returning a new service that has been decorated with the middleware.

impl<MakeSpan: Copy, OnRequest: Copy, OnResponse: Copy, OnFailure: Copy> Copy for TraceLayer<MakeSpan, OnRequest, OnResponse, OnFailure>