Struct BreadcrumbLayer 

pub struct BreadcrumbLayer { /* private fields */ }

Adds tracing events as Sentry breadcrumbs.

Without a filter, events at every level become breadcrumbs. Configure a filter to limit breadcrumb volume; see BreadcrumbLayer::new for the recommended levels.

Using this layer alongside the legacy SentryLayer is unsupported. Use either the legacy layer or the individual layers, not both.

Implementations

impl BreadcrumbLayer

pub fn new() -> Self

Creates a layer that adds tracing events as Sentry breadcrumbs.

For most users, we would recommend using the LogLayer instead of this layer, as logs are sent regardless of whether an error occurs.

Breadcrumbs are only sent attached to Sentry error events. Users using this layer may therefore also wish to enable the ErrorLayer.

Filtering

Without a filter, events at every level become breadcrumbs. Configure a filter to limit breadcrumb volume. We recommend capturing WARN and INFO events. If you also use the error layer, exclude ERROR events, which would otherwise duplicate the error event as a breadcrumb. If a custom filter sends the same event to both layers, install the breadcrumb layer before the error layer so that breadcrumb is included in the error.

use sentry::integrations::tracing::{BreadcrumbLayer, ErrorLayer};
use tracing::Level;
use tracing_subscriber::filter::{filter_fn, LevelFilter};

tracing_subscriber::registry()
    .with(
        BreadcrumbLayer::new().with_filter(filter_fn(|metadata| {
            matches!(*metadata.level(), Level::WARN | Level::INFO)
        })),
    )
    .with(ErrorLayer::new().with_filter(LevelFilter::ERROR))
    .init();

// These will be captured as breadcrumbs ...
tracing::info!("INFO breadcrumb");
tracing::warn!("WARN breadcrumb");

// ... but this will not be.
tracing::debug!("DEBUG breadcrumb");

// This will not be captured as a breadcrumb, but as an error event by the error layer. The
// breadcrumbs above will be contained in that error event.
tracing::error!("ERROR event");

pub fn enable_span_attributes(self) -> Self

Include attributes of parent spans in breadcrumbs.

We can only include spans captured by a super::SpanLayer on the same subscriber. So, this option only has any effect when the SpanLayer is installed.

Filtering

Parent-span attributes are included only when the span is accepted by both SpanLayer and BreadcrumbLayer. A filter that only accepts WARN and INFO metadata therefore omits attributes from spans at other levels.

To include attributes from all spans captured by SpanLayer, we recommend accepting all spans in this layer’s filter, while filtering events to the desired levels, like so:

Trait Implementations

impl Default for BreadcrumbLayer

fn default() -> Self

Returns the “default value” for a type.

impl<S> Layer<S> for BreadcrumbLayer

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

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_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.

fn on_record(&self, _span: &Id, _values: &Record<'_>, _ctx: Context<'_, S>)

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

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_enter(&self, _id: &Id, _ctx: Context<'_, S>)

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

fn on_exit(&self, _id: &Id, _ctx: Context<'_, S>)

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

fn on_close(&self, _id: Id, _ctx: Context<'_, S>)

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

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,

Available on crate features alloc or std only.

Erases the type of this Layer, returning a Boxed dyn Layer trait object.