Enum relay_metrics::MetricType

pub enum MetricType {
    Counter,
    Distribution,
    Set,
    Gauge,
}

The type of a MetricResourceIdentifier, determining its aggregation and evaluation.

Variants

Counter

Counts instances of an event.

Counters can be incremented and decremented. The default operation is to increment a counter by 1, although increments by larger values are equally possible.

Counters are declared as "c". Alternatively, "m" is allowed.

Distribution

Builds a statistical distribution over values reported.

Based on individual reported values, distributions allow to query the maximum, minimum, or average of the reported values, as well as statistical quantiles. With an increasing number of values in the distribution, its accuracy becomes approximate.

Distributions are declared as "d". Alternatively, "d" and "ms" are allowed.

Set

Counts the number of unique reported values.

Sets allow sending arbitrary discrete values, including strings, and store the deduplicated count. With an increasing number of unique values in the set, its accuracy becomes approximate. It is not possible to query individual values from a set.

Sets are declared as "s".

Gauge

Stores absolute snapshots of values.

In addition to plain counters, gauges store a snapshot of the maximum, minimum and sum of all values, as well as the last reported value.

Gauges are declared as "g".

Implementations

impl MetricType

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

Return the shortcode for this metric type.

Trait Implementations

impl Clone for MetricType

fn clone(&self) -> MetricType

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MetricType

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for MetricType

fn deserialize<D>( deserializer: D, ) -> Result<MetricType, <D as Deserializer<'de>>::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for MetricType

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

Formats the value using the given formatter.

impl FromStr for MetricType

type Err = ParseMetricError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<MetricType, <MetricType as FromStr>::Err>

Parses a string s to return a value of this type.

impl Hash for MetricType

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for MetricType

fn cmp(&self, other: &MetricType) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for MetricType

fn eq(&self, other: &MetricType) -> 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 PartialOrd for MetricType

fn partial_cmp(&self, other: &MetricType) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for MetricType

fn serialize<S>( &self, serializer: S, ) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for MetricType

impl Eq for MetricType

impl StructuralPartialEq for MetricType