Infra for deprecation logging #11033
Conversation
Add support for a specific deprecation logging that can be used to turn on in order to notify users of a specific feature, flag, setting, parameter, ... being deprecated. The deprecation logger logs with a "deprecation." prefix logger (or "org.elasticsearch.deprecation." if full name is used), and outputs the logging to a dedicated deprecation log file. Deprecation logging are logged under the DEBUG category. The idea is not to enabled them by default (under WARN or ERROR) when running embedded in another application. By default they are turned off (INFO), in order to turn it on, the "deprecation" category need to be set to DEBUG. This can be set in the logging file or using the cluster update settings API.
|
It looks good, my only concern is that this new code is not used anywhere. Maybe it wouldn't be too hard to make ParseField use it? |
|
@jpountz ahh, yea, thats my next step, I just wanted to get feedback on the approach, I can create an example usage |
| @@ -4,6 +4,10 @@ rootLogger: ${es.logger.level}, console, file | |||
| logger: | |||
| # log action execution errors for easier debugging | |||
| action: DEBUG | |||
|
|
|||
| # deprecation logging, turn to DEBUG to see them | |||
There was a problem hiding this comment.
Maybe be even more explicit that this logger only receives logs at the debug level, so any higher level will not log any message
|
Can we make this logger easier to grab/create? I'm thinking e.g. in meta field mappers (which are not components) and I dont think we should need to pass this down through all the layers form the mappings module (as we do not for other loggers right now). Perhaps something like ESLoggerFactory, or maybe just another method on that? Maybe too the logger could just fail to initialize if the log level is set incorrectly for it? |
clintongormley
added
:Core/Infra/Logging
|
@rjernst I dont think the logger should fail to initialize, because we can change the log levels using the cluster update settings API Would it be sufficient in your use-case to just have another constructor for the DeprecationLogger deprecationLogger = new DeprecationLogger(this.getClass().getName()); |
|
created a follow up PR that adds documentation, tests and the possibility to use the |
The commit for closing #11033 was not building the asciidoc documentation.
The ResourceWatcher used settings prefixed `watcher.`, which potentially could clash with the watcher plugin. In order to prevent confusion, the settings have been renamed to `resource.reload` prefixes. This also uses the deprecation logging infrastructure introduced in elastic#11033 to log deprecated settings and their alternative at startup. Closes elastic#11175
The ResourceWatcher used settings prefixed `watcher.`, which potentially could clash with the watcher plugin. In order to prevent confusion, the settings have been renamed to `resource.reload` prefixes. This also uses the deprecation logging infrastructure introduced in elastic#11033 to log deprecated settings and their alternative at startup. Closes elastic#11175
The ResourceWatcher used settings prefixed `watcher.`, which potentially could clash with the watcher plugin. In order to prevent confusion, the settings have been renamed to `resource.reload` prefixes. This also uses the deprecation logging infrastructure introduced in elastic#11033 to log deprecated settings and their alternative at startup. Closes elastic#11175
Add support for a specific deprecation logging that can be used to turn on in order to notify users of a specific feature, flag, setting, parameter, ... being deprecated.
The deprecation logger logs with a "deprecation." prefix logger (or "org.elasticsearch.deprecation." if full name is used), and outputs the logging to a dedicated deprecation log file.
Deprecation logging are logged under the DEBUG category. The idea is not to enabled them by default (under WARN or ERROR) when running embedded in another application.
By default they are turned off (INFO), in order to turn it on, the "deprecation" category need to be set to DEBUG. This can be set in the logging file or using the cluster update settings API.