Struct metrics_util::Histogram

pub struct Histogram { /* private fields */ }

A bucketed histogram.

This histogram tracks the number of samples that fall into pre-defined buckets, rather than exposing any sort of quantiles.

This type is most useful with systems that prefer bucketed data, such as Prometheus’ histogram type, as opposed to its summary type, which deals with quantiles.

Implementations

impl Histogram

pub fn new(bounds: &[f64]) -> Option<Histogram>

Creates a new Histogram.

If bounds is empty, returns None.

pub fn sum(&self) -> f64

Gets the sum of all samples.

pub fn count(&self) -> u64

Gets the sample count.

pub fn buckets(&self) -> Vec<(f64, u64)>

Gets the buckets.

Buckets are tuples, where the first element is the bucket limit itself, and the second element is the count of samples in that bucket.

pub fn record(&mut self, sample: f64)

Records a single sample.

pub fn record_many<'a, S>(&mut self, samples: S)

where S: IntoIterator<Item = &'a f64> + 'a,

Records multiple samples.

Trait Implementations

impl Clone for Histogram

fn clone(&self) -> Histogram

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Histogram

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

Formats the value using the given formatter.