Skip to content

Commit 9414446

Browse files
[8.6] [Known Issue] Add docs to describe a known issue/limitation of EQL rule cross-cluster search (#4813) (#4925)
* [Known Issue] Add docs to describe a known issue/limitation of EQL rule cross-cluster search (#4813) # Conflicts: # docs/detections/api/rules/rules-api-create.asciidoc # docs/detections/rules-ui-create.asciidoc * Removed merge markers
1 parent fff36e7 commit 9414446

File tree

2 files changed

+8
-1
lines changed

2 files changed

+8
-1
lines changed

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

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -399,11 +399,16 @@ documents from the {es} index containing the threat values.
399399
context] array used to define the conditions for when alerts are created from
400400
events. Defaults to an empty array.
401401

402-
|index |String[] |Indices on which the rule functions. Defaults to the
402+
|index |String[] a|Indices on which the rule functions. Defaults to the
403403
Security Solution indices defined on the {kib} Advanced Settings page
404404
(*Kibana* → *Stack Management* → *Advanced Settings* →
405405
`securitySolution:defaultIndex`).
406406

407+
[NOTE]
408+
======
409+
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 <<rules-cross-cluster-search,cross-cluster search>>. This updates the rule's API key to use `superuser` privileges and allows the rule to use cross-cluster search.
410+
======
411+
407412
|risk_score_mapping |Object[] a|Overrides generated alerts' `risk_score` with
408413
a value from the source event:
409414

docs/detections/rules-ui-create.asciidoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -193,6 +193,8 @@ IMPORTANT: Alerts created by threshold rules are synthetic alerts that do not re
193193
==== Create an event correlation rule
194194
. To create an event correlation rule using EQL, select *Event Correlation*, then:
195195
.. Define which {es} indices or data view the rule searches for alerts.
196+
+
197+
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 <<rules-cross-cluster-search,cross-cluster search>>. This updates the rule's API key to use `superuser` privileges and allows the rule to use cross-cluster search.
196198
.. Add an {ref}/eql-syntax.html[EQL statement] used to detect alerts.
197199
+
198200
For example, the following rule detects when `msxsl.exe` makes an outbound

0 commit comments

Comments
 (0)