Struct SentryLayer

pub struct SentryLayer<S> { /* private fields */ }

Provides a tracing layer that dispatches events to sentry

Implementations

impl<S> SentryLayer<S>

pub fn event_filter<F>(self, filter: F) -> Self

where F: Fn(&Metadata<'_>) -> EventFilter + Send + Sync + 'static,

Sets a custom event filter function.

The filter classifies how sentry should handle Events based on their Metadata.

pub fn event_mapper<F>(self, mapper: F) -> Self

where F: Fn(&Event<'_>, Context<'_, S>) -> EventMapping + Send + Sync + 'static,

Sets a custom event mapper function.

The mapper is responsible for creating either breadcrumbs or events from Events.

pub fn span_filter<F>(self, filter: F) -> Self

where F: Fn(&Metadata<'_>) -> bool + Send + Sync + 'static,

Sets a custom span filter function.

The filter classifies whether sentry should handle tracing::Spans based on their Metadata.

pub fn enable_span_attributes(self) -> Self

Enable every parent span’s attributes to be sent along with own event’s attributes.

Note that the root span is considered a transaction so its context will only be grabbed only if you set the transaction to be sampled. The most straightforward way to do this is to set the traces_sample_rate to 1.0 while configuring your sentry client.

Trait Implementations

impl<S> Default for SentryLayer<S>

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

fn default() -> Self

Returns the “default value” for a type.

impl<S> Layer<S> for SentryLayer<S>

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

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

When a new Span gets created, run the filter and start a new sentry span if it passes, setting it as the current sentry span.

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

Sets entered span as current sentry span. A tracing span can be entered and existed multiple times, for example, when using a tracing::Instrumented future.

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

Set exited span’s parent as current sentry span.

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

When a span gets closed, finish the underlying sentry span, and set back its parent as the current sentry span.

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

Implement the writing of extra data to span

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

Notifies this layer that an event has occurred.

fn on_register_dispatch(&self, subscriber: &Dispatch)

Performs late initialization when installing this layer as a Subscriber.

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

Performs late initialization when attaching a Layer to a Subscriber.

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.

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.

fn on_follows_from(&self, _span: &Id, _follows: &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 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.

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.

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.