Enum sentry_core::metrics::MetricValue

pub enum MetricValue {
    Counter(CounterValue),
    Distribution(DistributionValue),
    Set(SetValue),
    Gauge(GaugeValue),
}

The value of a Metric, indicating its type.

Variants

Counter(CounterValue)

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 and even floating point values are possible.

Example

use sentry::metrics::{Metric, MetricValue};

Metric::build("my.counter", MetricValue::Counter(1.0)).send();

Distribution(DistributionValue)

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.

Example

use sentry::metrics::{Metric, MetricValue};

Metric::build("my.distribution", MetricValue::Distribution(42.0)).send();

Set(SetValue)

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.

Example

To create a set value, use MetricValue::set_from_str or MetricValue::set_from_display. These functions convert the provided argument into a unique hash value, which is then used as the set value.

use sentry::metrics::{Metric, MetricValue};

Metric::build("my.set", MetricValue::set_from_str("foo")).send();

Gauge(GaugeValue)

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. Note that the “last” component of this aggregation is not commutative. Which value is preserved as last value is implementation-defined.

Example

use sentry::metrics::{Metric, MetricValue};

Metric::build("my.gauge", MetricValue::Gauge(42.0)).send();

Implementations

impl MetricValue

pub fn set_from_str(string: &str) -> Self

Returns a set value representing the given string.

pub fn set_from_display(display: impl Display) -> Self

Returns a set value representing the given argument.

Trait Implementations

impl Clone for MetricValue

fn clone(&self) -> MetricValue

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MetricValue

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

Formats the value using the given formatter.

impl PartialEq for MetricValue

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl Copy for MetricValue

impl StructuralPartialEq for MetricValue