Enum TracingEvent

#[non_exhaustive]
pub enum TracingEvent {
    NewCallSite {
        id: MetadataId,
        data: CallSiteData,
    },
    NewSpan {
        id: RawSpanId,
        parent_id: Option<RawSpanId>,
        metadata_id: MetadataId,
        values: TracedValues<String>,
    },
    FollowsFrom {
        id: RawSpanId,
        follows_from: RawSpanId,
    },
    SpanEntered {
        id: RawSpanId,
    },
    SpanExited {
        id: RawSpanId,
    },
    SpanCloned {
        id: RawSpanId,
    },
    SpanDropped {
        id: RawSpanId,
    },
    ValuesRecorded {
        id: RawSpanId,
        values: TracedValues<String>,
    },
    NewEvent {
        metadata_id: MetadataId,
        parent: Option<RawSpanId>,
        values: TracedValues<String>,
    },
}

Event produced during tracing.

These events are emitted by a TracingEventSender and then consumed by a TracingEventReceiver to pass tracing info across an API boundary.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

NewCallSite

New call site.

Fields

id: MetadataId

Unique ID of the call site that will be used to refer to it in the following events.

data: CallSiteData

Information about the call site.

NewSpan

New tracing span.

Fields

id: RawSpanId

Unique ID of the span that will be used to refer to it in the following events.

parent_id: Option<RawSpanId>

Parent span ID. None means using the contextual parent (i.e., the current span).

metadata_id: MetadataId

ID of the span metadata.

values: TracedValues<String>

Values associated with the span.

FollowsFrom

New “follows from” relation between spans.

Fields

id: RawSpanId

ID of the follower span.

follows_from: RawSpanId

ID of the source span.

SpanEntered

Span was entered.

Fields

id: RawSpanId

ID of the span.

SpanExited

Span was exited.

Fields

id: RawSpanId

ID of the span.

SpanCloned

Span was cloned.

Fields

id: RawSpanId

ID of the span.

SpanDropped

Span was dropped (aka closed).

Fields

id: RawSpanId

ID of the span.

ValuesRecorded

New values recorded for a span.

Fields

id: RawSpanId

ID of the span.

values: TracedValues<String>

Recorded values.

NewEvent

New event.

Fields

metadata_id: MetadataId

ID of the event metadata.

parent: Option<RawSpanId>

Parent span ID. None means using the contextual parent (i.e., the current span).

values: TracedValues<String>

Values associated with the event.

Implementations

impl TracingEvent

pub fn normalize(events: &mut [Self])

Normalizes a captured sequence of events so that it does not contain information that changes between program runs (e.g., metadata IDs) or due to minor refactoring (source code lines). Normalized events can be used for snapshot testing and other purposes when reproducibility is important.

Trait Implementations

impl Clone for TracingEvent

fn clone(&self) -> TracingEvent

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TracingEvent

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for TracingEvent

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for TracingEvent

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.