Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged
merged 2 commits into from
Sep 14, 2023
Merged

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e95e3ab
Alert suppression clarification (#3879)
natasha-moore-elastic Sep 14, 2023
211b0fc
Resolves conflicts
natasha-moore-elastic Sep 14, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions docs/detections/alert-suppression.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 2 additions & 0 deletions docs/detections/rules-ui-create.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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>>.

Expand Down