Struct prometheus::Histogram

pub struct Histogram { /* fields omitted */ }

A Histogram counts individual observations from an event or sample stream in configurable buckets. Similar to a summary, it also provides a sum of observations and an observation count.

On the Prometheus server, quantiles can be calculated from a Histogram using the histogram_quantile function in the query language.

Note that Histograms, in contrast to Summaries, can be aggregated with the Prometheus query language (see the documentation for detailed procedures). However, Histograms require the user to pre-define suitable buckets, and they are in general less accurate. The Observe method of a Histogram has a very low performance overhead in comparison with the Observe method of a Summary.

Methods

impl Histogram

fn with_opts(opts: HistogramOpts) -> Result<Histogram>

with_opts creates a Histogram with the opts options.

impl Histogram

fn observe(&self, v: f64)

observe adds a single observation to the Histogram.

fn start_timer(&self) -> HistogramTimer

start_timer returns a HistogramTimer to track a duration.

fn local(&self) -> LocalHistogram

local returns a LocalHistogram for single thread usage.

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

fn desc(&self) -> Vec<&Desc>

desc returns descriptors for metrics.

fn collect(&self) -> Vec<MetricFamily>

collect collects metrics.