torrust-metrics 0.1.0

Prometheus metrics integration library providing type-safe metric collection and aggregation.
Documentation 
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

use crate::metric::MetricName;

#[derive(thiserror::Error, Debug, Clone)]
pub enum Error {
    #[error("Metric names must be unique across all metrics types.")]
    MetricNameCollisionInConstructor {
        counter_names: Vec<String>,
        gauge_names: Vec<String>,
    },

    #[error("Found duplicate metric name in list. Metric names must be unique across all metrics types.")]
    DuplicateMetricNameInList { metric_name: MetricName },

    #[error("Cannot merge metric '{metric_name}': it already exists in the current collection")]
    MetricNameCollisionInMerge { metric_name: MetricName },

    #[error("Cannot create metric with name '{metric_name}': another metric with this name already exists")]
    MetricNameCollisionAdding { metric_name: MetricName },
}

#[cfg(test)]
mod tests {
    use super::Error;
    use crate::metric_name;

    #[test]
    fn it_should_display_metric_name_collision_in_constructor() {
        let err = Error::MetricNameCollisionInConstructor {
            counter_names: vec!["hits_total".to_owned()],
            gauge_names: vec!["temperature".to_owned()],
        };
        let msg = err.to_string();
        assert!(msg.contains("unique"));
    }

    #[test]
    fn it_should_display_duplicate_metric_name_in_list() {
        let err = Error::DuplicateMetricNameInList {
            metric_name: metric_name!("hits_total"),
        };
        let msg = err.to_string();
        assert!(msg.contains("duplicate") || msg.contains("Duplicate"));
    }

    #[test]
    fn it_should_display_metric_name_collision_in_merge() {
        let err = Error::MetricNameCollisionInMerge {
            metric_name: metric_name!("hits_total"),
        };
        let msg = err.to_string();
        assert!(msg.contains("hits_total"));
    }

    #[test]
    fn it_should_display_metric_name_collision_adding() {
        let err = Error::MetricNameCollisionAdding {
            metric_name: metric_name!("hits_total"),
        };
        let msg = err.to_string();
        assert!(msg.contains("hits_total"));
    }

    #[test]
    fn it_should_be_cloneable() {
        let err = Error::MetricNameCollisionAdding {
            metric_name: metric_name!("hits_total"),
        };
        let cloned = err.clone();
        assert_eq!(err.to_string(), cloned.to_string());
    }
}