Backport PR #12830 to 7.x: ecs-compatibility docs#13016
Merged
Conversation
karenzone
approved these changes
Jun 22, 2021
Contributor
karenzone
left a comment
There was a problem hiding this comment.
Nicely done! I left one comment in line. Otherwise, LGTM. 🎉
Co-authored-by: Karen Metts <35154725+karenzone@users.noreply.github.com>
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Backport subset of PR #12830 to 7.x branch. Original message:
Release notes
[rn:skip]
What does this PR do?
This change adds documentation about how to configure ECS Compatibility Modes at the plugin instance, pipeline, and global levels.
These docs are a 7.x-targeted backport of docs introduced in #12830 for 8.0, that have been re-worded from the perspective of Logstash 7.x to lead people toward the upgrade.
If a user wants to "lock in" pre-ECS behaviour in 7.x, they can do at different levels so by:
ecs_compatibility => disabledon each individual plugin; ORpipeline.ecs_compatibility: disabledin each pipeline's definition (config/pipelines.ymlor Central Management)pipeline.ecs_compatibility: disabledinconfig/logstash.ymlto provide a global default for pipelines.Why is it important/What is the impact to the user?
The transition to ECS being on-by-default with Logstash 8.0 is a potentially sharp edge, as the plugins that implement ECS Compatibility modes will operate differently than in their legacy versions when run in Logstash 8, unless specific effort is made to opt-out of the breaking change.
Checklist