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
.. Find *Detection rules (SIEM)* in the navigation menu or by using the {kibana-ref}/introduction.html#kibana-navigation-search[global search field].
42
+
.. In the Rules table, 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
-
.. Go to *Alerts*.
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
-
.. Go to *Alerts*.
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 *Rules* -> *Shared exception lists*.
58
+
.. Find the **Shared exception lists** page in the navigation menu or by using the {kibana-ref}/introduction.html#kibana-navigation-search[global search field].
@@ -157,16 +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 rule details page (*Rules* -> *Detection rules (SIEM)*), and then search for and select the Elastic *Endpoint Security* rule.
160
+
.. Find *Detection rules (SIEM)* in the navigation menu or by using the {kibana-ref}/introduction.html#kibana-navigation-search[global search field].
161
+
.. In the Rules table, search for and select the Elastic *Endpoint Security* rule.
161
162
.. Scroll down the rule details page, select the *Endpoint exceptions* tab, then click *Add endpoint exception*.
162
163
163
164
* To add an Endpoint exception from the Alerts table:
164
-
.. Go to *Alerts*.
165
+
.. Find **Alerts** in the navigation menu or by using the {kibana-ref}/introduction.html#kibana-navigation-search[global search field].
165
166
.. Scroll down to the Alerts table, and from an {elastic-endpoint}
166
167
alert, click the *More actions* menu (*...*), then select *Add Endpoint exception*.
167
168
168
169
* To add an Endpoint exception from Shared Exception Lists page:
169
-
.. Go to *Rules* -> *Shared exception lists*.
170
+
.. Find the *Shared exception lists* page in the navigation menu or by using the {kibana-ref}/introduction.html#kibana-navigation-search[global search field].
170
171
.. Expand the Endpoint Security Exception List or click the list name to open the list's details page. Next, click *Add endpoint exception*.
171
172
+
172
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.
To view a rule's exceptions, open the rule's details page (*Rules* -> *Detection rules (SIEM)* -> *_Rule name_*), then scroll down and select the *Rule exceptions* or *Endpoint exceptions* tab. All exceptions that belong to the rule will display in a list. From the list, you can filter, edit, and delete exceptions. You can also toggle between *Active exceptions* and *Expired exceptions*.
268
+
To view a rule's exceptions:
268
269
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
+
. Scroll down and select the *Rule exceptions* or *Endpoint exceptions* tab. All exceptions that belong to the rule will display in a list.
272
+
+
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
+7-3Lines changed: 7 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -27,7 +27,9 @@ 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 *Rules* -> *Detection rules (SIEM)*. The badge next to *Add Elastic rules* shows the number of prebuilt rules available for installation.
30
+
. Find *Detection rules (SIEM)* in the navigation menu or by using the {kibana-ref}/introduction.html#kibana-navigation-search[global search field], then go to the Rules table.
31
+
+
32
+
The badge next to *Add Elastic rules* shows the number of prebuilt rules available for installation.
@@ -81,7 +83,8 @@ Each prebuilt rule includes several tags identifying the rule's purpose, detecti
81
83
[[select-all-prebuilt-rules]]
82
84
=== Select and duplicate all prebuilt rules
83
85
84
-
. Go to *Rules* -> *Detection rules (SIEM)*, then select the *Elastic rules* filter.
86
+
. Find *Detection rules (SIEM)* in the navigation menu or by using the {kibana-ref}/introduction.html#kibana-navigation-search[global search field].
87
+
. In the *Rules* table, select the *Elastic rules* filter.
85
88
. Click *Select all _x_ rules* above the rules table.
86
89
. Click *Bulk actions* -> *Duplicate*.
87
90
. Select whether to duplicate the rules' exceptions, then click *Duplicate*.
@@ -94,7 +97,8 @@ You can then modify the duplicated rules and, if required, delete the prebuilt o
94
97
95
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.
96
99
97
-
. Go to *Rules* -> *Detection rules (SIEM)*, then select the *Rule Updates* tab.
100
+
. Find *Detection rules (SIEM)* in the navigation menu or by using the {kibana-ref}/introduction.html#kibana-navigation-search[global search field].
101
+
. In the *Rules* table, select the *Rule Updates* tab.
98
102
+
99
103
NOTE: The *Rule Updates* tab doesn't appear if all your installed prebuilt rules are up to date.
The **MITRE ATT&CK® coverage** page (**Rules** -> **MITRE ATT&CK® Coverage**) shows which https://attack.mitre.org[MITRE ATT&CK®] adversary tactics and techniques are covered by your installed and enabled detection rules. This includes both Elastic prebuilt rules and custom rules.
9
+
The **MITRE ATT&CK® coverage** page shows which https://attack.mitre.org[MITRE ATT&CK®] adversary tactics and techniques are covered by your installed and enabled detection rules. This includes both Elastic prebuilt rules and custom rules.
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 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**.
14
+
13
15
[NOTE]
14
16
====
15
17
This page only includes the detection rules you currently have installed, and only rules that are mapped to MITRE ATT&CK®. The coverage page maps detections to the following https://attack.mitre.org/resources/updates/updates-april-2024[MITRE ATT&CK® version] used by {elastic-sec}: `v15.1`. Elastic prebuilt rules that aren't installed and custom rules that are either unmapped or mapped to a deprecated tactic or technique will not appear on the coverage map.
Copy file name to clipboardExpand all lines: docs/detections/rules-cross-cluster-search.asciidoc
+2-1Lines changed: 2 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -66,7 +66,8 @@ 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
-
. Go to {kib} -> *Stack Management* -> *Rules*.
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
+
*Rules*.
70
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.
71
72
. Select the rule's actions menu (*...*), then *Update API key*.
Copy file name to clipboardExpand all lines: docs/detections/rules-ui-create.asciidoc
+22-17Lines changed: 22 additions & 17 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -42,9 +42,9 @@ 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 *Rules* -> *Detection rules (SIEM)* -> *Create new rule*. The *Create new rule* page displays.
46
-
. To create a rule based on a {ml} anomaly threshold, select *Machine Learning*,
47
-
then select:
45
+
. Find *Detection rules (SIEM)* in the navigation menu or by using the {kibana-ref}/introduction.html#kibana-navigation-search[global search field].
46
+
. Click *Create new rule*.
47
+
. To create a rule based on a {ml} anomaly threshold, select *Machine Learning* on the *Create new rule* page, then select:
48
48
.. The required {ml} jobs.
49
49
+
50
50
NOTE: If a required job isn't currently running, it will automatically start when you finish configuring and enable the rule.
@@ -68,9 +68,9 @@ in the step or its sub-steps, apply the change to the other rule types, too.
68
68
[discrete]
69
69
[[create-custom-rule]]
70
70
=== Create a custom query rule
71
-
. Go to *Rules* -> *Detection rules (SIEM)* -> *Create new rule*. The *Create new rule* page displays.
72
-
. To create a rule based on a KQL or Lucene query, select *Custom query*,
73
-
then:
71
+
. Find *Detection rules (SIEM)* in the navigation menu or by using the {kibana-ref}/introduction.html#kibana-navigation-search[global search field].
72
+
. Click *Create new rule*.
73
+
. To create a rule based on a KQL or Lucene query, select *Custom query* on the *Create new rule* page, then:
74
74
.. Define which {es} indices or data view the rule searches for alerts.
75
75
.. Use the filter and query fields to create the criteria used for detecting
76
76
alerts.
@@ -119,8 +119,9 @@ in these steps or sub-steps, apply the change to the other rule types, too.
119
119
[discrete]
120
120
[[create-threshold-rule]]
121
121
=== Create a threshold rule
122
-
. Go to *Rules* -> *Detection rules (SIEM)* -> *Create new rule*. The *Create new rule* page displays.
123
-
. To create a rule based on a source event field threshold, select *Threshold*, then:
122
+
. Find *Detection rules (SIEM)* in the navigation menu or by using the {kibana-ref}/introduction.html#kibana-navigation-search[global search field].
123
+
. Click *Create new rule*.
124
+
. To create a rule based on a source event field threshold, select *Threshold* on the *Create new rule* page, then:
124
125
.. Define which {es} indices the rule analyzes for alerts.
125
126
.. Use the filter and query fields to create the criteria used for detecting
126
127
alerts.
@@ -159,7 +160,9 @@ in these steps or sub-steps, apply the change to the other rule types, too.
159
160
[discrete]
160
161
[[create-eql-rule]]
161
162
=== Create an event correlation rule
162
-
. Go to *Rules* -> *Detection rules (SIEM)* -> *Create new rule*. The *Create new rule* page displays.
163
+
. Find *Detection rules (SIEM)* in the navigation menu or by using the {kibana-ref}/introduction.html#kibana-navigation-search[global search field].
164
+
. Click *Create new rule*.
165
+
. To create an event correlation rule using EQL, select *Event Correlation* on the *Create new rule* page, then:
163
166
. To create an event correlation rule using EQL, select *Event Correlation*, then:
164
167
.. Define which {es} indices or data view the rule searches when querying for events.
165
168
.. Write an {ref}/eql-syntax.html[EQL query] that searches for matching events or a series of matching events.
@@ -225,9 +228,9 @@ in these steps or sub-steps, apply the change to the other rule types, too.
225
228
226
229
NOTE: {elastic-sec} provides limited support for indicator match rules. See <<support-indicator-rules>> for more information.
227
230
228
-
. Go to *Rules* -> *Detection rules (SIEM)* -> *Create new rule*. The *Create new rule* page displays.
229
-
. 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*, then fill in the following fields:
230
-
231
+
. Find *Detection rules (SIEM)* in the navigation menu or by using the {kibana-ref}/introduction.html#kibana-navigation-search[global search field].
232
+
. Click *Create new rule*.
233
+
. 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:
231
234
.. *Source*: The individual index patterns or data view that specifies what data to search.
232
235
.. *Custom query*: The query and filters used to retrieve the required results from
233
236
the {elastic-sec} event indices. For example, if you want to match documents that only contain a `destination.ip` address field, add `destination.ip : *`.
@@ -304,7 +307,7 @@ You uploaded a value list of known ransomware domains, and you want to be notifi
304
307
* *Field*: Enter the field from the Elastic Security event indices to be used for comparing values.
305
308
* *Indicator index field*: Enter the type of value list you created (i.e., `keyword`, `text`, or `IP`).
306
309
+
307
-
TIP: If you don't remember this information, go to *Rules* -> *Detection rules (SIEM)* -> *Manage valuelists*. Locate the appropriate value list and note the field in the corresponding `Type` column. (Examples include keyword, text, and IP.)
310
+
TIP: If you don't remember this information, refer to the appropriate <<value-lists-exceptions, value list>> and find the list's type in the *Type* column (for example, the type can be `Keywords`, `Text`, or `IP`).
. Go to *Rules* -> *Detection rules (SIEM)* -> *Create new rule*. The *Create new rule* page displays.
317
-
. To create a rule that searches for each new term detected in source documents, select *New Terms*, then:
319
+
. Find *Detection rules (SIEM)* in the navigation menu or by using the {kibana-ref}/introduction.html#kibana-navigation-search[global search field].
320
+
. Click *Create new rule*.
321
+
. To create a rule that searches for each new term detected in source documents, select *New Terms* on the *Create new rule* page, then:
318
322
.. Specify what data to search by entering individual {es} index patterns or selecting an existing data view.
319
323
.. Use the filter and query fields to create the criteria used for detecting
320
324
alerts.
@@ -353,8 +357,9 @@ Use {ref}/esql.html[{esql}] to query your source events and aggregate event data
353
357
354
358
To create an {esql} rule:
355
359
356
-
. Go to *Rules* -> *Detection rules (SIEM)* -> *Create new rule*. The *Create new rule* page appears.
357
-
. Select **{esql}**, then write a query.
360
+
. Find *Detection rules (SIEM)* in the navigation menu or by using the {kibana-ref}/introduction.html#kibana-navigation-search[global search field].
361
+
. Click *Create new rule*.
362
+
. Select **{esql}**, then write a query.
358
363
+
359
364
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