SpanCollector

Struct SpanCollector 

Source
pub struct SpanCollector {
    pub capture_span_for_reports_with_children: bool,
}
Expand description

Attachment collector for capturing tracing spans.

When registered as a report creation hook, this collector automatically captures the current tracing span and attaches it as a Span attachment.

§Examples

Basic usage with default settings:

use rootcause::hooks::Hooks;
use rootcause_tracing::SpanCollector;

Hooks::new()
    .report_creation_hook(SpanCollector::new())
    .install()
    .expect("failed to install hooks");

Custom configuration:

use rootcause::hooks::Hooks;
use rootcause_tracing::SpanCollector;

let collector = SpanCollector {
    capture_span_for_reports_with_children: true,
};

Hooks::new()
    .report_creation_hook(collector)
    .install()
    .expect("failed to install hooks");

Fields§

§capture_span_for_reports_with_children: bool

Whether to capture spans for all reports or only leaf reports (those without children).

When true, all reports get span attachments. When false, only leaf reports do.

Implementations§

Source§

impl SpanCollector

Source

pub fn new() -> Self

Creates a new SpanCollector with default settings.

Configuration is controlled by environment variables.

§Environment Variables
  • ROOTCAUSE_TRACING - Comma-separated options:
    • leafs - Only capture tracing spans for leaf errors (errors without children)
§Examples
use rootcause::hooks::Hooks;
use rootcause_tracing::SpanCollector;

// Respects ROOTCAUSE_TRACING environment variable
Hooks::new()
    .report_creation_hook(SpanCollector::new())
    .install()
    .expect("failed to install hooks");

Trait Implementations§

Source§

impl Clone for SpanCollector

Source§

fn clone(&self) -> SpanCollector

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Default for SpanCollector

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl ReportCreationHook for SpanCollector

Source§

fn on_local_creation(&self, report: ReportMut<'_, Dynamic, Local>)

Called when a Local report is created. Read more
Source§

fn on_sendsync_creation(&self, report: ReportMut<'_, Dynamic, SendSync>)

Called when a SendSync report is created. Read more
Source§

impl Copy for SpanCollector

Auto Trait Implementations§

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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<O> ObjectMarkerFor<Local> for O
where O: 'static,

Source§

impl<O> ObjectMarkerFor<SendSync> for O
where O: 'static + Send + Sync,

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

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

Source§

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>,

Source§

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.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more