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
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -38,8 +38,8 @@ 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 navigation menu or look for “Detection rules (SIEM)” using the {kibana-ref}/introduction.html#kibana-navigation-search[global search field].
42
-
.. Search for the rule that you want to add an exception to, then click its name to open the rule details.
41
+
.. 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"]
@@ -157,8 +157,8 @@ 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 navigation menu or look for “Detection rules (SIEM)” using the {kibana-ref}/introduction.html#kibana-navigation-search[global search field].
161
-
.. 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.
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:
Copy file name to clipboardExpand all lines: docs/detections/prebuilt-rules-management.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
@@ -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 navigation menu or look for “Detection rules (SIEM)” using the {kibana-ref}/introduction.html#kibana-navigation-search[global search field].
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
31
+
32
32
The badge next to *Add Elastic rules* shows the number of prebuilt rules available for installation.
33
33
+
@@ -83,8 +83,8 @@ 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 navigation menu or look for “Detection rules (SIEM)” using the {kibana-ref}/introduction.html#kibana-navigation-search[global search field].
87
-
. From the *Rules* page, 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.
88
88
. Click *Select all _x_ rules* above the rules table.
89
89
. Click *Bulk actions* -> *Duplicate*.
90
90
. Select whether to duplicate the rules' exceptions, then click *Duplicate*.
@@ -97,8 +97,8 @@ 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 navigation menu or look for “Detection rules (SIEM)” using the {kibana-ref}/introduction.html#kibana-navigation-search[global search field].
101
-
. From the *Rules* page, 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.
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
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -35,8 +35,8 @@ 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 navigation menu or look for “Detection rules (SIEM)” using the {kibana-ref}/introduction.html#kibana-navigation-search[global search field].
39
-
. Search for and then click on the *Unusual Process Execution Path - Alternate Data Stream* rule.
38
+
. Find *Detection rules (SIEM)* in the navigation menu or by using the {kibana-ref}/introduction.html#kibana-navigation-search[global search field].
39
+
. In the Rules table, 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-ui-create.asciidoc
+15-8Lines changed: 15 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -42,8 +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 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
-
. To create a rule based on a {ml} anomaly threshold, select *Machine Learning* on the *Create new rule*, 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:
47
48
.. The required {ml} jobs.
48
49
+
49
50
NOTE: If a required job isn't currently running, it will automatically start when you finish configuring and enable the rule.
@@ -67,7 +68,8 @@ in the step or its sub-steps, apply the change to the other rule types, too.
67
68
[discrete]
68
69
[[create-custom-rule]]
69
70
=== Create a custom query rule
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
+
. 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*.
71
73
. To create a rule based on a KQL or Lucene query, select *Custom query* on the *Create new rule* page, then:
72
74
.. Define which {es} indices or data view the rule searches for alerts.
73
75
.. Use the filter and query fields to create the criteria used for detecting
@@ -117,7 +119,8 @@ in these steps or sub-steps, apply the change to the other rule types, too.
117
119
[discrete]
118
120
[[create-threshold-rule]]
119
121
=== Create a threshold rule
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].
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*.
121
124
. To create a rule based on a source event field threshold, select *Threshold* on the *Create new rule* page, then:
122
125
.. Define which {es} indices the rule analyzes for alerts.
123
126
.. Use the filter and query fields to create the criteria used for detecting
@@ -157,7 +160,8 @@ in these steps or sub-steps, apply the change to the other rule types, too.
157
160
[discrete]
158
161
[[create-eql-rule]]
159
162
=== Create an event correlation rule
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].
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*.
161
165
. To create an event correlation rule using EQL, select *Event Correlation* on the *Create new rule* page, then:
162
166
. To create an event correlation rule using EQL, select *Event Correlation*, then:
163
167
.. Define which {es} indices or data view the rule searches when querying for events.
@@ -224,7 +228,8 @@ in these steps or sub-steps, apply the change to the other rule types, too.
224
228
225
229
NOTE: {elastic-sec} provides limited support for indicator match rules. See <<support-indicator-rules>> for more information.
226
230
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].
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*.
228
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:
229
234
.. *Source*: The individual index patterns or data view that specifies what data to search.
230
235
.. *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 navigation menu or look for “Detection rules (SIEM)” using the {kibana-ref}/introduction.html#kibana-navigation-search[global search field].
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*.
315
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:
316
322
.. Specify what data to search by entering individual {es} index patterns or selecting an existing data view.
317
323
.. Use the filter and query fields to create the criteria used for detecting
@@ -351,7 +357,8 @@ Use {ref}/esql.html[{esql}] to query your source events and aggregate event data
351
357
352
358
To create an {esql} rule:
353
359
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].
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*.
355
362
. Select **{esql}**, then write a query.
356
363
+
357
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>>.
Copy file name to clipboardExpand all lines: docs/detections/rules-ui-manage.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
@@ -67,7 +67,7 @@ For prebuilt Elastic rules, you can't modify most settings. You can only edit <<
67
67
Similarly, rules will be skipped if they can't be modified by a bulk edit. For example, if you try to apply a tag to rules that already have that tag, or apply an index pattern to rules that use data views.
68
68
====
69
69
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].
70
+
. Find *Detection rules (SIEM)* in the navigation menu or by using the {kibana-ref}/introduction.html#kibana-navigation-search[global search field].
71
71
. Do one of the following:
72
72
* Edit a single rule: Select the *All actions* menu (*...*) on a rule, then select *Edit rule settings*. The *Edit rule settings* view opens, where you can modify the <<rules-ui-create, rule's settings>>.
73
73
* Bulk edit multiple rules: Select the rules you want to edit, then select an action from the *Bulk actions* menu:
@@ -98,8 +98,8 @@ You can duplicate, enable, disable, delete, and snooze actions for rules:
98
98
99
99
NOTE: When duplicating a rule with exceptions, you can choose to duplicate the rule and its exceptions (active and expired), the rule and active exceptions only, or only the rule. If you duplicate the rule and its exceptions, copies of the exceptions are created and added to the duplicated rule's <<detections-ui-exceptions,default rule list>>. If the original rule used exceptions from a shared exception list, the duplicated rule will reference the same shared exception list.
100
100
101
-
. 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].
102
-
. Do one of the following:
101
+
. Find *Detection rules (SIEM)* in the navigation menu or by using the {kibana-ref}/introduction.html#kibana-navigation-search[global search field].
102
+
. In the Rules table, do one of the following:
103
103
* Select the *All actions* menu (*...*) on a rule, then select an action.
104
104
* Select all the rules you want to modify, then select an action from the *Bulk actions* menu.
105
105
* To enable or disable a single rule, switch on the rule's *Enabled* toggle.
@@ -115,8 +115,8 @@ Manually run enabled rules for a specified period of time for testing purposes o
115
115
116
116
IMPORTANT: Before manually running rules, make sure you properly understand and plan for rule dependencies. Incorrect scheduling can lead to inconsistent rule results.
117
117
118
-
. 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].
119
-
. From the *Rules* page, do one of the following:
118
+
. Find *Detection rules (SIEM)* in the navigation menu or by using the {kibana-ref}/introduction.html#kibana-navigation-search[global search field].
119
+
. In the *Rules* table, do one of the following:
120
120
* Select the **All actions** menu (**...**) on a rule, then select **Manual run**.
121
121
* Select all the rules you want to manually run, select the **Bulk actions** menu, then select **Manual run**.
122
122
. Specify when the manual run starts and ends. The default selection is the current day starting three hours in the past. The rule will search for events during the selected time range.
@@ -175,9 +175,9 @@ TIP: You can also use {kib}'s {kibana-ref}/managing-saved-objects.html#managing-
175
175
176
176
To export and import detection rules:
177
177
178
-
. 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].
178
+
. Find *Detection rules (SIEM)* in the navigation menu or by using the {kibana-ref}/introduction.html#kibana-navigation-search[global search field].
179
179
. To export rules:
180
-
.. In the rules table, select the rules you want to export.
180
+
.. In the Rules table, select the rules you want to export.
181
181
.. Select *Bulk actions* -> *Export*, then save the exported file.
Copy file name to clipboardExpand all lines: docs/detections/value-list-exceptions.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
@@ -39,7 +39,7 @@ act as delimiters.
39
39
* The maximum accepted file size is 9 million bytes.
40
40
=========================
41
41
42
-
. 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
+
. Find *Detection rules (SIEM)* in the navigation menu or by using the {kibana-ref}/introduction.html#kibana-navigation-search[global search field].
43
43
. Click *Manage value lists*. The *Manage value lists* window opens.
44
44
+
45
45
[role="screenshot"]
@@ -61,7 +61,7 @@ You can edit, remove, or export existing value lists.
61
61
[discrete]
62
62
==== Edit value lists
63
63
64
-
. 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].
64
+
. Find *Detection rules (SIEM)* in the navigation menu or by using the {kibana-ref}/introduction.html#kibana-navigation-search[global search field].
65
65
. Click **Manage value lists**. The **Manage value lists** window opens.
66
66
. In the **Value lists** table, click the value list you want to edit.
67
67
. Do any of the following:
@@ -83,7 +83,7 @@ TIP: You can also edit value lists while creating and managing exceptions that u
83
83
[discrete]
84
84
==== Export or remove value lists
85
85
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].
86
+
. Find *Detection rules (SIEM)* in the navigation menu or by using the {kibana-ref}/introduction.html#kibana-navigation-search[global search field].
87
87
. Click *Manage value lists*. The *Manage value lists* window opens.
88
88
. From the *Value lists* table, you can:
89
89
.. Click the **Export value list** button (image:images/export-value-list.png[Export button from Manage value lists window,15,15]) to export the value list.
0 commit comments