Merge pull request #1542 from ulmako/master

extend spike documentation
jertel · Sep 25, 2024 · c885e9f · c885e9f
2 parents e3c7363 + d53f534
commit c885e9f
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 1 deletion.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -7,7 +7,7 @@
 - None
 
 ## Other changes
-- None
+- [Docs] Mention the two available Spike-rule metrics that are add into the match record - [#1542](https://github.com/jertel/elastalert2/pull/1542) - @ulmako
 
 # 2.20.0
 

diff --git a/docs/source/ruletypes.rst b/docs/source/ruletypes.rst
@@ -1412,6 +1412,11 @@ default 50, unique terms.
 
 ``query_key``: Counts of documents will be stored independently for each value of ``query_key``.
 
+.. note::
+
+  Matches of the rule type ``spike`` contain two additional fields: ``spike_count`` contains the number of events that occurred during the
+  current timeframe. ``reference_count`` contains the number of events that occurred during the reference timeframe.
+
 Flatline
 ~~~~~~~~