Enum vector_core::event::metric::MetricValue

pub enum MetricValue {
    Counter {
        value: f64,
    },
    Gauge {
        value: f64,
    },
    Set {
        values: BTreeSet<String>,
    },
    Distribution {
        samples: Vec<Sample>,
        statistic: StatisticKind,
    },
    AggregatedHistogram {
        buckets: Vec<Bucket>,
        count: u64,
        sum: f64,
    },
    AggregatedSummary {
        quantiles: Vec<Quantile>,
        count: u64,
        sum: f64,
    },
    Sketch {
        sketch: MetricSketch,
    },
}

Metric value. Container for the actual value of a metric.

Variants

Counter

A cumulative numerical value that can only increase or be reset to zero.

Fields

value: f64

The value of the counter.

Gauge

A single numerical value that can arbitrarily go up and down.

Fields

value: f64

The value of the gauge.

Set

A set of (unordered) unique values for a key.

Fields

values: BTreeSet<String>

The values in the set.

Distribution

A set of observations without any aggregation or sampling.

Fields

samples: Vec<Sample>

The observed values within this distribution.

statistic: StatisticKind

The type of statistics to derive for this distribution.

AggregatedHistogram

A set of observations which are counted into buckets.

It also contains the total count of all observations and their sum to allow calculating the mean.

Fields

buckets: Vec<Bucket>

The buckets within this histogram.

count: u64

The total number of observations contained within this histogram.

sum: f64

The sum of all observations contained within this histogram.

AggregatedSummary

A set of observations which are represented by quantiles.

Each quantile contains the upper value of the quantile (0 <= φ <= 1). It also contains the total count of all observations and their sum to allow calculating the mean.

Fields

quantiles: Vec<Quantile>

The quantiles measured from this summary.

count: u64

The total number of observations contained within this summary.

sum: f64

The sum of all observations contained within this histogram.

Sketch

A data structure that can answer questions about the cumulative distribution of the contained samples in space-efficient way.

Sketches represent the data in a way that queries over it have bounded error guarantees without needing to hold every single sample in memory. They are also, typically, able to be merged with other sketches of the same type such that client-side and server-side aggregation can be accomplished without loss of accuracy in the queries.

Fields

sketch: MetricSketch

Implementations

impl MetricValue

pub fn is_empty(&self) -> bool

Returns true if the value is empty.

Emptiness is dictated by whether or not the value has any samples or measurements present. Consequently, scalar values (counter, gauge) are never considered empty.

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

Gets the name of this value as a string.

This maps to the name of the enum variant itself.

pub fn distribution_to_agg_histogram( &self, buckets: &[f64], ) -> Option<MetricValue>

Converts a distribution to an aggregated histogram.

Histogram bucket bounds are based on buckets, where the value is the upper bound of the bucket. Samples will be thus be ordered in a “less than” fashion: if the given sample is less than or equal to a given bucket’s upper bound, it will be counted towards that bucket at the given sample rate.

If this value is not a distribution, then None is returned. Otherwise, Some(MetricValue::AggregatedHistogram) is returned.

pub fn distribution_to_sketch(&self) -> Option<MetricValue>

Converts a distribution to a sketch.

This conversion specifically use the AgentDDSketch sketch variant, in the default configuration that matches the Datadog Agent, parameter-wise.

If this value is not a distribution, then None is returned. Otherwise, Some(MetricValue::Sketch) is returned.

pub fn zero(&mut self)

Zeroes out all the values contained in this value.

This keeps all the bucket/value vectors for the histogram and summary metric types intact while zeroing the counts. Distribution metrics are emptied of all their values.

pub fn add(&mut self, other: &Self) -> bool

Adds another value to this one.

If the other value is not the same type, or if they are but their defining characteristics of the value are different (i.e. aggregated histograms with different bucket layouts), then false is returned. Otherwise, true is returned.

pub fn subtract(&mut self, other: &Self) -> bool

Subtracts another value from this one.

If the other value is not the same type, or if they are but their defining characteristics of the value are different (i.e. aggregated histograms with different bucket layouts), then false is returned. Otherwise, true is returned.

Trait Implementations

impl AsRef<MetricValue> for Metric

fn as_ref(&self) -> &MetricValue

Converts this type into a shared reference of the (usually inferred) input type.

impl ByteSizeOf for MetricValue

fn allocated_bytes(&self) -> usize

Returns the allocated bytes of this type

fn size_of(&self) -> usize

Returns the in-memory size of this type

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 Configurable for MetricValue

fn referenceable_name() -> Option<&'static str>

Gets the referenceable name of this value, if any.

fn metadata() -> Metadata

Gets the metadata for this value.

fn generate_schema( schema_gen: &RefCell<SchemaGenerator>, ) -> Result<SchemaObject, GenerateError>

Generates the schema for this value.

fn is_optional() -> bool

where Self: Sized,

Whether or not this value is optional.

fn validate_metadata(_metadata: &Metadata) -> Result<(), GenerateError>

where Self: Sized,

Validates the given metadata against this type.

fn as_configurable_ref() -> ConfigurableRef

where Self: Sized + 'static,

Create a new configurable reference table.

impl Debug for MetricValue

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for MetricValue

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for MetricValue

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

Formats the value using the given formatter.

impl From<AgentDDSketch> for MetricValue

fn from(ddsketch: AgentDDSketch) -> Self

Converts to this type from the input type.

impl From<MetricValue> for Value

fn from(value: MetricValue) -> Self

Converts to this type from the input type.

impl From<MetricValue> for MetricValue

fn from(value: MetricValue) -> Self

Converts to this type from the input type.

impl From<Value> for MetricValue

fn from(value: MetricValue) -> Self

Converts to this type from the input type.

impl PartialEq for MetricValue

fn eq(&self, other: &Self) -> 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 Serialize for MetricValue

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl ToValue for MetricValue

fn to_value(&self) -> Value

Convert this value into a serde_json::Value. Must not fail.