* terms of the Eclipse Public License v1.0 which accompanies this distribution,
* and is available at http://www.eclipse.org/legal/epl-v10.html
*/
-
package org.opendaylight.controller.cluster.raft;
-import akka.japi.Procedure;
import akka.persistence.SnapshotSelectionCriteria;
-import com.google.protobuf.ByteString;
-import org.opendaylight.controller.cluster.DataPersistenceProvider;
+import com.google.common.annotations.VisibleForTesting;
+import com.google.common.io.ByteSource;
+import java.io.IOException;
+import java.io.OutputStream;
+import java.util.List;
+import java.util.Optional;
+import java.util.function.Consumer;
+import org.eclipse.jdt.annotation.NonNull;
+import org.opendaylight.controller.cluster.io.FileBackedOutputStream;
+import org.opendaylight.controller.cluster.raft.base.messages.ApplySnapshot;
import org.opendaylight.controller.cluster.raft.base.messages.CaptureSnapshot;
import org.opendaylight.controller.cluster.raft.base.messages.SendInstallSnapshot;
+import org.opendaylight.controller.cluster.raft.base.messages.SnapshotComplete;
import org.opendaylight.controller.cluster.raft.behaviors.RaftActorBehavior;
+import org.opendaylight.controller.cluster.raft.persisted.EmptyState;
+import org.opendaylight.controller.cluster.raft.persisted.Snapshot;
import org.slf4j.Logger;
+/**
+ * Manages the capturing of snapshots for a RaftActor.
+ *
+ * @author Moiz Raja
+ * @author Thomas Pantelis
+ */
public class SnapshotManager implements SnapshotState {
-
+ @SuppressWarnings("checkstyle:MemberName")
private final SnapshotState IDLE = new Idle();
- private final SnapshotState CAPTURING = new Capturing();
+
+ @SuppressWarnings({"checkstyle:MemberName", "checkstyle:AbbreviationAsWordInName"})
private final SnapshotState PERSISTING = new Persisting();
+
+ @SuppressWarnings({"checkstyle:MemberName", "checkstyle:AbbreviationAsWordInName"})
private final SnapshotState CREATING = new Creating();
- private final Logger LOG;
+ private final Logger log;
private final RaftActorContext context;
private final LastAppliedTermInformationReader lastAppliedTermInformationReader =
new LastAppliedTermInformationReader();
private SnapshotState currentState = IDLE;
private CaptureSnapshot captureSnapshot;
+ private long lastSequenceNumber = -1;
- public SnapshotManager(RaftActorContext context, Logger logger) {
+ private Consumer<Optional<OutputStream>> createSnapshotProcedure = null;
+
+ private ApplySnapshot applySnapshot;
+ private RaftActorSnapshotCohort snapshotCohort = NoopRaftActorSnapshotCohort.INSTANCE;
+
+ /**
+ * Constructs an instance.
+ *
+ * @param context the RaftActorContext
+ * @param logger the Logger
+ */
+ public SnapshotManager(final RaftActorContext context, final Logger logger) {
this.context = context;
- this.LOG = logger;
+ this.log = logger;
+ }
+
+ public boolean isApplying() {
+ return applySnapshot != null;
}
@Override
}
@Override
- public boolean captureToInstall(ReplicatedLogEntry lastLogEntry, long replicatedToAllIndex, String targetFollower) {
+ public boolean captureToInstall(final ReplicatedLogEntry lastLogEntry, final long replicatedToAllIndex,
+ final String targetFollower) {
return currentState.captureToInstall(lastLogEntry, replicatedToAllIndex, targetFollower);
}
@Override
- public boolean capture(ReplicatedLogEntry lastLogEntry, long replicatedToAllIndex) {
+ public boolean capture(final ReplicatedLogEntry lastLogEntry, final long replicatedToAllIndex) {
return currentState.capture(lastLogEntry, replicatedToAllIndex);
}
@Override
- public void create(Procedure<Void> callback) {
- currentState.create(callback);
+ public boolean captureWithForcedTrim(final ReplicatedLogEntry lastLogEntry, final long replicatedToAllIndex) {
+ return currentState.captureWithForcedTrim(lastLogEntry, replicatedToAllIndex);
}
@Override
- public void persist(DataPersistenceProvider persistenceProvider, byte[] snapshotBytes,
- RaftActorBehavior currentBehavior, long totalMemory) {
- currentState.persist(persistenceProvider, snapshotBytes, currentBehavior, totalMemory);
+ public void apply(final ApplySnapshot snapshot) {
+ currentState.apply(snapshot);
}
@Override
- public void commit(DataPersistenceProvider persistenceProvider, long sequenceNumber) {
- currentState.commit(persistenceProvider, sequenceNumber);
+ public void persist(final Snapshot.State state, final Optional<OutputStream> installSnapshotStream,
+ final long totalMemory) {
+ currentState.persist(state, installSnapshotStream, totalMemory);
+ }
+
+ @Override
+ public void commit(final long sequenceNumber, final long timeStamp) {
+ currentState.commit(sequenceNumber, timeStamp);
}
@Override
}
@Override
- public long trimLog(long desiredTrimIndex, RaftActorBehavior currentBehavior) {
- return currentState.trimLog(desiredTrimIndex, currentBehavior);
+ public long trimLog(final long desiredTrimIndex) {
+ return currentState.trimLog(desiredTrimIndex);
+ }
+
+ @SuppressWarnings("checkstyle:hiddenField")
+ void setCreateSnapshotConsumer(final Consumer<Optional<OutputStream>> createSnapshotProcedure) {
+ this.createSnapshotProcedure = createSnapshotProcedure;
+ }
+
+ void setSnapshotCohort(final RaftActorSnapshotCohort snapshotCohort) {
+ this.snapshotCohort = snapshotCohort;
+ }
+
+ public Snapshot.@NonNull State convertSnapshot(final ByteSource snapshotBytes) throws IOException {
+ return snapshotCohort.deserializeSnapshot(snapshotBytes);
+ }
+
+ public long getLastSequenceNumber() {
+ return lastSequenceNumber;
}
- private boolean hasFollowers(){
- return context.getPeerAddresses().keySet().size() > 0;
+ @VisibleForTesting
+ public CaptureSnapshot getCaptureSnapshot() {
+ return captureSnapshot;
}
- private String persistenceId(){
+ private boolean hasFollowers() {
+ return context.hasFollowers();
+ }
+
+ private String persistenceId() {
return context.getId();
}
+ /**
+ * Constructs a CaptureSnapshot instance.
+ *
+ * @param lastLogEntry the last log entry for the snapshot.
+ * @param replicatedToAllIndex the index of the last entry replicated to all followers.
+ * @return a new CaptureSnapshot instance.
+ */
+ public CaptureSnapshot newCaptureSnapshot(final ReplicatedLogEntry lastLogEntry, final long replicatedToAllIndex,
+ final boolean mandatoryTrim) {
+ TermInformationReader lastAppliedTermInfoReader =
+ lastAppliedTermInformationReader.init(context.getReplicatedLog(), context.getLastApplied(),
+ lastLogEntry, hasFollowers());
+
+ long lastAppliedIndex = lastAppliedTermInfoReader.getIndex();
+ long lastAppliedTerm = lastAppliedTermInfoReader.getTerm();
+
+ TermInformationReader replicatedToAllTermInfoReader =
+ replicatedToAllTermInformationReader.init(context.getReplicatedLog(), replicatedToAllIndex);
+
+ long newReplicatedToAllIndex = replicatedToAllTermInfoReader.getIndex();
+ long newReplicatedToAllTerm = replicatedToAllTermInfoReader.getTerm();
+
+ List<ReplicatedLogEntry> unAppliedEntries = context.getReplicatedLog().getFrom(lastAppliedIndex + 1);
+
+ final long lastLogEntryIndex;
+ final long lastLogEntryTerm;
+ if (lastLogEntry == null) {
+ // When we don't have journal present, for example two captureSnapshots executed right after another with no
+ // new journal we still want to preserve the index and term in the snapshot.
+ lastAppliedIndex = lastLogEntryIndex = context.getReplicatedLog().getSnapshotIndex();
+ lastAppliedTerm = lastLogEntryTerm = context.getReplicatedLog().getSnapshotTerm();
+
+ log.debug("{}: Capturing Snapshot : lastLogEntry is null. Using snapshot values lastAppliedIndex {} and "
+ + "lastAppliedTerm {} instead.", persistenceId(), lastAppliedIndex, lastAppliedTerm);
+ } else {
+ lastLogEntryIndex = lastLogEntry.getIndex();
+ lastLogEntryTerm = lastLogEntry.getTerm();
+ }
+
+ return new CaptureSnapshot(lastLogEntryIndex, lastLogEntryTerm, lastAppliedIndex, lastAppliedTerm,
+ newReplicatedToAllIndex, newReplicatedToAllTerm, unAppliedEntries, mandatoryTrim);
+ }
+
private class AbstractSnapshotState implements SnapshotState {
@Override
public boolean isCapturing() {
+ return true;
+ }
+
+ @Override
+ public boolean capture(final ReplicatedLogEntry lastLogEntry, final long replicatedToAllIndex) {
+ log.debug("capture should not be called in state {}", this);
return false;
}
@Override
- public boolean capture(ReplicatedLogEntry lastLogEntry, long replicatedToAllIndex) {
- LOG.debug("capture should not be called in state {}", this);
+ public boolean captureToInstall(final ReplicatedLogEntry lastLogEntry, final long replicatedToAllIndex,
+ final String targetFollower) {
+ log.debug("captureToInstall should not be called in state {}", this);
return false;
}
@Override
- public boolean captureToInstall(ReplicatedLogEntry lastLogEntry, long replicatedToAllIndex, String targetFollower) {
- LOG.debug("captureToInstall should not be called in state {}", this);
+ public boolean captureWithForcedTrim(final ReplicatedLogEntry lastLogEntry, final long replicatedToAllIndex) {
+ log.debug("captureWithForcedTrim should not be called in state {}", this);
return false;
}
@Override
- public void create(Procedure<Void> callback) {
- LOG.debug("create should not be called in state {}", this);
+ public void apply(final ApplySnapshot snapshot) {
+ log.debug("apply should not be called in state {}", this);
}
@Override
- public void persist(DataPersistenceProvider persistenceProvider, byte[] snapshotBytes,
- RaftActorBehavior currentBehavior, long totalMemory) {
- LOG.debug("persist should not be called in state {}", this);
+ public void persist(final Snapshot.State state, final Optional<OutputStream> installSnapshotStream,
+ final long totalMemory) {
+ log.debug("persist should not be called in state {}", this);
}
@Override
- public void commit(DataPersistenceProvider persistenceProvider, long sequenceNumber) {
- LOG.debug("commit should not be called in state {}", this);
+ public void commit(final long sequenceNumber, final long timeStamp) {
+ log.debug("commit should not be called in state {}", this);
}
@Override
public void rollback() {
- LOG.debug("rollback should not be called in state {}", this);
+ log.debug("rollback should not be called in state {}", this);
}
@Override
- public long trimLog(long desiredTrimIndex, RaftActorBehavior currentBehavior) {
- LOG.debug("trimLog should not be called in state {}", this);
+ public long trimLog(final long desiredTrimIndex) {
+ log.debug("trimLog should not be called in state {}", this);
return -1;
}
- protected long doTrimLog(long desiredTrimIndex, RaftActorBehavior currentBehavior){
+ protected long doTrimLog(final long desiredTrimIndex) {
// we would want to keep the lastApplied as its used while capturing snapshots
long lastApplied = context.getLastApplied();
- long tempMin = Math.min(desiredTrimIndex, (lastApplied > -1 ? lastApplied - 1 : -1));
+ long tempMin = Math.min(desiredTrimIndex, lastApplied > -1 ? lastApplied - 1 : -1);
- if(LOG.isTraceEnabled()) {
- LOG.trace("{}: performSnapshotWithoutCapture: desiredTrimIndex: {}, lastApplied: {}, tempMin: {}",
+ if (log.isTraceEnabled()) {
+ log.trace("{}: performSnapshotWithoutCapture: desiredTrimIndex: {}, lastApplied: {}, tempMin: {}",
persistenceId(), desiredTrimIndex, lastApplied, tempMin);
}
if (tempMin > -1 && context.getReplicatedLog().isPresent(tempMin)) {
- LOG.debug("{}: fakeSnapshot purging log to {} for term {}", persistenceId(), tempMin,
+ log.debug("{}: fakeSnapshot purging log to {} for term {}", persistenceId(), tempMin,
context.getTermInformation().getCurrentTerm());
//use the term of the temp-min, since we check for isPresent, entry will not be null
context.getReplicatedLog().snapshotPreCommit(tempMin, entry.getTerm());
context.getReplicatedLog().snapshotCommit();
return tempMin;
- } else if(tempMin > currentBehavior.getReplicatedToAllIndex()) {
+ }
+
+ final RaftActorBehavior currentBehavior = context.getCurrentBehavior();
+ if (tempMin > currentBehavior.getReplicatedToAllIndex()) {
// It's possible a follower was lagging and an install snapshot advanced its match index past
// the current replicatedToAllIndex. Since the follower is now caught up we should advance the
// replicatedToAllIndex (to tempMin). The fact that tempMin wasn't found in the log is likely
private class Idle extends AbstractSnapshotState {
- private boolean capture(ReplicatedLogEntry lastLogEntry, long replicatedToAllIndex, String targetFollower) {
- TermInformationReader lastAppliedTermInfoReader =
- lastAppliedTermInformationReader.init(context.getReplicatedLog(), context.getLastApplied(),
- lastLogEntry, hasFollowers());
+ @Override
+ public boolean isCapturing() {
+ return false;
+ }
- long lastAppliedIndex = lastAppliedTermInfoReader.getIndex();
- long lastAppliedTerm = lastAppliedTermInfoReader.getTerm();
+ @SuppressWarnings("checkstyle:IllegalCatch")
+ private boolean capture(final ReplicatedLogEntry lastLogEntry, final long replicatedToAllIndex,
+ final String targetFollower, final boolean mandatoryTrim) {
+ captureSnapshot = newCaptureSnapshot(lastLogEntry, replicatedToAllIndex, mandatoryTrim);
- TermInformationReader replicatedToAllTermInfoReader =
- replicatedToAllTermInformationReader.init(context.getReplicatedLog(), replicatedToAllIndex);
+ OutputStream installSnapshotStream = null;
+ if (targetFollower != null) {
+ installSnapshotStream = context.getFileBackedOutputStreamFactory().newInstance();
+ log.info("{}: Initiating snapshot capture {} to install on {}",
+ persistenceId(), captureSnapshot, targetFollower);
+ } else {
+ log.info("{}: Initiating snapshot capture {}", persistenceId(), captureSnapshot);
+ }
- long newReplicatedToAllIndex = replicatedToAllTermInfoReader.getIndex();
- long newReplicatedToAllTerm = replicatedToAllTermInfoReader.getTerm();
+ lastSequenceNumber = context.getPersistenceProvider().getLastSequenceNumber();
- // send a CaptureSnapshot to self to make the expensive operation async.
- captureSnapshot = new CaptureSnapshot(lastLogEntry.getIndex(),
- lastLogEntry.getTerm(), lastAppliedIndex, lastAppliedTerm,
- newReplicatedToAllIndex, newReplicatedToAllTerm, targetFollower!=null);
+ log.debug("{}: lastSequenceNumber prior to capture: {}", persistenceId(), lastSequenceNumber);
- SnapshotManager.this.currentState = CAPTURING;
+ SnapshotManager.this.currentState = CREATING;
- if(targetFollower != null){
- LOG.info("{}: Initiating snapshot capture {}", persistenceId(), captureSnapshot);
- } else {
- LOG.info("{}: Initiating snapshot capture {} to install on {}",
- persistenceId(), captureSnapshot, targetFollower);
+ try {
+ createSnapshotProcedure.accept(Optional.ofNullable(installSnapshotStream));
+ } catch (Exception e) {
+ SnapshotManager.this.currentState = IDLE;
+ log.error("Error creating snapshot", e);
+ return false;
}
- context.getActor().tell(captureSnapshot, context.getActor());
-
return true;
}
@Override
- public boolean capture(ReplicatedLogEntry lastLogEntry, long replicatedToAllIndex) {
- return capture(lastLogEntry, replicatedToAllIndex, null);
+ public boolean capture(final ReplicatedLogEntry lastLogEntry, final long replicatedToAllIndex) {
+ return capture(lastLogEntry, replicatedToAllIndex, null, false);
}
@Override
- public boolean captureToInstall(ReplicatedLogEntry lastLogEntry, long replicatedToAllIndex, String targetFollower) {
- return capture(lastLogEntry, replicatedToAllIndex, targetFollower);
+ public boolean captureToInstall(final ReplicatedLogEntry lastLogEntry, final long replicatedToAllIndex,
+ final String targetFollower) {
+ return capture(lastLogEntry, replicatedToAllIndex, targetFollower, false);
}
@Override
- public String toString() {
- return "Idle";
+ public boolean captureWithForcedTrim(final ReplicatedLogEntry lastLogEntry, final long replicatedToAllIndex) {
+ return capture(lastLogEntry, replicatedToAllIndex, null, true);
}
@Override
- public long trimLog(long desiredTrimIndex, RaftActorBehavior currentBehavior) {
- return doTrimLog(desiredTrimIndex, currentBehavior);
- }
- }
+ public void apply(final ApplySnapshot toApply) {
+ SnapshotManager.this.applySnapshot = toApply;
- private class Capturing extends AbstractSnapshotState {
+ lastSequenceNumber = context.getPersistenceProvider().getLastSequenceNumber();
- @Override
- public boolean isCapturing() {
- return true;
- }
+ log.debug("lastSequenceNumber prior to persisting applied snapshot: {}", lastSequenceNumber);
- @Override
- public void create(Procedure<Void> callback) {
- try {
- callback.apply(null);
- SnapshotManager.this.currentState = CREATING;
- } catch (Exception e) {
- LOG.error("Unexpected error occurred", e);
- }
+ context.getPersistenceProvider().saveSnapshot(toApply.getSnapshot());
+
+ SnapshotManager.this.currentState = PERSISTING;
}
@Override
public String toString() {
- return "Capturing";
+ return "Idle";
}
+ @Override
+ public long trimLog(final long desiredTrimIndex) {
+ return doTrimLog(desiredTrimIndex);
+ }
}
private class Creating extends AbstractSnapshotState {
@Override
- public boolean isCapturing() {
- return true;
- }
-
- @Override
- public void persist(DataPersistenceProvider persistenceProvider, byte[] snapshotBytes,
- RaftActorBehavior currentBehavior, long totalMemory) {
+ public void persist(final Snapshot.State snapshotState, final Optional<OutputStream> installSnapshotStream,
+ final long totalMemory) {
// create a snapshot object from the state provided and save it
// when snapshot is saved async, SaveSnapshotSuccess is raised.
- Snapshot sn = Snapshot.create(snapshotBytes,
- context.getReplicatedLog().getFrom(captureSnapshot.getLastAppliedIndex() + 1),
+ Snapshot snapshot = Snapshot.create(snapshotState,
+ captureSnapshot.getUnAppliedEntries(),
captureSnapshot.getLastIndex(), captureSnapshot.getLastTerm(),
- captureSnapshot.getLastAppliedIndex(), captureSnapshot.getLastAppliedTerm());
-
- persistenceProvider.saveSnapshot(sn);
-
- LOG.info("{}: Persisting of snapshot done:{}", persistenceId(), sn.getLogMessage());
-
- long dataThreshold = totalMemory *
- context.getConfigParams().getSnapshotDataThresholdPercentage() / 100;
- if (context.getReplicatedLog().dataSize() > dataThreshold) {
-
- if(LOG.isDebugEnabled()) {
- LOG.debug("{}: dataSize {} exceeds dataThreshold {} - doing snapshotPreCommit with index {}",
- persistenceId(), context.getReplicatedLog().dataSize(), dataThreshold,
- captureSnapshot.getLastAppliedIndex());
+ captureSnapshot.getLastAppliedIndex(), captureSnapshot.getLastAppliedTerm(),
+ context.getTermInformation().getCurrentTerm(),
+ context.getTermInformation().getVotedFor(), context.getPeerServerInfo(true));
+
+ context.getPersistenceProvider().saveSnapshot(snapshot);
+
+ log.info("{}: Persisting of snapshot done: {}", persistenceId(), snapshot);
+
+ final ConfigParams config = context.getConfigParams();
+ final long absoluteThreshold = config.getSnapshotDataThreshold();
+ final long dataThreshold = absoluteThreshold != 0 ? absoluteThreshold * ConfigParams.MEGABYTE
+ : totalMemory * config.getSnapshotDataThresholdPercentage() / 100;
+
+ final boolean dataSizeThresholdExceeded = context.getReplicatedLog().dataSize() > dataThreshold;
+ final boolean logSizeExceededSnapshotBatchCount =
+ context.getReplicatedLog().size() >= config.getSnapshotBatchCount();
+
+ final RaftActorBehavior currentBehavior = context.getCurrentBehavior();
+ if (dataSizeThresholdExceeded || logSizeExceededSnapshotBatchCount || captureSnapshot.isMandatoryTrim()) {
+ if (log.isDebugEnabled()) {
+ if (dataSizeThresholdExceeded) {
+ log.debug("{}: log data size {} exceeds the memory threshold {} - doing snapshotPreCommit "
+ + "with index {}", context.getId(), context.getReplicatedLog().dataSize(),
+ dataThreshold, captureSnapshot.getLastAppliedIndex());
+ } else if (logSizeExceededSnapshotBatchCount) {
+ log.debug("{}: log size {} exceeds the snapshot batch count {} - doing snapshotPreCommit with "
+ + "index {}", context.getId(), context.getReplicatedLog().size(),
+ config.getSnapshotBatchCount(), captureSnapshot.getLastAppliedIndex());
+ } else {
+ log.debug("{}: user triggered or root overwrite snapshot encountered, trimming log up to "
+ + "last applied index {}", context.getId(), captureSnapshot.getLastAppliedIndex());
+ }
}
- // if memory is less, clear the log based on lastApplied.
- // this could/should only happen if one of the followers is down
- // as normally we keep removing from the log when its replicated to all.
+ // We either exceeded the memory threshold or the log size exceeded the snapshot batch
+ // count so, to keep the log memory footprint in check, clear the log based on lastApplied.
+ // This could/should only happen if one of the followers is down as normally we keep
+ // removing from the log as entries are replicated to all.
context.getReplicatedLog().snapshotPreCommit(captureSnapshot.getLastAppliedIndex(),
captureSnapshot.getLastAppliedTerm());
// Don't reset replicatedToAllIndex to -1 as this may prevent us from trimming the log after an
// install snapshot to a follower.
- if(captureSnapshot.getReplicatedToAllIndex() >= 0) {
+ if (captureSnapshot.getReplicatedToAllIndex() >= 0) {
currentBehavior.setReplicatedToAllIndex(captureSnapshot.getReplicatedToAllIndex());
}
- } else if(captureSnapshot.getReplicatedToAllIndex() != -1){
+ } else if (captureSnapshot.getReplicatedToAllIndex() != -1) {
// clear the log based on replicatedToAllIndex
context.getReplicatedLog().snapshotPreCommit(captureSnapshot.getReplicatedToAllIndex(),
captureSnapshot.getReplicatedToAllTerm());
context.getReplicatedLog().getSnapshotTerm());
}
- LOG.info("{}: Removed in-memory snapshotted entries, adjusted snaphsotIndex:{} " +
- "and term:{}", persistenceId(), captureSnapshot.getLastAppliedIndex(),
- captureSnapshot.getLastAppliedTerm());
-
- if (context.getId().equals(currentBehavior.getLeaderId())
- && captureSnapshot.isInstallSnapshotInitiated()) {
- // this would be call straight to the leader and won't initiate in serialization
- currentBehavior.handleMessage(context.getActor(), new SendInstallSnapshot(
- ByteString.copyFrom(snapshotBytes)));
+ log.info("{}: Removed in-memory snapshotted entries, adjusted snaphsotIndex: {} and term: {}",
+ context.getId(), context.getReplicatedLog().getSnapshotIndex(),
+ context.getReplicatedLog().getSnapshotTerm());
+
+ if (installSnapshotStream.isPresent()) {
+ if (context.getId().equals(currentBehavior.getLeaderId())) {
+ try {
+ ByteSource snapshotBytes = ((FileBackedOutputStream)installSnapshotStream.get()).asByteSource();
+ currentBehavior.handleMessage(context.getActor(),
+ new SendInstallSnapshot(snapshot, snapshotBytes));
+ } catch (IOException e) {
+ log.error("{}: Snapshot install failed due to an unrecoverable streaming error",
+ context.getId(), e);
+ }
+ } else {
+ ((FileBackedOutputStream)installSnapshotStream.get()).cleanup();
+ }
}
captureSnapshot = null;
private class Persisting extends AbstractSnapshotState {
@Override
- public void commit(DataPersistenceProvider persistenceProvider, long sequenceNumber) {
- context.getReplicatedLog().snapshotCommit();
- persistenceProvider.deleteSnapshots(new SnapshotSelectionCriteria(
- sequenceNumber - context.getConfigParams().getSnapshotBatchCount(), 43200000));
+ @SuppressWarnings("checkstyle:IllegalCatch")
+ public void commit(final long sequenceNumber, final long timeStamp) {
+ log.debug("{}: Snapshot success - sequence number: {}", persistenceId(), sequenceNumber);
+
+ if (applySnapshot != null) {
+ try {
+ Snapshot snapshot = applySnapshot.getSnapshot();
+
+ //clears the followers log, sets the snapshot index to ensure adjusted-index works
+ context.setReplicatedLog(ReplicatedLogImpl.newInstance(snapshot, context));
+ context.setLastApplied(snapshot.getLastAppliedIndex());
+ context.setCommitIndex(snapshot.getLastAppliedIndex());
+ context.getTermInformation().update(snapshot.getElectionTerm(), snapshot.getElectionVotedFor());
+
+ if (snapshot.getServerConfiguration() != null) {
+ context.updatePeerIds(snapshot.getServerConfiguration());
+ }
+
+ if (!(snapshot.getState() instanceof EmptyState)) {
+ snapshotCohort.applySnapshot(snapshot.getState());
+ }
+
+ applySnapshot.getCallback().onSuccess();
+ } catch (Exception e) {
+ log.error("{}: Error applying snapshot", context.getId(), e);
+ }
+ } else {
+ context.getReplicatedLog().snapshotCommit();
+ }
- persistenceProvider.deleteMessages(sequenceNumber);
+ context.getPersistenceProvider().deleteSnapshots(new SnapshotSelectionCriteria(scala.Long.MaxValue(),
+ timeStamp - 1, 0L, 0L));
- SnapshotManager.this.currentState = IDLE;
+ context.getPersistenceProvider().deleteMessages(lastSequenceNumber);
+
+ snapshotComplete();
}
@Override
public void rollback() {
- context.getReplicatedLog().snapshotRollback();
+ // Nothing to rollback if we're applying a snapshot from the leader.
+ if (applySnapshot == null) {
+ context.getReplicatedLog().snapshotRollback();
+
+ log.info("{}: Replicated Log rolled back. Snapshot will be attempted in the next cycle."
+ + "snapshotIndex:{}, snapshotTerm:{}, log-size:{}", persistenceId(),
+ context.getReplicatedLog().getSnapshotIndex(),
+ context.getReplicatedLog().getSnapshotTerm(),
+ context.getReplicatedLog().size());
+ } else {
+ applySnapshot.getCallback().onFailure();
+ }
- LOG.info("{}: Replicated Log rolled back. Snapshot will be attempted in the next cycle." +
- "snapshotIndex:{}, snapshotTerm:{}, log-size:{}", persistenceId(),
- context.getReplicatedLog().getSnapshotIndex(),
- context.getReplicatedLog().getSnapshotTerm(),
- context.getReplicatedLog().size());
+ snapshotComplete();
+ }
+ private void snapshotComplete() {
+ lastSequenceNumber = -1;
+ applySnapshot = null;
SnapshotManager.this.currentState = IDLE;
+
+ context.getActor().tell(SnapshotComplete.INSTANCE, context.getActor());
}
@Override
}
- private static interface TermInformationReader {
+ private interface TermInformationReader {
long getIndex();
+
long getTerm();
}
- private static class LastAppliedTermInformationReader implements TermInformationReader{
+ static class LastAppliedTermInformationReader implements TermInformationReader {
private long index;
private long term;
- public LastAppliedTermInformationReader init(ReplicatedLog log, long originalIndex,
- ReplicatedLogEntry lastLogEntry, boolean hasFollowers){
+ LastAppliedTermInformationReader init(final ReplicatedLog log, final long originalIndex,
+ final ReplicatedLogEntry lastLogEntry, final boolean hasFollowers) {
ReplicatedLogEntry entry = log.get(originalIndex);
this.index = -1L;
this.term = -1L;
if (!hasFollowers) {
- if(lastLogEntry != null) {
+ if (lastLogEntry != null) {
+ // since we have persisted the last-log-entry to persistent journal before the capture,
+ // we would want to snapshot from this entry.
index = lastLogEntry.getIndex();
term = lastLogEntry.getTerm();
}
} else if (entry != null) {
index = entry.getIndex();
term = entry.getTerm();
- } else if(log.getSnapshotIndex() > -1){
+ } else if (log.getSnapshotIndex() > -1) {
index = log.getSnapshotIndex();
term = log.getSnapshotTerm();
}
}
@Override
- public long getIndex(){
+ public long getIndex() {
return this.index;
}
@Override
- public long getTerm(){
+ public long getTerm() {
return this.term;
}
}
- private static class ReplicatedToAllTermInformationReader implements TermInformationReader{
+ private static class ReplicatedToAllTermInformationReader implements TermInformationReader {
private long index;
private long term;
- ReplicatedToAllTermInformationReader init(ReplicatedLog log, long originalIndex){
+ ReplicatedToAllTermInformationReader init(final ReplicatedLog log, final long originalIndex) {
ReplicatedLogEntry entry = log.get(originalIndex);
this.index = -1L;
this.term = -1L;
}
@Override
- public long getIndex(){
+ public long getIndex() {
return this.index;
}
@Override
- public long getTerm(){
+ public long getTerm() {
return this.term;
}
}
Code Review / controller.git / blobdiff