pub struct DcontextLayer<S> { /* private fields */ }Expand description
A tracing_subscriber::Layer that automatically creates dcontext scopes
when tracing spans are entered.
§Levels of Integration
-
Auto-scoping (zero config): Every span enter creates a new dcontext scope that inherits the parent scope’s values. The scope is reverted on span exit.
-
Field extraction: Extract tracing span fields into dcontext values. Configure via
TracingFieldmetadata at registration time. -
Span info: Optionally expose span metadata (name, target, level) as a
SpanInfocontext value.
§Example
ⓘ
use tracing_subscriber::prelude::*;
use dcontext_tracing::TracingField;
// Configure extraction + enrichment at registration time:
builder.register_with::<String>("request_id", |opts| {
opts.cached().with_metadata(
TracingField::builder("rid")
.extract_from_str(|s| Some(s.to_string()))
.enrich_display::<String>()
.build()
)
});
// The layer auto-discovers metadata — no field configuration needed:
tracing_subscriber::registry()
.with(dcontext_tracing::DcontextLayer::new())
.init();Implementations§
Source§impl<S> DcontextLayer<S>
impl<S> DcontextLayer<S>
Sourcepub fn new() -> Self
pub fn new() -> Self
Create a new DcontextLayer with default settings (auto-scoping only).
Field extraction is auto-discovered from TracingField
metadata in the registry. No explicit field configuration is needed.
Sourcepub fn builder() -> DcontextLayerBuilder<S>
pub fn builder() -> DcontextLayerBuilder<S>
Create a DcontextLayerBuilder for configuring the layer.
Trait Implementations§
Source§impl<S> Default for DcontextLayer<S>
impl<S> Default for DcontextLayer<S>
Source§impl<S> Layer<S> for DcontextLayer<S>where
S: Subscriber + for<'a> LookupSpan<'a>,
impl<S> Layer<S> for DcontextLayer<S>where
S: Subscriber + for<'a> LookupSpan<'a>,
Source§fn on_new_span(&self, attrs: &Attributes<'_>, id: &Id, ctx: Context<'_, S>)
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>)
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_enter(&self, id: &Id, ctx: Context<'_, S>)
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>)
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>)
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_register_dispatch(&self, subscriber: &Dispatch)
fn on_register_dispatch(&self, subscriber: &Dispatch)
Performs late initialization when installing this layer as a
Subscriber. Read moreSource§fn register_callsite(&self, metadata: &'static Metadata<'static>) -> Interest
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 moreSource§fn enabled(&self, metadata: &Metadata<'_>, ctx: Context<'_, S>) -> bool
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 moreSource§fn on_follows_from(&self, _span: &Id, _follows: &Id, _ctx: Context<'_, S>)
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.Source§fn on_event(&self, _event: &Event<'_>, _ctx: Context<'_, S>)
fn on_event(&self, _event: &Event<'_>, _ctx: Context<'_, S>)
Notifies this layer that an event has occurred.
Source§fn on_id_change(&self, _old: &Id, _new: &Id, _ctx: Context<'_, S>)
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.
Source§fn and_then<L>(self, layer: L) -> Layered<L, Self, S>
fn and_then<L>(self, layer: L) -> Layered<L, Self, S>
Composes this layer around the given
Layer, returning a Layered
struct implementing Layer. Read moreSource§fn with_subscriber(self, inner: S) -> Layered<Self, S>where
Self: Sized,
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 moreSource§fn with_filter<F>(self, filter: F) -> Filtered<Self, F, S>
fn with_filter<F>(self, filter: F) -> Filtered<Self, F, S>
Auto Trait Implementations§
impl<S> Freeze for DcontextLayer<S>
impl<S> RefUnwindSafe for DcontextLayer<S>
impl<S> Send for DcontextLayer<S>
impl<S> Sync for DcontextLayer<S>
impl<S> Unpin for DcontextLayer<S>
impl<S> UnsafeUnpin for DcontextLayer<S>
impl<S> UnwindSafe for DcontextLayer<S>
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
Mutably borrows from an owned value. Read more