Struct glean_core::NumeratorMetric

pub struct NumeratorMetric(_);

Developer-facing API for recording rate metrics with external denominators.

Instances of this class type are automatically generated by the parsers at build time, allowing developers to record values that were previously registered in the metrics.yaml file.

Implementations

impl NumeratorMetric

pub fn new(meta: CommonMetricData) -> Self

The public constructor used by automatically generated metrics.

pub fn add_to_numerator(&self, amount: i32)

Increases the numerator by amount.

Arguments

• amount - The amount to increase by. Should be non-negative.

Notes

Logs an error if the amount is negative.

pub fn test_get_value(&self, ping_name: Option<String>) -> Option<Rate>

Exported for test purposes.

Gets the currently stored value as a pair of integers.

Arguments

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

This doesn’t clear the stored value.

pub fn test_get_num_recorded_errors(&self, error: ErrorType) -> i32

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 - 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.

Trait Implementations

impl Clone for NumeratorMetric

fn clone(&self) -> NumeratorMetric

Returns a copy of the value.

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

Performs copy-assignment from source.

impl MetricType for NumeratorMetric

fn meta(&self) -> &CommonMetricData

Access the stored metadata

fn with_name(&self, _name: String) -> Selfwhere
    Self: Sized,

Create a new metric from this with a new name.

fn with_dynamic_label(&self, _label: String) -> Selfwhere
    Self: Sized,

Create a new metric from this with a specific label.

fn should_record(&self, glean: &Glean) -> bool

Whether this metric should currently be recorded