Struct glean_core::metrics::EventMetric

pub struct EventMetric { /* private fields */ }

An event metric.

Events allow recording of e.g. individual occurences of user actions, say every time a view was open and from where. Each time you record an event, it records a timestamp, the event’s name and a set of custom values.

Implementations

impl EventMetric

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

Creates a new event metric.

pub fn record<M: Into<Option<HashMap<i32, String>>>>(
    &self,
    glean: &Glean,
    timestamp: u64,
    extra: M
)

Records an event.

Arguments

• glean - The Glean instance this metric belongs to.
• timestamp - A monotonically increasing timestamp, in milliseconds. This must be provided since the actual recording of the event may happen some time later than the moment the event occurred.
• extra - A HashMap of (key, value) pairs. The key is an index into the metric’s allowed_extra_keys vector where the key’s string is looked up. If any key index is out of range, an error is reported and no event is recorded.

pub fn test_has_value(&self, glean: &Glean, store_name: &str) -> bool

Test-only API (exported for FFI purposes).

Tests whether there are currently stored events for this event metric.

This doesn’t clear the stored value.

pub fn test_get_value(
    &self,
    glean: &Glean,
    store_name: &str
) -> Option<Vec<RecordedEvent>>

Test-only API (exported for FFI purposes).

Get the vector of currently stored events for this event metric.

This doesn’t clear the stored value.

pub fn test_get_value_as_json_string(
    &self,
    glean: &Glean,
    store_name: &str
) -> String

Test-only API (exported for FFI purposes).

Gets the currently stored events for this event metric as a JSON-encoded string.

This doesn’t clear the stored value.

Trait Implementations

impl Clone for EventMetric

fn clone(&self) -> EventMetric

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for EventMetric

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

Formats the value using the given formatter.

impl MetricType for EventMetric

fn meta(&self) -> &CommonMetricData

Access the stored metadata

fn meta_mut(&mut self) -> &mut CommonMetricData

Access the stored metadata mutable

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

Whether this metric should currently be recorded