update add a Level label to the sentry metrics

Author: fisherdarling

foundations/src/alerts/metrics.rs

@@ -1,5 +1,6 @@
 //! Panic and sentry event related metrics.
 
+use super::Level;
 use crate::telemetry::metrics::Counter;
 
 /// Panic metrics.
@@ -13,5 +14,5 @@ pub mod panics {
 #[crate::telemetry::metrics::metrics(crate_path = "crate", unprefixed)]
 pub mod sentry_events {
     /// Total number of sentry events observed.
-    pub fn total() -> Counter;
+    pub fn total(level: Level) -> Counter;
 }

foundations/src/alerts/mod.rs

@@ -62,6 +62,44 @@ pub use self::panic::{panic_hook, PanicHookBuilder};
 #[cfg(feature = "sentry")]
 pub use self::sentry::{sentry_hook, SentryHookBuilder};
 
+/// Sentry event severity level for metrics labeling.
+#[derive(Clone, Copy, Debug, Eq, Hash, PartialEq, serde::Serialize)]
+#[serde(rename_all = "lowercase")]
+#[allow(missing_docs)]
+pub enum Level {
+    Debug,
+    Info,
+    Warning,
+    Error,
+    Fatal,
+}
+
+#[cfg(feature = "sentry")]
+impl From<sentry_core::Level> for Level {
+    fn from(level: sentry_core::Level) -> Self {
+        match level {
+            sentry_core::Level::Debug => Level::Debug,
+            sentry_core::Level::Info => Level::Info,
+            sentry_core::Level::Warning => Level::Warning,
+            sentry_core::Level::Error => Level::Error,
+            sentry_core::Level::Fatal => Level::Fatal,
+        }
+    }
+}
+
+#[cfg(feature = "sentry")]
+impl From<Level> for sentry_core::Level {
+    fn from(level: Level) -> Self {
+        match level {
+            Level::Debug => sentry_core::Level::Debug,
+            Level::Info => sentry_core::Level::Info,
+            Level::Warning => sentry_core::Level::Warning,
+            Level::Error => sentry_core::Level::Error,
+            Level::Fatal => sentry_core::Level::Fatal,
+        }
+    }
+}
+
 /// Trait for recording sentry and panic hook metrics.
 ///
 /// Implement this trait to use a custom metrics registry instead of
@@ -71,7 +109,7 @@ pub trait FatalErrorRegistry: Send + Sync {
     fn inc_panics_total(&self, by: u64);
 
     /// Increment the sentry events counter.
-    fn inc_sentry_events_total(&self, by: u64);
+    fn inc_sentry_events_total(&self, level: Level, by: u64);
 }
 
 #[doc(hidden)]
@@ -88,8 +126,8 @@ pub mod _private {
             super::metrics::panics::total().inc_by(by);
         }
 
-        fn inc_sentry_events_total(&self, by: u64) {
-            super::metrics::sentry_events::total().inc_by(by);
+        fn inc_sentry_events_total(&self, level: super::Level, by: u64) {
+            super::metrics::sentry_events::total(level).inc_by(by);
         }
     }
 

foundations/src/alerts/sentry.rs

@@ -73,7 +73,7 @@ impl<R: FatalErrorRegistry + Send + Sync + 'static> SentryHookBuilder<HasRegistr
         let previous = options.before_send.take();
 
         options.before_send = Some(Arc::new(move |event| {
-            registry.inc_sentry_events_total(1);
+            registry.inc_sentry_events_total(event.level.into(), 1);
 
             // Call previous hook if any
             if let Some(ref prev) = previous {

foundations/tests/sentry_hook.rs

@@ -16,7 +16,7 @@ mod with_metrics {
     };
 
     use super::{simulate_sentry_event, TEST_DSN};
-    use foundations::alerts::metrics;
+    use foundations::alerts::{metrics, Level};
 
     #[test]
     fn sentry_hook_increments_metric_on_event() {
@@ -26,7 +26,7 @@ mod with_metrics {
         let _guard = sentry::init((TEST_DSN, options));
 
         simulate_sentry_event();
-        assert_eq!(metrics::sentry_events::total().get(), 1);
+        assert_eq!(metrics::sentry_events::total(Level::Error).get(), 1);
     }
 
     #[test]
@@ -40,7 +40,7 @@ mod with_metrics {
         simulate_sentry_event();
         simulate_sentry_event();
 
-        assert_eq!(metrics::sentry_events::total().get(), 3);
+        assert_eq!(metrics::sentry_events::total(Level::Error).get(), 3);
     }
 
     #[test]
@@ -67,7 +67,7 @@ mod with_metrics {
 
         // Both hooks should have been called
         assert_eq!(previous_hook_count.load(Ordering::Relaxed), 2);
-        assert_eq!(metrics::sentry_events::total().get(), 2);
+        assert_eq!(metrics::sentry_events::total(Level::Error).get(), 2);
     }
 
     #[test]
@@ -86,7 +86,7 @@ mod with_metrics {
         handle1.join().unwrap();
         handle2.join().unwrap();
 
-        assert_eq!(metrics::sentry_events::total().get(), 3);
+        assert_eq!(metrics::sentry_events::total(Level::Error).get(), 3);
     }
 
     #[test]
@@ -113,7 +113,7 @@ mod with_metrics {
             handle2.await.unwrap();
         });
 
-        assert_eq!(metrics::sentry_events::total().get(), 3);
+        assert_eq!(metrics::sentry_events::total(Level::Error).get(), 3);
     }
 
     #[test]
@@ -140,7 +140,7 @@ mod with_metrics {
         impl FatalErrorRegistry for TestRegistry {
             fn inc_panics_total(&self, _by: u64) {}
 
-            fn inc_sentry_events_total(&self, by: u64) {
+            fn inc_sentry_events_total(&self, _level: Level, by: u64) {
                 self.sentry_events.fetch_add(by, Ordering::Relaxed);
             }
         }
@@ -158,7 +158,7 @@ mod with_metrics {
 
         // Custom registry should be used, not the default metrics
         assert_eq!(registry.sentry_events(), 1);
-        assert_eq!(metrics::sentry_events::total().get(), 0);
+        assert_eq!(metrics::sentry_events::total(Level::Error).get(), 0);
     }
 
     #[test]
@@ -185,13 +185,13 @@ mod with_metrics {
         });
 
         // The hook should have been called via the cloned options
-        assert_eq!(metrics::sentry_events::total().get(), 1);
+        assert_eq!(metrics::sentry_events::total(Level::Error).get(), 1);
     }
 }
 
 #[cfg(not(feature = "metrics"))]
 mod no_metrics {
-    use foundations::alerts::FatalErrorRegistry;
+    use foundations::alerts::{FatalErrorRegistry, Level};
     use std::sync::{
         atomic::{AtomicU64, Ordering},
         Arc,
@@ -223,7 +223,7 @@ mod no_metrics {
             self.panics.fetch_add(by, Ordering::Relaxed);
         }
 
-        fn inc_sentry_events_total(&self, by: u64) {
+        fn inc_sentry_events_total(&self, _level: Level, by: u64) {
             self.sentry_events.fetch_add(by, Ordering::Relaxed);
         }
     }