refactor: [torrust#1403] move labeled metrics to primitives pkg

Author: josecelano

Cargo.lock

@@ -1,8 +1,8 @@
 //! API resources for the [`stats`](crate::v1::context::stats)
 //! API context.
-use bittorrent_http_tracker_core::statistics::metrics::LabeledMetric;
 use serde::{Deserialize, Serialize};
 use torrust_rest_tracker_api_core::statistics::services::{TrackerLabeledMetrics, TrackerMetrics};
+use torrust_tracker_primitives::metrics::LabeledMetrics;
 
 /// It contains all the statistics generated by the tracker.
 #[derive(Serialize, Deserialize, Debug, PartialEq, Eq)]
@@ -118,10 +118,10 @@ impl From<TrackerMetrics> for Stats {
 }
 
 /// It contains all the statistics generated by the tracker.
-#[derive(Serialize, Debug, PartialEq, Eq)]
+#[derive(Serialize, Debug, PartialEq)]
 pub struct LabeledStats {
     // Extendable metrics
-    labeled_metrics: Vec<LabeledMetric>,
+    labeled_metrics: LabeledMetrics,
 }
 
 impl From<TrackerLabeledMetrics> for LabeledStats {

packages/axum-rest-tracker-api-server/src/v1/context/stats/resources.rs

@@ -1,6 +1,7 @@
 use std::collections::BTreeMap;
 
 use serde::Serialize;
+use torrust_tracker_primitives::metrics::LabeledMetrics;
 
 /// Metrics collected by the tracker.
 #[derive(Debug, Clone, PartialEq, Default, Serialize)]
@@ -17,107 +18,11 @@ pub struct Metrics {
     /// Total number of TCP (HTTP tracker) `scrape` requests from IPv6 peers.
     pub tcp6_scrapes_handled: u64,
 
-    pub labeled_metrics: Vec<LabeledMetric>,
+    pub labeled_metrics: LabeledMetrics,
 }
 
 impl Metrics {
     pub fn increase_counter(&mut self, metric_name: &str, metric_labels: &BTreeMap<String, String>) {
-        let mut found = false;
-
-        for labeled_metric in &mut self.labeled_metrics {
-            // todo:
-            //   - Check that the metric has the counter type.
-
-            if labeled_metric.metric.name == metric_name && labeled_metric.labels == *metric_labels {
-                labeled_metric.metric.value += 1;
-                found = true;
-                break;
-            }
-        }
-
-        if !found {
-            self.labeled_metrics.push(LabeledMetric {
-                metric: Metric {
-                    name: metric_name.to_string(),
-                    kind: "counter".to_string(),
-                    value: 1,
-                },
-                labels: metric_labels.clone(),
-            });
-        }
-    }
-}
-
-#[derive(Debug, Clone, Eq, PartialEq, Default, Serialize)]
-pub struct LabeledMetric {
-    pub metric: Metric,
-    pub labels: BTreeMap<String, String>,
-}
-
-#[derive(Debug, Clone, Eq, PartialEq, Default, Serialize)]
-pub struct Metric {
-    pub name: String,
-    pub kind: String,
-    pub value: u64, // todo: change to f64. See https://prometheus.io/docs/concepts/data_model/#samples
-}
-
-#[cfg(test)]
-mod tests {
-    use std::collections::BTreeMap;
-
-    use super::LabeledMetric;
-    use crate::statistics::metrics::{Metric, Metrics};
-
-    #[allow(clippy::no_effect_replace)]
-    #[test]
-    fn metrics_should_be_serializable_to_json() {
-        let metrics = Metrics {
-            tcp4_announces_handled: 1,
-            tcp4_scrapes_handled: 2,
-            tcp6_announces_handled: 3,
-            tcp6_scrapes_handled: 4,
-            labeled_metrics: vec![LabeledMetric {
-                metric: Metric {
-                    name: "announce_requests_received_total".to_string(),
-                    kind: "counter".to_string(),
-                    value: 325,
-                },
-                labels: BTreeMap::from([
-                    ("ip_version".to_string(), "ipv4".to_string()),
-                    ("protocol".to_string(), "udp".to_string()),
-                    ("url".to_string(), "udp://127.0.0.1:6969".to_string()),
-                ]),
-            }],
-        };
-
-        let json = serde_json::to_string(&metrics).unwrap();
-
-        assert_eq!(
-            formatjson::format_json(&json).unwrap(),
-            formatjson::format_json(
-                r#"
-                {
-                    "tcp4_announces_handled":1,
-                    "tcp4_scrapes_handled":2,
-                    "tcp6_announces_handled":3,
-                    "tcp6_scrapes_handled":4,
-                    "labeled_metrics": [
-                        {
-                            "metric": {
-                                "name": "announce_requests_received_total",
-                                "kind": "counter",
-                                "value": 325
-                            },
-                            "labels": {
-                                "ip_version":"ipv4",
-                                "protocol":"udp",
-                                "url":"udp://127.0.0.1:6969"
-                            }
-                        }
-                    ]
-                }"#
-            )
-            .unwrap()
-        );
+        self.labeled_metrics.increase_counter(metric_name, metric_labels);
     }
 }

packages/http-tracker-core/src/statistics/metrics.rs

@@ -20,6 +20,7 @@ binascii = "0"
 bittorrent-primitives = "0.1.0"
 derive_more = { version = "2", features = ["constructor"] }
 serde = { version = "1", features = ["derive"] }
+serde_json = "1.0.140"
 tdyne-peer-id = "1"
 tdyne-peer-id-registry = "0"
 thiserror = "2"
@@ -28,4 +29,5 @@ url = "2.5.4"
 zerocopy = "0.7"
 
 [dev-dependencies]
+formatjson = "0.3.1"
 rstest = "0.25.0"

packages/primitives/Cargo.toml

@@ -5,6 +5,7 @@
 //! by the tracker server crate, but also by other crates in the Torrust
 //! ecosystem.
 pub mod core;
+pub mod metrics;
 pub mod pagination;
 pub mod peer;
 pub mod service_binding;

packages/primitives/src/lib.rs

@@ -0,0 +1,103 @@
+use std::collections::BTreeMap;
+
+use serde::Serialize;
+
+/// Metrics collected by the tracker.
+#[derive(Debug, Clone, PartialEq, Default, Serialize)]
+pub struct LabeledMetrics {
+    pub metrics: Vec<LabeledMetric>,
+}
+
+impl LabeledMetrics {
+    pub fn increase_counter(&mut self, metric_name: &str, metric_labels: &BTreeMap<String, String>) {
+        let mut found = false;
+
+        for labeled_metric in &mut self.metrics {
+            // todo:
+            //   - Check that the metric has the counter type.
+
+            if labeled_metric.metric.name == metric_name && labeled_metric.labels == *metric_labels {
+                labeled_metric.metric.value += 1;
+                found = true;
+                break;
+            }
+        }
+
+        if !found {
+            self.metrics.push(LabeledMetric {
+                metric: Metric {
+                    name: metric_name.to_string(),
+                    kind: "counter".to_string(),
+                    value: 1,
+                },
+                labels: metric_labels.clone(),
+            });
+        }
+    }
+}
+
+#[derive(Debug, Clone, Eq, PartialEq, Default, Serialize)]
+pub struct LabeledMetric {
+    pub metric: Metric,
+    pub labels: BTreeMap<String, String>,
+}
+
+#[derive(Debug, Clone, Eq, PartialEq, Default, Serialize)]
+pub struct Metric {
+    pub name: String,
+    pub kind: String,
+    pub value: u64, // todo: change to f64. See https://prometheus.io/docs/concepts/data_model/#samples
+}
+
+#[cfg(test)]
+mod tests {
+    use std::collections::BTreeMap;
+
+    use super::LabeledMetric;
+    use crate::metrics::{LabeledMetrics, Metric};
+
+    #[allow(clippy::no_effect_replace)]
+    #[test]
+    fn metrics_should_be_serializable_to_json() {
+        let metrics = LabeledMetrics {
+            metrics: vec![LabeledMetric {
+                metric: Metric {
+                    name: "announce_requests_received_total".to_string(),
+                    kind: "counter".to_string(),
+                    value: 325,
+                },
+                labels: BTreeMap::from([
+                    ("ip_version".to_string(), "ipv4".to_string()),
+                    ("protocol".to_string(), "udp".to_string()),
+                    ("url".to_string(), "udp://127.0.0.1:6969".to_string()),
+                ]),
+            }],
+        };
+
+        let json = serde_json::to_string(&metrics).unwrap();
+
+        assert_eq!(
+            formatjson::format_json(&json).unwrap(),
+            formatjson::format_json(
+                r#"
+                {
+                    "metrics": [
+                        {
+                            "metric": {
+                                "name": "announce_requests_received_total",
+                                "kind": "counter",
+                                "value": 325
+                            },
+                            "labels": {
+                                "ip_version":"ipv4",
+                                "protocol":"udp",
+                                "url":"udp://127.0.0.1:6969"
+                            }
+                        }
+                    ]
+                }"#
+            )
+            .unwrap()
+        );
+    }
+}

packages/primitives/src/metrics.rs

@@ -1,10 +1,10 @@
 use std::sync::Arc;
 
-use bittorrent_http_tracker_core::statistics::metrics::LabeledMetric;
 use bittorrent_tracker_core::torrent::repository::in_memory::InMemoryTorrentRepository;
 use bittorrent_udp_tracker_core::services::banning::BanService;
 use bittorrent_udp_tracker_core::{self};
 use tokio::sync::RwLock;
+use torrust_tracker_primitives::metrics::LabeledMetrics;
 use torrust_tracker_primitives::swarm_metadata::AggregateSwarmMetadata;
 use torrust_udp_tracker_server::statistics as udp_server_statistics;
 
@@ -81,7 +81,7 @@ pub async fn get_metrics(
 #[derive(Debug, PartialEq)]
 pub struct TrackerLabeledMetrics {
     // Extendable metrics
-    pub labeled_metrics: Vec<LabeledMetric>,
+    pub labeled_metrics: LabeledMetrics,
 }
 
 /// It returns all the [`TrackerLabeledMetrics`]