Skip to content

Commit d260416

Browse files
[8.17-8.18] More changes to the LogsDB page (#6639) (#6785)
* First draft * Redundant * Update detections-logsdb-impact.asciidoc * change tense * Small fixes * One more change (cherry picked from commit 4c4cc44) Co-authored-by: Nastasha Solomon <[email protected]>
1 parent 3f2fccb commit d260416

File tree

1 file changed

+15
-3
lines changed

1 file changed

+15
-3
lines changed

docs/detections/detections-logsdb-impact.asciidoc

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,27 @@
11
[[detections-logsdb-index-mode-impact]]
22
= Using logsdb index mode with {elastic-sec}
33

4-
NOTE: To use the {ref}/mapping-source-field.html#synthetic-source[synthetic `_source`] feature, you must have the appropriate subscription. Refer to the subscription page for https://www.elastic.co/subscriptions/cloud[Elastic Cloud] and {subscriptions}[Elastic Stack/self-managed] for the breakdown of available features and their associated subscription tiers.
4+
.Requirements
5+
[sidebar]
6+
--
7+
To use the {ref}/mapping-source-field.html#synthetic-source[synthetic `_source`] feature, you must have the appropriate subscription. Refer to the subscription page for https://www.elastic.co/subscriptions/cloud[Elastic Cloud] and {subscriptions}[Elastic Stack/self-managed] for the breakdown of available features and their associated subscription tiers.
8+
--
59

610
This topic explains the impact of using logsdb index mode with {elastic-sec}.
711

812
With logsdb index mode, the original `_source` field is not stored in the index but can be reconstructed using {ref}/mapping-source-field.html#synthetic-source[synthetic `_source`].
913

1014
When the `_source` is reconstructed, {ref}/mapping-source-field.html#synthetic-source-modifications[modifications] are possible. Therefore, there could be a mismatch between users' expectations and how fields are formatted.
1115

12-
Continue reading to find out how this affects specific {elastic-sec} components.
16+
Continue reading to learn how logsdb index mode affects CPU and storage usage and specific {elastic-sec} components.
1317

14-
NOTE: Logsdb index mode is fully supported, and is recommended for new {elastic-sec} deployments. Logsdb is not recommended for existing {elastic-sec} deployments unless users fully understand and accept the documented changes to detection alert documents, runtime fields, and rule actions (refer to the sections below), and have ensured that their deployment has sufficient excess hot data tier CPU capacity to support the logsdb ingesting and indexing process. Enabling logsdb without sufficient excess hot data tier CPU capacity may result in data ingestion backups and or security detection rule timeouts and errors.
18+
NOTE: Logsdb index mode is fully supported, and is recommended for all {elastic-sec} deployments. Users with existing {elastic-sec} deployments are advised to fully understand and accept the documented changes to detection alert documents, runtime fields, and rule actions (refer to the sections below), and ensure that their deployment has sufficient excess hot data tier CPU capacity to support the logsdb ingest and indexing process. Enabling logsdb index mode without sufficient excess hot data tier CPU capacity may result in data ingestion backups and/or security detection rule timeouts and errors.
19+
20+
[discrete]
21+
[[logsdb-cpu-storage]]
22+
== CPU and storage
23+
24+
Logsdb index mode significantly reduces storage needs by using slightly more CPU during ingest. After enabling logsdb index mode for your data sources, you may need to adjust cluster sizing in response to the new CPU and storage needs. To learn more about how logsdb index mode optimizes CPU and storage usage, check out https://www.elastic.co/search-labs/blog/elasticsearch-logsdb-index-mode[our blog].
1525

1626
[discrete]
1727
[[logsdb-alerts]]
@@ -65,3 +75,5 @@ The following will not work with synthetic source (logsdb index mode enabled):
6575
----
6676
"source": """ emit(params._source['agent.name'] + "_____" + doc['agent.name'].value ); """
6777
----
78+
79+
Also note that runtime fields with scripts that reference `params._source` may need to be updated. Scripts that currently use dotted field names to access source fields must be converted to use the nested access pattern instead, unless the object being accessed has `subobjects` set to `false`. Fields that are not mapped also need to be accessed in scripts using the nested access pattern (for example, `params._source['foo']['bar']['baz']` or `params._source.foo.bar.baz`, not `params._source['foo.bar.baz']`). To learn more about how synthetic source names fields and changes that you may need to make to your scripts, refer to {ref}/mapping-source-field.html#synthetic-source-modifications-field-names[Fields named as they are mapped].

0 commit comments

Comments
 (0)