Skip to content

Commit 74fcc76

Browse files
mergify[bot]nastasha-solomonjmikell821
authored
[8.x] Don't modify index mappings for Alerts indices (#6882) (#6904)
* First draft * Add link to runtime fields * apply to other areas * remove s * cleanup * Update docs/reference/alert-schema.asciidoc --------- (cherry picked from commit a09754a) Co-authored-by: Nastasha Solomon <[email protected]> Co-authored-by: Janeen Mikell Roberts <[email protected]>
1 parent b3fd9d3 commit 74fcc76

File tree

3 files changed

+10
-1
lines changed

3 files changed

+10
-1
lines changed

docs/detections/about-rules.asciidoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,8 @@ When you create a rule, you must either specify the {es} index pattens for which
5959

6060
NOTE: To access data views, ensure you have the {kibana-ref}/data-views.html#data-views-read-only-access[required permissions].
6161

62+
IMPORTANT: System indices, such as the alert indices, contain important configuration and internal data; do not change their mappings. Changes can lead to rule execution and alert indexing failures. Use <<runtime-fields, runtime fields>> instead, which allow you to add fields to existing alert and event documents.
63+
6264
[float]
6365
[[about-notifications]]
6466
=== Notifications

docs/detections/query-alert-indices.asciidoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22
== Query alert indices
33
This page explains how you should query alert indices, for example, when building rule queries, custom dashboards, or visualizations. For more information about alert event field definitions, review the <<alert-schema, Alert schema>>.
44

5+
IMPORTANT: System indices, such as the alert indices, contain important configuration and internal data; do not change their mappings. Changes can lead to rule execution and alert indexing failures. Use <<runtime-fields, runtime fields>> instead, which allow you to add fields to existing alert and event documents.
6+
57
[discrete]
68
=== Alert index aliases
79
We recommend querying the following index aliases:

docs/reference/alert-schema.asciidoc

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,12 @@
99

1010
{elastic-sec} stores alerts that have been generated by detection rules in hidden {es} indices. In 8.x versions, the index pattern is `.alerts-security.alerts-<space-id->`. In 7.x versions, the index pattern was `.siem-signals-<space-id>`, and some field names were different. The following table includes the current names and cross-references the legacy field names.
1111

12-
NOTE: Users are advised NOT to use the `_source` field in alert documents, but rather to use the `fields` option in the search API to programmatically obtain the list of fields used in these documents. Learn more about {ref}/search-fields.html[retrieving selected fields from a search].
12+
[IMPORTANT]
13+
====
14+
15+
* System indices, such as the alert indices, contain important configuration and internal data; do not change their mappings. Changes can lead to rule execution and alert indexing failures. Use <<runtime-fields, runtime fields>> instead, which allow you to add fields to existing alert and event documents.
16+
* We recommend to NOT use the `_source` field in alert documents, but rather the `fields` option in the search API to programmatically obtain the list of fields used in these documents. Learn more about {ref}/search-fields.html[retrieving selected fields from a search].
17+
====
1318

1419
NOTE: The non-ECS fields listed below are beta and subject to change.
1520

0 commit comments

Comments
 (0)