diff options
author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-28 14:29:10 +0000 |
---|---|---|
committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-28 14:29:10 +0000 |
commit | 2aa4a82499d4becd2284cdb482213d541b8804dd (patch) | |
tree | b80bf8bf13c3766139fbacc530efd0dd9d54394c /third_party/rust/glean/src/private/timing_distribution.rs | |
parent | Initial commit. (diff) | |
download | firefox-2aa4a82499d4becd2284cdb482213d541b8804dd.tar.xz firefox-2aa4a82499d4becd2284cdb482213d541b8804dd.zip |
Adding upstream version 86.0.1.upstream/86.0.1upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'third_party/rust/glean/src/private/timing_distribution.rs')
-rw-r--r-- | third_party/rust/glean/src/private/timing_distribution.rs | 99 |
1 files changed, 99 insertions, 0 deletions
diff --git a/third_party/rust/glean/src/private/timing_distribution.rs b/third_party/rust/glean/src/private/timing_distribution.rs new file mode 100644 index 0000000000..5e1a9f930f --- /dev/null +++ b/third_party/rust/glean/src/private/timing_distribution.rs @@ -0,0 +1,99 @@ +// 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, RwLock}; + +use glean_core::metrics::{DistributionData, MetricType, TimeUnit, TimerId}; +use glean_core::ErrorType; + +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 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. +#[derive(Clone)] +pub struct TimingDistributionMetric( + pub(crate) Arc<RwLock<glean_core::metrics::TimingDistributionMetric>>, +); + +impl TimingDistributionMetric { + /// The public constructor used by automatically generated metrics. + pub fn new(meta: glean_core::CommonMetricData, time_unit: TimeUnit) -> Self { + Self(Arc::new(RwLock::new( + glean_core::metrics::TimingDistributionMetric::new(meta, time_unit), + ))) + } +} + +#[inherent(pub)] +impl glean_core::traits::TimingDistribution for TimingDistributionMetric { + fn start(&self) -> TimerId { + let start_time = time::precise_time_ns(); + self.0.write().unwrap().set_start(start_time) + } + + fn stop_and_accumulate(&self, id: TimerId) { + let stop_time = time::precise_time_ns(); + let metric = Arc::clone(&self.0); + dispatcher::launch(move || { + crate::with_glean(|glean| { + metric + .write() + .unwrap() + .set_stop_and_accumulate(glean, id, stop_time) + }) + }); + } + + fn cancel(&self, id: TimerId) { + let metric = Arc::clone(&self.0); + dispatcher::launch(move || metric.write().unwrap().cancel(id)); + } + + fn test_get_value<'a, S: Into<Option<&'a str>>>( + &self, + ping_name: S, + ) -> Option<DistributionData> { + crate::block_on_dispatcher(); + + crate::with_glean(|glean| { + // The order of taking these locks matter. Glean must be first. + let inner = self + .0 + .read() + .expect("Lock poisoned for timing distribution metric on test_get_value."); + let queried_ping_name = ping_name + .into() + .unwrap_or_else(|| &inner.meta().send_in_pings[0]); + + inner.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.read().unwrap().meta(), + error, + ping_name.into(), + ) + .unwrap_or(0) + }) + } +} |