Enum CorrelationIdField

pub enum CorrelationIdField {
    CorrelationId(u64),
    CorrelationIdStr(String),
    CorrelationIdStrIid(u64),
}

An opaque identifier to correlate this slice with other slices that are considered part of the same logical operation, even if they are not causally connected. Examples uses of a correlation id might be the number of frame going through various stages of rendering in a GPU, the id for an RPC request going through a distributed system, or the id of a network request going through various stages of processing by the kernel.

NOTE: if the events are causually connected, you probably want to use flows instead of OR in addition to correlation ids.

UIs can use this identifier to visually link these slices, for instance, by assigning them a consistent color or highlighting the entire correlated set when one slice is hovered.

Only one field within this ‘oneof’ should be set to define the correlation.

Variants

CorrelationId(u64)

A 64-bit unsigned integer used as the correlation ID.

Best for performance and compact traces if the identifier is naturally numerical or can be easily mapped to one by the trace producer.

CorrelationIdStr(String)

A string value used as the correlation ID.

Offers maximum flexibility for human-readable or complex identifiers (e.g., GUIDs). Note: Using many unique, long strings may increase trace size. For frequently repeated string identifiers, consider ‘correlation_id_string_iid’.

CorrelationIdStrIid(u64)

An interned string identifier (an IID) for correlation.

This 64-bit ID refers to a string defined in the ‘correlation_id_str’ field within the packet sequence’s InternedData. This approach combines the descriptiveness and uniqueness of strings with the efficiency of integer IDs for storage and comparison, especially for identifiers that repeat across many events.

Implementations

impl CorrelationIdField

pub fn encode<B>(&self, buf: &mut B)

where B: BufMut,

Encodes the message to a buffer.

pub fn merge<B>( field: &mut Option<CorrelationIdField>, tag: u32, wire_type: WireType, buf: &mut B, ctx: DecodeContext, ) -> Result<(), DecodeError>

where B: Buf,

Decodes an instance of the message from a buffer, and merges it into self.

pub fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

Trait Implementations

impl Clone for CorrelationIdField

fn clone(&self) -> CorrelationIdField

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CorrelationIdField

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

Formats the value using the given formatter.

impl PartialEq for CorrelationIdField

fn eq(&self, other: &CorrelationIdField) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for CorrelationIdField