Struct SpanLayer 

#[non_exhaustive]
pub struct SpanLayer {}

Captures tracing spans as Sentry transactions and spans.

Install this layer to capture spans; event layers do not manage the span lifecycle. Without a filter, this layer captures spans at every level. Configure a filter to limit span volume; see SpanLayer::new for the recommended levels.

Using this layer alongside the legacy SentryLayer is unsupported. Combining the two layers can panic when a span is created. Use either the legacy layer or the individual layers, not both.

Implementations

impl SpanLayer

pub fn new() -> Self

Creates a layer that captures tracing spans as Sentry transactions and spans.

Filtering

Without a filter, this layer captures spans at every level. Configure a level filter to limit span volume. We recommend capturing spans at the INFO level, and more severe.

use sentry::integrations::tracing::SpanLayer;
use tracing_subscriber::filter::LevelFilter;

tracing_subscriber::registry()
    .with(SpanLayer::new().with_filter(LevelFilter::INFO))
    .init();

// This will be captured ...
let _info = tracing::info_span!("INFO span").entered();

// ... but this will not be, due to LevelFilter::INFO being set.
let _debug = tracing::debug_span!("DEBUG span").entered();

Trait Implementations

impl Default for SpanLayer

fn default() -> Self

Returns the “default value” for a type.

impl<S> Layer<S> for SpanLayer

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, start a new sentry span, setting it as the current sentry span.

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

Sets the entered span as current sentry span.

A tracing span can be entered and exited multiple times, for example, when using a tracing::Instrumented future.

Spans must be exited on the same thread that they are entered. The sentry-tracing integration’s behavior is undefined if spans are exited on threads other than the one they are entered from; specifically, doing so will likely cause data to bleed between Hubs in unexpected ways.

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

Drop the current span’s HubSwitchGuard to restore the parent Hub.

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

Finish the underlying sentry span when the tracing span closes.

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

Implement the writing of extra data to span.

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_event(&self, _event: &Event<'_>, _ctx: Context<'_, S>)

Notifies this layer that an event has occurred.

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.