Skip to content

Improve transient settings deprecation message #79504

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Oct 19, 2021
Merged

Improve transient settings deprecation message #79504

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
cb285e4
Improve transient settings deprecation message
Oct 19, 2021
0070895
Update message as per docs team's suggestion.
Oct 19, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion ...precation/src/main/java/org/elasticsearch/xpack/deprecation/ClusterDeprecationChecks.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.",
Copy link
Member

@masseyke masseyke Oct 19, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Contributor Author

@grcevski grcevski Oct 19, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sure thing, I'll change the PR to use that exact wording :).

Copy link
Contributor Author

@grcevski grcevski Oct 19, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @masseyke! I updated the wording to match the docs team recommendation.

"https://ela.st/es-deprecation-7-transient-cluster-settings",
"Use persistent settings to define your cluster settings instead.",
String.format(Locale.ROOT,
"Use persistent settings instead of transient settings for the following: [%s]",
state.metadata().transientSettings().names().stream().sorted().collect(Collectors.joining(", "))),
false,
null);
}
Expand Down
16 changes: 14 additions & 2 deletions ...tion/src/test/java/org/elasticsearch/xpack/deprecation/ClusterDeprecationChecksTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,29 +13,41 @@
import org.elasticsearch.test.ESTestCase;
import org.elasticsearch.xpack.core.deprecation.DeprecationIssue;

import java.util.Locale;

import static org.hamcrest.Matchers.equalTo;

public class ClusterDeprecationChecksTests extends ESTestCase {

public void testCheckTransientSettingsExistence() {
Settings persistentSettings = Settings.builder()
.put("xpack.monitoring.collection.enabled", true)
.build();

Settings transientSettings = Settings.builder()
.put("indices.recovery.max_bytes_per_sec", "20mb")
.put("action.auto_create_index", true)
.put("cluster.routing.allocation.enable", "primaries")
.build();
Metadata metadataWithTransientSettings = Metadata.builder()
.persistentSettings(persistentSettings)
.transientSettings(transientSettings)
.build();

ClusterState badState = ClusterState.builder(new ClusterName("test")).metadata(metadataWithTransientSettings).build();
DeprecationIssue issue = ClusterDeprecationChecks.checkTransientSettingsExistence(badState);
String expectedDetails = String.format(Locale.ROOT,
"Use persistent settings instead of transient settings for the following: [%s]",
String.join(", ", "action", "cluster", "indices"));
assertThat(issue, equalTo(
new DeprecationIssue(DeprecationIssue.Level.WARNING,
"Transient cluster settings are in the process of being removed.",
"https://ela.st/es-deprecation-7-transient-cluster-settings",
"Use persistent settings to define your cluster settings instead.",
expectedDetails,
false, null)
));

Settings persistentSettings = Settings.builder()
persistentSettings = Settings.builder()
.put("indices.recovery.max_bytes_per_sec", "20mb")
.build();
Metadata metadataWithoutTransientSettings = Metadata.builder()
Expand Down