Struct prometrics::metrics::Summary

pub struct Summary(_);

Summary samples observations (usually things like request durations and response sizes).

It provides a total count of observations and a sum of all observed values, and it calculates configurable quantiles over a sliding time window.

Cloned summaries share the same buckets.

Methods

impl Summary

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

Makes a new Summary instance.

Note that it is recommended to create this via SummaryBuilder.

pub fn metric_name(&self) -> &MetricName

Returns the name of this summary.

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

Returns the help of this summary.

pub fn labels(&self) -> &Labels

Returns the user defined labels of this summary.

pub fn labels_mut(&mut self) -> LabelsMut

Returns the mutable user defined labels of this summary.

pub fn timestamp(&self) -> &Timestamp

Returns the timestamp of this summary.

pub fn timestamp_mut(&self) -> TimestampMut

Returns the mutable timestamp of this summary.

pub fn count(&self) -> u64

Returns the total observation count.

pub fn sum(&self) -> f64

Returns the sum of the observed values.

pub fn quantiles(&self) -> Vec<(Quantile, f64)>

Calculates and returns the quantile-value pairs of this summary.

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) -> SummaryCollector

Returns a collector for this histogram.

Trait Implementations

impl Clone for Summary

fn clone(&self) -> Summary

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Summary

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

Formats the value using the given formatter.

impl Display for Summary

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

Formats the value using the given formatter.

impl From<Summary> for Metric

fn from(f: Summary) -> Self

Performs the conversion.