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/rules-ui-create.asciidoc
+18-16Lines changed: 18 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -42,9 +42,8 @@ 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
+
. Go to the *Rules* page. To access the it, find **Detection rules (SIEM)** in the navigation menu or look for “Detection rules (SIEM)” using the <<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:
48
47
.. The required {ml} jobs.
49
48
+
50
49
NOTE: If a required job isn't currently running, it will automatically start when you finish configuring and enable the rule.
@@ -68,9 +67,8 @@ in the step or its sub-steps, apply the change to the other rule types, too.
68
67
[discrete]
69
68
[[create-custom-rule]]
70
69
=== 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:
70
+
. Go to the *Rules* page. To access the it, find **Detection rules (SIEM)** in the navigation menu or look for “Detection rules (SIEM)” using the <<kibana-navigation-search,global search field>>.
71
+
. To create a rule based on a KQL or Lucene query, select *Custom query* on the *Create new rule* page, then:
74
72
.. Define which {es} indices or data view the rule searches for alerts.
75
73
.. Use the filter and query fields to create the criteria used for detecting
76
74
alerts.
@@ -119,8 +117,8 @@ in these steps or sub-steps, apply the change to the other rule types, too.
119
117
[discrete]
120
118
[[create-threshold-rule]]
121
119
=== 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:
120
+
. Go to the *Rules* page. To access the it, find **Detection rules (SIEM)** in the navigation menu or look for “Detection rules (SIEM)” using the <<kibana-navigation-search,global search field>>.
121
+
. To create a rule based on a source event field threshold, select *Threshold* on the *Create new rule* page, then:
124
122
.. Define which {es} indices the rule analyzes for alerts.
125
123
.. Use the filter and query fields to create the criteria used for detecting
126
124
alerts.
@@ -159,7 +157,8 @@ in these steps or sub-steps, apply the change to the other rule types, too.
159
157
[discrete]
160
158
[[create-eql-rule]]
161
159
=== Create an event correlation rule
162
-
. Go to *Rules* -> *Detection rules (SIEM)* -> *Create new rule*. The *Create new rule* page displays.
160
+
. Go to the *Rules* page. To access the it, find **Detection rules (SIEM)** in the navigation menu or look for “Detection rules (SIEM)” using the <<kibana-navigation-search,global search field>>.
161
+
. To create an event correlation rule using EQL, select *Event Correlation* on the *Create new rule* page, then:
163
162
. To create an event correlation rule using EQL, select *Event Correlation*, then:
164
163
.. Define which {es} indices or data view the rule searches when querying for events.
165
164
.. Write an {ref}/eql-syntax.html[EQL query] that searches for matching events or a series of matching events.
@@ -225,9 +224,8 @@ in these steps or sub-steps, apply the change to the other rule types, too.
225
224
226
225
NOTE: {elastic-sec} provides limited support for indicator match rules. See <<support-indicator-rules>> for more information.
227
226
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
-
227
+
. Go to the *Rules* page. To access the it, find **Detection rules (SIEM)** in the navigation menu or look for “Detection rules (SIEM)” using the <<kibana-navigation-search,global search field>>.
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:
231
229
.. *Source*: The individual index patterns or data view that specifies what data to search.
232
230
.. *Custom query*: The query and filters used to retrieve the required results from
233
231
the {elastic-sec} event indices. For example, if you want to match documents that only contain a `destination.ip` address field, add `destination.ip : *`.
@@ -306,15 +304,19 @@ You uploaded a value list of known ransomware domains, and you want to be notifi
306
304
+
307
305
TIP: If you don't remember this information, go to *Rules* -> *Detection rules (SIEM)* -> *Manage value lists*. Locate the appropriate value list and note the field in the corresponding `Type` column. (Examples include keyword, text, and IP.)
308
306
307
+
////
308
+
Revisit this tip ^
309
+
////
310
+
309
311
[role="screenshot"]
310
312
image::images/indicator_value_list.png[]
311
313
312
314
[discrete]
313
315
[[create-new-terms-rule]]
314
316
=== Create a new terms rule
315
317
316
-
. 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:
318
+
. Go to the *Rules* page. To access the it, find **Detection rules (SIEM)** in the navigation menu or look for “Detection rules (SIEM)” using the <<kibana-navigation-search,global search field>>.
319
+
. 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
320
.. Specify what data to search by entering individual {es} index patterns or selecting an existing data view.
319
321
.. Use the filter and query fields to create the criteria used for detecting
320
322
alerts.
@@ -353,8 +355,8 @@ Use {ref}/esql.html[{esql}] to query your source events and aggregate event data
353
355
354
356
To create an {esql} rule:
355
357
356
-
. Go to *Rules* -> *Detection rules (SIEM)* -> *Create new rule*. The *Create new rule* page appears.
357
-
. Select **{esql}**, then write a query.
358
+
. Go to the *Rules* page. To access the it, find **Detection rules (SIEM)** in the navigation menu or look for “Detection rules (SIEM)” using the <<kibana-navigation-search,global search field>>.
359
+
. Select **{esql}**, then write a query.
358
360
+
359
361
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