[logging] Add deprecation for the default pattern layout. #115316
Closed
Conversation
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
lukeelmers
added
Team:Core
|
Pinging @elastic/kibana-core (Team:Core) |
|
@elasticmachine merge upstream |
lukeelmers
commented
Oct 18, 2021
| addDeprecation({ | ||
| configPath: 'logging.root.appenders', | ||
| level: 'warning', | ||
| documentationUrl: `https://github.com/elastic/kibana/blob/${branch}/src/core/server/logging/README.mdx#configuration`, |
There was a problem hiding this comment.
I'll open a follow-up PR to improve our documentation and can adjust this link at that time. Just wanted to get this PR up first so that we can get it in before FF.
Comment on lines
+622
to
+627
| i18n.translate('core.deprecations.loggingPatternLayoutDefault.manualSteps1', { | ||
| defaultMessage: `[recommended] Update your log ingestion configuration to use ECS format.`, | ||
| }), | ||
| i18n.translate('core.deprecations.loggingPatternLayoutDefault.manualSteps2', { | ||
| defaultMessage: `Alternatively, you can preserve the existing format by configuring a custom appender with \`layout.type: 'pattern'\``, | ||
| }), |
There was a problem hiding this comment.
I struggled with how to phrase these; any feedback is welcomed.
rudolf
approved these changes
Oct 18, 2021
mshustov
approved these changes
Oct 18, 2021
|
@elasticmachine merge upstream |
💛 Build succeeded, but was flaky
Metrics [docs]
History
To update your PR or re-run it, just comment with: cc @lukeelmers |
|
Closing as discussed in #114968 (comment) |
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.
Part of #114968
As outlined in #114968, we plan to change Kibana's default logging format to use the JSON (ECS) layout.
To make this transition as smooth as possible for the small number of users who have opted in to the new logging system in 7.x, this PR adds a deprecation warning that is surfaced in the upgrade assistant. (PR going directly into 7.x, as I'd be removing it from 8.0 in the follow-up anyway).
The warning is shown to anyone who has explicitly configured the default root
consoleappender. The warning won't show to someone who has configured their own appender calledconsole(which would overwrite the default one), as they would have already explicitly set a specificlayoutin their config.As a follow-up, we will make some improvements to the documentation in order to explain the upgrade path more clearly. For now, this focuses on introducing the deprecation itself.
Note that I'm not adding an actual deprecation docs entry for the release notes because we aren't deprecating the pattern layout, we are just switching a default, and I don't want to cause any confusion.