Struct glean_core::metrics::CustomDistributionMetric
source · [−]pub struct CustomDistributionMetric { /* private fields */ }
Expand description
A custom distribution metric.
Memory distributions are used to accumulate and store memory sizes.
Implementations
sourceimpl CustomDistributionMetric
impl CustomDistributionMetric
sourcepub fn new(
meta: CommonMetricData,
range_min: i64,
range_max: i64,
bucket_count: i64,
histogram_type: HistogramType
) -> Self
pub fn new(
meta: CommonMetricData,
range_min: i64,
range_max: i64,
bucket_count: i64,
histogram_type: HistogramType
) -> Self
Creates a new memory distribution metric.
sourcepub fn accumulate_samples(&self, samples: Vec<i64>)
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.
sourcepub fn test_get_value(
&self,
ping_name: Option<String>
) -> Option<DistributionData>
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.
sourcepub fn test_get_num_recorded_errors(
&self,
error: ErrorType,
ping_name: Option<String>
) -> i32
pub fn test_get_num_recorded_errors(
&self,
error: ErrorType,
ping_name: Option<String>
) -> i32
Exported for test purposes.
Gets the number of recorded errors for the given metric and error type.
Arguments
error
- The type of errorping_name
- represents the optional name of the ping to retrieve the metric for. Defaults to the first value insend_in_pings
.
Returns
The number of errors reported.
Trait Implementations
sourceimpl Clone for CustomDistributionMetric
impl Clone for CustomDistributionMetric
sourcefn clone(&self) -> CustomDistributionMetric
fn clone(&self) -> CustomDistributionMetric
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl Debug for CustomDistributionMetric
impl Debug for CustomDistributionMetric
sourceimpl MetricType for CustomDistributionMetric
impl MetricType for CustomDistributionMetric
sourcefn meta(&self) -> &CommonMetricData
fn meta(&self) -> &CommonMetricData
Access the stored metadata
sourcefn with_name(&self, _name: String) -> Self where
Self: Sized,
fn with_name(&self, _name: String) -> Self where
Self: Sized,
Create a new metric from this with a new name.
sourcefn with_dynamic_label(&self, _label: String) -> Self where
Self: Sized,
fn with_dynamic_label(&self, _label: String) -> Self where
Self: Sized,
Create a new metric from this with a specific label.
sourcefn should_record(&self, glean: &Glean) -> bool
fn should_record(&self, glean: &Glean) -> bool
Whether this metric should currently be recorded Read more
Auto Trait Implementations
impl RefUnwindSafe for CustomDistributionMetric
impl Send for CustomDistributionMetric
impl Sync for CustomDistributionMetric
impl Unpin for CustomDistributionMetric
impl UnwindSafe for CustomDistributionMetric
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more