Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[8.16] Updates docs about excluding cold and frozen data from rule executions #5962

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/detections/detection-engine-intro.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ Indicator match rules provide a powerful capability to search your security data

In addition, the following support restrictions are in place:

* {elastic-sec} does not support the use of either cold or frozen {ref}/data-tiers.html[tier data] with indicator match rules.
* Indicator match rules don't support cold or frozen data, but will query cold and frozen {ref}/data-tiers.html[data tiers] if they exist. To exclude query results from cold and frozen tiers, configure the `excludedDataTiersForRuleExecution` <<exclude-cold-frozen-data-rule-executions,advanced setting>> (which applies to all rules in a space), or add a <<exclude-cold-frozen-data-individual-rules,Query DSL filter>> to individual rules.
* Indicator match rules with an additional look-back time value greater than 24 hours are not supported.

[float]
Expand Down
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
[[exclude-cold-frozen-data-individual-rules]]
== Exclude cold and frozen data from a rule
== Exclude cold and frozen data from rule executions

:frontmatter-description: Configure a rule to ignore cold and frozen data during execution.
:frontmatter-tags-products: [security]
:frontmatter-tags-content-type: [how-to]
:frontmatter-tags-user-goals: [manage]

Rules that query cold and frozen data might perform more slowly. To exclude cold and frozen data, add a Query DSL filter that ignores cold and frozen {ref}/data-tiers.html[data tiers] when executing. You can add the filter when creating a new rule or updating an existing one.
Rules that query cold and frozen {ref}/data-tiers.html[data tiers] might perform more slowly. To exclude query results from cold and frozen tiers, add a Query DSL filter that ignores cold and frozen documents when executing. This can help Elasticsearch exclude cold and frozen data more efficiently. You can add the filter when creating a new rule or updating an existing one.

NOTE: This method is not supported for {esql} and {ml} rules.

TIP: To ensure that _all_ rules in a {kib} space exclude cold and frozen data when executing, configure the `excludedDataTiersForRuleExecution` <<exclude-cold-frozen-data-rule-executions,advanced setting>>.
TIP: To ensure that _all_ rules in a {kib} space exclude cold and frozen documents when executing, configure the `excludedDataTiersForRuleExecution` <<exclude-cold-frozen-data-rule-executions,advanced setting>>.

Here is a sample Query DSL filter that excludes frozen tier data from a rule's execution:
Here is a sample Query DSL filter that excludes documents from a frozen tier during a rule's execution:

[source,console]
----
Expand All @@ -29,7 +29,7 @@ Here is a sample Query DSL filter that excludes frozen tier data from a rule's e
}
----

Here is another sample Query DSL filter that excludes cold and frozen tier data from a rule's execution:
Here is another sample Query DSL filter that excludes documents from cold and frozen tiers during a rules execution:

[source,console]
----
Expand Down
2 changes: 1 addition & 1 deletion docs/getting-started/advanced-setting.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -180,7 +180,7 @@ The `securitySolution:alertTags` field determines which options display in the a
[[exclude-cold-frozen-data-rule-executions]]
== Exclude cold and frozen data from rule executions

To ensure rules don't search cold and frozen data when executing, specify cold and frozen {ref}/data-tiers.html[data tiers] in the `excludedDataTiersForRuleExecution` field. Multiple data tiers must be separated by commas, for example: `data_frozen`, `data_cold`. This setting is turned off by default; turning it on can improve rule performance and reduce execution time.
To ensure rules exclude query results from cold and frozen tiers when executing, specify cold and frozen {ref}/data-tiers.html[data tiers] in the `excludedDataTiersForRuleExecution` field. Multiple data tiers must be separated by commas, for example: `data_frozen`, `data_cold`. This setting is turned off by default; turning it on can improve rule performance and reduce execution time.

This setting does not apply to {esql} or {ml} rules.

Expand Down