Enum polkadot_node_jaeger::Span

pub enum Span {
    Enabled(Span),
    Disabled,
}

A wrapper type for a span.

Handles running with and without jaeger.

Variants

Enabled(Span)

Running with jaeger being enabled.

Disabled

Running with jaeger disabled.

Implementations

impl Span

pub fn new<I: LazyIdent>(identifier: I, span_name: &'static str) -> Span

Creates a new span builder based on anything that can be lazily evaluated to and identifier.

Attention: The primary identifier will be used for identification and as such should be

pub fn from_encodable<I: Encode>(identifier: I, span_name: &'static str) -> Span

Creates a new span builder based on an encodable type. The encoded bytes are then used to derive the true trace identifier.

pub fn child(&self, name: &str) -> Self

Derive a child span from self.

pub fn with_trace_id(self, candidate_hash: CandidateHash) -> Self

Attach a ‘traceID’ tag set to the decimal representation of the candidate hash.

pub fn with_string_tag<V: ToString>(self, tag: &'static str, val: V) -> Self

pub fn with_peer_id(self, peer: &PeerId) -> Self

Attach a peer-id tag to the span.

pub fn with_optional_peer_id(self, peer: Option<&PeerId>) -> Self

Attach a peer-id tag to the span when peer is present.

pub fn with_candidate(self, candidate_hash: CandidateHash) -> Self

Attach a candidate hash to the span.

pub fn with_para_id(self, para_id: ParaId) -> Self

Attach a para-id to the span.

pub fn with_stage(self, stage: Stage) -> Self

Attach a candidate stage. Should always come with a CandidateHash.

pub fn with_validator_index(self, validator: ValidatorIndex) -> Self

pub fn with_chunk_index(self, chunk_index: ChunkIndex) -> Self

pub fn with_relay_parent(self, relay_parent: Hash) -> Self

pub fn with_claimed_validator_index( self, claimed_validator_index: ValidatorIndex, ) -> Self

pub fn with_pov(self, pov: &PoV) -> Self

pub fn with_int_tag(self, tag: &'static str, i: i64) -> Self

Add an additional int tag to the span without consuming.

Should be used sparingly, introduction of new types is preferred.

pub fn with_uint_tag(self, tag: &'static str, u: u64) -> Self

pub fn with_string_fmt_debug_tag<V: Debug>( self, tag: &'static str, val: V, ) -> Self

pub fn add_follows_from(&mut self, other: &Self)

Adds the FollowsFrom relationship to this span with respect to the given one.

pub fn add_pov(&mut self, pov: &PoV)

Add a PoV hash meta tag with lazy hash evaluation, without consuming the span.

pub fn add_para_id(&mut self, para_id: ParaId)

pub fn add_string_tag<V: ToString>(&mut self, tag: &'static str, val: V)

Add a string tag, without consuming the span.

pub fn add_string_fmt_debug_tag<V: Debug>(&mut self, tag: &'static str, val: V)

Add a string tag, without consuming the span.

pub fn add_int_tag(&mut self, tag: &'static str, value: i64)

pub fn add_uint_tag(&mut self, tag: &'static str, value: u64)

pub const fn is_enabled(&self) -> bool

Check whether jaeger is enabled in order to avoid computational overhead.

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

Obtain the trace identifier for this set of spans.

Trait Implementations

impl Debug for Span

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

Formats the value using the given formatter.

impl From<Option<Span>> for Span

fn from(src: Option<Span>) -> Self

Converts to this type from the input type.

impl From<Span> for Span

fn from(src: Span) -> Self

Converts to this type from the input type.