Skip to content

Commit df4673a

Browse files
Merge branch 'main' into issue-5878-visualise-tab
2 parents 1c6f95f + c73c723 commit df4673a

File tree

9 files changed

+34
-20
lines changed

9 files changed

+34
-20
lines changed

docs/detections/alert-suppression.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
* {ml-cap} rules have <<ml-requirements,additional requirements>> for alert suppression.
1010

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."]
1212
--
1313

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

docs/detections/api/rules/rules-api-create.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -511,7 +511,7 @@ a detection rule exception (`detection`) or an endpoint exception (`endpoint`).
511511
[[opt-fields-alert-suppression-create]]
512512
===== Optional alert suppression fields for query, indicator match, threshold, event correlation (non-sequence queries only), new terms, {esql}, and {ml} rules
513513

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."]
515515

516516
====== Query, indicator match, event correlation (non-sequence queries only), new terms, {esql}, and {ml} rules
517517

docs/detections/api/rules/rules-api-update.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -540,7 +540,7 @@ in the UI (*Rules* -> *Detection rules (SIEM)* -> *_Rule name_*).
540540
[[opt-fields-alert-suppression-update]]
541541
===== Optional alert suppression fields for query, indicator match, threshold, event correlation (non-sequence queries only), new terms, {esql}, and {ml} rules
542542

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."]
544544

545545
====== Query, indicator match, event correlation (non-sequence queries only), new terms, {esql}, and {ml} rules
546546

docs/detections/rules-ui-create.asciidoc

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ then select:
5050
NOTE: If a required job isn't currently running, it will automatically start when you finish configuring and enable the rule.
5151
.. The anomaly score threshold above which alerts are created.
5252
+
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.
5454
+
5555
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.
5656
+
@@ -139,7 +139,7 @@ You can also leave the *Group by* field undefined. The rule then creates an aler
139139
+
140140
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.
141141

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.
143143
+
144144

145145
////
@@ -269,7 +269,7 @@ they can be selected here. When alerts generated by the rule are investigated
269269
in the Timeline, Timeline query values are replaced with their corresponding alert
270270
field values.
271271
+
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.
273273
+
274274

275275
////
@@ -328,7 +328,7 @@ IMPORTANT: When checking multiple fields, each unique combination of values from
328328
+
329329
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>>.
330330

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.
332332
+
333333

334334
////
@@ -361,7 +361,7 @@ NOTE: Refer to the sections below to learn more about <<esql-rule-query-types,{e
361361
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.
362362
+
363363

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.
365365
+
366366

367367
////

docs/getting-started/advanced-setting.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -190,7 +190,7 @@ The `securitySolution:alertTags` field determines which options display in the a
190190

191191
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.
192192

193-
This setting does not apply to {esql} or {ml} rules.
193+
This setting does not apply to {ml} rules.
194194

195195
[TIP]
196196
====

docs/reference/alert-schema.asciidoc

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -195,9 +195,15 @@ Type: string[]
195195

196196
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:
197197

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.
199199
* **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.
200200

201201
Type: date
202202

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`.
206+
207+
Type: keyword
208+
203209
|==============================================

docs/serverless/alerts/alert-schema.mdx

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -891,7 +891,7 @@ The non-ECS fields listed below are beta and subject to change.
891891

892892
</DocCell>
893893
</DocRow>
894-
<DocRow>
894+
<DocRow>
895895
<DocCell>`kibana.alert.workflow_assignee_ids`</DocCell>
896896
<DocCell>
897897
List of users assigned to an alert.
@@ -904,17 +904,25 @@ The non-ECS fields listed below are beta and subject to change.
904904

905905
</DocCell>
906906
</DocRow>
907-
<DocRow>
907+
<DocRow>
908908
<DocCell> `kibana.alert.intended_timestamp`</DocCell>
909909
<DocCell>
910910
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:
911911

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.
913913
* **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.
914914

915-
916915
Type: date
917916

918917
</DocCell>
919918
</DocRow>
919+
<DocRow>
920+
<DocCell> `kibana.alert.rule.execution.type`</DocCell>
921+
<DocCell>
922+
Shows if an alert was created by a manual run or a scheduled run. The value can be `manual` or `scheduled`.
923+
924+
Type: keyword
925+
926+
</DocCell>
927+
</DocRow>
920928
</DocTable>

docs/serverless/alerts/alert-suppression.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ status: in review
1212
<DocCallOut color="warning" title="Requirements and notice">
1313
- ((ml-cap)) rules have <DocLink slug="/serverless/security/ml-requirements">additional requirements</DocLink> for alert suppression.
1414

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.
1616
</DocCallOut>
1717

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

docs/serverless/rules/rules-ui-create.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ To create or edit ((ml)) rules, you need an appropriate user role. Additionally,
4949

5050
1. The anomaly score threshold above which alerts are created.
5151

52-
1. <DocBadge template="technical preview" /> (Optional) Use **Suppress alerts by** to reduce the number of repeated or duplicate alerts created by the rule. Refer to <DocLink slug="/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 <DocLink slug="/serverless/security/alert-suppression">Suppress detection alerts</DocLink> for more information.
5353

5454
<DocCallOut title="Note">
5555
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,
141141
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.
142142
</DocCallOut>
143143

144-
1. <DocBadge template="technical preview" /> (Optional) Select **Suppress alerts** to reduce the number of repeated or duplicate alerts created by the rule. Refer to <DocLink slug="/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 <DocLink slug="/serverless/security/alert-suppression">Suppress detection alerts</DocLink> for more information.
145145

146146
{/* The following steps are repeated across multiple rule types. If you change anything
147147
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,
285285
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.
286286
</DocCallOut>
287287

288-
1. <DocBadge template="technical preview" /> (Optional) Use **Suppress alerts by** to reduce the number of repeated or duplicate alerts created by the rule. Refer to <DocLink slug="/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 <DocLink slug="/serverless/security/alert-suppression">Suppress detection alerts</DocLink> for more information.
289289

290290
{/* The following steps are repeated across multiple rule types. If you change anything
291291
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
352352

353353
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 <DocLink slug="/serverless/security/rules-create" section="set-the-rules-schedule">set the rule's schedule</DocLink>.
354354

355-
1. <DocBadge template="technical preview" /> (Optional) Use **Suppress alerts by** to reduce the number of repeated or duplicate alerts created by the rule. Refer to <DocLink slug="/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 <DocLink slug="/serverless/security/alert-suppression">Suppress detection alerts</DocLink> for more information.
356356

357357
{/* The following steps are repeated across multiple rule types. If you change anything
358358
in these steps or sub-steps, apply the change to the other rule types, too. */}
@@ -389,7 +389,7 @@ To create an ((esql)) rule:
389389
Click the help icon (<DocIcon type="iInCircle" title="Click the ES|QL help icon" />) to open the in-product reference documentation for all ((esql)) commands and functions.
390390
</DocCallOut>
391391

392-
1. <DocBadge template="technical preview" /> (Optional) Use **Suppress alerts by** to reduce the number of repeated or duplicate alerts created by the rule. Refer to <DocLink slug="/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 <DocLink slug="/serverless/security/alert-suppression">Suppress detection alerts</DocLink> for more information.
393393

394394
{/* The following steps are repeated across multiple rule types. If you change anything
395395
in these steps or sub-steps, apply the change to the other rule types, too. */}

0 commit comments

Comments
 (0)