Struct glean_core::metrics::LabeledMetric

pub struct LabeledMetric<T> { /* fields omitted */ }

A labeled metric.

Labeled metrics allow to record multiple sub-metrics of the same type under different string labels.

Implementations

impl<T> LabeledMetric<T> where
    T: MetricType + Clone, 

pub fn new(submetric: T, labels: Option<Vec<String>>) -> LabeledMetric<T>

Creates a new labeled metric from the given metric instance and optional list of labels.

See get for information on how static or dynamic labels are handled.

pub fn get(&self, label: &str) -> T

Gets a specific metric for a given label.

If a set of acceptable labels were specified in the metrics.yaml file, and the given label is not in the set, it will be recorded under the special OTHER_LABEL label.

If a set of acceptable labels was not specified in the metrics.yaml file, only the first 16 unique labels will be used. After that, any additional labels will be recorded under the special OTHER_LABEL label.

Labels must be snake_case and less than 30 characters. If an invalid label is used, the metric will be recorded in the special OTHER_LABEL label.

pub fn get_submetric(&self) -> &T

Gets the template submetric.

The template submetric is the actual metric that is cloned and modified to record for a specific label.

Trait Implementations

impl<T: Clone> Clone for LabeledMetric<T>

fn clone(&self) -> LabeledMetric<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for LabeledMetric<T>

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

Formats the value using the given formatter.