org.graylog2.periodical.IndexRangesMigrationPeriodical Maven / Gradle / Ivy
/**
* This file is part of Graylog.
*
* Graylog is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* Graylog 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
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with Graylog. If not, see .
*/
package org.graylog2.periodical;
import com.fasterxml.jackson.annotation.JsonAutoDetect;
import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.google.common.base.Joiner;
import com.google.common.collect.ImmutableSet;
import com.google.common.collect.Sets;
import com.google.common.util.concurrent.Uninterruptibles;
import org.graylog2.indexer.IndexSet;
import org.graylog2.indexer.IndexSetRegistry;
import org.graylog2.indexer.cluster.Cluster;
import org.graylog2.indexer.indexset.IndexSetConfig;
import org.graylog2.indexer.ranges.IndexRange;
import org.graylog2.indexer.ranges.IndexRangeService;
import org.graylog2.indexer.ranges.LegacyMongoIndexRangeService;
import org.graylog2.notifications.Notification;
import org.graylog2.notifications.NotificationService;
import org.graylog2.plugin.cluster.ClusterConfigService;
import org.graylog2.plugin.periodical.Periodical;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import javax.inject.Inject;
import java.util.Optional;
import java.util.Set;
import java.util.SortedSet;
import java.util.concurrent.TimeUnit;
import java.util.stream.Collectors;
import static com.google.common.base.Preconditions.checkNotNull;
/**
* A {@link Periodical} to check if index ranges need to be recalculated and notify the administrators about it.
*
* @see Refactor index ranges handling (#1274)
* @since 1.2.0
*/
public class IndexRangesMigrationPeriodical extends Periodical {
private static final Logger LOG = LoggerFactory.getLogger(IndexRangesMigrationPeriodical.class);
private final Cluster cluster;
private final IndexSetRegistry indexSetRegistry;
private final IndexRangeService indexRangeService;
private final NotificationService notificationService;
private final LegacyMongoIndexRangeService legacyMongoIndexRangeService;
private final ClusterConfigService clusterConfigService;
@Inject
public IndexRangesMigrationPeriodical(final Cluster cluster,
final IndexSetRegistry indexSetRegistry,
final IndexRangeService indexRangeService,
final NotificationService notificationService,
final LegacyMongoIndexRangeService legacyMongoIndexRangeService,
final ClusterConfigService clusterConfigService) {
this.cluster = checkNotNull(cluster);
this.indexSetRegistry = checkNotNull(indexSetRegistry);
this.indexRangeService = checkNotNull(indexRangeService);
this.notificationService = checkNotNull(notificationService);
this.legacyMongoIndexRangeService = checkNotNull(legacyMongoIndexRangeService);
this.clusterConfigService = checkNotNull(clusterConfigService);
}
@Override
public void doRun() {
final MongoIndexRangesMigrationComplete migrationComplete = clusterConfigService.get(MongoIndexRangesMigrationComplete.class);
if (migrationComplete != null && migrationComplete.complete) {
LOG.debug("Migration of index ranges (pre Graylog 1.2.2) already complete. Skipping migration process.");
return;
}
while (!cluster.isConnected() || !cluster.isHealthy()) {
Uninterruptibles.sleepUninterruptibly(5, TimeUnit.SECONDS);
}
final Set indexNames = ImmutableSet.copyOf(indexSetRegistry.getManagedIndices());
// Migrate old MongoDB index ranges
final SortedSet mongoIndexRanges = legacyMongoIndexRangeService.findAll();
for (IndexRange indexRange : mongoIndexRanges) {
if(indexNames.contains(indexRange.indexName())) {
LOG.info("Migrating index range from MongoDB: {}", indexRange);
indexRangeService.save(indexRange);
} else {
LOG.info("Removing stale index range from MongoDB: {}", indexRange);
}
legacyMongoIndexRangeService.delete(indexRange.indexName());
}
// Check whether all index ranges have been migrated
final int numberOfIndices = indexNames.size();
final SortedSet allIndexRanges = indexRangeService.findAll();
final int numberOfIndexRanges = allIndexRanges.size();
if (numberOfIndices > numberOfIndexRanges) {
LOG.info("There are more indices ({}) than there are index ranges ({}). Notifying administrator.",
numberOfIndices, numberOfIndexRanges);
// remove all present index names so we can display the index sets that need manual fixing
final Set extraIndices = Sets.newHashSet(indexNames);
allIndexRanges.forEach(indexRange -> extraIndices.remove(indexRange.indexName()));
final Set affectedIndexSetNames = extraIndices.stream()
.map(indexSetRegistry::getForIndex)
.filter(Optional::isPresent)
.map(Optional::get)
.map(IndexSet::getConfig)
.map(IndexSetConfig::title)
.collect(Collectors.toSet());
final Notification notification = notificationService.buildNow()
.addSeverity(Notification.Severity.URGENT)
.addType(Notification.Type.INDEX_RANGES_RECALCULATION)
.addDetail("indices", numberOfIndices)
.addDetail("index_ranges", numberOfIndexRanges)
.addDetail("index_sets", affectedIndexSetNames.isEmpty() ? null : Joiner.on(", ").join(affectedIndexSetNames));
notificationService.publishIfFirst(notification);
}
clusterConfigService.write(new MongoIndexRangesMigrationComplete(true));
}
@Override
public boolean runsForever() {
return true;
}
@Override
public boolean stopOnGracefulShutdown() {
return false;
}
@Override
public boolean masterOnly() {
return true;
}
@Override
public boolean startOnThisNode() {
return true;
}
@Override
public boolean isDaemon() {
return true;
}
@Override
public int getInitialDelaySeconds() {
return 0;
}
@Override
public int getPeriodSeconds() {
return 0;
}
@Override
protected Logger getLogger() {
return LOG;
}
@JsonAutoDetect
public static class MongoIndexRangesMigrationComplete {
@JsonProperty
public boolean complete;
@JsonCreator
public MongoIndexRangesMigrationComplete(@JsonProperty("complete") boolean complete) {
this.complete = complete;
}
}
}