Skip to content

Commit 90bbcfc

Browse files
mergify[bot]nastasha-solomongithub-actions[bot]
authored
[8.x] [Serverless][8.18] EQL Sequence alert suppression (backport #6291) (#6381)
* [Serverless][8.18] EQL Sequence alert suppression (#6291) * First draft * draft 1 * Update docs/detections/alert-suppression.asciidoc * fix it? * Moves info * updating ref * Update docs/detections/building-block-rule.asciidoc * Update docs/serverless/rules/building-block-rule.asciidoc * Removing empty lines * Removes tech preview label for 8.18 * updates note about reqs * Re-adds + * Fixes Serverless note * Fixes numebring (cherry picked from commit ed389ce) # Conflicts: # docs/serverless/alerts/alert-suppression.asciidoc * Delete docs/serverless directory and its contents --------- Co-authored-by: Nastasha Solomon <79124755+nastasha-solomon@users.noreply.github.com> Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
1 parent d6c2d3e commit 90bbcfc

File tree

2 files changed

+5
-8
lines changed

2 files changed

+5
-8
lines changed

docs/detections/alert-suppression.asciidoc

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,16 +7,14 @@
77
* Alert suppression requires a https://www.elastic.co/pricing[Platinum or higher subscription].
88

99
* {ml-cap} rules have <<ml-requirements,additional requirements>> for alert suppression.
10-
11-
preview::["Alert suppression is in technical preview for event correlation rules. The functionality may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features."]
1210
--
1311

1412
Alert suppression allows you to reduce the number of repeated or duplicate detection alerts created by these detection rule types:
1513

1614
* <<create-custom-rule,Custom query>>
1715
* <<create-threshold-rule,Threshold>>
1816
* <<create-indicator-rule,Indicator match>>
19-
* <<create-eql-rule,Event correlation>> (non-sequence queries only)
17+
* <<create-eql-rule,Event correlation>>
2018
* <<create-new-terms-rule,New terms>>
2119
* <<create-esql-rule,{esql}>>
2220
* <<create-ml-rule,{ml-cap}>>
@@ -34,7 +32,7 @@ You can configure alert suppression when you create or edit a supported rule typ
3432
. When configuring the rule type (the *Define rule* step for a new rule, or the *Definition* tab for an existing rule), specify how you want to group events for alert suppression:
3533
+
3634
--
37-
* **Custom query, indicator match, threshold, event correlation (non-sequence queries only), new terms, {ml}, and {esql} rules:** In *Suppress alerts by*, enter 1-3 field names to group events by the fields' values.
35+
* **Custom query, indicator match, threshold, event correlation, new terms, {ml}, and {esql} rules:** In *Suppress alerts by*, enter 1-3 field names to group events by the fields' values.
3836
* **Threshold rule:** In *Group by*, enter up to 3 field names to group events by the fields' values, or leave the setting empty to group all qualifying events together.
3937

4038
--
@@ -45,7 +43,7 @@ If you specify a field with multiple values, alerts with that field are handled
4543
4644
* **Custom query or threshold rules:** A group of alerts 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 value of `127.0.0.1`, `127.0.0.2`, and `127.0.0.3`.
4745
* **Indicator match, event correlation (non-sequence queries only), new terms, {esql}, or {ml} rules:** Alerts with the specified field name and identical array values are grouped together. For example, if you suppress alerts by `destination.ip` of `[127.0.0.1, 127.0.0.2, 127.0.0.3]`, alerts with the entire array are grouped and only one alert is created for the group.
48-
46+
* **Event correlation (sequence queries only) rules:** If the specified field contains an array of values, suppression only happens if the field's values are an exact match and in the same order. For example, if you specify the field `myips` and one sequence alert has [1.1.1.1, 0.0.0.0] and another sequence alert has [1.1.1.1, 192.168.0.1], neither of those alerts will be suppressed, despite sharing an array element.
4947
======
5048

5149
. If available, select how often to create alerts for duplicate events:
@@ -114,5 +112,5 @@ image::images/timeline-button.png[Investigate in timeline button, 200]
114112

115113
Some rule types have a maximum number of alerts that can be suppressed (custom query rules don't have a suppression limit):
116114

117-
* **Threshold, event correlation (non-sequence queries only), {esql}, and {ml}:** The maximum number of alerts is the value you choose for the rule's **Max alerts per run** <<rule-ui-advanced-params,advanced setting>>, which is `100` by default.
115+
* **Threshold, event correlation, {esql}, and {ml}:** The maximum number of alerts is the value you choose for the rule's **Max alerts per run** <<rule-ui-advanced-params,advanced setting>>, which is `100` by default.
118116
* **Indicator match and new terms:** The maximum number is five times the value you choose for the rule's **Max alerts per run** <<rule-ui-advanced-params,advanced setting>>. The default value is `100`, which means the default maximum limit for indicator match rules and new term rules is `500`.

docs/detections/rules-ui-create.asciidoc

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -205,9 +205,8 @@ NOTE: For sequence events, the {security-app} generates a single alert when all
205205
* *Timestamp field*: Contains the event timestamp used for sorting a sequence of events. This is different from the *Timestamp override* advanced setting, which is used for querying events within a range. Defaults to the `@timestamp` ECS field.
206206
+
207207

208-
. 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 by the rule. Refer to <<alert-suppression>> for more information.
208+
. 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 by the rule. Refer to <<alert-suppression>> for more information.
209209
+
210-
211210
////
212211
The following steps are repeated across multiple rule types. If you change anything
213212
in these steps or sub-steps, apply the change to the other rule types, too.

0 commit comments

Comments
 (0)