Skip to main content

TracingField

Struct TracingField 

Source
pub struct TracingField { /* private fields */ }
Expand description

Unified tracing metadata for a context key.

Controls three behaviors:

  • Extract: populate a context variable from a tracing span field
  • Enrich log: include the context value in log output
  • Record span: record the context value into span fields

Created via TracingFieldBuilder:

use dcontext_tracing::TracingField;

builder.register_with::<String>("request_id", |opts| {
    opts.cached().with_metadata(
        TracingField::builder("rid")
            .extract_from_str(|s| Some(s.to_string()))
            .enrich_display::<String>()  // enables both log + span
            .build()
    )
});

Implementations§

Source§

impl TracingField

Source

pub fn builder(log_name: &'static str) -> TracingFieldBuilder

Start building a TracingField with the given log field name.

The log_name is the field name used in log output and (by default) span recording. It can differ from the context key.

Source

pub fn log_name(&self) -> &'static str

The field name used in log output.

Source

pub fn span_field(&self) -> Option<&'static str>

The span field name to extract from, if extraction is enabled.

Source

pub fn record_field(&self) -> &'static str

The span field name to record into. Returns record_field if set, otherwise log_name.

Source

pub fn has_extract(&self) -> bool

Whether this field has extraction enabled.

Source

pub fn has_enrich(&self) -> bool

Whether this field has any enrichment enabled (log or span).

Source

pub fn has_log_enrich(&self) -> bool

Whether this field has log enrichment enabled.

Source

pub fn has_span_record(&self) -> bool

Whether this field has span recording enabled.

Source

pub fn format(&self, any_val: &dyn Any) -> Option<String>

Format a type-erased value for log enrichment. Returns None if log enrichment is not enabled or the type doesn’t match.

Source

pub fn format_for_span(&self, any_val: &dyn Any) -> Option<String>

Format a type-erased value for span recording. Returns None if span recording is not enabled or the type doesn’t match.

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