Skip to content

Commit 8c28415

Browse files
First draft
1 parent 0d95022 commit 8c28415

File tree

1 file changed

+10
-3
lines changed

1 file changed

+10
-3
lines changed

solutions/security/detect-and-alert/using-logsdb-index-mode-with-elastic-security.md

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@ applies_to:
1010

1111
# Using logsdb index mode with Elastic Security [detections-logsdb-index-mode-impact]
1212

13-
::::{note}
14-
To use the [synthetic `_source`](elasticsearch://reference/elasticsearch/mapping-reference/mapping-source-field.md#synthetic-source) feature, you must have the appropriate subscription. Refer to the subscription page for [Elastic Cloud](https://www.elastic.co/subscriptions/cloud) and [Elastic Stack/self-managed](https://www.elastic.co/subscriptions) for the breakdown of available features and their associated subscription tiers.
13+
::::{admonition} Requirements
14+
To use the [synthetic `_source`](elasticsearch://reference/elasticsearch/mapping-reference/mapping-source-field.md#synthetic-source) feature in the {{stack}}, you must have the appropriate subscription. Refer to the subscription page for [Elastic Cloud](https://www.elastic.co/subscriptions/cloud) and [Elastic Stack/self-managed](https://www.elastic.co/subscriptions) for the breakdown of available features and their associated subscription tiers.
1515
::::
1616

1717

@@ -24,12 +24,18 @@ When the `_source` is reconstructed, [modifications](elasticsearch://reference/e
2424
Continue reading to find out how this affects specific {{elastic-sec}} components.
2525

2626
::::{note}
27+
2728
The following statement applies to {{stack}} users only:
2829

29-
Logsdb is not recommended for {{elastic-sec}} at this time. Users must fully understand and accept the documented changes to detection alert documents (see below), and ensure their deployment has excess hot data tier CPU resource capacity before enabling logsdb mode, as logsdb mode requires additional CPU resources during the ingest/indexing process. Enabling logsdb without sufficient hot data tier CPU may result in data ingestion backups and/or security detection rule timeouts and errors.
30+
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.
31+
3032
::::
3133

3234

35+
## CPU and storage [logsdb-cpu-storage]
36+
37+
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 [our blog](https://www.elastic.co/search-labs/blog/elasticsearch-logsdb-index-mode).
38+
3339

3440
## Alerts [logsdb-alerts]
3541

@@ -78,3 +84,4 @@ The following will not work with synthetic source (logsdb index mode enabled):
7884
"source": """ emit(params._source['agent.name'] + "_____" + doc['agent.name'].value ); """
7985
```
8086

87+
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 [Fields named as they are mapped](elasticsearch://reference/elasticsearch/mapping-reference/mapping-source-field.md#synthetic-source-modifications-field-names).

0 commit comments

Comments
 (0)