Struct prometheus::Histogram

source ·
pub struct Histogram { /* private fields */ }
Expand description

A Metric 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 prometheus documentation for detailed procedures). However, Histograms require the user to pre-define suitable buckets, (see linear_buckets and exponential_buckets for some helper provided here) 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.

Implementations§

source§

impl Histogram

source

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

with_opts creates a Histogram with the opts options.

source§

impl Histogram

source

pub fn observe(&self, v: f64)

Add a single observation to the Histogram.

source

pub fn start_timer(&self) -> HistogramTimer

Return a HistogramTimer to track a duration.

source

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

Observe execution time of a closure, in second.

source

pub fn local(&self) -> LocalHistogram

Return a LocalHistogram for single thread usage.

source

pub fn get_sample_sum(&self) -> f64

Return accumulated sum of all samples.

source

pub fn get_sample_count(&self) -> u64

Return count of all samples.

Trait Implementations§

source§

impl Clone for Histogram

source§

fn clone(&self) -> Histogram

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Collector for Histogram

source§

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

Return descriptors for metrics.
source§

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

Collect metrics.
source§

impl Debug for Histogram

source§

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

Formats the value using the given formatter. Read more
source§

impl Metric for Histogram

source§

fn metric(&self) -> Metric

Return the protocol Metric.

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> CloneToUninit for T
where T: Clone,

source§

default unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.