Documentation for LocalRateLimit Filter Metrics (#88)

* Documentation for LocalRateLimit Filter Metrics I hope I got this right, I'm not sure I understand how Prometheus metrics work. Work on #5 * Update src/extensions/filters/local_rate_limit/mod.rs Co-authored-by: Ifeanyi Ubah <[email protected]>
googleforgames · Aug 22, 2020 · 7010c5f · 7010c5f
1 parent 96d4f92
commit 7010c5f
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/src/extensions/filters/local_rate_limit/mod.rs b/src/extensions/filters/local_rate_limit/mod.rs
@@ -50,6 +50,10 @@ mod metrics;
 ///  `config.period` (optional) is the duration during which config.max_packets applies.
 ///  If none is provided, it defaults to 1 second.
 ///
+/// # Metrics
+///
+/// `quilkin_filter_LocalRateLimit_packets_dropped`: Total number of packets dropped due to rate limiting
+///
 
 /// Config represents a RateLimitFilter's configuration.
 #[derive(Serialize, Deserialize, Debug)]