Skip to content

RATIS-1862 Add the parameter whether to take Snapshot when stopping to adapt to different services #896

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

Merged
szetszwo merged 2 commits into from
Jul 28, 2023
Merged

RATIS-1862 Add the parameter whether to take Snapshot when stopping to adapt to different services #896

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e191d69
finish
OneSizeFitsQuorum Jul 28, 2023
ea4b55b
fix review
OneSizeFitsQuorum Jul 28, 2023
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
12 changes: 12 additions & 0 deletions ratis-server-api/src/main/java/org/apache/ratis/server/RaftServerConfigKeys.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -586,6 +586,18 @@ static void setAutoTriggerEnabled(RaftProperties properties, boolean autoTrigger
setBoolean(properties::setBoolean, AUTO_TRIGGER_ENABLED_KEY, autoTriggerEnabled);
}

/** whether trigger snapshot when stop raft server */
String TRIGGER_WHEN_STOP_ENABLED_KEY = PREFIX + ".trigger-when-stop.enabled";
/** by default let the state machine to trigger snapshot when stop */
boolean TRIGGER_WHEN_STOP_ENABLED_DEFAULT = true;
static boolean triggerWhenStopEnabled(RaftProperties properties) {
return getBoolean(properties::getBoolean,
TRIGGER_WHEN_STOP_ENABLED_KEY, TRIGGER_WHEN_STOP_ENABLED_DEFAULT, getDefaultLog());
}
static void setTriggerWhenStopEnabled(RaftProperties properties, boolean triggerWhenStopEnabled) {
setBoolean(properties::setBoolean, TRIGGER_WHEN_STOP_ENABLED_KEY, triggerWhenStopEnabled);
}

/** The log index gap between to two snapshot creations. */
String CREATION_GAP_KEY = PREFIX + ".creation.gap";
long CREATION_GAP_DEFAULT = 1024;
Expand Down
5 changes: 4 additions & 1 deletion ratis-server/src/main/java/org/apache/ratis/server/impl/StateMachineUpdater.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,8 @@ enum State {
private final RaftServerImpl server;
private final RaftLog raftLog;

private final boolean triggerSnapshotWhenStopEnabled;

private final Long autoSnapshotThreshold;
private final boolean purgeUptoSnapshotIndex;

Expand Down Expand Up @@ -103,6 +105,7 @@ enum State {
this.appliedIndex = new RaftLogIndex("appliedIndex", lastAppliedIndex);
this.snapshotIndex = new RaftLogIndex("snapshotIndex", lastAppliedIndex);

this.triggerSnapshotWhenStopEnabled = RaftServerConfigKeys.Snapshot.triggerWhenStopEnabled(properties);
final boolean autoSnapshot = RaftServerConfigKeys.Snapshot.autoTriggerEnabled(properties);
this.autoSnapshotThreshold = autoSnapshot? RaftServerConfigKeys.Snapshot.autoTriggerThreshold(properties): null;
final int numSnapshotFilesRetained = RaftServerConfigKeys.Snapshot.retentionFileNum(properties);
Expand Down Expand Up @@ -315,7 +318,7 @@ private boolean shouldTakeSnapshot() {
if (autoSnapshotThreshold == null) {
return false;
} else if (shouldStop()) {
return getLastAppliedIndex() - snapshotIndex.get() > 0;
return triggerSnapshotWhenStopEnabled && getLastAppliedIndex() - snapshotIndex.get() > 0;
}
return state == State.RUNNING &&
getStateMachineLastAppliedIndex() - snapshotIndex.get() >= autoSnapshotThreshold;
Expand Down