org.graylog2.indexer.IndexSetValidator Maven / Gradle / Ivy
/*
* Copyright (C) 2020 Graylog, Inc.
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the Server Side Public License, version 1,
* as published by MongoDB, Inc.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* Server Side Public License for more details.
*
* You should have received a copy of the Server Side Public License
* along with this program. If not, see
* .
*/
package org.graylog2.indexer;
import com.google.auto.value.AutoValue;
import com.google.common.base.Strings;
import org.graylog2.configuration.ElasticsearchConfiguration;
import org.graylog2.indexer.indexset.IndexSetConfig;
import org.graylog2.indexer.rotation.strategies.TimeBasedRotationStrategyConfig;
import org.graylog2.plugin.indexer.retention.RetentionStrategyConfig;
import org.graylog2.shared.utilities.StringUtils;
import org.joda.time.DateTime;
import org.joda.time.DateTimeZone;
import org.joda.time.Duration;
import org.joda.time.Period;
import javax.annotation.Nullable;
import javax.inject.Inject;
import java.util.Optional;
public class IndexSetValidator {
private final static Duration MINIMUM_FIELD_TYPE_REFRESH_INTERVAL = Duration.standardSeconds(1L);
private final IndexSetRegistry indexSetRegistry;
private final ElasticsearchConfiguration elasticsearchConfiguration;
@Inject
public IndexSetValidator(IndexSetRegistry indexSetRegistry, ElasticsearchConfiguration elasticsearchConfiguration) {
this.indexSetRegistry = indexSetRegistry;
this.elasticsearchConfiguration = elasticsearchConfiguration;
}
public Optional validate(IndexSetConfig newConfig) {
// Don't validate prefix conflicts in case of an update
if (Strings.isNullOrEmpty(newConfig.id())) {
final Violation prefixViolation = validatePrefix(newConfig);
if (prefixViolation != null) {
return Optional.of(prefixViolation);
}
}
final Violation refreshIntervalViolation = validateRefreshInterval(newConfig);
if (refreshIntervalViolation != null) {
return Optional.of(refreshIntervalViolation);
}
return Optional.ofNullable(validateRetentionPeriod(newConfig));
}
@Nullable
private Violation validateRefreshInterval(IndexSetConfig newConfig) {
// Ensure fieldTypeRefreshInterval is not shorter than a second, as that may impact performance
if (newConfig.fieldTypeRefreshInterval().isShorterThan(MINIMUM_FIELD_TYPE_REFRESH_INTERVAL)) {
return Violation.create("Index field_type_refresh_interval \"" + newConfig.fieldTypeRefreshInterval().toString() + "\" is too short. It must be 1 second or longer.");
}
return null;
}
@Nullable
private Violation validatePrefix(IndexSetConfig newConfig) {
// Build an example index name with the new prefix and check if this would be managed by an existing index set
final String indexName = newConfig.indexPrefix() + MongoIndexSet.SEPARATOR + "0";
if (indexSetRegistry.isManagedIndex(indexName)) {
return Violation.create("Index prefix \"" + newConfig.indexPrefix() + "\" would conflict with an existing index set!");
}
// Check if the new index set configuration has a more generic index prefix than an existing index set,
// or vice versa.
// Example: new=graylog_foo existing=graylog => graylog is more generic so this is an error
// Example: new=gray existing=graylog => gray is more generic so this is an error
// This avoids problems with wildcard matching like "graylog_*".
for (final IndexSet indexSet : indexSetRegistry) {
if (newConfig.indexPrefix().startsWith(indexSet.getIndexPrefix()) || indexSet.getIndexPrefix().startsWith(newConfig.indexPrefix())) {
return Violation.create("Index prefix \"" + newConfig.indexPrefix() + "\" would conflict with existing index set prefix \"" + indexSet.getIndexPrefix() + "\"");
}
}
return null;
}
@Nullable
private Violation validateRetentionPeriod(IndexSetConfig config) {
final Period maxRetentionPeriod = elasticsearchConfiguration.getMaxIndexRetentionPeriod();
if (maxRetentionPeriod == null) {
return null;
}
if (!(config.rotationStrategy() instanceof TimeBasedRotationStrategyConfig)) {
return null;
}
final Period rotationPeriod =
((TimeBasedRotationStrategyConfig) config.rotationStrategy()).rotationPeriod().normalizedStandard();
final Period effectiveRetentionPeriod =
rotationPeriod.multipliedBy(config.retentionStrategy().maxNumberOfIndices()).normalizedStandard();
final DateTime now = DateTime.now(DateTimeZone.UTC);
if (now.plus(effectiveRetentionPeriod).isAfter(now.plus(maxRetentionPeriod))) {
return Violation.create(
StringUtils.f("Index retention setting %s=%d would result in an effective index retention period of %s. This exceeds the configured maximum of %s=%s.",
RetentionStrategyConfig.MAX_NUMBER_OF_INDEXES_FIELD, config.retentionStrategy().maxNumberOfIndices(), effectiveRetentionPeriod,
ElasticsearchConfiguration.MAX_INDEX_RETENTION_PERIOD, maxRetentionPeriod));
}
return null;
}
@AutoValue
public static abstract class Violation {
public abstract String message();
public static Violation create(String message) {
return new AutoValue_IndexSetValidator_Violation(message);
}
}
}