Struct prometheus::Histogram
[−]
[src]
pub struct Histogram { // some 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
[src]
fn with_opts(opts: HistogramOpts) -> Result<Histogram>
with_opts
creates a Histogram
with the opts
options.
impl Histogram
[src]
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.
Trait Implementations
impl Clone for Histogram
[src]
fn clone(&self) -> Histogram
Returns a copy of the value. Read more
fn clone_from(&mut self, source: &Self)
1.0.0
Performs copy-assignment from source
. Read more
impl Collector for Histogram
[src]
fn desc(&self) -> &Desc
desc
returns the descriptor for the metric collector.
fn collect(&self) -> MetricFamily
collect
collects the metric.