You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/detections/alert-suppression.asciidoc
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,7 +8,7 @@
8
8
9
9
* {ml-cap} rules have <<ml-requirements,additional requirements>> for alert suppression.
10
10
11
-
preview::["Alert suppression is in technical preview for threshold, indicator match, event correlation, and new terms 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."]
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."]
12
12
--
13
13
14
14
Alert suppression allows you to reduce the number of repeated or duplicate detection alerts created by these detection rule types:
Copy file name to clipboardExpand all lines: docs/detections/api/rules/rules-api-create.asciidoc
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -511,7 +511,7 @@ a detection rule exception (`detection`) or an endpoint exception (`endpoint`).
511
511
[[opt-fields-alert-suppression-create]]
512
512
===== Optional alert suppression fields for query, indicator match, threshold, event correlation (non-sequence queries only), new terms, {esql}, and {ml} rules
513
513
514
-
preview::["Alert suppression is in technical preview for threshold, indicator match, event correlation, new terms, {ml}, and {esql} 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."]
514
+
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."]
515
515
516
516
====== Query, indicator match, event correlation (non-sequence queries only), new terms, {esql}, and {ml} rules
Copy file name to clipboardExpand all lines: docs/detections/api/rules/rules-api-update.asciidoc
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -540,7 +540,7 @@ in the UI (*Rules* -> *Detection rules (SIEM)* -> *_Rule name_*).
540
540
[[opt-fields-alert-suppression-update]]
541
541
===== Optional alert suppression fields for query, indicator match, threshold, event correlation (non-sequence queries only), new terms, {esql}, and {ml} rules
542
542
543
-
preview::["Alert suppression is in technical preview for threshold, indicator match, event correlation, new terms, {ml}, and {esql} 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."]
543
+
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."]
544
544
545
545
====== Query, indicator match, event correlation (non-sequence queries only), new terms, {esql}, and {ml} rules
Copy file name to clipboardExpand all lines: docs/detections/rules-ui-create.asciidoc
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -50,7 +50,7 @@ then select:
50
50
NOTE: If a required job isn't currently running, it will automatically start when you finish configuring and enable the rule.
51
51
.. The anomaly score threshold above which alerts are created.
52
52
+
53
-
. 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.
53
+
. (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.
54
54
+
55
55
NOTE: Because {ml} rules generate alerts from anomalies, which don't contain source event fields, you can only use anomaly fields when configuring alert suppression.
56
56
+
@@ -139,7 +139,7 @@ You can also leave the *Group by* field undefined. The rule then creates an aler
139
139
+
140
140
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.
141
141
142
-
. preview:[] (Optional, https://www.elastic.co/pricing[Platinum or higher subscription] required) Select *Suppress alerts* to reduce the number of repeated or duplicate alerts created by the rule. Refer to <<alert-suppression>> for more information.
142
+
. (Optional, https://www.elastic.co/pricing[Platinum or higher subscription] required) Select *Suppress alerts* to reduce the number of repeated or duplicate alerts created by the rule. Refer to <<alert-suppression>> for more information.
143
143
+
144
144
145
145
////
@@ -269,7 +269,7 @@ they can be selected here. When alerts generated by the rule are investigated
269
269
in the Timeline, Timeline query values are replaced with their corresponding alert
270
270
field values.
271
271
+
272
-
. preview:[] (Optional, https://www.elastic.co/pricing[Platinum or higher subscription] required) Select *Suppress alerts* to reduce the number of repeated or duplicate alerts created by the rule. Refer to <<alert-suppression>> for more information.
272
+
. (Optional, https://www.elastic.co/pricing[Platinum or higher subscription] required) Select *Suppress alerts* to reduce the number of repeated or duplicate alerts created by the rule. Refer to <<alert-suppression>> for more information.
273
273
+
274
274
275
275
////
@@ -328,7 +328,7 @@ IMPORTANT: When checking multiple fields, each unique combination of values from
328
328
+
329
329
For example, if a rule has an interval of 5 minutes, no additional look-back time, and a history window size of 7 days, a term will be considered new only if the time it appears within the last 7 days is also within the last 5 minutes. Configure the rule interval and additional look-back time when you <<rule-schedule, set the rule's schedule>>.
330
330
331
-
. 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.
331
+
. (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.
332
332
+
333
333
334
334
////
@@ -361,7 +361,7 @@ NOTE: Refer to the sections below to learn more about <<esql-rule-query-types,{e
361
361
TIP: Click the help icon (image:images/esql-help-ref-button.png[Click the ES|QL help icon,20,20]) to open the in-product reference documentation for all {esql} commands and functions.
362
362
+
363
363
364
-
. 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.
364
+
. (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.
Copy file name to clipboardExpand all lines: docs/getting-started/advanced-setting.asciidoc
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -190,7 +190,7 @@ The `securitySolution:alertTags` field determines which options display in the a
190
190
191
191
To ensure rules don't search cold and frozen data when executing, specify cold and frozen {ref}/data-tiers.html[data tiers] in the `excludedDataTiersForRuleExecution` field. Multiple data tiers must be separated by commas, for example: `data_frozen`, `data_cold`. This setting is turned off by default; turning it on can improve rule performance and reduce execution time.
192
192
193
-
This setting does not apply to {esql} or {ml} rules.
Copy file name to clipboardExpand all lines: docs/reference/alert-schema.asciidoc
+7-1Lines changed: 7 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -195,9 +195,15 @@ Type: string[]
195
195
196
196
Shows the alert’s estimated timestamp, had the alert been created when the source event initially occurred. The value in this field is determined by the way the rule was run:
197
197
198
-
* **Scheduled run**: Alerts created by scheduled runs have the same timestamp as the `kibana.alert.rule.execution.timestamp` field, which shows when the rule was executed.
198
+
* **Scheduled run**: Alerts created by scheduled runs have the same timestamp as the `@timestamp` field, which shows when the alert was created.
199
199
* **Manual run**: Alerts created by manual runs have a timestamp that falls within the time range specified for the manual run. For example, if you set a rule to manually run on event data from `10/01/2024 05:00 PM` to `10/07/2024 05:00 PM`, the `kibana.alert.intended_timestamp` value will be a date and time within that range.
200
200
201
201
Type: date
202
202
203
+
|N/A | `kibana.alert.rule.execution.type` a|
204
+
205
+
Shows if an alert was created by a manual run or a scheduled run. The value can be `manual` or `scheduled`.
Shows the alert’s estimated timestamp, had the alert been created when the source event initially occurred. The value in this field is determined by the way the rule was run:
911
911
912
-
***Scheduled run**: Alerts created by scheduled runs have the same timestamp as the `kibana.alert.rule.execution.timestamp` field, which shows when the rule was executed.
912
+
***Scheduled run**: Alerts created by scheduled runs have the same timestamp as the `@timestamp` field, which shows when the alert was created.
913
913
* **Manual run**: Alerts created by manual runs have a timestamp that falls within the time range specified for the manual run. For example, if you set a rule to manually run on event data from `10/01/2024 05:00 PM` to `10/07/2024 05:00 PM`, the `kibana.alert.intended_timestamp` value will be a date and time within that range.
Copy file name to clipboardExpand all lines: docs/serverless/alerts/alert-suppression.mdx
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,7 +12,7 @@ status: in review
12
12
<DocCallOutcolor="warning"title="Requirements and notice">
13
13
- ((ml-cap)) rules have <DocLinkslug="/serverless/security/ml-requirements">additional requirements</DocLink> for alert suppression.
14
14
15
-
- Alert suppression is in technical preview for threshold, indicator match, event correlation, and new terms 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.
15
+
- 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.
16
16
</DocCallOut>
17
17
18
18
Alert suppression allows you to reduce the number of repeated or duplicate detection alerts created by these detection rule types:
Copy file name to clipboardExpand all lines: docs/serverless/rules/rules-ui-create.mdx
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -49,7 +49,7 @@ To create or edit ((ml)) rules, you need an appropriate user role. Additionally,
49
49
50
50
1. The anomaly score threshold above which alerts are created.
51
51
52
-
1.<DocBadgetemplate="technical preview" /> (Optional) Use **Suppress alerts by** to reduce the number of repeated or duplicate alerts created by the rule. Refer to <DocLinkslug="/serverless/security/alert-suppression">Suppress detection alerts</DocLink> for more information.
52
+
1. (Optional) Use **Suppress alerts by** to reduce the number of repeated or duplicate alerts created by the rule. Refer to <DocLinkslug="/serverless/security/alert-suppression">Suppress detection alerts</DocLink> for more information.
53
53
54
54
<DocCallOuttitle="Note">
55
55
Because ((ml)) rules generate alerts from anomalies, which don't contain source event fields, you can only use anomaly fields when configuring alert suppression.
@@ -141,7 +141,7 @@ To create or edit ((ml)) rules, you need an appropriate user role. Additionally,
141
141
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.
142
142
</DocCallOut>
143
143
144
-
1.<DocBadgetemplate="technical preview" /> (Optional) Select **Suppress alerts** to reduce the number of repeated or duplicate alerts created by the rule. Refer to <DocLinkslug="/serverless/security/alert-suppression">Suppress detection alerts</DocLink> for more information.
144
+
1. (Optional) Select **Suppress alerts** to reduce the number of repeated or duplicate alerts created by the rule. Refer to <DocLinkslug="/serverless/security/alert-suppression">Suppress detection alerts</DocLink> for more information.
145
145
146
146
{/* The following steps are repeated across multiple rule types. If you change anything
147
147
in these steps or sub-steps, apply the change to the other rule types, too. */}
@@ -285,7 +285,7 @@ To create or edit ((ml)) rules, you need an appropriate user role. Additionally,
285
285
they can be selected here. When alerts generated by the rule are investigated in the Timeline, Timeline query values are replaced with their corresponding alert field values.
286
286
</DocCallOut>
287
287
288
-
1.<DocBadgetemplate="technical preview" /> (Optional) Use **Suppress alerts by** to reduce the number of repeated or duplicate alerts created by the rule. Refer to <DocLinkslug="/serverless/security/alert-suppression">Suppress detection alerts</DocLink> for more information.
288
+
1. (Optional) Use **Suppress alerts by** to reduce the number of repeated or duplicate alerts created by the rule. Refer to <DocLinkslug="/serverless/security/alert-suppression">Suppress detection alerts</DocLink> for more information.
289
289
290
290
{/* The following steps are repeated across multiple rule types. If you change anything
291
291
in these steps or sub-steps, apply the change to the other rule types, too. */}
@@ -352,7 +352,7 @@ You uploaded a value list of known ransomware domains, and you want to be notifi
352
352
353
353
For example, if a rule has an interval of 5 minutes, no additional look-back time, and a history window size of 7 days, a term will be considered new only if the time it appears within the last 7 days is also within the last 5 minutes. Configure the rule interval and additional look-back time when you <DocLinkslug="/serverless/security/rules-create"section="set-the-rules-schedule">set the rule's schedule</DocLink>.
354
354
355
-
1.<DocBadgetemplate="technical preview" /> (Optional) Use **Suppress alerts by** to reduce the number of repeated or duplicate alerts created by the rule. Refer to <DocLinkslug="/serverless/security/alert-suppression">Suppress detection alerts</DocLink> for more information.
355
+
1. (Optional) Use **Suppress alerts by** to reduce the number of repeated or duplicate alerts created by the rule. Refer to <DocLinkslug="/serverless/security/alert-suppression">Suppress detection alerts</DocLink> for more information.
356
356
357
357
{/* The following steps are repeated across multiple rule types. If you change anything
358
358
in these steps or sub-steps, apply the change to the other rule types, too. */}
@@ -389,7 +389,7 @@ To create an ((esql)) rule:
389
389
Click the help icon (<DocIcontype="iInCircle"title="Click the ES|QL help icon" />) to open the in-product reference documentation for all ((esql)) commands and functions.
390
390
</DocCallOut>
391
391
392
-
1.<DocBadgetemplate="technical preview" /> (Optional) Use **Suppress alerts by** to reduce the number of repeated or duplicate alerts created by the rule. Refer to <DocLinkslug="/serverless/security/alert-suppression">Suppress detection alerts</DocLink> for more information.
392
+
1. (Optional) Use **Suppress alerts by** to reduce the number of repeated or duplicate alerts created by the rule. Refer to <DocLinkslug="/serverless/security/alert-suppression">Suppress detection alerts</DocLink> for more information.
393
393
394
394
{/* The following steps are repeated across multiple rule types. If you change anything
395
395
in these steps or sub-steps, apply the change to the other rule types, too. */}
0 commit comments