Trait glean::traits::Labeled[][src]

pub trait Labeled<T> where
    T: Clone
{ fn get(&self, label: &str) -> T;
fn test_get_num_recorded_errors<'a, S>(
        &self,
        error: ErrorType,
        ping_name: S
    ) -> i32
    where
        S: Into<Option<&'a str>>
; }
Expand description

A description for the LabeledMetric type.

When changing this trait, make sure all the operations are implemented in the related type in ../metrics/.

Required methods

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.

Exported for test purposes.

Gets the number of recorded errors for the given metric and error type.

Arguments

  • error - The type of error
  • ping_name - represents the optional name of the ping to retrieve the metric for. Defaults to the first value in send_in_pings.

Returns

The number of errors reported.

Implementors