Enum MetricValues 

pub enum MetricValues {
    Counter(ScalarPoints),
    Rate(ScalarPoints, Duration),
    Gauge(ScalarPoints),
    Set(SetPoints),
    Histogram(HistogramPoints),
    Distribution(SketchPoints),
}

The values of a metric.

Variants

Counter(ScalarPoints)

A counter.

Counters generally represent a monotonically increasing value, such as the number of requests received.

Rate(ScalarPoints, Duration)

A rate.

Rates define the rate of change over a given interval.

For example, a rate with a value of 15 and an interval of 10 seconds would indicate that the value increases by 15 every 10 seconds, or 1.5 per second.

Gauge(ScalarPoints)

A gauge.

Gauges represent the latest value of a quantity, such as the current number of active connections. This value can go up or down, but gauges do not track the individual changes to the value, only the latest value.

Set(SetPoints)

A set.

Sets represent a collection of unique values, such as the unique IP addresses that have connected to a service.

Histogram(HistogramPoints)

A histogram.

Histograms represent the distribution of a quantity, such as the response times for a service, with forced client-side aggregation. Individual samples are stored locally, in full fidelity, and aggregate statistics can be queried against the sample set, but the individual samples cannot be accessed.

Distribution(SketchPoints)

A distribution.

Distributions represent the distribution of a quantity, such as the response times for a service, in such a way that server-side aggregation is possible. Individual samples are stored in a sketch, which supports being merged with other sketches server-side to facilitate global aggregation.

Like histograms, sketches also provide the ability to be queried for aggregate statistics but the individual samples cannot be accessed.

Implementations

impl MetricValues

pub fn counter<V>(values: V) -> Self

where V: Into<ScalarPoints>,

Creates a set of counter values from the given value(s).

pub fn counter_sampled_fallible<I, E>( iter: I, sample_rate: Option<SampleRate>, ) -> Result<Self, E>

where I: Iterator<Item = Result<f64, E>>,

Creates a set of counter values from a fallible iterator of values, based on the given sample rate.

If sample_rate is None, no values will be modified. Otherwise, each value will be scaled proportionally to the quotient of 1 / sample_rate.

pub fn gauge<V>(values: V) -> Self

where V: Into<ScalarPoints>,

Creates a set of gauge values from the given value(s).

pub fn gauge_fallible<I, E>(iter: I) -> Result<Self, E>

where I: Iterator<Item = Result<f64, E>>,

Creates a set of gauge values from a fallible iterator of values.

pub fn set<V>(values: V) -> Self

where V: Into<SetPoints>,

Creates a set from the given values.

pub fn histogram<V>(values: V) -> Self

where V: Into<HistogramPoints>,

Creates a set of histogram values from the given value(s).

pub fn histogram_sampled_fallible<I, E>( iter: I, sample_rate: Option<SampleRate>, ) -> Result<Self, E>

where I: Iterator<Item = Result<f64, E>>,

Creates a set of histogram values from a fallible iterator of values, based on the given sample rate.

If sample_rate is None, only the values present in the iterator will be used. Otherwise, each value will be inserted at a scaled count of 1 / sample_rate.

pub fn distribution<V>(values: V) -> Self

where V: Into<SketchPoints>,

Creates a set of distribution values from the given value(s).

pub fn distribution_sampled_fallible<I, E>( iter: I, sample_rate: Option<SampleRate>, ) -> Result<Self, E>

where I: Iterator<Item = Result<f64, E>>,

Creates a set of distribution values from a fallible iterator of values, based on the given sample rate.

If sample_rate is None, only the values present in the iterator will be used. Otherwise, each value will be inserted at a scaled count of 1 / sample_rate.

pub fn rate<V>(values: V, interval: Duration) -> Self

where V: Into<ScalarPoints>,

Creates a set of rate values from the given value(s) and interval.

pub fn is_empty(&self) -> bool

Returns true if this metric has no values.

pub fn len(&self) -> usize

Returns the number of values in this metric.

pub fn all_timestamped(&self) -> bool

Returns true if all values in this metric have a timestamp.

pub fn any_timestamped(&self) -> bool

Returns true if any values in this metric have a timestamp.

pub fn set_timestamp(&mut self, timestamp: u64)

Sets the timestamp for all values in this metric.

This overrides all existing timestamps whether they are set or not. If timestamp is zero, all existing timestamps will be cleared.

pub fn split_timestamped(&mut self) -> Self

Splits all timestamped values into a new MetricValues, leaving the remaining values in self.

pub fn split_at_timestamp(&mut self, timestamp: u64) -> Option<Self>

Splits all values with a timestamp less than or equal to timestamp into a new MetricValues, leaving the remaining values in self.

pub fn collapse_non_timestamped(&mut self, timestamp: u64)

Collapses all non-timestamped values into a single value with the given timestamp.

pub fn merge(&mut self, other: Self)

Merges another set of metric values into this one.

If both self and other are the same metric type, their values will be merged appropriately. If the metric types are different, or a specific precondition for the metric type is not met, the incoming values will override the existing values instead.

For rates, the interval of both rates must match to be merged. For gauges, the incoming value will override the existing value.

pub fn as_str(&self) -> &'static str

Returns the metric value type as a string.

pub fn is_serie(&self) -> bool

Returns true if this metric is a serie.

pub fn is_sketch(&self) -> bool

Returns true if this metric is a sketch.

Trait Implementations

impl Clone for MetricValues

fn clone(&self) -> MetricValues

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MetricValues

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

Formats the value using the given formatter.

impl Display for MetricValues

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

Formats the value using the given formatter.

impl PartialEq for MetricValues

fn eq(&self, other: &MetricValues) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for MetricValues

impl StructuralPartialEq for MetricValues