Skip to content

Commit 172294a

Browse files
[Known Issue] Add docs to describe a known issue/limitation of EQL rule cross-cluster search (backport #4813) (#4816)
* [Known Issue] Add docs to describe a known issue/limitation of EQL rule cross-cluster search (#4813) (cherry picked from commit 01ec37b) # Conflicts: # docs/detections/api/rules/rules-api-create.asciidoc # docs/detections/rules-ui-create.asciidoc * Fixed conflict * Fixed conflict --------- Co-authored-by: Nastasha Solomon <[email protected]> Co-authored-by: nastasha.solomon <[email protected]>
1 parent ee9c982 commit 172294a

File tree

2 files changed

+6
-1
lines changed

2 files changed

+6
-1
lines changed

docs/detections/api/rules/rules-api-create.asciidoc

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -382,11 +382,13 @@ documents from the {es} index containing the threat values.
382382
context] array used to define the conditions for when alerts are created from
383383
events. Defaults to an empty array.
384384

385-
|index |String[] |Indices on which the rule functions. Defaults to the
385+
|index |String[] a|Indices on which the rule functions. Defaults to the
386386
Security Solution indices defined on the {kib} Advanced Settings page
387387
(*Kibana* → *Stack Management* → *Advanced Settings* →
388388
`securitySolution:defaultIndex`).
389389

390+
NOTE: Event correlation rules have a limitation that prevents them from querying multiple indices from different clusters (local and remote). To enable this, a user with the {ref}/built-in-roles.html[`superuser`] role must modify the EQL rules that are configured to use <<sec-requirements,cross-cluster search>>. This updates the rule's API key to use `superuser` privileges and allows the rule to use cross-cluster search.
391+
390392
|risk_score_mapping |Object[] a|Overrides generated alerts' `risk_score` with
391393
a value from the source event:
392394

docs/detections/rules-ui-create.asciidoc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -172,7 +172,10 @@ IMPORTANT: Alerts created by threshold rules are synthetic alerts that do not re
172172
[[create-eql-rule]]
173173
==== Create an event correlation rule
174174
. To create an event correlation rule using EQL, select *Event Correlation*, then:
175+
175176
.. Define which {es} indices the rule searches for alerts.
177+
+
178+
NOTE: Event correlation rules have a limitation that prevents them from querying multiple indices from different clusters (local and remote). To enable this, a user with the {ref}/built-in-roles.html[`superuser`] role must modify the EQL rules that are configured to use <<sec-requirements,cross-cluster search>>. This updates the rule's API key to use `superuser` privileges and allows the rule to use cross-cluster search.
176179
.. Add an {ref}/eql-syntax.html[EQL statement] used to detect alerts.
177180
+
178181
For example, the following rule detects when `msxsl.exe` makes an outbound

0 commit comments

Comments
 (0)