Struct tower_http::trace::Trace
source · pub struct Trace<S, M, MakeSpan = DefaultMakeSpan, OnRequest = DefaultOnRequest, OnResponse = DefaultOnResponse, OnBodyChunk = DefaultOnBodyChunk, OnEos = DefaultOnEos, OnFailure = DefaultOnFailure> { /* private fields */ }
Expand description
Middleware that adds high level tracing to a Service
.
See the module docs for an example.
Implementations§
source§impl<S, M> Trace<S, M>
impl<S, M> Trace<S, M>
sourcepub fn new(inner: S, make_classifier: M) -> Selfwhere
M: MakeClassifier,
pub fn new(inner: S, make_classifier: M) -> Selfwhere
M: MakeClassifier,
Create a new Trace
using the given MakeClassifier
.
sourcepub fn layer(make_classifier: M) -> TraceLayer<M>where
M: MakeClassifier,
pub fn layer(make_classifier: M) -> TraceLayer<M>where
M: MakeClassifier,
Returns a new Layer
that wraps services with a TraceLayer
middleware.
source§impl<S, M, MakeSpan, OnRequest, OnResponse, OnBodyChunk, OnEos, OnFailure> Trace<S, M, MakeSpan, OnRequest, OnResponse, OnBodyChunk, OnEos, OnFailure>
impl<S, M, MakeSpan, OnRequest, OnResponse, OnBodyChunk, OnEos, OnFailure> Trace<S, M, MakeSpan, OnRequest, OnResponse, OnBodyChunk, OnEos, OnFailure>
sourcepub fn into_inner(self) -> S
pub fn into_inner(self) -> S
Consumes self
, returning the underlying service.
sourcepub fn on_request<NewOnRequest>(
self,
new_on_request: NewOnRequest,
) -> Trace<S, M, MakeSpan, NewOnRequest, OnResponse, OnBodyChunk, OnEos, OnFailure>
pub fn on_request<NewOnRequest>( self, new_on_request: NewOnRequest, ) -> Trace<S, M, MakeSpan, NewOnRequest, OnResponse, OnBodyChunk, OnEos, OnFailure>
Customize what to do when a request is received.
NewOnRequest
is expected to implement OnRequest
.
sourcepub fn on_response<NewOnResponse>(
self,
new_on_response: NewOnResponse,
) -> Trace<S, M, MakeSpan, OnRequest, NewOnResponse, OnBodyChunk, OnEos, OnFailure>
pub fn on_response<NewOnResponse>( self, new_on_response: NewOnResponse, ) -> Trace<S, M, MakeSpan, OnRequest, NewOnResponse, OnBodyChunk, OnEos, OnFailure>
Customize what to do when a response has been produced.
NewOnResponse
is expected to implement OnResponse
.
sourcepub fn on_body_chunk<NewOnBodyChunk>(
self,
new_on_body_chunk: NewOnBodyChunk,
) -> Trace<S, M, MakeSpan, OnRequest, OnResponse, NewOnBodyChunk, OnEos, OnFailure>
pub fn on_body_chunk<NewOnBodyChunk>( self, new_on_body_chunk: NewOnBodyChunk, ) -> Trace<S, M, MakeSpan, OnRequest, OnResponse, NewOnBodyChunk, OnEos, OnFailure>
Customize what to do when a body chunk has been sent.
NewOnBodyChunk
is expected to implement OnBodyChunk
.
sourcepub fn on_eos<NewOnEos>(
self,
new_on_eos: NewOnEos,
) -> Trace<S, M, MakeSpan, OnRequest, OnResponse, OnBodyChunk, NewOnEos, OnFailure>
pub fn on_eos<NewOnEos>( self, new_on_eos: NewOnEos, ) -> Trace<S, M, MakeSpan, OnRequest, OnResponse, OnBodyChunk, NewOnEos, OnFailure>
Customize what to do when a streaming response has closed.
NewOnEos
is expected to implement OnEos
.
sourcepub fn on_failure<NewOnFailure>(
self,
new_on_failure: NewOnFailure,
) -> Trace<S, M, MakeSpan, OnRequest, OnResponse, OnBodyChunk, OnEos, NewOnFailure>
pub fn on_failure<NewOnFailure>( self, new_on_failure: NewOnFailure, ) -> Trace<S, M, MakeSpan, OnRequest, OnResponse, OnBodyChunk, OnEos, NewOnFailure>
Customize what to do when a response has been classified as a failure.
NewOnFailure
is expected to implement OnFailure
.
sourcepub fn make_span_with<NewMakeSpan>(
self,
new_make_span: NewMakeSpan,
) -> Trace<S, M, NewMakeSpan, OnRequest, OnResponse, OnBodyChunk, OnEos, OnFailure>
pub fn make_span_with<NewMakeSpan>( self, new_make_span: NewMakeSpan, ) -> Trace<S, M, NewMakeSpan, OnRequest, OnResponse, OnBodyChunk, OnEos, OnFailure>
sourcepub fn new_for_http(inner: S) -> Self
pub fn new_for_http(inner: S) -> Self
Create a new Trace
using ServerErrorsAsFailures
which supports classifying
regular HTTP responses based on the status code.
sourcepub fn new_for_grpc(inner: S) -> Self
pub fn new_for_grpc(inner: S) -> Self
Create a new Trace
using GrpcErrorsAsFailures
which supports classifying
gRPC responses and streams based on the grpc-status
header.
Trait Implementations§
source§impl<S: Clone, M: Clone, MakeSpan: Clone, OnRequest: Clone, OnResponse: Clone, OnBodyChunk: Clone, OnEos: Clone, OnFailure: Clone> Clone for Trace<S, M, MakeSpan, OnRequest, OnResponse, OnBodyChunk, OnEos, OnFailure>
impl<S: Clone, M: Clone, MakeSpan: Clone, OnRequest: Clone, OnResponse: Clone, OnBodyChunk: Clone, OnEos: Clone, OnFailure: Clone> Clone for Trace<S, M, MakeSpan, OnRequest, OnResponse, OnBodyChunk, OnEos, OnFailure>
source§impl<S: Debug, M: Debug, MakeSpan: Debug, OnRequest: Debug, OnResponse: Debug, OnBodyChunk: Debug, OnEos: Debug, OnFailure: Debug> Debug for Trace<S, M, MakeSpan, OnRequest, OnResponse, OnBodyChunk, OnEos, OnFailure>
impl<S: Debug, M: Debug, MakeSpan: Debug, OnRequest: Debug, OnResponse: Debug, OnBodyChunk: Debug, OnEos: Debug, OnFailure: Debug> Debug for Trace<S, M, MakeSpan, OnRequest, OnResponse, OnBodyChunk, OnEos, OnFailure>
source§impl<S, ReqBody, ResBody, M, OnRequestT, OnResponseT, OnFailureT, OnBodyChunkT, OnEosT, MakeSpanT> Service<Request<ReqBody>> for Trace<S, M, MakeSpanT, OnRequestT, OnResponseT, OnBodyChunkT, OnEosT, OnFailureT>where
S: Service<Request<ReqBody>, Response = Response<ResBody>>,
ReqBody: Body,
ResBody: Body,
ResBody::Error: Display + 'static,
S::Error: Display + 'static,
M: MakeClassifier,
M::Classifier: Clone,
MakeSpanT: MakeSpan<ReqBody>,
OnRequestT: OnRequest<ReqBody>,
OnResponseT: OnResponse<ResBody> + Clone,
OnBodyChunkT: OnBodyChunk<ResBody::Data> + Clone,
OnEosT: OnEos + Clone,
OnFailureT: OnFailure<M::FailureClass> + Clone,
impl<S, ReqBody, ResBody, M, OnRequestT, OnResponseT, OnFailureT, OnBodyChunkT, OnEosT, MakeSpanT> Service<Request<ReqBody>> for Trace<S, M, MakeSpanT, OnRequestT, OnResponseT, OnBodyChunkT, OnEosT, OnFailureT>where
S: Service<Request<ReqBody>, Response = Response<ResBody>>,
ReqBody: Body,
ResBody: Body,
ResBody::Error: Display + 'static,
S::Error: Display + 'static,
M: MakeClassifier,
M::Classifier: Clone,
MakeSpanT: MakeSpan<ReqBody>,
OnRequestT: OnRequest<ReqBody>,
OnResponseT: OnResponse<ResBody> + Clone,
OnBodyChunkT: OnBodyChunk<ResBody::Data> + Clone,
OnEosT: OnEos + Clone,
OnFailureT: OnFailure<M::FailureClass> + Clone,
§type Response = Response<ResponseBody<ResBody, <M as MakeClassifier>::ClassifyEos, OnBodyChunkT, OnEosT, OnFailureT>>
type Response = Response<ResponseBody<ResBody, <M as MakeClassifier>::ClassifyEos, OnBodyChunkT, OnEosT, OnFailureT>>
§type Future = ResponseFuture<<S as Service<Request<ReqBody>>>::Future, <M as MakeClassifier>::Classifier, OnResponseT, OnBodyChunkT, OnEosT, OnFailureT>
type Future = ResponseFuture<<S as Service<Request<ReqBody>>>::Future, <M as MakeClassifier>::Classifier, OnResponseT, OnBodyChunkT, OnEosT, OnFailureT>
impl<S: Copy, M: Copy, MakeSpan: Copy, OnRequest: Copy, OnResponse: Copy, OnBodyChunk: Copy, OnEos: Copy, OnFailure: Copy> Copy for Trace<S, M, MakeSpan, OnRequest, OnResponse, OnBodyChunk, OnEos, OnFailure>
Auto Trait Implementations§
impl<S, M, MakeSpan, OnRequest, OnResponse, OnBodyChunk, OnEos, OnFailure> Freeze for Trace<S, M, MakeSpan, OnRequest, OnResponse, OnBodyChunk, OnEos, OnFailure>
impl<S, M, MakeSpan, OnRequest, OnResponse, OnBodyChunk, OnEos, OnFailure> RefUnwindSafe for Trace<S, M, MakeSpan, OnRequest, OnResponse, OnBodyChunk, OnEos, OnFailure>where
S: RefUnwindSafe,
M: RefUnwindSafe,
MakeSpan: RefUnwindSafe,
OnRequest: RefUnwindSafe,
OnResponse: RefUnwindSafe,
OnBodyChunk: RefUnwindSafe,
OnEos: RefUnwindSafe,
OnFailure: RefUnwindSafe,
impl<S, M, MakeSpan, OnRequest, OnResponse, OnBodyChunk, OnEos, OnFailure> Send for Trace<S, M, MakeSpan, OnRequest, OnResponse, OnBodyChunk, OnEos, OnFailure>
impl<S, M, MakeSpan, OnRequest, OnResponse, OnBodyChunk, OnEos, OnFailure> Sync for Trace<S, M, MakeSpan, OnRequest, OnResponse, OnBodyChunk, OnEos, OnFailure>
impl<S, M, MakeSpan, OnRequest, OnResponse, OnBodyChunk, OnEos, OnFailure> Unpin for Trace<S, M, MakeSpan, OnRequest, OnResponse, OnBodyChunk, OnEos, OnFailure>
impl<S, M, MakeSpan, OnRequest, OnResponse, OnBodyChunk, OnEos, OnFailure> UnwindSafe for Trace<S, M, MakeSpan, OnRequest, OnResponse, OnBodyChunk, OnEos, OnFailure>where
S: UnwindSafe,
M: UnwindSafe,
MakeSpan: UnwindSafe,
OnRequest: UnwindSafe,
OnResponse: UnwindSafe,
OnBodyChunk: UnwindSafe,
OnEos: UnwindSafe,
OnFailure: UnwindSafe,
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
source§default unsafe fn clone_to_uninit(&self, dst: *mut T)
default unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)source§impl<T> CloneToUninit for Twhere
T: Copy,
impl<T> CloneToUninit for Twhere
T: Copy,
source§unsafe fn clone_to_uninit(&self, dst: *mut T)
unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T, Request> ServiceExt<Request> for T
impl<T, Request> ServiceExt<Request> for T
source§fn ready(&mut self) -> Ready<'_, Self, Request>where
Self: Sized,
fn ready(&mut self) -> Ready<'_, Self, Request>where
Self: Sized,
source§fn ready_and(&mut self) -> Ready<'_, Self, Request>where
Self: Sized,
fn ready_and(&mut self) -> Ready<'_, Self, Request>where
Self: Sized,
ServiceExt::ready
method insteadsource§fn ready_oneshot(self) -> ReadyOneshot<Self, Request>where
Self: Sized,
fn ready_oneshot(self) -> ReadyOneshot<Self, Request>where
Self: Sized,
source§fn oneshot(self, req: Request) -> Oneshot<Self, Request>where
Self: Sized,
fn oneshot(self, req: Request) -> Oneshot<Self, Request>where
Self: Sized,
Service
, calling with the providing request once it is ready.source§fn and_then<F>(self, f: F) -> AndThen<Self, F>
fn and_then<F>(self, f: F) -> AndThen<Self, F>
poll_ready
method. Read moresource§fn map_response<F, Response>(self, f: F) -> MapResponse<Self, F>
fn map_response<F, Response>(self, f: F) -> MapResponse<Self, F>
poll_ready
method. Read moresource§fn map_err<F, Error>(self, f: F) -> MapErr<Self, F>
fn map_err<F, Error>(self, f: F) -> MapErr<Self, F>
poll_ready
method. Read moresource§fn map_result<F, Response, Error>(self, f: F) -> MapResult<Self, F>
fn map_result<F, Response, Error>(self, f: F) -> MapResult<Self, F>
Result<Self::Response, Self::Error>
)
to a different value, regardless of whether the future succeeds or
fails. Read moresource§fn map_request<F, NewRequest>(self, f: F) -> MapRequest<Self, F>
fn map_request<F, NewRequest>(self, f: F) -> MapRequest<Self, F>
source§fn filter_async<F, NewRequest>(self, filter: F) -> AsyncFilter<Self, F>where
Self: Sized,
F: AsyncPredicate<NewRequest>,
fn filter_async<F, NewRequest>(self, filter: F) -> AsyncFilter<Self, F>where
Self: Sized,
F: AsyncPredicate<NewRequest>,
AsyncFilter
that conditionally accepts or
rejects requests based on an [async predicate]. Read more