Struct glean_core::metrics::MemoryDistributionMetric

pub struct MemoryDistributionMetric { /* private fields */ }

A memory distribution metric.

Memory distributions are used to accumulate and store memory sizes.

Implementations

impl MemoryDistributionMetric

pub fn new(meta: CommonMetricData, memory_unit: MemoryUnit) -> Self

Creates a new memory distribution metric.

pub fn accumulate(&self, sample: i64)

Accumulates the provided sample in the metric.

Arguments

• sample - The sample to be recorded by the metric. The sample is assumed to be in the configured memory unit of the metric.

Notes

Values bigger than 1 Terabyte (2⁴⁰ bytes) are truncated and an ErrorType::InvalidValue error is recorded.

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.

Please note that this assumes that the provided samples are already in the “unit” declared by the instance of the metric type (e.g. if the the instance this method was called on is using MemoryUnit::Kilobyte, then samples are assumed to be in that unit).

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.

Values bigger than 1 Terabyte (2⁴⁰ bytes) are truncated and an ErrorType::InvalidValue error is recorded.

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

Test-only API (exported for FFI purposes).

Gets the currently stored value.

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.

pub fn start_buffer(&self) -> LocalMemoryDistribution<'_>

Experimental: Start a new histogram buffer associated with this memory distribution metric.

A histogram buffer accumulates in-memory. Data is recorded into the metric on drop.

Trait Implementations

impl Clone for MemoryDistributionMetric

fn clone(&self) -> MemoryDistributionMetric

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MemoryDistributionMetric

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

Formats the value using the given formatter.

impl MetricType for MemoryDistributionMetric

fn meta(&self) -> &CommonMetricDataInternal

Access the stored metadata

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

Create a new metric from this with a new name.

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

Create a new metric from this with a specific label.

fn should_record(&self, glean: &Glean) -> bool

Whether this metric should currently be recorded