diff --git a/CHANGELOG.md b/CHANGELOG.md index 12a0046d..061559e0 100644 --- 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 index f57c9166..8b57fe1e 100644 --- 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 ~~~~~~~~