Struct TracingBuilder

pub struct TracingBuilder {
    pub(crate) progess_bar: bool,
    pub(crate) service_name: Option<&'static str>,
}

Fields

progess_bar: bool

service_name: Option<&'static str>

Implementations

impl TracingBuilder

pub fn enable_otlp(self, service_name: &'static str) -> TracingBuilder

Enable otlp by setting a custom service_name

pub fn enable_progressbar(self) -> TracingBuilder

Enable progress bar layer, default is disabled

pub fn build(self) -> Result<TracingHandle, Error>

This will setup tracing based on the configuration passed in. It will setup a stderr writer output layer and configure EnvFilter to honor RUST_LOG. The EnvFilter will be applied to all configured layers, also otlp.

It will also configure otlp if the feature is enabled and a service_name was provided. It will then correctly setup a channel which is later used for flushing the provider.

pub fn build_with_additional<L>( self, additional_layer: L, ) -> Result<TracingHandle, Error>

where L: Layer<Registry> + Send + Sync + 'static,

Similar to build() but allows passing in an additional tracing Layer.

This method is generic over the Layer to avoid the runtime cost of dynamic dispatch. While it only allows passing a single Layer, it can be composed of multiple ones:

build_with_additional(
  fmt::layer()
    .and_then(some_other_layer)
    .and_then(yet_another_layer)
    .with_filter(my_filter)
)

Trait Implementations

impl Default for TracingBuilder

fn default() -> TracingBuilder

Returns the “default value” for a type.