Struct prometheus_utils::HistogramWithLabels

pub struct HistogramWithLabels<L: Labels> { /* private fields */ }

A Prometheus histogram metric, with labels described by the type L.

The type L must implement the Labels trait; see the documentation for that trait for an overview of Prometheus metric labels.

Implementations

impl<L: Labels> HistogramWithLabels<L>

pub fn register_new(name: &str, help: &str) -> Self

Construct and immediately register a new HistogramWithLabels instance.

pub fn register_new_with_buckets(
    name: &str,
    help: &str,
    buckets: Vec<f64>
) -> Self

Construct and immediately register a new HistogramWithLabels instance.

This will use the provided buckets when registering the underlying HistogramVec.

pub fn observe(&self, labels: &L, value: f64)

Add a single observation to the histogram with the provided labels.

pub fn start_timer(&self, labels: &L) -> HistogramTimer

Return a HistogramTimer to track a duration, using the provided labels.

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

Observe execution time of a closure, in seconds.

pub fn get_sample_sum(&self, labels: &L) -> f64

Return accumulated sum of all samples, using the provided labels.

pub fn get_sample_count(&self, labels: &L) -> u64

Return count of all samples, using the provided labels.