🔭 [SDS-247] Add metric regarding multi-pass v0

sds/src/scanner/metrics.rs

@@ -0,0 +1,17 @@
+use crate::labels::Labels;
+use metrics::{counter, Counter};
+
+pub struct Metrics {
+    pub false_positive_excluded_attributes: Counter,
+}
+
+impl Metrics {
+    pub fn new(labels: &Labels) -> Self {
+        Metrics {
+            false_positive_excluded_attributes: counter!(
+                "false_positive.multipass.excluded_match",
+                labels.clone()
+            ),
+        }
+    }
+}

sds/src/scanner/mod.rs

@@ -13,11 +13,13 @@ use regex_automata::meta::Regex as MetaRegex;
 use std::sync::Arc;
 
 use self::cache_pool::{CachePool, CachePoolBuilder, CachePoolGuard};
+use self::metrics::Metrics;
 use ahash::AHashSet;
 use regex_automata::{Input, Match};
 
 pub(crate) mod cache_pool;
 pub mod error;
+mod metrics;
 
 pub struct StringMatch {
     start: usize,
@@ -62,6 +64,7 @@ pub struct RegexCompiledRule {
     pub proximity_keywords: CompiledProximityKeywords,
     pub validator: Option<Arc<dyn Validator>>,
     pub rule_cache_index: usize,
+    metrics: Metrics,
 }
 
 impl CompiledRuleTrait for RegexCompiledRule {
@@ -104,6 +107,8 @@ impl CompiledRuleTrait for RegexCompiledRule {
                                 start: regex_match.start(),
                                 end: regex_match.end(),
                             });
+                        } else {
+                            self.metrics.false_positive_excluded_attributes.increment(1)
                         }
                     }
 
@@ -176,6 +181,7 @@ impl RuleConfigTrait for RegexRuleConfig {
                 .clone()
                 .map(|x| Arc::new(x) as Arc<dyn Validator>),
             rule_cache_index: cache_index,
+            metrics: Metrics::new(&rule_labels),
         }))
     }
 }
@@ -540,7 +546,9 @@ mod test {
 
     use super::CompiledRuleTrait;
     use super::RuleConfigTrait;
+
     pub struct DumbRuleConfig {}
+
     pub struct DumbCompiledRule {
         pub match_action: MatchAction,
         pub scope: Scope,
@@ -973,7 +981,7 @@ mod test {
                 replacement_type: crate::ReplacementType::PartialStart,
                 start_index: 0,
                 end_index_exclusive: 3,
-                shift_offset: 0
+                shift_offset: 0,
             }
         );
 
@@ -985,7 +993,7 @@ mod test {
                 replacement_type: crate::ReplacementType::PartialStart,
                 start_index: 3,
                 end_index_exclusive: 6,
-                shift_offset: 0
+                shift_offset: 0,
             }
         );
 
@@ -997,7 +1005,7 @@ mod test {
                 replacement_type: crate::ReplacementType::PartialStart,
                 start_index: 6,
                 end_index_exclusive: 9,
-                shift_offset: 0
+                shift_offset: 0,
             }
         );
     }
@@ -1038,7 +1046,7 @@ mod test {
                 replacement_type: crate::ReplacementType::Placeholder,
                 start_index: 0,
                 end_index_exclusive: 3,
-                shift_offset: 0
+                shift_offset: 0,
             }
         );
 
@@ -1050,7 +1058,7 @@ mod test {
                 replacement_type: crate::ReplacementType::Placeholder,
                 start_index: 3,
                 end_index_exclusive: 6,
-                shift_offset: 0
+                shift_offset: 0,
             }
         );
 
@@ -1062,7 +1070,7 @@ mod test {
                 replacement_type: crate::ReplacementType::Placeholder,
                 start_index: 6,
                 end_index_exclusive: 9,
-                shift_offset: 0
+                shift_offset: 0,
             }
         );
     }
@@ -1097,7 +1105,7 @@ mod test {
                 replacement_type: crate::ReplacementType::Placeholder,
                 start_index: 1,
                 end_index_exclusive: 4,
-                shift_offset: 0
+                shift_offset: 0,
             }
         );
     }
@@ -1130,7 +1138,7 @@ mod test {
                 replacement_type: crate::ReplacementType::None,
                 start_index: 0,
                 end_index_exclusive: 3,
-                shift_offset: 0
+                shift_offset: 0,
             }
         );
     }
@@ -1163,7 +1171,7 @@ mod test {
                 replacement_type: crate::ReplacementType::None,
                 start_index: 0,
                 end_index_exclusive: 4,
-                shift_offset: 0
+                shift_offset: 0,
             }
         );
     }
@@ -1196,7 +1204,7 @@ mod test {
                 replacement_type: crate::ReplacementType::None,
                 start_index: 0,
                 end_index_exclusive: 3,
-                shift_offset: 0
+                shift_offset: 0,
             }
         );
     }