Struct LogHistogram

pub struct LogHistogram { /* private fields */ }

Available on tokio_unstable and crate feature rt only.

Log Histogram

This implements an H2 Histogram, a histogram similar to HdrHistogram, but with better performance. It guarantees an error bound of 2^-p.

Unlike a traditional H2 histogram this has two small changes:

1. The 0th bucket runs for 0..min_value. This allows truncating a large number of buckets that would cover extremely short timescales that customers usually don’t care about.
2. The final bucket runs all the way to u64::MAX — traditional H2 histograms would truncate or reject these values.

For information about the default configuration, see LogHistogramBuilder.

Implementations

impl LogHistogram

pub fn builder() -> LogHistogramBuilder

Creates a builder for LogHistogram

pub fn max_value(&self) -> u64

The maximum value that can be stored before truncation in this histogram

Trait Implementations

impl Clone for LogHistogram

fn clone(&self) -> LogHistogram

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for LogHistogram

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

Formats the value using the given formatter.

impl Default for LogHistogram

fn default() -> Self

Returns the “default value” for a type.

impl From<LogHistogramBuilder> for LogHistogram

fn from(value: LogHistogramBuilder) -> Self

Converts to this type from the input type.

impl PartialEq for LogHistogram

fn eq(&self, other: &LogHistogram) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for LogHistogram

impl Eq for LogHistogram

impl StructuralPartialEq for LogHistogram