Struct TracingHandle

pub struct TracingHandle {
    pub(crate) flush_tx: Option<Sender<Sender<()>>>,
    pub(crate) stdout_writer: IndicatifWriter<Stdout>,
    pub(crate) stderr_writer: IndicatifWriter<Stderr>,
}

Fields

flush_tx: Option<Sender<Sender<()>>>

A channel that can be sent to whenever traces/metrics should be flushed. Once flushing is finished, the sent oneshot::Sender will get triggered.

stdout_writer: IndicatifWriter<Stdout>

stderr_writer: IndicatifWriter<Stderr>

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 all attached tracing providers and will wait until the flush is completed. If no tracing providers like otlp are attached then this will be a noop.

This should only be called on a regular shutdown. If you correctly need to shutdown tracing on ctrl_c use force_shutdown otherwise you will get otlp errors.

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

This will flush all all attached tracing providers and will wait until the flush is completed. After this it will do some other necessary cleanup. If no tracing providers like otlp are attached then this will be a noop.

This should only be used if the tool received an ctrl_c otherwise you will get otlp errors. If you need to shutdown tracing on a regular exit, you should use the shutdown method.

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.