Struct apalis_core::layers::tracing::Trace

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

Available on crate feature trace only.

Middleware that adds high level tracing to an apalis Job.

Implementations

impl<S> Trace<S>

pub fn new(inner: S) -> Self

Create a new Trace .

pub fn layer() -> TraceLayer

Returns a new Layer that wraps services with a TraceLayer middleware.

impl<S, MakeSpan, OnRequest, OnResponse, OnFailure> Trace<S, MakeSpan, OnRequest, OnResponse, OnFailure>

pub fn get_ref(&self) -> &S

Gets a reference to the underlying service.

pub fn get_mut(&mut self) -> &mut S

Gets a mutable reference to the underlying service.

pub fn into_inner(self) -> S

Consumes self, returning the underlying service.

pub fn on_request<NewOnRequest>( self, new_on_request: NewOnRequest ) -> Trace<S, 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 ) -> Trace<S, 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 ) -> Trace<S, 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 ) -> Trace<S, 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<S: Clone, MakeSpan: Clone, OnRequest: Clone, OnResponse: Clone, OnFailure: Clone> Clone for Trace<S, MakeSpan, OnRequest, OnResponse, OnFailure>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<S: Debug, MakeSpan: Debug, OnRequest: Debug, OnResponse: Debug, OnFailure: Debug> Debug for Trace<S, MakeSpan, OnRequest, OnResponse, OnFailure>

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

Formats the value using the given formatter.

impl<J, S, OnRequestT, OnResponseT, OnFailureT, MakeSpanT, F, Res> Service<JobRequest<J>> for Trace<S, MakeSpanT, OnRequestT, OnResponseT, OnFailureT>where S: Service<JobRequest<J>, Response = Res, Error = JobError, Future = F> + Unpin + Send + 'static, S::Error: Display + 'static, MakeSpanT: MakeSpan<J>, OnRequestT: OnRequest<J>, OnResponseT: OnResponse<Res> + Clone + 'static, F: Future<Output = Result<Res, JobError>> + 'static, OnFailureT: OnFailure + Clone + 'static,

type Response = Res

Responses given by the service.

type Error = JobError

Errors produced by the service.

type Future = ResponseFuture<F, OnResponseT, OnFailureT>

The future response value.

fn poll_ready(&mut self, cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>>

Returns Poll::Ready(Ok(())) when the service is able to process requests.

fn call(&mut self, req: JobRequest<J>) -> Self::Future

Process the request and return the response asynchronously.

impl<S: Copy, MakeSpan: Copy, OnRequest: Copy, OnResponse: Copy, OnFailure: Copy> Copy for Trace<S, MakeSpan, OnRequest, OnResponse, OnFailure>