Logging: Restore and enhance legacy logging docs #135093
Conversation
TinaHeiligers
added
Team:Core
| appenders: [console_appender] | ||
| -------------------------------------------------------------------------------- | ||
|
|
||
| <1> Appender names are entirely custom with the restriction that appender names must be unique. Appenders may be used for multiple loggers. |
There was a problem hiding this comment.
I'm using the example as "soft" introduction to logging configuration.
| NOTE: To reload the <<logging-settings, logging settings>>, send a SIGHUP signal to {kib}. | ||
|
|
||
| // deprecated logging configuration settings |
There was a problem hiding this comment.
I've split the legacy and current "settings" into two grouped sections to make it clear what is deprecated and what current settings are/will be supported in 8.0
| + | ||
| [source,yaml] | ||
| -------------------------------------------------------------------------------- | ||
| logging: |
There was a problem hiding this comment.
specifically addresses #134462
| @@ -1,13 +1,33 @@ | |||
| [[logging-configuration-migration]] | |||
| == Logging configuration migration | |||
|
|
|||
| [float] | |||
| === Prepare for logging in 8.0 | |||
There was a problem hiding this comment.
Adds an overview section with specific things to watch out for.
|
Pinging @elastic/kibana-core (Team:Core) |
|
@elasticmachine merge upstream |
| [float] | ||
| === Prepare for logging in 8.0 | ||
|
|
||
| The entire logging system changed to offer a more consistent logging behavior with {es}. The current system differs from the more simplistic, deprecated system and allows you the freedom to customize what, how and where {kib} outputs log messages. While for logging based use cases, we recommend the <<logging-service, logging service guide>>, there are some important considerations: |
There was a problem hiding this comment.
nit: Maybe specifically call out log4j 2 here?
The entire logging system changed to offer a more consistent logging behavior with {es}, which uses the popular
log4j 2for managing logs.
There was a problem hiding this comment.
nit: For whatever reason my brain isn't grokking this line:
While for logging based use cases, we recommend the <<logging-service, logging service guide>>, there are some important considerations
Not super sure what you intended here, but maybe something like this?
The best place to learn about the new logging system is our logging service guide. However, there are some important considerations when you are working from migrating from the old to the new system:
There was a problem hiding this comment.
I was trying to say that we recommend going through the logging service guide if you rely on Kibana logging. Your wording is clearer, thanks!
|
|
||
| [float] | ||
| ==== Mixing deprecated and current configurations | ||
| {kib} supports mixed usage of the deprecated and current logging configuration styles, however, we recommend changing them all at once to reduce the risk of the systems interfering. |
There was a problem hiding this comment.
nit: or maybe "to reduce the risk of confusion that may arise from conflicting configs"?
| logging: | ||
| appenders: | ||
| console_appender: | ||
| type: console | ||
| layout: | ||
| type: pattern | ||
| highlight: true | ||
| root: | ||
| appenders: [default, console_appender] | ||
| level: debug |
There was a problem hiding this comment.
nit: Is this one necessary? The only non-default setting here is logging.root.level, so we might not need to change it?
There was a problem hiding this comment.
I added a full config to address Enabling debug logs in Kibana 7.17.3 not well documented and because folks often don't follow links to other documentation.
Co-authored-by: Luke Elmers <lukeelmers@gmail.com>
fixes #129381
fixes #134462
Part of #134169
Specifically:
adds legacy logging configuration setting back to the setup guide
enhances docs for platform logging
enhances and moves logging configuration migration guide to main upgrade docs
adds more detail and warnings about mixing legacy and current logging configuration
provide full logging configuration for
debuglevel loggingDocumentation was added for features that require explanation or tutorials