[8.6] Alert suppression clarification (backport #3879) (#3951)

* Alert suppression clarification (#3879) * Alert suppression clarification * Review updates * Updates note phrasing (cherry picked from commit 5baa89b) # Conflicts: # docs/detections/alert-suppression.asciidoc # docs/detections/rules-ui-create.asciidoc * Resolves conflicts --------- Co-authored-by: natasha-moore-elastic <[email protected]> Co-authored-by: natasha-moore-elastic <[email protected]>
elastic · Sep 14, 2023 · 05a9be6 · 05a9be6
1 parent c476da0
commit 05a9be6
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 0 deletions.
diff --git a/docs/detections/alert-suppression.asciidoc b/docs/detections/alert-suppression.asciidoc
@@ -21,6 +21,8 @@ NOTE: Alert suppression is not available for Elastic prebuilt rules. However, if
 
 You can configure alert suppression when you create or edit a <<create-custom-rule,custom query rule>>. When configuring the rule type (the *Define rule* step for a new rule, the *Definition* tab for an existing rule), enter one or more field names in *Suppress Alerts By*. Configure other rule settings, then save and enable the rule.
 
+NOTE: If you specify a field with multiple values, an alert grouping is created for each value. For example, if you suppress alerts by `destination.ip` of `[127.0.0.1, 127.0.0.2, 127.0.0.3]`, alerts will be suppressed separately for each matching value of `127.0.0.1`, `127.0.0.2`, and `127.0.0.3`. 
+
 TIP: Use the *Rule preview* before saving the rule to visualize how alert suppression will affect the alerts created, based on historical data.
 
 === Confirm suppressed alerts

diff --git a/docs/detections/rules-ui-create.asciidoc b/docs/detections/rules-ui-create.asciidoc
@@ -162,6 +162,8 @@ When you use a saved query, the *Load saved query "_query name_" dynamically on
 . preview:[] (Optional, https://www.elastic.co/pricing[Platinum or higher subscription] required) Use *Suppress Alerts By* to reduce the number of repeated or duplicate alerts created each time the rule runs. Enter a field name to group matching source events by the field's unique values, and only one alert will be created for each group of events per rule execution. You can also enter multiple fields to group events by unique combinations of values.
 +
 You'll still be able to view the original events associated with suppressed alerts by investigating the alert in Timeline. Refer to <<alert-suppression>> for more information.
++
+NOTE: If you specify a field with multiple values, an alert grouping is created for each value. For example, if you suppress alerts by `destination.ip` of `[127.0.0.1, 127.0.0.2, 127.0.0.3]`, alerts will be suppressed separately for each matching value of `127.0.0.1`, `127.0.0.2`, and `127.0.0.3`.
 
 . Click **Continue** to <<rule-ui-basic-params, configure basic rule settings>>.