Skip to content

Commit

Permalink
[Known Issue] Add docs to describe a known issue/limitation of EQL ru…
Browse files Browse the repository at this point in the history
…le cross-cluster search (backport #4813) (#4818)

* [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]>
  • Loading branch information
3 people authored Feb 16, 2024
1 parent a230cce commit 172d3a7
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 1 deletion.
4 changes: 3 additions & 1 deletion docs/detections/api/rules/rules-api-create.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -380,11 +380,13 @@ documents from the {es} index containing the threat values.
context] array used to define the conditions for when alerts are created from
events. Defaults to an empty array.

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

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.

|risk_score_mapping |Object[] a|Overrides generated alerts' `risk_score` with
a value from the source event:

Expand Down
3 changes: 3 additions & 0 deletions docs/detections/rules-ui-create.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -172,7 +172,10 @@ IMPORTANT: Alerts created by threshold rules are synthetic alerts that do not re
[[create-eql-rule]]
==== Create an event correlation rule
. To create an event correlation rule using EQL, select *Event Correlation*, then:

.. Define which {es} indices the rule searches for alerts.
+
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.
.. Add an {ref}/eql-syntax.html[EQL statement] used to detect alerts.
+
For example, the following rule detects when `msxsl.exe` makes an outbound
Expand Down

0 comments on commit 172d3a7

Please sign in to comment.