Improve transient settings deprecation message #79504
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
Add the setting name as part of the deprecation response.
grcevski
added
:Core/Infra/Core
|
Pinging @elastic/es-core-infra (Team:Core/Infra) |
masseyke
reviewed
Oct 19, 2021
| @@ -10,13 +10,18 @@ | |||
| import org.elasticsearch.cluster.ClusterState; | |||
| import org.elasticsearch.xpack.core.deprecation.DeprecationIssue; | |||
|
|
|||
| import java.util.Locale; | |||
| import java.util.stream.Collectors; | |||
|
|
|||
| public class ClusterDeprecationChecks { | |||
| static DeprecationIssue checkTransientSettingsExistence(ClusterState state) { | |||
| if (state.metadata().transientSettings().isEmpty() == false) { | |||
| return new DeprecationIssue(DeprecationIssue.Level.WARNING, | |||
| "Transient cluster settings are in the process of being removed.", | |||
There was a problem hiding this comment.
Looks like @debadair from our docs team has weighed in on this, and has recommended the message be "Transient cluster settings are deprecated" and the details be "Use persistent settings to configure your cluster." I like the idea of actually putting the setting names in the details like this though.
There was a problem hiding this comment.
Sure thing, I'll change the PR to use that exact wording :).
There was a problem hiding this comment.
Thanks @masseyke! I updated the wording to match the docs team recommendation.
grcevski
added a commit
to grcevski/elasticsearch
that referenced
this pull request
Oct 19, 2021
Update message as per docs team's suggestion.
💚 Backport successful
|
grcevski
added a commit
that referenced
this pull request
Oct 20, 2021
weizijun
added a commit
to weizijun/elasticsearch
that referenced
this pull request
Oct 20, 2021
* upstream/master: (24 commits) Implement framework for migrating system indices (elastic#78951) Improve transient settings deprecation message (elastic#79504) Remove getValue and getValues from Field (elastic#79516) Store Template's mappings as bytes for disk serialization (elastic#78746) [ML] Add queue_capacity setting to start deployment API (elastic#79433) [ML] muting rest compat test issue elastic#79518 (elastic#79519) Avoid redundant available indices check (elastic#76540) Re-enable BWC tests TEST Ensure password 14 chars length on Kerberos FIPS tests (elastic#79496) [DOCS] Temporarily remove APM links (elastic#79411) Fix CCSDuelIT for skipped shards (elastic#79490) Add other time accounting in HotThreads (elastic#79392) Add deprecation info API entries for deprecated monitoring settings (elastic#78799) Add note in breaking changes for nameid_format (elastic#77785) Use 'migration' instead of 'upgrade' in GET system feature migration status responses (elastic#79302) Upgrade lucene version 8b68bf60c98 (elastic#79461) Use Strings#EMPTY_ARRAY (elastic#79452) Quicker shared cache file preallocation (elastic#79447) [ML] Removing some code that's obsolete for 8.0 (elastic#79444) Ensure indexing_data CCR requests are compressed (elastic#79413) ...
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.
Add the supplied transient settings names as part of the deprecation response, to help people understand which settings they need to convert to persistent settings.