Skip to content
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

Validate index name time format setting at parse time #47911

Merged
merged 9 commits into from
Nov 5, 2019
Merged

Validate index name time format setting at parse time #47911

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
3aa28ae
validate index name time format setting at parse time
danhermann Oct 10, 2019
520fed0
broaden exceptions to catch, remove null value from test cases
danhermann Oct 14, 2019
e089174
fix tests
danhermann Oct 15, 2019
b612b77
Merge branch 'master' into 47711_index_name_time_format
elasticmachine Oct 17, 2019
c7c5746
provide default value for setting
danhermann Oct 18, 2019
ed16f46
change to Setting with paramterized type DateFormatter
danhermann Oct 31, 2019
53de812
Merge branch 'master' into 47711_index_name_time_format
elasticmachine Nov 1, 2019
cf69f76
fix checkstyle
danhermann Nov 1, 2019
ed86273
Merge branch '47711_index_name_time_format' of https://github.com/dan…
danhermann Nov 1, 2019
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
21 changes: 19 additions & 2 deletions ...plugin/monitoring/src/main/java/org/elasticsearch/xpack/monitoring/exporter/Exporter.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,9 +102,26 @@ public Iterator<Setting<?>> settings() {
/**
* Every {@code Exporter} allows users to use a different index time format.
*/
private static final Setting.AffixSetting<String> INDEX_NAME_TIME_FORMAT_SETTING =
static final Setting.AffixSetting<String> INDEX_NAME_TIME_FORMAT_SETTING =
Setting.affixKeySetting("xpack.monitoring.exporters.","index.name.time_format",
key -> Setting.simpleString(key, Property.Dynamic, Property.NodeScope));
key -> Setting.simpleString(
key,
Exporter.INDEX_FORMAT,
new Setting.Validator<String>() {
@Override
public void validate(String value) {
try {
if (value != null) {
DateFormatter.forPattern(value).withZone(ZoneOffset.UTC);
Copy link
Member

Choose a reason for hiding this comment

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

Is the generic type for this AffixSetting wrong? It seems like if we are going to parse into a DateFormatter, we should be doing that once, not duplicating here and in Exporter.dateTimeFormatter (where it also looks like we have default value logic?).

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@rjernst, it is true that a DateFormatter instance is ultimately what is produced for this setting. I could change INDEX_NAME_TIME_FORMAT_SETTING from its original AffixSetting<String> to a AffixSetting<DateFormatter> if that would be preferable.

Copy link
Member

Choose a reason for hiding this comment

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

I think that makes the most sense. In general, a major goal of the settings infrastructure is to do type parsing and validation for the intended type. In this case it seems we are adding checking, but the parsing isn't actually happening within the Setting instance.

}
} catch (RuntimeException e) {
throw new SettingsException("[" + INDEX_NAME_TIME_FORMAT_SETTING.getKey() +
"] invalid index name time format: [" + value + "]", e);
}
}
},
Property.Dynamic,
Property.NodeScope));

private static final String INDEX_FORMAT = "yyyy.MM.dd";

Expand Down
13 changes: 13 additions & 0 deletions .../monitoring/src/test/java/org/elasticsearch/xpack/monitoring/exporter/ExportersTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,6 +111,19 @@ public void testHostsMustBeSetIfTypeIsHttp() {
assertThat(e.getCause(), hasToString(containsString("host list for [" + prefix + ".host] is empty")));
}

public void testIndexNameTimeFormatMustBeValid() {
final String prefix = "xpack.monitoring.exporters.example";
final String setting = ".index.name.time_format";
final String value = "yyyy.MM.dd.j";
final Settings settings = Settings.builder().put(prefix + setting, value).build();
final IllegalArgumentException e = expectThrows(
IllegalArgumentException.class,
() -> Exporter.INDEX_NAME_TIME_FORMAT_SETTING.getConcreteSetting(prefix + setting).get(settings));
assertThat(e, hasToString(containsString("Failed to parse value [" + value + "] for setting [" + prefix + setting)));
assertThat(e.getCause(), instanceOf(SettingsException.class));
assertThat(e.getCause(), hasToString(containsString("invalid index name time format: [" + value + "]")));
}

public void testExporterIndexPattern() {
Exporter.Config config = mock(Exporter.Config.class);
when(config.name()).thenReturn("anything");
Expand Down