Struct Traceparent

pub struct Traceparent { /* private fields */ }

A W3C traceparent.

This type contains emit’s TraceId and SpanId, along with TraceFlags that determine sampling.

Traceparents exist at the edges of your application. On incoming requests, it may carry a traceparent header that can be parsed into a Traceparent and pushed onto the active trace context with Traceparent::push. On outgoing requests, the active trace context is pulled by Traceparent::current and formatted into a traceparent header.

Implementations

impl Traceparent

pub const fn new( trace_id: Option<TraceId>, span_id: Option<SpanId>, trace_flags: TraceFlags, ) -> Self

Create a new traceparent with the given trace id, span id, and trace flags.

pub fn try_from_str(traceparent: &str) -> Result<Self, Error>

Parse a traceparent from its text format, as defined in the W3C standard.

pub fn trace_id(&self) -> Option<&TraceId>

Get the trace id.

pub fn span_id(&self) -> Option<&SpanId>

Get the span id (also called the parent id).

pub fn trace_flags(&self) -> &TraceFlags

Get the trace flags.

These flags can be used to tell whether the traceparent is for a sampled trace or not.

pub fn current() -> Self

Get the current trace context.

If no context has been set, this method will return a new traceparent with no trace id or span id, but with TraceFlags::SAMPLED.

pub fn push(&self) -> Frame<TraceparentCtxt>

Get a Frame that can set the current trace context in a scope.

While the frame is active, Traceparent::current will return this traceparent.

pub fn is_valid(&self) -> bool

Whether the traceparent carries a non-empty trace id and span id.

An invalid traceparent can still be used for propagation, but will likely be ignored by downstream services.

Trait Implementations

impl Clone for Traceparent

fn clone(&self) -> Traceparent

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Traceparent

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

Formats the value using the given formatter.

impl Display for Traceparent

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

Formats the value using the given formatter.

impl FromStr for Traceparent

type Err = Error

The associated error which can be returned from parsing.

fn from_str(header: &str) -> Result<Self, Error>

Parses a string s to return a value of this type.

impl PartialEq for Traceparent

fn eq(&self, other: &Traceparent) -> 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 Copy for Traceparent

impl Eq for Traceparent

impl StructuralPartialEq for Traceparent