diff options
Diffstat (limited to 'third_party/rust/glean/src/private/custom_distribution.rs')
-rw-r--r-- | third_party/rust/glean/src/private/custom_distribution.rs | 81 |
1 files changed, 81 insertions, 0 deletions
diff --git a/third_party/rust/glean/src/private/custom_distribution.rs b/third_party/rust/glean/src/private/custom_distribution.rs new file mode 100644 index 0000000000..790850c8d7 --- /dev/null +++ b/third_party/rust/glean/src/private/custom_distribution.rs @@ -0,0 +1,81 @@ +// This Source Code Form is subject to the terms of the Mozilla Public +// License, v. 2.0. If a copy of the MPL was not distributed with this +// file, You can obtain one at https://mozilla.org/MPL/2.0/. + +use inherent::inherent; +use std::sync::Arc; + +use glean_core::metrics::{DistributionData, MetricType}; +use glean_core::{CommonMetricData, ErrorType, HistogramType}; + +use crate::dispatcher; + +// We need to wrap the glean-core type: otherwise if we try to implement +// the trait for the metric in `glean_core::metrics` we hit error[E0117]: +// only traits defined in the current crate can be implemented for arbitrary +// types. + +/// This implements the developer-facing API for recording custom 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. +#[derive(Clone)] +pub struct CustomDistributionMetric(pub(crate) Arc<glean_core::metrics::CustomDistributionMetric>); + +impl CustomDistributionMetric { + /// The public constructor used by automatically generated metrics. + pub fn new( + meta: CommonMetricData, + range_min: u64, + range_max: u64, + bucket_count: u64, + histogram_type: HistogramType, + ) -> Self { + Self(Arc::new( + glean_core::metrics::CustomDistributionMetric::new( + meta, + range_min, + range_max, + bucket_count, + histogram_type, + ), + )) + } +} + +#[inherent(pub)] +impl glean_core::traits::CustomDistribution for CustomDistributionMetric { + fn accumulate_samples_signed(&self, samples: Vec<i64>) { + let metric = Arc::clone(&self.0); + dispatcher::launch(move || { + crate::with_glean(|glean| metric.accumulate_samples_signed(glean, samples)) + }); + } + + fn test_get_value<'a, S: Into<Option<&'a str>>>( + &self, + ping_name: S, + ) -> Option<DistributionData> { + crate::block_on_dispatcher(); + + let queried_ping_name = ping_name + .into() + .unwrap_or_else(|| &self.0.meta().send_in_pings[0]); + + crate::with_glean(|glean| self.0.test_get_value(glean, queried_ping_name)) + } + + fn test_get_num_recorded_errors<'a, S: Into<Option<&'a str>>>( + &self, + error: ErrorType, + ping_name: S, + ) -> i32 { + crate::block_on_dispatcher(); + + crate::with_glean_mut(|glean| { + glean_core::test_get_num_recorded_errors(&glean, self.0.meta(), error, ping_name.into()) + .unwrap_or(0) + }) + } +} |