Struct apalis_core::layers::tracing::Trace

source · [−]

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

Available on crate feature trace only.

Expand description

Middleware that adds high level tracing to an apalis Job.

Implementations

source

impl<S> Trace<S>

source

pub fn new(inner: S) -> Self

Create a new Trace .

source

pub fn layer() -> TraceLayer

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

source

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

source

pub fn get_ref(&self) -> &S

Gets a reference to the underlying service.

source

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

Gets a mutable reference to the underlying service.

source

pub fn into_inner(self) -> S

Consumes self, returning the underlying service.

source

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.

source

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.

source

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.

source

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

source

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

source

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

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

source

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

source

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

Formats the value using the given formatter. Read more

source

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

type Response = JobResult

Responses given by the service.

type Error = JobError

Errors produced by the service.

type Future = ResponseFuture<F, OnResponseT, OnFailureT>

The future response value.

source

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

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

source

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

Process the request and return the response asynchronously. Read more

source

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

Auto Trait Implementations

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

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

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

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

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

Blanket Implementations

source

impl<T> Any for T where
T: 'static + ?Sized,

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T> Instrument for T

source

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

source

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

source

impl<T, U> Into for T where
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source

impl<T, Request> ServiceExt<Request> for T where
T: Service<Request> + ?Sized,

source

fn ready(&mut self) -> Ready<'_, Self, Request>

Yields a mutable reference to the service when it is ready to accept a request.

source

fn ready_and(&mut self) -> Ready<'_, Self, Request>

👎 Deprecated since 0.4.6:

please use the ServiceExt::ready method instead

Yields a mutable reference to the service when it is ready to accept a request.

source

fn ready_oneshot(self) -> ReadyOneshot<Self, Request>

Yields the service when it is ready to accept a request.

source

fn oneshot(self, req: Request) -> Oneshot<Self, Request>

Consume this Service, calling with the providing request once it is ready.

source

fn call_all<S>(self, reqs: S) -> CallAll<Self, S> where
S: Stream<Item = Request>,
Self::Error: Into<Box<dyn Error + Send + Sync + 'static, Global>>,

Process all requests from the given Stream, and produce a Stream of their responses. Read more

source

fn and_then<F>(self, f: F) -> AndThen<Self, F> where
F: Clone,

Executes a new future after this service’s future resolves. This does not alter the behaviour of the poll_ready method. Read more

source

fn map_response<F, Response>(self, f: F) -> MapResponse<Self, F> where
F: FnOnce(Self::Response) -> Response + Clone,

Maps this service’s response value to a different value. This does not alter the behaviour of the poll_ready method. Read more

source

fn map_err<F, Error>(self, f: F) -> MapErr<Self, F> where
F: FnOnce(Self::Error) -> Error + Clone,

Maps this service’s error value to a different value. This does not alter the behaviour of the poll_ready method. Read more

source

fn map_result<F, Response, Error>(self, f: F) -> MapResult<Self, F> where
Error: From<Self::Error>,
F: FnOnce(Result<Self::Response, Self::Error>) -> Result<Response, Error> + Clone,

Maps this service’s result type (Result<Self::Response, Self::Error>) to a different value, regardless of whether the future succeeds or fails. Read more

source

fn map_request<F, NewRequest>(self, f: F) -> MapRequest<Self, F> where
F: FnMut(NewRequest) -> Request,

Composes a function in front of the service. Read more

source

fn filter<F, NewRequest>(self, filter: F) -> Filter<Self, F> where
F: Predicate<NewRequest>,

Composes this service with a Filter that conditionally accepts or rejects requests based on a predicate. Read more

source

fn filter_async<F, NewRequest>(self, filter: F) -> AsyncFilter<Self, F> where
F: AsyncPredicate<NewRequest>,

Composes this service with an AsyncFilter that conditionally accepts or rejects requests based on an [async predicate]. Read more

source

fn then<F, Response, Error, Fut>(self, f: F) -> Then<Self, F> where
 Error: From<Self::Error>,
 F: FnOnce(Result<Self::Response, Self::Error>) -> Fut + Clone,
 Fut: Future<Output = Result<Response, Error>>,

Composes an asynchronous function after this service. Read more

source

fn map_future<F, Fut, Response, Error>(self, f: F) -> MapFuture<Self, F> where
 F: FnMut(Self::Future) -> Fut,
 Error: From<Self::Error>,
 Fut: Future<Output = Result<Response, Error>>,

Composes a function that transforms futures produced by the service. Read more

source

fn boxed(self) -> BoxService<Request, Self::Response, Self::Error> where
 Self: 'static + Send,
 Self::Future: 'static,
 Self::Future: Send,

Convert the service into a Service + Send trait object. Read more

source

fn boxed_clone(self) -> BoxCloneService<Request, Self::Response, Self::Error> where
 Self: 'static + Clone + Send,
 Self::Future: 'static,
 Self::Future: Send,

Convert the service into a Service + Clone + Send trait object. Read more

source

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

source

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

source

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

source

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

source

impl<T> WithSubscriber for T

source

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

source

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more

Struct apalis_core::layers::tracing::Trace

Implementations

impl<S> Trace<S>

pub fn new(inner: S) -> Self

pub fn layer() -> TraceLayer

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

pub fn get_ref(&self) -> &S

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

pub fn into_inner(self) -> S

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

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

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

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

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>

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

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

