-
Notifications
You must be signed in to change notification settings - Fork 188
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.17] Document impact of using logsDB for security users #6272
Open
nastasha-solomon
wants to merge
9
commits into
main
Choose a base branch
from
issue-5864-logsdb-8.17
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+81
−10
Open
Changes from all commits
Commits
Show all changes
9 commits
Select commit
Hold shift + click to select a range
408eb76
First draft
nastasha-solomon bede8cc
Removes serverless content
nastasha-solomon 041eeaa
Merge branch 'main' into issue-5864-logsdb-8.17
nastasha-solomon 90c24fc
Minor change
nastasha-solomon ff21b35
Removes unnecessary words
nastasha-solomon 3d2567b
Merge branch 'main' into issue-5864-logsdb-8.17
nastasha-solomon 461143c
Merge branch 'main' into issue-5864-logsdb-8.17
nastasha-solomon 80b2439
Merge branch 'main' into issue-5864-logsdb-8.17
nastasha-solomon e8520f5
Fixes casing for all mentions of logsdb
nastasha-solomon File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change | ||||||||
---|---|---|---|---|---|---|---|---|---|---|
@@ -0,0 +1,63 @@ | ||||||||||
[[detections-logsdb-index-mode-impact]] | ||||||||||
= Using logsdb index mode with {elastic-sec} | ||||||||||
|
||||||||||
This topic explains the impact of using logsdb index mode with {elastic-sec}. | ||||||||||
|
||||||||||
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`]. | ||||||||||
|
||||||||||
When the `_source` is reconstructed, {ref}/mapping-source-field.html#synthetic-source-modifications[modifications] are possible. Therefore, there could be a mismatch between user's expectations and how fields are formatted. | ||||||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
or
Suggested change
|
||||||||||
|
||||||||||
Continue reading to find out how this affects specific {elastic-sec} components. | ||||||||||
|
||||||||||
[discrete] | ||||||||||
[[logsdb-alerts]] | ||||||||||
== Alerts | ||||||||||
|
||||||||||
When alerts are generated, the `_source` event is copied into the alert to retain the original data. When the logsdb index mode is applied, the `_source` event stored in the alert is reconstructed using synthetic `_source`. | ||||||||||
|
||||||||||
If you're switching to use logsdb index mode, the `_source` field stored in the alert might look different in certain situations: | ||||||||||
|
||||||||||
* {ref}/mapping-source-field.html#synthetic-source-modifications-leaf-arrays[Arrays can be reconstructed differently or deduplicated] | ||||||||||
* {ref}/mapping-source-field.html#synthetic-source-modifications-field-names[Field names] | ||||||||||
* `geo_point` data fields (refer to {ref}/mapping-source-field.html#synthetic-source-modifications-ranges[Representation of ranges] and {ref}/mapping-source-field.html#synthetic-source-precision-loss-for-point-types[Reduced precision of `geo_point` values] for more information) | ||||||||||
|
||||||||||
Alerts generated by the following rule types could be affected: | ||||||||||
|
||||||||||
* Custom query | ||||||||||
* Event correlation (non-sequence only) | ||||||||||
* Non-aggregate rule types (for example, {esql} rules that use non-aggregating queries) | ||||||||||
|
||||||||||
Alerts that are generated by threshold, {ml}, and event correlation sequence rules are not affected since they do not contain copies of the original source. | ||||||||||
|
||||||||||
[discrete] | ||||||||||
[[logsdb-rule-actions]] | ||||||||||
== Rule actions | ||||||||||
|
||||||||||
While we do not recommend using `_source` for actions, in cases where the action relies on the `_source`, the same limitations and changes apply. | ||||||||||
|
||||||||||
If you send alert notifications by enabling {kibana-ref}/alerting-getting-started.html#alerting-concepts-actions[actions] to the external systems that have workflows or automations based on fields formatted from the original source, they may be affected. In particular, this can happen when the fields used are arrays of objects. | ||||||||||
|
||||||||||
We recommend checking and adjusting the rule actions using `_source` before switching to logsdb index mode. | ||||||||||
|
||||||||||
[discrete] | ||||||||||
[[logsdb-runtime-fields]] | ||||||||||
== Runtime fields | ||||||||||
|
||||||||||
Runtime fields that reference `_source` may be affected. Some runtime fields might not work and need to be adjusted. For example, if an event was indexed with the value of `agent.name` in the dot-notation form, it will be returned in the nested form and might not work. | ||||||||||
|
||||||||||
The following is an example of accessing `_source` that works with the logsdb index mode enabled: | ||||||||||
|
||||||||||
[source,console] | ||||||||||
---- | ||||||||||
"source": """ emit(params._source.agent.name + "_____" + doc['agent.name'].value ); """ | ||||||||||
"source": """ emit(params._source['agent']['name'] + "_____" + doc['agent.name'].value ); """ | ||||||||||
"source": """ emit(field('agent.name').get(null) + "_____" + doc['agent.name'].value ); """ | ||||||||||
"source": """ emit($('agent.name', null) + "_____" + doc['agent.name'].value ); """ | ||||||||||
---- | ||||||||||
|
||||||||||
The following will not work with synthetic source (logsdb index mode enabled): | ||||||||||
|
||||||||||
[source,console] | ||||||||||
---- | ||||||||||
"source": """ emit(params._source['agent.name'] + "_____" + doc['agent.name'].value ); """ | ||||||||||
---- |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change | ||||||||
---|---|---|---|---|---|---|---|---|---|---|
@@ -1,9 +1,9 @@ | ||||||||||
[[detections-logsdb-index-mode-impact]] | ||||||||||
= Using logsDB index mode with {sec-serverless} | ||||||||||
= Using logsdb index mode with {sec-serverless} | ||||||||||
|
||||||||||
LogsDB is enabled by default for {serverless-full}. This topic explains the impact of using logsDB index mode with {sec-serverless}. | ||||||||||
Logsdb is enabled by default for {serverless-full}. This topic explains the impact of using logsdb index mode with {sec-serverless}. | ||||||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||
|
||||||||||
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`]. | ||||||||||
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`]. | ||||||||||
|
||||||||||
When the `_source` is reconstructed, {ref}/mapping-source-field.html#synthetic-source-modifications[modifications] are possible. Therefore, there could be a mismatch between user's expectations and how fields are formatted. | ||||||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
or
Suggested change
|
||||||||||
|
||||||||||
|
@@ -13,9 +13,9 @@ Continue reading to find out how this affects specific {sec-serverless} componen | |||||||||
[[logsdb-alerts]] | ||||||||||
== Alerts | ||||||||||
|
||||||||||
When alerts are generated, the `_source` event is copied into the alert to retain the original data. When the logsDB index mode is applied, the `_source` event stored in the alert is reconstructed using synthetic `_source`. | ||||||||||
When alerts are generated, the `_source` event is copied into the alert to retain the original data. When the logsdb index mode is applied, the `_source` event stored in the alert is reconstructed using synthetic `_source`. | ||||||||||
|
||||||||||
If you're switching to use logsDB index mode, the `_source` field stored in the alert might look different in certain situations: | ||||||||||
If you're switching to use logsdb index mode, the `_source` field stored in the alert might look different in certain situations: | ||||||||||
|
||||||||||
* {ref}/mapping-source-field.html#synthetic-source-modifications-leaf-arrays[Arrays can be reconstructed differently or deduplicated] | ||||||||||
* {ref}/mapping-source-field.html#synthetic-source-modifications-field-names[Field names] | ||||||||||
|
@@ -37,15 +37,15 @@ While we do not recommend using `_source` for actions, in cases where the action | |||||||||
|
||||||||||
If you send alert notifications by enabling {kibana-ref}/alerting-getting-started.html#alerting-concepts-actions[actions] to the external systems that have workflows or automations based on fields formatted from the original source, they may be affected. In particular, this can happen when the fields used are arrays of objects. | ||||||||||
|
||||||||||
We recommend checking and adjusting the rule actions using `_source` before switching to logsDB index mode. | ||||||||||
We recommend checking and adjusting the rule actions using `_source` before switching to logsdb index mode. | ||||||||||
|
||||||||||
[discrete] | ||||||||||
[[logsdb-runtime-fields]] | ||||||||||
== Runtime fields | ||||||||||
|
||||||||||
Runtime fields that reference `_source` may be affected. Some runtime fields might not work and need to be adjusted. For example, if an event was indexed with the value of `agent.name` in the dot-notation form, it will be returned in the nested form and might not work. | ||||||||||
|
||||||||||
The following is an example of accessing `_source` that works with the logsDB index mode enabled: | ||||||||||
The following is an example of accessing `_source` that works with the logsdb index mode enabled: | ||||||||||
|
||||||||||
[source,console] | ||||||||||
---- | ||||||||||
|
@@ -55,7 +55,7 @@ The following is an example of accessing `_source` that works with the logsDB in | |||||||||
"source": """ emit($('agent.name', null) + "_____" + doc['agent.name'].value ); """ | ||||||||||
---- | ||||||||||
|
||||||||||
The following will not work with synthetic source (logsDB index mode enabled): | ||||||||||
The following will not work with synthetic source (logsdb index mode enabled): | ||||||||||
|
||||||||||
[source,console] | ||||||||||
---- | ||||||||||
|
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.