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

Jump to bottom

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 all 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
22 changes: 10 additions & 12 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 @@ -15,7 +15,6 @@
import org.elasticsearch.license.XPackLicenseState;
import org.elasticsearch.xpack.monitoring.exporter.http.HttpExporter;

import java.time.ZoneOffset;
import java.util.Arrays;
import java.util.Collections;
import java.util.Iterator;
Expand Down Expand Up @@ -102,9 +101,14 @@ 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 =
Setting.affixKeySetting("xpack.monitoring.exporters.","index.name.time_format",
key -> Setting.simpleString(key, Property.Dynamic, Property.NodeScope));
static final Setting.AffixSetting<DateFormatter> INDEX_NAME_TIME_FORMAT_SETTING =
Setting.affixKeySetting("xpack.monitoring.exporters.","index.name.time_format",
key -> new Setting<DateFormatter>(
key,
Exporter.INDEX_FORMAT,
DateFormatter::forPattern,
Property.Dynamic,
Property.NodeScope));

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

Expand Down Expand Up @@ -150,14 +154,8 @@ public void close() {
protected abstract void doClose();

protected static DateFormatter dateTimeFormatter(final Config config) {
Setting<String> setting = INDEX_NAME_TIME_FORMAT_SETTING.getConcreteSettingForNamespace(config.name);
String format = setting.exists(config.settings()) ? setting.get(config.settings()) : INDEX_FORMAT;
try {
return DateFormatter.forPattern(format).withZone(ZoneOffset.UTC);
} catch (IllegalArgumentException e) {
throw new SettingsException("[" + INDEX_NAME_TIME_FORMAT_SETTING.getKey() + "] invalid index name time format: ["
+ format + "]", e);
}
Setting<DateFormatter> setting = INDEX_NAME_TIME_FORMAT_SETTING.getConcreteSettingForNamespace(config.name);
return setting.get(config.settings());
}

public static List<Setting.AffixSetting<?>> getSettings() {
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("Invalid format: [" + value + "]: Unknown pattern letter: j")));
assertThat(e.getCause(), instanceOf(IllegalArgumentException.class));
assertThat(e.getCause(), hasToString(containsString("Unknown pattern letter: j")));
}

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