Struct glean::private::EventMetric

pub struct EventMetric<K> { /* private fields */ }

Developer-facing API for recording event metrics.

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<K: ExtraKeys> EventMetric<K>

pub fn new(meta: CommonMetricData) -> Self

The public constructor used by automatically generated metrics.

pub fn with_runtime_extra_keys( meta: CommonMetricData, allowed_extra_keys: Vec<String>, ) -> Self

The public constructor used by runtime-defined metrics.

pub fn record_with_time(&self, timestamp: u64, extra: HashMap<String, String>)

Record a new event with a provided timestamp.

It’s the caller’s responsibility to ensure the timestamp comes from the same clock source. Use glean::get_timestamp_ms to get a valid timestamp.

impl<K> EventMetric<K>

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

Returns

The number of errors reported.

impl<K> EventMetric<K>

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

See TestGetValue::test_get_value

impl<K: ExtraKeys> EventMetric<K>

pub fn record<M: Into<Option<<Self as Event>::Extra>>>(&self, extra: M)

See traits::Event::record

Trait Implementations

impl<K: Clone> Clone for EventMetric<K>

fn clone(&self) -> EventMetric<K>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<K: ExtraKeys> Event for EventMetric<K>

type Extra = K

The type of the allowed extra keys for this event.

fn record<M: Into<Option<<Self as Event>::Extra>>>(&self, extra: M)

Records an event.

impl<K> MallocSizeOf for EventMetric<K>

fn size_of(&self, ops: &mut MallocSizeOfOps) -> usize

Measure the heap usage of all descendant heap-allocated structures, but not the space taken up by the value itself.

impl<'a, K> MetricIdentifier<'a> for EventMetric<K>

fn get_identifiers(&'a self) -> (&'a str, &'a str, Option<&'a str>)

Retrieve the category, name and (maybe) label of the metric

impl<K> TestGetValue for EventMetric<K>

type Output = Vec<RecordedEvent>

The output type of test_get_value

fn test_get_value( &self, ping_name: Option<String>, ) -> Option<Vec<RecordedEvent>>

Test-only API (exported for FFI purposes).