Struct glean_core::metrics::TimespanMetric

pub struct TimespanMetric { /* fields omitted */ }

A timespan metric.

Timespans are used to make a measurement of how much time is spent in a particular task.

Methods

impl TimespanMetric

pub fn new(meta: CommonMetricData, time_unit: TimeUnit) -> Self

Create a new timespan metric.

pub fn set_start(&mut self, glean: &Glean, start_time: u64)

Start tracking time for the provided metric.

This records an error if it's already tracking time (i.e. start was already called with no corresponding stop): in that case the original start time will be preserved.

pub fn set_stop(&mut self, glean: &Glean, stop_time: u64)

Stop tracking time for the provided metric. Sets the metric to the elapsed time.

This will record an error if no start was called.

pub fn cancel(&mut self)

Abort a previous start call. No error is recorded if no start was called.

pub fn set_raw(&self, glean: &Glean, elapsed: Duration, overwrite: bool)

Explicitly set the timespan value.

This API should only be used if your library or application requires recording times in a way that can not make use of start/stop/cancel.

Care should be taken using this if the ping lifetime might contain more than one timespan measurement. To be safe, set_raw should generally be followed by sending a custom ping containing the timespan.

Arguments

• elapsed - The elapsed time to record.
• overwrite - Whether or not to overwrite existing data.

pub fn test_get_value(&self, glean: &Glean, storage_name: &str) -> Option<u64>

Test-only API (exported for FFI purposes).

Get the currently stored value as an integer.

This doesn't clear the stored value.

Trait Implementations

impl Debug for TimespanMetric

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

Formats the value using the given formatter.

impl MetricType for TimespanMetric

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