1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97

// 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.

/// 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);
        crate::launch_with_glean(move |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)
        })
    }
}