type Response = JobResult

type Error = JobError

type Future = ResponseFuture<F, OnResponseT, OnFailureT>

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

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

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

Auto Trait Implementations

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

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

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

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

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

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

fn from(t: T) -> T

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

fn in_current_span(self) -> Instrumented<Self>

impl<T, U> Into<U> for T where U: From<T>,

fn into(self) -> U

impl<T, Request> ServiceExt<Request> for T where T: Service<Request> + ?Sized,

fn ready(&mut self) -> Ready<'_, Self, Request>

fn ready_and(&mut self) -> Ready<'_, Self, Request>

fn ready_oneshot(self) -> ReadyOneshot<Self, Request>

fn oneshot(self, req: Request) -> Oneshot<Self, Request>

fn call_all<S>(self, reqs: S) -> CallAll<Self, S> where S: Stream<Item = Request>, Self::Error: Into<Box<dyn Error + Send + Sync + 'static, Global>>,

fn and_then<F>(self, f: F) -> AndThen<Self, F> where F: Clone,

fn map_response<F, Response>(self, f: F) -> MapResponse<Self, F> where F: FnOnce(Self::Response) -> Response + Clone,

fn map_err<F, Error>(self, f: F) -> MapErr<Self, F> where F: FnOnce(Self::Error) -> Error + Clone,

fn map_result<F, Response, Error>(self, f: F) -> MapResult<Self, F> where Error: From<Self::Error>, F: FnOnce(Result<Self::Response, Self::Error>) -> Result<Response, Error> + Clone,

fn map_request<F, NewRequest>(self, f: F) -> MapRequest<Self, F> where F: FnMut(NewRequest) -> Request,

fn filter<F, NewRequest>(self, filter: F) -> Filter<Self, F> where F: Predicate<NewRequest>,

fn filter_async<F, NewRequest>(self, filter: F) -> AsyncFilter<Self, F> where F: AsyncPredicate<NewRequest>,

fn then<F, Response, Error, Fut>(self, f: F) -> Then<Self, F> where Error: From<Self::Error>, F: FnOnce(Result<Self::Response, Self::Error>) -> Fut + Clone, Fut: Future<Output = Result<Response, Error>>,

fn map_future<F, Fut, Response, Error>(self, f: F) -> MapFuture<Self, F> where F: FnMut(Self::Future) -> Fut, Error: From<Self::Error>, Fut: Future<Output = Result<Response, Error>>,

fn boxed(self) -> BoxService<Request, Self::Response, Self::Error> where Self: 'static + Send, Self::Future: 'static, Self::Future: Send,

fn boxed_clone(self) -> BoxCloneService<Request, Self::Response, Self::Error> where Self: 'static + Clone + Send, Self::Future: 'static, Self::Future: Send,

impl<T> ToOwned for T where T: Clone,

type Owned = T

fn to_owned(&self) -> T

fn clone_into(&self, target: &mut T)

impl<T, U> TryFrom<U> for T where U: Into<T>,

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for T where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where S: Into<Dispatch>,

fn with_current_subscriber(self) -> WithDispatch<Self>

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

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

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

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

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

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

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

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

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

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T, U> Into<U> for T where
U: From<T>,

impl<T, Request> ServiceExt<Request> for T where
T: Service<Request> + ?Sized,

fn call_all<S>(self, reqs: S) -> CallAll<Self, S> where
S: Stream<Item = Request>,
Self::Error: Into<Box<dyn Error + Send + Sync + 'static, Global>>,

fn and_then<F>(self, f: F) -> AndThen<Self, F> where
F: Clone,

fn map_response<F, Response>(self, f: F) -> MapResponse<Self, F> where
F: FnOnce(Self::Response) -> Response + Clone,

fn map_err<F, Error>(self, f: F) -> MapErr<Self, F> where
F: FnOnce(Self::Error) -> Error + Clone,

fn map_result<F, Response, Error>(self, f: F) -> MapResult<Self, F> where
Error: From<Self::Error>,
F: FnOnce(Result<Self::Response, Self::Error>) -> Result<Response, Error> + Clone,

fn map_request<F, NewRequest>(self, f: F) -> MapRequest<Self, F> where
F: FnMut(NewRequest) -> Request,

fn filter<F, NewRequest>(self, filter: F) -> Filter<Self, F> where
F: Predicate<NewRequest>,

fn filter_async<F, NewRequest>(self, filter: F) -> AsyncFilter<Self, F> where
F: AsyncPredicate<NewRequest>,

fn then<F, Response, Error, Fut>(self, f: F) -> Then<Self, F> where
Error: From<Self::Error>,
F: FnOnce(Result<Self::Response, Self::Error>) -> Fut + Clone,
Fut: Future<Output = Result<Response, Error>>,

fn map_future<F, Fut, Response, Error>(self, f: F) -> MapFuture<Self, F> where
F: FnMut(Self::Future) -> Fut,
Error: From<Self::Error>,
Fut: Future<Output = Result<Response, Error>>,

fn boxed(self) -> BoxService<Request, Self::Response, Self::Error> where
Self: 'static + Send,
Self::Future: 'static,
Self::Future: Send,

fn boxed_clone(self) -> BoxCloneService<Request, Self::Response, Self::Error> where
Self: 'static + Clone + Send,
Self::Future: 'static,
Self::Future: Send,

impl<T> ToOwned for T where
T: Clone,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,