Struct glean_core::metrics::TimespanMetric

pub struct TimespanMetric { /* private fields */ }

A timespan metric.

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

Implementations

impl TimespanMetric

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

Creates a new timespan metric.

pub fn start(&self)

Starts 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 set_stop): in that case the original start time will be preserved.

pub fn stop(&self)

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

This will record an error if no set_start was called.

pub fn cancel(&self)

Aborts a previous set_start call. No error is recorded if no set_start was called.

pub fn set_raw(&self, elapsed: Duration)

Explicitly sets 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 set_start/set_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.

pub fn set_raw_nanos(&self, elapsed_nanos: i64)

Explicitly sets the timespan value in nanoseconds.

This API should only be used if your library or application requires recording times in a way that can not make use of set_start/set_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_nanos - The elapsed time to record, in nanoseconds.

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

Test-only API (exported for FFI purposes).

Gets the currently stored value as an integer.

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 - represents 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 TimespanMetric

fn clone(&self) -> TimespanMetric

Returns a copy of the value.

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

Performs copy-assignment from source.

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) -> &CommonMetricDataInternal

Access the stored metadata

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

where Self: Sized,

Create a new metric from this with a new name.

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

where 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