Struct TracingHandle

pub struct TracingHandle {
    pub(crate) stdout_writer: IndicatifWriter<Stdout>,
    pub(crate) stderr_writer: IndicatifWriter<Stderr>,
    pub(crate) meter_provider: Option<SdkMeterProvider>,
    pub(crate) tracer_provider: Option<SdkTracerProvider>,
}

Fields

stdout_writer: IndicatifWriter<Stdout>

stderr_writer: IndicatifWriter<Stderr>

meter_provider: Option<SdkMeterProvider>

tracer_provider: Option<SdkTracerProvider>

Implementations

impl TracingHandle

pub fn get_stdout_writer(&self) -> IndicatifWriter<Stdout>

Returns a writer for std::io::Stdout that ensures its output will not be clobbered by active progress bars.

Instead of println!(...) prefer writeln!(handle.get_stdout_writer(), ...)

pub fn get_stderr_writer(&self) -> IndicatifWriter<Stderr>

Returns a writer for std::io::Stderr that ensures its output will not be clobbered by active progress bars.

Instead of println!(...) prefer writeln!(handle.get_stderr_writer(), ...).

pub async fn flush(&self) -> Result<(), Error>

This will flush possible attached tracing providers, e.g. otlp exported, if enabled. If there is none enabled this will result in a noop.

It will wait until the flush is complete.

pub async fn shutdown(&self) -> Result<(), Error>

This will flush all attached tracing providers and will wait until the flush is completed, then call shutdown. If no tracing providers like otlp are attached then this will be a noop.

This should only be called on a regular shutdown.

Trait Implementations

impl Clone for TracingHandle

fn clone(&self) -> TracingHandle

Returns a copy of the value.

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

Performs copy-assignment from source.