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/add-exceptions.asciidoc
+8-8Lines changed: 8 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -38,24 +38,24 @@ specific event in the sequence, update the rule's EQL statement. For example:
38
38
+
39
39
--
40
40
* To add an exception from the rule details page:
41
-
.. Go to the *Rules* page. To access it, find **Detection rules (SIEM)** in the main navigation menu menu or look for “Detection rules (SIEM)” using the {kibana-ref}/introduction.html#kibana-navigation-search[global search field].
41
+
.. Go to the *Rules* page. To access it, find **Detection rules (SIEM)** in the navigation menu or look for “Detection rules (SIEM)” using the {kibana-ref}/introduction.html#kibana-navigation-search[global search field].
42
42
.. Search for the rule that you want to add an exception to, then click its name to open the rule details.
43
43
.. Scroll down the rule details page, select the *Rule exceptions* tab, then click *Add rule exception*.
44
44
+
45
45
[role="screenshot"]
46
46
image::images/rule-exception-tab.png[Detail of rule exceptions tab]
47
47
48
48
* To add an exception from the Alerts table:
49
-
.. Find **Alerts** in the main navigation menu or by using the {kibana-ref}/introduction.html#kibana-navigation-search[global search field].
49
+
.. Find **Alerts** in the navigation menu or by using the {kibana-ref}/introduction.html#kibana-navigation-search[global search field].
50
50
.. Scroll down to the Alerts table, go to the alert you want to create an exception for, click the *More Actions* menu (*...*), then select *Add rule exception*.
51
51
52
52
* To add an exception from the alert details flyout:
53
-
.. Find **Alerts** in the main navigation menu or by using the {kibana-ref}/introduction.html#kibana-navigation-search[global search field].
53
+
.. Find **Alerts** in the navigation menu or by using the {kibana-ref}/introduction.html#kibana-navigation-search[global search field].
54
54
.. Click the *View details* button from the Alerts table.
55
55
.. In the alert details flyout, click *Take action -> Add rule exception*.
56
56
57
57
* To add an exception from the Shared Exception Lists page:
58
-
.. Go to the *Shared exception lists* page. Find **Detection rules (SIEM)** in the main navigation menu or look for “Detection rules (SIEM)” using the {kibana-ref}/introduction.html#kibana-navigation-search[global search field], then go to *Shared exception lists*.
58
+
.. Find the **Shared exception lists** pagein the navigation menu or by using the {kibana-ref}/introduction.html#kibana-navigation-search[global search field].
@@ -157,17 +157,17 @@ Additionally, to add an Endpoint exception to the Endpoint Security rule, there
157
157
--
158
158
159
159
* To add an Endpoint exception from the rule details page:
160
-
.. Go to the *Rules* page. To access it, find **Detection rules (SIEM)** in the main navigation menu or look for “Detection rules (SIEM)” using the {kibana-ref}/introduction.html#kibana-navigation-search[global search field].
160
+
.. Go to the *Rules* page. To access it, find **Detection rules (SIEM)** in the navigation menu or look for “Detection rules (SIEM)” using the {kibana-ref}/introduction.html#kibana-navigation-search[global search field].
161
161
.. Search for and select the Elastic *Endpoint Security* rule.
162
162
.. Scroll down the rule details page, select the *Endpoint exceptions* tab, then click *Add endpoint exception*.
163
163
164
164
* To add an Endpoint exception from the Alerts table:
165
-
.. Find **Alerts** in the main navigation menu or by using the {kibana-ref}/introduction.html#kibana-navigation-search[global search field].
165
+
.. Find **Alerts** in the navigation menu or by using the {kibana-ref}/introduction.html#kibana-navigation-search[global search field].
166
166
.. Scroll down to the Alerts table, and from an {elastic-endpoint}
167
167
alert, click the *More actions* menu (*...*), then select *Add Endpoint exception*.
168
168
169
169
* To add an Endpoint exception from Shared Exception Lists page:
170
-
.. Go to the *Shared exception lists* page. Find **Detection rules (SIEM)** in the main navigation menu or look for “Detection rules (SIEM)” using the {kibana-ref}/introduction.html#kibana-navigation-search[global search field], then go to *Shared exception lists*.
170
+
.. Find the *Shared exception lists* pagein the navigation menu or by using the {kibana-ref}/introduction.html#kibana-navigation-search[global search field].
171
171
.. Expand the Endpoint Security Exception List or click the list name to open the list's details page. Next, click *Add endpoint exception*.
172
172
+
173
173
NOTE: The Endpoint Security Exception List is automatically created. By default, it's associated with the Endpoint Security rule and any rules with the <<rule-ui-advanced-params, *{elastic-endpoint} exceptions*>> option selected.
. Open the rule's details page. To do this, find **Detection rules (SIEM)** in the main navigation menu or look for “Detection rules (SIEM)” using the {kibana-ref}/introduction.html#kibana-navigation-search[global search field], search for the rule that you want to examine, then click the rule's name to open its details.
270
+
. Open the rule's details page. To do this, find **Detection rules (SIEM)** in the navigation menu or look for “Detection rules (SIEM)” using the {kibana-ref}/introduction.html#kibana-navigation-search[global search field], search for the rule that you want to examine, then click the rule's name to open its details.
271
271
. Scroll down and select the *Rule exceptions* or *Endpoint exceptions* tab. All exceptions that belong to the rule will display in a list.
272
272
+
273
273
From the list, you can filter, edit, and delete exceptions. You can also toggle between *Active exceptions* and *Expired exceptions*.
Copy file name to clipboardExpand all lines: docs/detections/prebuilt-rules-management.asciidoc
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -27,7 +27,7 @@ Follow these guidelines to start using the {security-app}'s <<prebuilt-rules, pr
27
27
[[load-prebuilt-rules]]
28
28
=== Install and enable Elastic prebuilt rules
29
29
30
-
. Go to the *Rules* page. To access it, find **Detection rules (SIEM)** in the main navigation menu or look for “Detection rules (SIEM)” using the {kibana-ref}/introduction.html#kibana-navigation-search[global search field].
30
+
. Go to the *Rules* page. To access it, find **Detection rules (SIEM)** in the navigation menu or look for “Detection rules (SIEM)” using the {kibana-ref}/introduction.html#kibana-navigation-search[global search field].
31
31
+
32
32
The badge next to *Add Elastic rules* shows the number of prebuilt rules available for installation.
33
33
+
@@ -83,7 +83,7 @@ Each prebuilt rule includes several tags identifying the rule's purpose, detecti
83
83
[[select-all-prebuilt-rules]]
84
84
=== Select and duplicate all prebuilt rules
85
85
86
-
. Go to the *Rules* page. To access it, find **Detection rules (SIEM)** in the main navigation menu or look for “Detection rules (SIEM)” using the {kibana-ref}/introduction.html#kibana-navigation-search[global search field].
86
+
. Go to the *Rules* page. To access it, find **Detection rules (SIEM)** in the navigation menu or look for “Detection rules (SIEM)” using the {kibana-ref}/introduction.html#kibana-navigation-search[global search field].
87
87
. From the *Rules* page, select the *Elastic rules* filter.
88
88
. Click *Select all _x_ rules* above the rules table.
89
89
. Click *Bulk actions* -> *Duplicate*.
@@ -97,7 +97,7 @@ You can then modify the duplicated rules and, if required, delete the prebuilt o
97
97
98
98
Elastic regularly updates prebuilt rules to optimize their performance and ensure they detect the latest threats and techniques. When updated versions are available for your installed prebuilt rules, the *Rule Updates* tab appears on the *Rules* page, allowing you to update your installed rules with the latest versions.
99
99
100
-
. Go to the *Rules* page. To access it, find **Detection rules (SIEM)** in the main navigation menu or look for “Detection rules (SIEM)” using the {kibana-ref}/introduction.html#kibana-navigation-search[global search field].
100
+
. Go to the *Rules* page. To access it, find **Detection rules (SIEM)** in the navigation menu or look for “Detection rules (SIEM)” using the {kibana-ref}/introduction.html#kibana-navigation-search[global search field].
101
101
. From the *Rules* page, select the *Rule Updates* tab.
102
102
+
103
103
NOTE: The *Rule Updates* tab doesn't appear if all your installed prebuilt rules are up to date.
Copy file name to clipboardExpand all lines: docs/detections/prebuilt-rules/tune-rule-signals.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
@@ -35,7 +35,7 @@ add an exception for the required application.
35
35
For example, to prevent the <<unusual-process-execution-path-alternate-data-stream>> rule from
36
36
producing alerts for an in-house application named `myautomatedbuild`:
37
37
38
-
. Go to the *Rules* page. To access it, find **Detection rules (SIEM)** in the main navigation menu or look for “Detection rules (SIEM)” using the {kibana-ref}/introduction.html#kibana-navigation-search[global search field].
38
+
. Go to the *Rules* page. To access it, find **Detection rules (SIEM)** in the navigation menu or look for “Detection rules (SIEM)” using the {kibana-ref}/introduction.html#kibana-navigation-search[global search field].
39
39
. Search for and then click on the *Unusual Process Execution Path - Alternate Data Stream* rule.
40
40
+
41
41
The *Unusual Process Execution Path - Alternate Data Stream* rule details page is displayed.
Copy file name to clipboardExpand all lines: docs/detections/rules-coverage.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
@@ -10,7 +10,7 @@ The **MITRE ATT&CK® coverage** page shows which https://attack.mitre.org[MITRE
10
10
11
11
Mirroring the MITRE ATT&CK® framework, columns represent major tactics, and cells within each column represent a tactic's related techniques. Cells are darker when a technique has more rules matching the current filters, as indicated in the **Legend** at the top.
12
12
13
-
To access the **MITRE ATT&CK® coverage** page, find **Detection rules (SIEM)** in the main navigation menu or look for “Detection rules (SIEM)” using the {kibana-ref}/introduction.html#kibana-navigation-search[global search field], then go to **MITRE ATT&CK® coverage**.
13
+
To access the **MITRE ATT&CK® coverage** page, find **Detection rules (SIEM)** in the navigation menu or look for “Detection rules (SIEM)” using the {kibana-ref}/introduction.html#kibana-navigation-search[global search field], then go to **MITRE ATT&CK® coverage**.
Copy file name to clipboardExpand all lines: docs/detections/rules-cross-cluster-search.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
@@ -66,7 +66,7 @@ To update a rule's API key, log into the local cluster as a user with the privil
66
66
67
67
* Edit and save the rule.
68
68
* Update the rule's API key manually:
69
-
. Find **Stack Management** in the main navigation menu or by using the {kibana-ref}/introduction.html#kibana-navigation-search[global search field], then go to
69
+
. Find **Stack Management** in the navigation menu or by using the {kibana-ref}/introduction.html#kibana-navigation-search[global search field], then go to
70
70
*Rules*.
71
71
. Use the search box and filters to find the rules you want to update. For example, use the *Type* filter to find rules under the *Security* category.
72
72
. Select the rule's actions menu (*...*), then *Update API key*.
Copy file name to clipboardExpand all lines: docs/detections/rules-ui-create.asciidoc
+7-7Lines changed: 7 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -42,7 +42,7 @@ To create or edit {ml} rules, you must have the https://www.elastic.co/subscript
42
42
{ess-trial}[cloud deployment]. Additionally, you must have the {ref}/built-in-roles.html[`machine_learning_admin`] user
43
43
role, and the selected {ml} job must be running for the rule to function correctly.
44
44
==============
45
-
. Go to the *Rules* page. To access it, find **Detection rules (SIEM)** in the main navigation menu or look for “Detection rules (SIEM)” using the {kibana-ref}/introduction.html#kibana-navigation-search[global search field].
45
+
. Go to the *Rules* page. To access it, find **Detection rules (SIEM)** in the navigation menu or look for “Detection rules (SIEM)” using the {kibana-ref}/introduction.html#kibana-navigation-search[global search field].
46
46
. To create a rule based on a {ml} anomaly threshold, select *Machine Learning* on the *Create new rule*, then select:
47
47
.. The required {ml} jobs.
48
48
+
@@ -67,7 +67,7 @@ in the step or its sub-steps, apply the change to the other rule types, too.
67
67
[discrete]
68
68
[[create-custom-rule]]
69
69
=== Create a custom query rule
70
-
. Go to the *Rules* page. To access it, find **Detection rules (SIEM)** in the main navigation menu or look for “Detection rules (SIEM)” using the {kibana-ref}/introduction.html#kibana-navigation-search[global search field].
70
+
. Go to the *Rules* page. To access it, find **Detection rules (SIEM)** in the navigation menu or look for “Detection rules (SIEM)” using the {kibana-ref}/introduction.html#kibana-navigation-search[global search field].
71
71
. To create a rule based on a KQL or Lucene query, select *Custom query* on the *Create new rule* page, then:
72
72
.. Define which {es} indices or data view the rule searches for alerts.
73
73
.. Use the filter and query fields to create the criteria used for detecting
@@ -117,7 +117,7 @@ in these steps or sub-steps, apply the change to the other rule types, too.
117
117
[discrete]
118
118
[[create-threshold-rule]]
119
119
=== Create a threshold rule
120
-
. Go to the *Rules* page. To access it, find **Detection rules (SIEM)** in the main navigation menu or look for “Detection rules (SIEM)” using the {kibana-ref}/introduction.html#kibana-navigation-search[global search field].
120
+
. Go to the *Rules* page. To access it, find **Detection rules (SIEM)** in the navigation menu or look for “Detection rules (SIEM)” using the {kibana-ref}/introduction.html#kibana-navigation-search[global search field].
121
121
. To create a rule based on a source event field threshold, select *Threshold* on the *Create new rule* page, then:
122
122
.. Define which {es} indices the rule analyzes for alerts.
123
123
.. Use the filter and query fields to create the criteria used for detecting
@@ -157,7 +157,7 @@ in these steps or sub-steps, apply the change to the other rule types, too.
157
157
[discrete]
158
158
[[create-eql-rule]]
159
159
=== Create an event correlation rule
160
-
. Go to the *Rules* page. To access it, find **Detection rules (SIEM)** in the main navigation menu or look for “Detection rules (SIEM)” using the {kibana-ref}/introduction.html#kibana-navigation-search[global search field].
160
+
. Go to the *Rules* page. To access it, find **Detection rules (SIEM)** in the navigation menu or look for “Detection rules (SIEM)” using the {kibana-ref}/introduction.html#kibana-navigation-search[global search field].
161
161
. To create an event correlation rule using EQL, select *Event Correlation* on the *Create new rule* page, then:
162
162
. To create an event correlation rule using EQL, select *Event Correlation*, then:
163
163
.. Define which {es} indices or data view the rule searches when querying for events.
@@ -224,7 +224,7 @@ in these steps or sub-steps, apply the change to the other rule types, too.
224
224
225
225
NOTE: {elastic-sec} provides limited support for indicator match rules. See <<support-indicator-rules>> for more information.
226
226
227
-
. Go to the *Rules* page. To access it, find **Detection rules (SIEM)** in the main navigation menu or look for “Detection rules (SIEM)” using the {kibana-ref}/introduction.html#kibana-navigation-search[global search field].
227
+
. Go to the *Rules* page. To access it, find **Detection rules (SIEM)** in the navigation menu or look for “Detection rules (SIEM)” using the {kibana-ref}/introduction.html#kibana-navigation-search[global search field].
228
228
. To create a rule that searches for events whose specified field value matches the specified indicator field value in the indicator index patterns, select *Indicator Match* on the *Create new rule* page, then fill in the following fields:
229
229
.. *Source*: The individual index patterns or data view that specifies what data to search.
230
230
.. *Custom query*: The query and filters used to retrieve the required results from
. Go to the *Rules* page. To access it, find **Detection rules (SIEM)** in the main navigation menu or look for “Detection rules (SIEM)” using the {kibana-ref}/introduction.html#kibana-navigation-search[global search field].
314
+
. Go to the *Rules* page. To access it, find **Detection rules (SIEM)** in the navigation menu or look for “Detection rules (SIEM)” using the {kibana-ref}/introduction.html#kibana-navigation-search[global search field].
315
315
. To create a rule that searches for each new term detected in source documents, select *New Terms* on the *Create new rule* page, then:
316
316
.. Specify what data to search by entering individual {es} index patterns or selecting an existing data view.
317
317
.. Use the filter and query fields to create the criteria used for detecting
@@ -351,7 +351,7 @@ Use {ref}/esql.html[{esql}] to query your source events and aggregate event data
351
351
352
352
To create an {esql} rule:
353
353
354
-
. Go to the *Rules* page. To access it, find **Detection rules (SIEM)** in the main navigation menu or look for “Detection rules (SIEM)” using the {kibana-ref}/introduction.html#kibana-navigation-search[global search field].
354
+
. Go to the *Rules* page. To access it, find **Detection rules (SIEM)** in the navigation menu or look for “Detection rules (SIEM)” using the {kibana-ref}/introduction.html#kibana-navigation-search[global search field].
355
355
. Select **{esql}**, then write a query.
356
356
+
357
357
NOTE: Refer to the sections below to learn more about <<esql-rule-query-types,{esql} query types>>, <<esql-query-design,query design considerations>>, and <<esql-rule-limitations,rule limitations>>.
0 commit comments