Enum metrics::BuilderError

pub enum BuilderError {
    UpkeepFailure,
    // some variants omitted
}

Errors during receiver creation.

Variants

UpkeepFailure

Failed to spawn the upkeep thread.

As histograms are windowed, reads and writes require getting the current time so they can perform the required maintenance, or upkeep, on the internal structures to roll over old buckets, etc.

Acquiring the current time is fast compared to most operations, but is a significant portion of the other time it takes to write to a histogram, which limits overall throughput under high load.

We spin up a background thread, or the "upkeep thread", which updates a global time source that the read and write operations exclusively rely on. While this source is not as up-to-date as the real clock, it is much faster to access.

Trait Implementations

impl Clone for BuilderError

fn clone(&self) -> BuilderError

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BuilderError

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Display for BuilderError

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Error for BuilderError

fn description(&self) -> &str

This method is soft-deprecated.

fn cause(&self) -> Option<&dyn Error>

Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

The lower-level cause of this error, if any.

fn source(&self) -> Option<&(dyn Error + 'static)>

The lower-level source of this error, if any.