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
// 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::MetricType; 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 string 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 StringMetric(pub(crate) Arc<glean_core::metrics::StringMetric>); impl StringMetric { /// The public constructor used by automatically generated metrics. pub fn new(meta: glean_core::CommonMetricData) -> Self { Self(Arc::new(glean_core::metrics::StringMetric::new(meta))) } } #[inherent(pub)] impl glean_core::traits::String for StringMetric { /// Sets to the specified value. /// /// # Arguments /// /// * `value` - The string to set the metric to. /// /// ## Notes /// /// Truncates the value if it is longer than `MAX_STRING_LENGTH` bytes and logs an error. fn set<S: Into<std::string::String>>(&self, value: S) { let metric = Arc::clone(&self.0); let new_value = value.into(); dispatcher::launch(move || crate::with_glean(|glean| metric.set(glean, new_value))); } /// **Exported for test purposes.** /// /// Gets the currently stored value as a string. /// /// This doesn't clear the stored value. /// /// # Arguments /// /// * `ping_name` - represents the optional name of the ping to retrieve the /// metric for. Defaults to the first value in `send_in_pings`. fn test_get_value<'a, S: Into<Option<&'a str>>>( &self, ping_name: S, ) -> Option<std::string::String> { dispatcher::block_on_queue(); 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)) } /// **Exported for test purposes.** /// /// Gets the number of recorded errors for the given metric and error type. /// /// # Arguments /// /// * `error` - The type of error /// * `ping_name` - represents the optional name of the ping to retrieve the /// metric for. Defaults to the first value in `send_in_pings`. /// /// # Returns /// /// The number of errors reported. fn test_get_num_recorded_errors<'a, S: Into<Option<&'a str>>>( &self, error: ErrorType, ping_name: S, ) -> i32 { crate::with_glean_mut(|glean| { glean_core::test_get_num_recorded_errors(&glean, self.0.meta(), error, ping_name.into()) .unwrap_or(0) }) } }