Struct prometrics::metrics::Histogram

pub struct Histogram(_);

Histogram samples observations (usually things like request durations or response sizes) and counts them in configurable buckets. It also provides a sum of all observed values.

Cloned histograms share the same buckets.

Methods

impl Histogram

pub fn new(name: &str) -> Result<Self>

Makes a new Histogram instance.

Note that it is recommended to create this via HistogramBuilder.

pub fn metric_name(&self) -> &MetricName

Returns the name of this histogram.

pub fn help(&self) -> Option<&str>

Returns the help of this histogram.

pub fn labels(&self) -> &Labels

Returns the user defined labels of this histogram.

pub fn labels_mut(&mut self) -> LabelsMut

Returns the mutable user defined labels of this histogram.

pub fn timestamp(&self) -> &Timestamp

Returns the timestamp of this histogram.

pub fn timestamp_mut(&mut self) -> TimestampMut

Returns the mutable timestamp of this histogram.

Important traits for &'a mut [u8]

impl<'a> Write for &'a mut [u8]impl<'a> Read for &'a [u8]

pub fn buckets(&self) -> &[Bucket]

Returns the buckets of this histogram.

Important traits for CumulativeBuckets<'a>

impl<'a> Iterator for CumulativeBuckets<'a> type Item = CumulativeBucket;

pub fn cumulative_buckets(&self) -> CumulativeBuckets

Returns the cumulative buckets of this histogram.

pub fn count(&self) -> u64

Returns the total observation count.

pub fn sum(&self) -> f64

Returns the sum of the observed values.

pub fn observe(&self, value: f64)

Observes a value.

pub fn time<F, T>(&self, f: F) -> T where
    F: FnOnce() -> T, 

Measures the exeuction time of f and observes its duration in seconds.

pub fn collector(&self) -> HistogramCollector

Returns a collector for this histogram.

Trait Implementations

impl From<Histogram> for Metric

fn from(f: Histogram) -> Self

Performs the conversion.

impl Debug for Histogram

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

Formats the value using the given formatter.

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 Display for Histogram

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

Formats the value using the given formatter.