From 3085af5e7a189774d065d38e8a4d4f1a1252515a Mon Sep 17 00:00:00 2001 From: Nastasha Solomon <79124755+nastasha-solomon@users.noreply.github.com> Date: Thu, 15 Feb 2024 16:04:19 -0500 Subject: [PATCH 1/2] [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 --- docs/detections/api/rules/rules-api-create.asciidoc | 9 +++++++++ docs/detections/rules-ui-create.asciidoc | 10 ++++++++++ 2 files changed, 19 insertions(+) diff --git a/docs/detections/api/rules/rules-api-create.asciidoc b/docs/detections/api/rules/rules-api-create.asciidoc index 1baa76f4c5..6ccad2ac23 100644 --- a/docs/detections/api/rules/rules-api-create.asciidoc +++ b/docs/detections/api/rules/rules-api-create.asciidoc @@ -409,6 +409,15 @@ Security Solution indices defined on the {kib} Advanced Settings page (*Kibana* → *Stack Management* → *Advanced Settings* → `securitySolution:defaultIndex`). +<<<<<<< HEAD +======= +[NOTE] +====== +- This field is not supported for ES\|QL rules. +- 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 <>. This updates the rule's API key to use `superuser` privileges and allows the rule to use cross-cluster search. +====== + +>>>>>>> 01ec37b9 ([Known Issue] Add docs to describe a known issue/limitation of EQL rule cross-cluster search (#4813)) |risk_score_mapping |Object[] a|Overrides generated alerts' `risk_score` with a value from the source event: diff --git a/docs/detections/rules-ui-create.asciidoc b/docs/detections/rules-ui-create.asciidoc index e050f440c7..6ae0b1f1ba 100644 --- a/docs/detections/rules-ui-create.asciidoc +++ b/docs/detections/rules-ui-create.asciidoc @@ -203,8 +203,18 @@ 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: +<<<<<<< HEAD .. Define which {es} indices or data view the rule searches for alerts. .. Add an {ref}/eql-syntax.html[EQL statement] used to detect alerts. +======= +.. Define which {es} indices or data view the rule searches when querying for events. ++ +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 <>. This updates the rule's API key to use `superuser` privileges and allows the rule to use cross-cluster search. + +.. Write an {ref}/eql-syntax.html[EQL query] that searches for matching events or a series of matching events. ++ +TIP: To find events that are missing in a sequence, use the {ref}/eql-syntax.html#eql-missing-events[missing events] syntax. +>>>>>>> 01ec37b9 ([Known Issue] Add docs to describe a known issue/limitation of EQL rule cross-cluster search (#4813)) + For example, the following rule detects when `msxsl.exe` makes an outbound network connection: From cf2e6bd6f7db93b49026462968c5361ee830af82 Mon Sep 17 00:00:00 2001 From: "nastasha.solomon" Date: Sat, 16 Mar 2024 16:52:18 -0400 Subject: [PATCH 2/2] Removed merge markers --- docs/detections/api/rules/rules-api-create.asciidoc | 8 ++------ docs/detections/rules-ui-create.asciidoc | 10 +--------- 2 files changed, 3 insertions(+), 15 deletions(-) diff --git a/docs/detections/api/rules/rules-api-create.asciidoc b/docs/detections/api/rules/rules-api-create.asciidoc index 6ccad2ac23..45878f2a0e 100644 --- a/docs/detections/api/rules/rules-api-create.asciidoc +++ b/docs/detections/api/rules/rules-api-create.asciidoc @@ -404,20 +404,16 @@ 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`). -<<<<<<< HEAD -======= [NOTE] ====== -- This field is not supported for ES\|QL rules. -- 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 <>. This updates the rule's API key to use `superuser` privileges and allows the rule to use cross-cluster search. +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 <>. This updates the rule's API key to use `superuser` privileges and allows the rule to use cross-cluster search. ====== ->>>>>>> 01ec37b9 ([Known Issue] Add docs to describe a known issue/limitation of EQL rule cross-cluster search (#4813)) |risk_score_mapping |Object[] a|Overrides generated alerts' `risk_score` with a value from the source event: diff --git a/docs/detections/rules-ui-create.asciidoc b/docs/detections/rules-ui-create.asciidoc index 6ae0b1f1ba..43a5134981 100644 --- a/docs/detections/rules-ui-create.asciidoc +++ b/docs/detections/rules-ui-create.asciidoc @@ -203,18 +203,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: -<<<<<<< HEAD .. Define which {es} indices or data view the rule searches for alerts. -.. Add an {ref}/eql-syntax.html[EQL statement] used to detect alerts. -======= -.. Define which {es} indices or data view the rule searches when querying for events. + 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 <>. This updates the rule's API key to use `superuser` privileges and allows the rule to use cross-cluster search. - -.. Write an {ref}/eql-syntax.html[EQL query] that searches for matching events or a series of matching events. -+ -TIP: To find events that are missing in a sequence, use the {ref}/eql-syntax.html#eql-missing-events[missing events] syntax. ->>>>>>> 01ec37b9 ([Known Issue] Add docs to describe a known issue/limitation of EQL rule cross-cluster search (#4813)) +.. Add an {ref}/eql-syntax.html[EQL statement] used to detect alerts. + For example, the following rule detects when `msxsl.exe` makes an outbound network connection: