Struct tracing_capture::CaptureLayer

source ·
pub struct CaptureLayer<S> { /* private fields */ }
Expand description

Tracing [Layer] that captures (optionally filtered) spans and events.

The layer can optionally filter spans and events in addition to global [Subscriber] filtering. This could be used instead of per-layer filtering if it’s not supported by the Subscriber. Keep in mind that without filtering, CaptureLayer can capture a lot of unnecessary spans / events.

Captured events are tied to the nearest captured span in the span hierarchy. If no entered spans are captured when the event is emitted, the event will be captured in Storage::root_events().

§Examples

See crate-level docs for an example of usage.

Implementations§

source§

impl<S> CaptureLayer<S>
where S: Subscriber + for<'a> LookupSpan<'a>,

source

pub fn new(storage: &SharedStorage) -> Self

Creates a new layer that will use the specified storage to store captured data. Captured spans are not filtered; like any [Layer], filtering can be set up on the layer or subscriber level.

source

pub fn with_filter<F>(self, filter: F) -> Self
where F: Filter<S> + Send + Sync + 'static,

Specifies filtering for this layer. Unlike with per-layer filtering, the resulting layer will perform filtering for all [Subscriber]s, not just Registry.

Trait Implementations§

source§

impl<S> Debug for CaptureLayer<S>

source§

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

Formats the value using the given formatter. Read more
source§

impl<S> Layer<S> for CaptureLayer<S>
where S: Subscriber + for<'a> LookupSpan<'a>,

source§

fn on_new_span(&self, attrs: &Attributes<'_>, id: &Id, ctx: Context<'_, S>)

Notifies this layer that a new span was constructed with the given Attributes and Id.
source§

fn on_record(&self, id: &Id, values: &Record<'_>, ctx: Context<'_, S>)

Notifies this layer that a span with the given Id recorded the given values.
source§

fn on_event(&self, event: &Event<'_>, ctx: Context<'_, S>)

Notifies this layer that an event has occurred.
source§

fn on_enter(&self, id: &Id, ctx: Context<'_, S>)

Notifies this layer that a span with the given ID was entered.
source§

fn on_exit(&self, id: &Id, ctx: Context<'_, S>)

Notifies this layer that the span with the given ID was exited.
source§

fn on_close(&self, id: Id, ctx: Context<'_, S>)

Notifies this layer that the span with the given ID has been closed.
source§

fn on_follows_from(&self, id: &Id, follows_id: &Id, ctx: Context<'_, S>)

Notifies this layer that a span with the ID span recorded that it follows from the span with the ID follows.
§

fn on_register_dispatch(&self, subscriber: &Dispatch)

Performs late initialization when installing this layer as a Subscriber. Read more
§

fn on_layer(&mut self, subscriber: &mut S)

Performs late initialization when attaching a Layer to a [Subscriber]. Read more
§

fn register_callsite(&self, metadata: &'static Metadata<'static>) -> Interest

Registers a new callsite with this layer, returning whether or not the layer is interested in being notified about the callsite, similarly to Subscriber::register_callsite. Read more
§

fn enabled(&self, metadata: &Metadata<'_>, ctx: Context<'_, S>) -> bool

Returns true if this layer is interested in a span or event with the given metadata in the current [Context], similarly to Subscriber::enabled. Read more
§

fn event_enabled(&self, _event: &Event<'_>, _ctx: Context<'_, S>) -> bool

Called before on_event, to determine if on_event should be called.
§

fn on_id_change(&self, _old: &Id, _new: &Id, _ctx: Context<'_, S>)

Notifies this layer that a span ID has been cloned, and that the subscriber returned a different ID.
§

fn and_then<L>(self, layer: L) -> Layered<L, Self, S>
where L: Layer<S>, Self: Sized,

Composes this layer around the given Layer, returning a Layered struct implementing Layer. Read more
§

fn with_subscriber(self, inner: S) -> Layered<Self, S>
where Self: Sized,

Composes this Layer with the given Subscriber, returning a Layered struct that implements Subscriber. Read more
§

fn with_filter<F>(self, filter: F) -> Filtered<Self, F, S>
where Self: Sized, F: Filter<S>,

Combines self with a [Filter], returning a Filtered layer. Read more
§

fn boxed(self) -> Box<dyn Layer<S> + Send + Sync>
where Self: Sized + Layer<S> + Send + Sync + 'static, S: Subscriber,

Erases the type of this [Layer], returning a Boxed dyn Layer trait object. Read more

Auto Trait Implementations§

§

impl<S> Freeze for CaptureLayer<S>

§

impl<S> !RefUnwindSafe for CaptureLayer<S>

§

impl<S> Send for CaptureLayer<S>

§

impl<S> Sync for CaptureLayer<S>

§

impl<S> Unpin for CaptureLayer<S>

§

impl<S> !UnwindSafe for CaptureLayer<S>

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,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

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

source§

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

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

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

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, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

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

Performs the conversion.
source§

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

§

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

The type returned in the event of a conversion error.
source§

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

Performs the conversion.