Struct BackgroundWorker

pub struct BackgroundWorker { /* private fields */ }

This worker manages a background async task that schedules the network requests to send traces to the webhook on the running tokio runtime.

Ensure to invoke .start() before, and .teardown() after, your application code runs. This is required to ensure proper initialization and shutdown.

tracing-layer-core synchronously generates payloads to send to the webhook using the tracing events from the global subscriber. However, all network requests are offloaded onto an unbuffered channel and processed by a provided future acting as an asynchronous worker.

Implementations

impl BackgroundWorker

pub async fn start(&self)

Starts the background worker.

This function should only be called once. Attempting to call start more than once will lead to a deadlock, as the function internally locks the receiver mutex and spawns a task to process messages.

pub async fn shutdown(self)

Initiates the shutdown of the background worker.

Sends a shutdown message to the worker and waits for the worker task to complete. If the worker task handle has already been dropped, an error message will be printed.

Trait Implementations

impl Clone for BackgroundWorker

fn clone(&self) -> BackgroundWorker

Returns a copy of the value.

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

Performs copy-assignment from source.