From e67d3d816ccdda8e57df6154c286c8cbedf4a5c1 Mon Sep 17 00:00:00 2001
From: durch <durch@users.noreply.github.com>
Date: Tue, 19 Mar 2024 20:50:46 +0100
Subject: [PATCH] Push package name to metrics

---
 Cargo.lock                          |  1 -
 common/nym-metrics/Cargo.toml       |  1 -
 common/nym-metrics/src/lib.rs       | 50 +++++++++++++++++++++++++----
 mixnode/src/node/node_statistics.rs |  2 +-
 4 files changed, 44 insertions(+), 10 deletions(-)

diff --git a/Cargo.lock b/Cargo.lock
index d7ab5721bc..95685f31c6 100644
--- a/Cargo.lock
+++ b/Cargo.lock
@@ -5792,7 +5792,6 @@ dependencies = [
  "lazy_static",
  "log",
  "prometheus",
- "regex",
 ]
 
 [[package]]
diff --git a/common/nym-metrics/Cargo.toml b/common/nym-metrics/Cargo.toml
index 0b49297719..537a69a142 100644
--- a/common/nym-metrics/Cargo.toml
+++ b/common/nym-metrics/Cargo.toml
@@ -14,5 +14,4 @@ license.workspace = true
 prometheus = { workspace = true }
 log = { workspace = true }
 dashmap = { workspace = true }
-regex = "1.1"
 lazy_static = "1.4"
diff --git a/common/nym-metrics/src/lib.rs b/common/nym-metrics/src/lib.rs
index 6df54bb8e4..a9e22909d3 100644
--- a/common/nym-metrics/src/lib.rs
+++ b/common/nym-metrics/src/lib.rs
@@ -1,23 +1,37 @@
 use dashmap::DashMap;
 pub use log::error;
 use log::{debug, warn};
-use regex::Regex;
 use std::fmt;
 pub use std::time::Instant;
 
 use prometheus::{core::Collector, Counter, Encoder as _, Gauge, Registry, TextEncoder};
 
+#[macro_export]
+macro_rules! prepend_package_name {
+    ($name: literal) => {
+        &format!(
+            "{}_{}",
+            std::module_path!()
+                .split("::")
+                .next()
+                .unwrap_or("x")
+                .to_string(),
+            $name
+        )
+    };
+}
+
 #[macro_export]
 macro_rules! inc_by {
     ($name:literal, $x:expr) => {
-        $crate::REGISTRY.inc_by($name, $x as f64);
+        $crate::REGISTRY.inc_by($crate::prepend_package_name!($name), $x as f64);
     };
 }
 
 #[macro_export]
 macro_rules! inc {
     ($name:literal) => {
-        $crate::REGISTRY.inc($name);
+        $crate::REGISTRY.inc($crate::prepend_package_name!($name));
     };
 }
 
@@ -35,13 +49,13 @@ macro_rules! nanos {
         // if the block needs to return something, we can return it
         let r = $x;
         let duration = start.elapsed().as_nanos() as f64;
+        let name = $crate::prepend_package_name!($name);
         $crate::REGISTRY.inc_by(&format!("{}_nanos", $name), duration);
         r
     }};
 }
 
 lazy_static::lazy_static! {
-    pub static ref RE: Regex = Regex::new(r"[^a-zA-Z0-9_]").unwrap();
     pub static ref REGISTRY: MetricsController = MetricsController::default();
 }
 
@@ -223,9 +237,31 @@ impl MetricsController {
     }
 }
 
-#[inline(always)]
 fn sanitize_metric_name(name: &str) -> String {
-    RE.replace_all(name, "_").to_string()
+    // The first character must be [a-zA-Z_:], and all subsequent characters must be [a-zA-Z0-9_:].
+    let mut out = String::with_capacity(name.len());
+    let mut is_invalid: fn(char) -> bool = invalid_metric_name_start_character;
+    for c in name.chars() {
+        if is_invalid(c) {
+            out.push('_');
+        } else {
+            out.push(c);
+        }
+        is_invalid = invalid_metric_name_character;
+    }
+    out
+}
+
+#[inline]
+fn invalid_metric_name_start_character(c: char) -> bool {
+    // Essentially, needs to match the regex pattern of [a-zA-Z_:].
+    !(c.is_ascii_alphabetic() || c == '_' || c == ':')
+}
+
+#[inline]
+fn invalid_metric_name_character(c: char) -> bool {
+    // Essentially, needs to match the regex pattern of [a-zA-Z0-9_:].
+    !(c.is_ascii_alphanumeric() || c == '_' || c == ':')
 }
 
 #[cfg(test)]
@@ -236,7 +272,7 @@ mod tests {
     fn test_sanitization() {
         assert_eq!(
             sanitize_metric_name("packets_sent_34.242.65.133:1789"),
-            "packets_sent_34_242_65_133_1789"
+            "packets_sent_34_242_65_133:1789"
         )
     }
 }
diff --git a/mixnode/src/node/node_statistics.rs b/mixnode/src/node/node_statistics.rs
index 9ac08b2f0e..aaabbb7a30 100644
--- a/mixnode/src/node/node_statistics.rs
+++ b/mixnode/src/node/node_statistics.rs
@@ -542,6 +542,6 @@ mod tests {
         assert_eq!(&stats.packets_sent_since_last_update.len(), &1);
         assert_eq!(&stats.packets_received_since_startup, &0.);
         assert_eq!(&stats.packets_dropped_since_startup_all, &0.);
-        assert_eq!(metrics!(), "# HELP packets_dropped_since_startup_all packets_dropped_since_startup_all\n# TYPE packets_dropped_since_startup_all counter\npackets_dropped_since_startup_all 0\n# HELP packets_received_since_startup packets_received_since_startup\n# TYPE packets_received_since_startup counter\npackets_received_since_startup 0\n# HELP packets_sent_since_startup_all packets_sent_since_startup_all\n# TYPE packets_sent_since_startup_all counter\npackets_sent_since_startup_all 2\n")
+        assert_eq!(metrics!(), "# HELP nym_mixnode_packets_dropped_since_startup_all nym_mixnode_packets_dropped_since_startup_all\n# TYPE nym_mixnode_packets_dropped_since_startup_all counter\nnym_mixnode_packets_dropped_since_startup_all 0\n# HELP nym_mixnode_packets_received_since_startup nym_mixnode_packets_received_since_startup\n# TYPE nym_mixnode_packets_received_since_startup counter\nnym_mixnode_packets_received_since_startup 0\n# HELP nym_mixnode_packets_sent_since_startup_all nym_mixnode_packets_sent_since_startup_all\n# TYPE nym_mixnode_packets_sent_since_startup_all counter\nnym_mixnode_packets_sent_since_startup_all 2\n")
     }
 }