Struct glean::private::TimingDistributionMetric

pub struct TimingDistributionMetric(_);

Developer-facing API for recording timing distribution 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 TimingDistributionMetric

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

The public constructor used by automatically generated metrics.

pub fn accumulate_raw_samples_nanos(&self, samples: Vec<u64>)

Accumulates the provided samples in the metric.

Arguments

• samples - A list of samples recorded by the metric. Samples must be in nanoseconds.

Notes

Reports an ErrorType::InvalidOverflow error for samples that are longer than MAX_SAMPLE_TIME.

impl TimingDistributionMetric

pub fn start(&self) -> TimerId

See glean_core::traits::TimingDistribution::start

pub fn stop_and_accumulate(&self, __arg1: TimerId)

See glean_core::traits::TimingDistribution::stop_and_accumulate

pub fn cancel(&self, __arg1: TimerId)

See glean_core::traits::TimingDistribution::cancel

pub fn test_get_value<'a, S: Into<Option<&'a str>>>(
    &self,
    __arg1: S
) -> Option<DistributionData>

See glean_core::traits::TimingDistribution::test_get_value

pub fn test_get_num_recorded_errors<'a, S: Into<Option<&'a str>>>(
    &self,
    __arg1: ErrorType,
    __arg2: S
) -> i32

See glean_core::traits::TimingDistribution::test_get_num_recorded_errors

Trait Implementations

impl Clone for TimingDistributionMetric

fn clone(&self) -> TimingDistributionMetric

Returns a copy of the value.

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

Performs copy-assignment from source.

impl TimingDistribution for TimingDistributionMetric

fn start(&self) -> TimerId

Start tracking time for the provided metric. Multiple timers can run simultaneously.

fn stop_and_accumulate(&self, id: TimerId)

Stops tracking time for the provided metric and associated timer id.

fn cancel(&self, id: TimerId)

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

fn test_get_value<'a, S: Into<Option<&'a str>>>(
    &self,
    ping_name: S
) -> Option<DistributionData>

Exported for test purposes.

fn test_get_num_recorded_errors<'a, S: Into<Option<&'a str>>>(
    &self,
    error: ErrorType,
    ping_name: S
) -> i32

Exported for test purposes.