Skip to content

Commit 9a3fca7

Browse files
[Detection Engine][Docs][8.18] New wording for frozen tier support (#6659)
* First draft * Revisions * Update docs/detections/detection-engine-intro.asciidoc * lowercase * Update docs/detections/detection-engine-intro.asciidoc Co-authored-by: Marshall Main <[email protected]> * Update docs/detections/detection-engine-intro.asciidoc Co-authored-by: Marshall Main <[email protected]> * Update docs/detections/detection-engine-intro.asciidoc * contractions * Update docs/detections/detection-engine-intro.asciidoc * Update docs/detections/detection-engine-intro.asciidoc * Update docs/detections/detection-engine-intro.asciidoc * Update docs/detections/detection-engine-intro.asciidoc * fixes --------- Co-authored-by: Marshall Main <[email protected]>
1 parent 04b8ba2 commit 9a3fca7

File tree

1 file changed

+15
-9
lines changed

1 file changed

+15
-9
lines changed

docs/detections/detection-engine-intro.asciidoc

Lines changed: 15 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -51,20 +51,26 @@ To make sure you can access Detections and manage rules, see
5151

5252
[float]
5353
[[cold-tier-detections]]
54-
== Compatibility with cold and frozen tier nodes
54+
== Manage data in cold and frozen tiers
5555

56-
Cold and frozen {ref}/data-tiers.html[data tiers] hold time series data that is only accessed occasionally. In {stack} version >=7.11.0, {elastic-sec} supports cold but not frozen tier data for the following {es} indices:
56+
Cold {ref}/data-tiers.html[data tiers] store time series data that's accessed infrequently and rarely updated, while frozen data tiers hold time series data that's accessed even less frequently and never updated. If you're automating searches across different data tiers using rules, consider the following best practices and limitations.
5757

58-
* Index patterns specified in `securitySolution:defaultIndex`
59-
* Index patterns specified in the definitions of detection rules, except for indicator match rules
60-
* Index patterns specified in the data sources selector on various {security-app} pages
58+
[float]
59+
[[best-practices-data-tiers]]
60+
=== Best practices
61+
62+
* **Retention in hot tier**: We recommend keeping data in the hot data tier ({ilm-cap} hot phase) for at least 24 hours. {ilm-cap} policies that move ingested data from the hot phase to another phase (for example, cold or frozen) in less than 24 hours may cause performance issues and/or rule execution errors.
63+
* **Replicas for mission-critical data**: Your data should have replicas if it must be highly available. Since frozen tiers don't support replicas, shard unavailability can cause partial rule run failures if rules query frozen tiers. Shard unavailability may also occur during or after {stack} upgrades. If this happens, you can <<manually-run-rules,manually rerun>> rules over the affected time period once the shards are available.
6164

62-
{elastic-sec} does *NOT* support either cold or frozen tier data for the following {es} indices:
6365

64-
* Index patterns controlled by {elastic-sec}, including alerts and list indices
65-
* Index patterns specified in the definition of indicator match rules
66+
[float]
67+
[[limitations-data-tiers]]
68+
=== Limitations
69+
70+
Data tiers are a powerful and useful tool. When using them, keep the following in mind:
6671

67-
Using either cold or frozen tier data for unsupported indices may result in detection rule timeouts and overall performance degradation.
72+
* To avoid rule failures, do not modify {ilm} policies for {elastic-sec}-controlled indices, such as alert and list indices.
73+
* Source data must have an {ilm} policy that keeps it in the hot or warm tiers for at least 24 hours before moving to cold or frozen tiers.
6874

6975
[float]
7076
[[support-indicator-rules]]

0 commit comments

Comments
 (0)