From f06c7c96f85f4baac3afeeeb32660f870c6f3ee4 Mon Sep 17 00:00:00 2001 From: Ulrich Konrad Date: Wed, 25 Sep 2024 13:26:46 +0200 Subject: [PATCH 1/4] extend spike documentation Add information on spike_count and reference_count to the documentation of rule type spike --- docs/source/ruletypes.rst | 5 +++++ 1 file changed, 5 insertions(+) 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 ~~~~~~~~ From e2376d58901de2cee265024a050f7a696614cc70 Mon Sep 17 00:00:00 2001 From: Jason Ertel Date: Wed, 25 Sep 2024 07:36:15 -0400 Subject: [PATCH 2/4] Update CHANGELOG.md --- CHANGELOG.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 12a0046d..3cdc59e8 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 - [#1525](https://github.com/jertel/elastalert2/pull/1542) - @jertel # 2.20.0 From ffa64926044d80d147f590fbaa9e69c65589cba8 Mon Sep 17 00:00:00 2001 From: Jason Ertel Date: Wed, 25 Sep 2024 07:37:55 -0400 Subject: [PATCH 3/4] Update CHANGELOG.md --- CHANGELOG.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 3cdc59e8..cc0543d4 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,7 +7,7 @@ - None ## Other changes -- [Docs] Mention the two available Spike-rule metrics that are add into the match record - [#1525](https://github.com/jertel/elastalert2/pull/1542) - @jertel +- [Docs] Mention the two available Spike-rule metrics that are add into the match record - [#1525](https://github.com/jertel/elastalert2/pull/1542) - @ulmako # 2.20.0 From d53f5348befc8bc419f230e216b5c6fcacce54b9 Mon Sep 17 00:00:00 2001 From: Jason Ertel Date: Wed, 25 Sep 2024 07:38:26 -0400 Subject: [PATCH 4/4] Update CHANGELOG.md --- CHANGELOG.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index cc0543d4..061559e0 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,7 +7,7 @@ - None ## Other changes -- [Docs] Mention the two available Spike-rule metrics that are add into the match record - [#1525](https://github.com/jertel/elastalert2/pull/1542) - @ulmako +- [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