Skip to content

Commit b8828e2

Browse files
Revisiting instructions to rules page
1 parent d191dbc commit b8828e2

File tree

6 files changed

+36
-29
lines changed

6 files changed

+36
-29
lines changed

docs/detections/add-exceptions.asciidoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -38,8 +38,8 @@ specific event in the sequence, update the rule's EQL statement. For example:
3838
+
3939
--
4040
* 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.
4343
.. Scroll down the rule details page, select the *Rule exceptions* tab, then click *Add rule exception*.
4444
+
4545
[role="screenshot"]
@@ -157,8 +157,8 @@ Additionally, to add an Endpoint exception to the Endpoint Security rule, there
157157
--
158158

159159
* 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.
162162
.. Scroll down the rule details page, select the *Endpoint exceptions* tab, then click *Add endpoint exception*.
163163

164164
* To add an Endpoint exception from the Alerts table:

docs/detections/prebuilt-rules-management.asciidoc

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ Follow these guidelines to start using the {security-app}'s <<prebuilt-rules, pr
2727
[[load-prebuilt-rules]]
2828
=== Install and enable Elastic prebuilt rules
2929

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.
3131
+
3232
The badge next to *Add Elastic rules* shows the number of prebuilt rules available for installation.
3333
+
@@ -83,8 +83,8 @@ Each prebuilt rule includes several tags identifying the rule's purpose, detecti
8383
[[select-all-prebuilt-rules]]
8484
=== Select and duplicate all prebuilt rules
8585

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.
8888
. Click *Select all _x_ rules* above the rules table.
8989
. Click *Bulk actions* -> *Duplicate*.
9090
. 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
9797

9898
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.
9999

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.
102102
+
103103
NOTE: The *Rule Updates* tab doesn't appear if all your installed prebuilt rules are up to date.
104104
+

docs/detections/prebuilt-rules/tune-rule-signals.asciidoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,8 +35,8 @@ add an exception for the required application.
3535
For example, to prevent the <<unusual-process-execution-path-alternate-data-stream>> rule from
3636
producing alerts for an in-house application named `myautomatedbuild`:
3737

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.
4040
+
4141
The *Unusual Process Execution Path - Alternate Data Stream* rule details page is displayed.
4242
[role="screenshot"]

docs/detections/rules-ui-create.asciidoc

Lines changed: 15 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -42,8 +42,9 @@ To create or edit {ml} rules, you must have the https://www.elastic.co/subscript
4242
{ess-trial}[cloud deployment]. Additionally, you must have the {ref}/built-in-roles.html[`machine_learning_admin`] user
4343
role, and the selected {ml} job must be running for the rule to function correctly.
4444
==============
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:
4748
.. The required {ml} jobs.
4849
+
4950
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.
6768
[discrete]
6869
[[create-custom-rule]]
6970
=== 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*.
7173
. To create a rule based on a KQL or Lucene query, select *Custom query* on the *Create new rule* page, then:
7274
.. Define which {es} indices or data view the rule searches for alerts.
7375
.. 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.
117119
[discrete]
118120
[[create-threshold-rule]]
119121
=== 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*.
121124
. To create a rule based on a source event field threshold, select *Threshold* on the *Create new rule* page, then:
122125
.. Define which {es} indices the rule analyzes for alerts.
123126
.. 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.
157160
[discrete]
158161
[[create-eql-rule]]
159162
=== 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*.
161165
. To create an event correlation rule using EQL, select *Event Correlation* on the *Create new rule* page, then:
162166
. To create an event correlation rule using EQL, select *Event Correlation*, then:
163167
.. 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.
224228

225229
NOTE: {elastic-sec} provides limited support for indicator match rules. See <<support-indicator-rules>> for more information.
226230

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*.
228233
. 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:
229234
.. *Source*: The individual index patterns or data view that specifies what data to search.
230235
.. *Custom query*: The query and filters used to retrieve the required results from
@@ -311,7 +316,8 @@ image::images/indicator_value_list.png[]
311316
[[create-new-terms-rule]]
312317
=== Create a new terms rule
313318

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].
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*.
315321
. To create a rule that searches for each new term detected in source documents, select *New Terms* on the *Create new rule* page, then:
316322
.. Specify what data to search by entering individual {es} index patterns or selecting an existing data view.
317323
.. 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
351357

352358
To create an {esql} rule:
353359

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*.
355362
. Select **{esql}**, then write a query.
356363
+
357364
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>>.

docs/detections/rules-ui-manage.asciidoc

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ For prebuilt Elastic rules, you can't modify most settings. You can only edit <<
6767
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.
6868
====
6969

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].
7171
. Do one of the following:
7272
* 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>>.
7373
* 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:
9898

9999
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.
100100

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:
103103
* Select the *All actions* menu (*...*) on a rule, then select an action.
104104
* Select all the rules you want to modify, then select an action from the *Bulk actions* menu.
105105
* 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
115115

116116
IMPORTANT: Before manually running rules, make sure you properly understand and plan for rule dependencies. Incorrect scheduling can lead to inconsistent rule results.
117117

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:
120120
* Select the **All actions** menu (**...**) on a rule, then select **Manual run**.
121121
* Select all the rules you want to manually run, select the **Bulk actions** menu, then select **Manual run**.
122122
. 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-
175175

176176
To export and import detection rules:
177177

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].
179179
. 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.
181181
.. Select *Bulk actions* -> *Export*, then save the exported file.
182182
. To import rules:
183183
+

docs/detections/value-list-exceptions.asciidoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ act as delimiters.
3939
* The maximum accepted file size is 9 million bytes.
4040
=========================
4141

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].
4343
. Click *Manage value lists*. The *Manage value lists* window opens.
4444
+
4545
[role="screenshot"]
@@ -61,7 +61,7 @@ You can edit, remove, or export existing value lists.
6161
[discrete]
6262
==== Edit value lists
6363

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].
6565
. Click **Manage value lists**. The **Manage value lists** window opens.
6666
. In the **Value lists** table, click the value list you want to edit.
6767
. Do any of the following:
@@ -83,7 +83,7 @@ TIP: You can also edit value lists while creating and managing exceptions that u
8383
[discrete]
8484
==== Export or remove value lists
8585

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].
8787
. Click *Manage value lists*. The *Manage value lists* window opens.
8888
. From the *Value lists* table, you can:
8989
.. 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

Comments
 (0)