From 63a730127b8e13ccee98d1849761f25adfe9accf Mon Sep 17 00:00:00 2001 From: "mergify[bot]" <37929162+mergify[bot]@users.noreply.github.com> Date: Wed, 22 Jun 2022 16:45:23 -0400 Subject: [PATCH] [DOCS] Revise workaround for aggregated fields in threshold rules (#2074) (#2106) * Remove workaround from create rule docs * Restore admonition, with revisions from Madison (cherry picked from commit 6f0d069e5c4d498780e7d33e60887261e623c7c4) Co-authored-by: Joe Peeples --- docs/detections/rules-ui-create.asciidoc | 14 ++------------ 1 file changed, 2 insertions(+), 12 deletions(-) diff --git a/docs/detections/rules-ui-create.asciidoc b/docs/detections/rules-ui-create.asciidoc index e5b496dae1..91fc51bbf5 100644 --- a/docs/detections/rules-ui-create.asciidoc +++ b/docs/detections/rules-ui-create.asciidoc @@ -164,18 +164,8 @@ For example, if `Group by` is `source.ip`, `destination.ip` and its `Threshold` + You can also leave the `Group by` field undefined. The rule then creates an alert when the number of search results is equal to or greater than the threshold value. If you set `Count` to limit the results by `process.name` >= 2, an alert will only be generated for source/destination IP pairs that appear with at least 2 unique process names across all events. + -[IMPORTANT] -============== -Signals created by *threshold* rules are synthetic signals that do not resemble the source documents. The signal itself only contains data about the fields that were aggregated over (the `Group by` fields). Additionally, the signal contains "lookup" data for retrieving a *Timeline* of all of the source events that caused the threshold to be exceeded. -If you wish to create an <> based on a threshold rule, you can obtain values of the fields that were aggregated over by entering the following: -``` -{{#context.alerts}} - {{#signal.threshold_result.terms}} - {{value}} - {{/signal.threshold_result.terms}} -{{/context.alerts}} -``` -============== +IMPORTANT: Alerts created by threshold rules are synthetic alerts that do not resemble the source documents. The alert itself only contains data about the fields that were aggregated over (the `Group by` fields). Other fields are omitted, because they can vary across all source documents that were counted toward the threshold. Additionally, you can reference the actual count of documents that exceeded the threshold from the `kibana.alert.threshold_result.count` field. + . Continue with <> (optional) or click *Continue* to <>. [discrete]