Struct glean_core::metrics::EventMetric [−][src]
pub struct EventMetric { /* fields omitted */ }
Expand description
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
Creates a new event metric.
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
- AHashMap
of (key, value) pairs. The key is an index into the metric’sallowed_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.
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.
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.
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
Access the stored metadata
Access the stored metadata mutable
Whether this metric should currently be recorded Read more
Auto Trait Implementations
impl RefUnwindSafe for EventMetric
impl Send for EventMetric
impl Sync for EventMetric
impl Unpin for EventMetric
impl UnwindSafe for EventMetric
Blanket Implementations
Mutably borrows from an owned value. Read more