Struct glean_core::CustomDistributionMetric

pub struct CustomDistributionMetric { /* private fields */ }

A custom distribution metric.

Memory distributions are used to accumulate and store memory sizes.

Implementations

impl CustomDistributionMetric

pub fn new(
    meta: CommonMetricData,
    range_min: i64,
    range_max: i64,
    bucket_count: i64,
    histogram_type: HistogramType
) -> Self

Creates a new memory distribution metric.

pub fn accumulate_samples(&self, samples: Vec<i64>)

Accumulates the provided signed samples in the metric.

This is required so that the platform-specific code can provide us with 64 bit signed integers if no u64 comparable type is available. This will take care of filtering and reporting errors for any provided negative sample.

Arguments

• samples - The vector holding the samples to be recorded by the metric.

Notes

Discards any negative value in samples and report an ErrorType::InvalidValue for each of them.

pub fn accumulate_single_sample(&self, sample: i64)

Accumulates precisely one signed sample and appends it to the metric.

Signed is required so that the platform-specific code can provide us with a 64 bit signed integer if no u64 comparable type is available. This will take care of filtering and reporting errors.

Arguments

• sample - The singular sample to be recorded by the metric.

Notes

Discards any negative value of sample and reports an ErrorType::InvalidValue.

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

Test-only API (exported for FFI purposes).

Gets the currently stored value as an integer.

This doesn’t clear the stored value.

Arguments

• ping_name - the optional name of the ping to retrieve the metric for. Defaults to the first value in send_in_pings.

Returns

The stored value or None if nothing stored.

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

Returns

The number of errors reported.

Trait Implementations

impl Clone for CustomDistributionMetric

fn clone(&self) -> CustomDistributionMetric

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CustomDistributionMetric

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

Formats the value using the given formatter.

impl MetricType for CustomDistributionMetric

fn meta(&self) -> &CommonMetricDataInternal

Access the stored metadata

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

Create a new metric from this with a new name.

fn with_dynamic_label(&self, _label: String) -> Selfwhere
    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