mod common;
use crate::common::*;
use serde_json::json;
use glean_core::metrics::*;
use glean_core::storage::StorageManager;
use glean_core::{test_get_num_recorded_errors, ErrorType};
use glean_core::{CommonMetricData, Glean, Lifetime};
mod linear {
use super::*;
#[test]
fn serializer_should_correctly_serialize_custom_distribution() {
let (_t, tmpname) = tempdir();
let cfg = glean_core::Configuration {
data_path: tmpname,
application_id: GLOBAL_APPLICATION_ID.into(),
upload_enabled: true,
max_events: None,
};
{
let glean = Glean::new(cfg.clone()).unwrap();
let metric = CustomDistributionMetric::new(
CommonMetricData {
name: "distribution".into(),
category: "telemetry".into(),
send_in_pings: vec!["store1".into()],
disabled: false,
lifetime: Lifetime::Ping,
..Default::default()
},
1,
100,
100,
HistogramType::Linear,
);
metric.accumulate_samples_signed(&glean, vec![50]);
let val = metric
.test_get_value(&glean, "store1")
.expect("Value should be stored");
assert_eq!(val.sum(), 50);
}
{
let glean = Glean::new(cfg.clone()).unwrap();
let snapshot = StorageManager
.snapshot_as_json(glean.storage(), "store1", true)
.unwrap();
assert_eq!(
json!(50),
snapshot["custom_distribution"]["telemetry.distribution"]["sum"]
);
}
}
#[test]
fn set_value_properly_sets_the_value_in_all_stores() {
let (glean, _t) = new_glean();
let store_names: Vec<String> = vec!["store1".into(), "store2".into()];
let metric = CustomDistributionMetric::new(
CommonMetricData {
name: "distribution".into(),
category: "telemetry".into(),
send_in_pings: store_names.clone(),
disabled: false,
lifetime: Lifetime::Ping,
..Default::default()
},
1,
100,
100,
HistogramType::Linear,
);
metric.accumulate_samples_signed(&glean, vec![50]);
for store_name in store_names {
let snapshot = StorageManager
.snapshot_as_json(glean.storage(), &store_name, true)
.unwrap();
assert_eq!(
json!(50),
snapshot["custom_distribution"]["telemetry.distribution"]["sum"]
);
assert_eq!(
json!(1),
snapshot["custom_distribution"]["telemetry.distribution"]["values"]["50"]
);
}
}
#[test]
fn the_accumulate_samples_api_correctly_stores_memory_values() {
let (glean, _t) = new_glean();
let metric = CustomDistributionMetric::new(
CommonMetricData {
name: "distribution".into(),
category: "telemetry".into(),
send_in_pings: vec!["store1".into()],
disabled: false,
lifetime: Lifetime::Ping,
..Default::default()
},
1,
100,
100,
HistogramType::Linear,
);
metric.accumulate_samples_signed(&glean, [1, 2, 3].to_vec());
let val = metric
.test_get_value(&glean, "store1")
.expect("Value should be stored");
assert_eq!(val.sum(), 6);
assert_eq!(val.count(), 3);
assert_eq!(1, val.values()[&1]);
assert_eq!(1, val.values()[&2]);
assert_eq!(1, val.values()[&3]);
assert!(test_get_num_recorded_errors(
&glean,
metric.meta(),
ErrorType::InvalidValue,
Some("store1")
)
.is_err());
}
#[test]
fn the_accumulate_samples_api_correctly_handles_negative_values() {
let (glean, _t) = new_glean();
let metric = CustomDistributionMetric::new(
CommonMetricData {
name: "distribution".into(),
category: "telemetry".into(),
send_in_pings: vec!["store1".into()],
disabled: false,
lifetime: Lifetime::Ping,
..Default::default()
},
1,
100,
100,
HistogramType::Linear,
);
metric.accumulate_samples_signed(&glean, [-1, 1, 2, 3].to_vec());
let val = metric
.test_get_value(&glean, "store1")
.expect("Value should be stored");
assert_eq!(val.sum(), 6);
assert_eq!(val.count(), 3);
assert_eq!(1, val.values()[&1]);
assert_eq!(1, val.values()[&2]);
assert_eq!(1, val.values()[&3]);
assert_eq!(
Ok(1),
test_get_num_recorded_errors(
&glean,
metric.meta(),
ErrorType::InvalidValue,
Some("store1")
)
);
}
#[test]
fn json_snapshotting_works() {
let (glean, _t) = new_glean();
let metric = CustomDistributionMetric::new(
CommonMetricData {
name: "distribution".into(),
category: "telemetry".into(),
send_in_pings: vec!["store1".into()],
disabled: false,
lifetime: Lifetime::Ping,
..Default::default()
},
1,
100,
100,
HistogramType::Linear,
);
metric.accumulate_samples_signed(&glean, vec![50]);
let snapshot = metric.test_get_value_as_json_string(&glean, "store1");
assert!(snapshot.is_some());
}
}
mod exponential {
use super::*;
#[test]
fn serializer_should_correctly_serialize_custom_distribution() {
let (_t, tmpname) = tempdir();
let cfg = glean_core::Configuration {
data_path: tmpname,
application_id: GLOBAL_APPLICATION_ID.into(),
upload_enabled: true,
max_events: None,
};
{
let glean = Glean::new(cfg.clone()).unwrap();
let metric = CustomDistributionMetric::new(
CommonMetricData {
name: "distribution".into(),
category: "telemetry".into(),
send_in_pings: vec!["store1".into()],
disabled: false,
lifetime: Lifetime::Ping,
..Default::default()
},
1,
100,
10,
HistogramType::Exponential,
);
metric.accumulate_samples_signed(&glean, vec![50]);
let val = metric
.test_get_value(&glean, "store1")
.expect("Value should be stored");
assert_eq!(val.sum(), 50);
}
{
let glean = Glean::new(cfg.clone()).unwrap();
let snapshot = StorageManager
.snapshot_as_json(glean.storage(), "store1", true)
.unwrap();
assert_eq!(
json!(50),
snapshot["custom_distribution"]["telemetry.distribution"]["sum"]
);
}
}
#[test]
fn set_value_properly_sets_the_value_in_all_stores() {
let (glean, _t) = new_glean();
let store_names: Vec<String> = vec!["store1".into(), "store2".into()];
let metric = CustomDistributionMetric::new(
CommonMetricData {
name: "distribution".into(),
category: "telemetry".into(),
send_in_pings: store_names.clone(),
disabled: false,
lifetime: Lifetime::Ping,
..Default::default()
},
1,
100,
10,
HistogramType::Exponential,
);
metric.accumulate_samples_signed(&glean, vec![50]);
for store_name in store_names {
let snapshot = StorageManager
.snapshot_as_json(glean.storage(), &store_name, true)
.unwrap();
assert_eq!(
json!(50),
snapshot["custom_distribution"]["telemetry.distribution"]["sum"]
);
assert_eq!(
json!(1),
snapshot["custom_distribution"]["telemetry.distribution"]["values"]["29"]
);
}
}
#[test]
fn the_accumulate_samples_api_correctly_stores_memory_values() {
let (glean, _t) = new_glean();
let metric = CustomDistributionMetric::new(
CommonMetricData {
name: "distribution".into(),
category: "telemetry".into(),
send_in_pings: vec!["store1".into()],
disabled: false,
lifetime: Lifetime::Ping,
..Default::default()
},
1,
100,
10,
HistogramType::Exponential,
);
metric.accumulate_samples_signed(&glean, [1, 2, 3].to_vec());
let val = metric
.test_get_value(&glean, "store1")
.expect("Value should be stored");
assert_eq!(val.sum(), 6);
assert_eq!(val.count(), 3);
assert_eq!(1, val.values()[&1]);
assert_eq!(1, val.values()[&2]);
assert_eq!(1, val.values()[&3]);
assert!(test_get_num_recorded_errors(
&glean,
metric.meta(),
ErrorType::InvalidValue,
Some("store1")
)
.is_err());
}
#[test]
fn the_accumulate_samples_api_correctly_handles_negative_values() {
let (glean, _t) = new_glean();
let metric = CustomDistributionMetric::new(
CommonMetricData {
name: "distribution".into(),
category: "telemetry".into(),
send_in_pings: vec!["store1".into()],
disabled: false,
lifetime: Lifetime::Ping,
..Default::default()
},
1,
100,
10,
HistogramType::Exponential,
);
metric.accumulate_samples_signed(&glean, [-1, 1, 2, 3].to_vec());
let val = metric
.test_get_value(&glean, "store1")
.expect("Value should be stored");
assert_eq!(val.sum(), 6);
assert_eq!(val.count(), 3);
assert_eq!(1, val.values()[&1]);
assert_eq!(1, val.values()[&2]);
assert_eq!(1, val.values()[&3]);
assert_eq!(
Ok(1),
test_get_num_recorded_errors(
&glean,
metric.meta(),
ErrorType::InvalidValue,
Some("store1")
)
);
}
#[test]
fn json_snapshotting_works() {
let (glean, _t) = new_glean();
let metric = CustomDistributionMetric::new(
CommonMetricData {
name: "distribution".into(),
category: "telemetry".into(),
send_in_pings: vec!["store1".into()],
disabled: false,
lifetime: Lifetime::Ping,
..Default::default()
},
1,
100,
10,
HistogramType::Exponential,
);
metric.accumulate_samples_signed(&glean, vec![50]);
let snapshot = metric.test_get_value_as_json_string(&glean, "store1");
assert!(snapshot.is_some());
}
}