Introduce deprecation categories #68061
Merged
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
The JSON logs that Elasticsearch produces are roughly in an ECS shape. This PR improves that alignment.
Sort-of backport of elastic#67443. Closes elastic#64824. Introduce the concept of categories to deprecation logging. Every location where we log a deprecation message must now include a deprecation category.
pugnascotia
added
>enhancement
:Core/Infra/Logging
|
Pinging @elastic/es-core-infra (Team:Core/Infra) |
williamrandolph
approved these changes
Jan 28, 2021
| } | ||
| if (BootstrapInfo.getSystemProperties().get("es.xcontent.strict_duplicate_detection") != null) { | ||
| final String message = String.format( | ||
| Locale.ROOT, | ||
| "The Java option es.xcontent.strict_duplicate_detection is set to [%s]; " + | ||
| "this option is deprecated and non-functional and should be removed from Java configuration.", | ||
| BootstrapInfo.getSystemProperties().get("es.xcontent.strict_duplicate_detection")); | ||
| DeprecationLogger.getLogger(Bootstrap.class).deprecate("strict_duplicate_detection_setting_removed", message); | ||
| DeprecationLogger.getLogger(Bootstrap.class).deprecate(DeprecationCategory.OTHER, "strict_duplicate_detection_setting_removed", |
There was a problem hiding this comment.
Arguably this could be SETTINGS, although it's a JVM setting and not an Elasticsearch setting.
| @@ -277,7 +278,8 @@ private Long parseNullValue(DateFieldType fieldType) { | |||
| try { | |||
| return fieldType.parse(nullValue.getValue()); | |||
| } catch (Exception e) { | |||
| DEPRECATION_LOGGER.deprecate("date_mapper_null_field", "Error parsing [" + nullValue.getValue() | |||
| DEPRECATION_LOGGER.deprecate(DeprecationCategory.MAPPINGS, "date_mapper_null_field", | |||
| "Error parsing [" + nullValue.getValue() | |||
There was a problem hiding this comment.
extreme, probably-shouldn't-even-write-this-comment nitpick: putting the line break after field [" might be slightly more visually appealing
(I hope these tiny nitpicks give you confidence in the thoroughness of my review, rather than just annoying you.)
| AccessController.doPrivileged(new PrivilegedAction<Void>() { | ||
| @SuppressLoggerChecks(reason = "safely delegates to logger") | ||
| @Override | ||
| public Void run() { | ||
| deprecationLogger.deprecate(key, message, params); | ||
| deprecationLogger.deprecate(category, key, message, params); |
There was a problem hiding this comment.
Consider just passing in DeprecationCategory.PARSING here instead of altering the methods below. Since this method is private I think it's safe to say it'll be used for parsing issues within this class.
|
Thank you @williamrandolph! |
pgomulka
added a commit
that referenced
this pull request
Oct 18, 2021
Deprecation logs in 7.x are using ESJsonLayout and it requires additional fields to be declared in a log4j config in order to emit values to logs. This commit adds category field to deprecation log pattern context: in 8.0 we use ECSLayout which do not require to declare additional fields upfront. In 7.x we have to declare them in the logging config. The PR introducing categories in master #67443. A backport to 7.x which missed this field #68061
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.
Sort-of backport of #67443.
Closes #64824. Introduce the concept of categories to deprecation
logging. Every location where we log a deprecation message must now
include a deprecation category.