Struct opentelemetry::api::metrics::MetricOptions

pub struct MetricOptions {
    pub description: String,
    pub unit: Unit,
    pub keys: Vec<Key>,
    pub alternate: bool,
}

MetricOptions contains some options for metrics of any kind.

Fields

description: String

Description is an optional field describing the metric instrument.

unit: Unit

Unit is an optional field describing the metric instrument. Valid values are specified according to the UCUM.

keys: Vec<Key>

Keys are dimension names for the given metric.

alternate: bool

Alternate defines the property of metric value dependent on a metric type.

• for Counter, true implies that the metric is an up-down Counter

• for Gauge, true implies that the metric is a non-descending Gauge

• for Measure, true implies that the metric supports positive and negative values

Methods

impl MetricOptions

pub fn with_description<S: Into<String>>(self, description: S) -> Self

Set a description for the current set of options.

pub fn with_unit(self, unit: Unit) -> Self

Set a Unit for the current set of metric options.

pub fn with_keys(self, keys: Vec<Key>) -> Self

Set a list of Keys for the current set metric of options.

pub fn with_monotonic(self, _monotonic: bool) -> Self

Set monotonic for the given set of metric options.

pub fn with_absolute(self, absolute: bool) -> Self

Set absolute for the given set of metric options.

Trait Implementations

impl Default for MetricOptions

fn default() -> MetricOptions

Returns the "default value" for a type.

impl Debug for MetricOptions

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

Formats the value using the given formatter.