docs: improve docs for preferSnapshotReplicationThreshold

(cherry picked from commit 33e1974)
camunda · Jan 11, 2022 · c1bcfe7 · c1bcfe7
1 parent 91b8f02
commit c1bcfe7
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 6 deletions.
diff --git a/atomix/cluster/src/main/java/io/atomix/raft/partition/RaftPartitionGroup.java b/atomix/cluster/src/main/java/io/atomix/raft/partition/RaftPartitionGroup.java
@@ -493,8 +493,9 @@ public Builder withPartitionDistributor(final PartitionDistributor partitionDist
     }
 
     /**
-     * Sets the threshold for preferring snapshot replication. When a follower lags behind by more
-     * than the threshold, the leader prefers sending a snapshot over replicating records.
+     * Sets the threshold for preferring snapshot replication. The unit is <i>number of records</i>
+     * by which a follower may lag behind before the leader starts to prefer replicating snapshots
+     * instead of records.
      *
      * @param preferSnapshotReplicationThreshold the threshold to use
      * @return this builder for chaining

diff --git a/dist/src/main/config/broker.standalone.yaml.template b/dist/src/main/config/broker.standalone.yaml.template
@@ -621,8 +621,8 @@
         # maxQuorumResponseTimeout = 0ms
 
         # Threshold used by the leader to decide between replicating a snapshot or records.
-        # If a follower lags behind by more than the threshold, the leader will prefer replicating
-        # snapshots.
+        # The unit is number of records by which the follower may lag behind before the leader
+        # prefers replicating snapshots instead of records.
         # This setting can also be overridden using the environment variable ZEEBE_BROKER_EXPERIMENTAL_RAFT_PREFERSNAPSHOTREPLICATIONTHRESHOLD.
         # preferSnapshotReplicationThreshold = 100
 

diff --git a/dist/src/main/config/broker.yaml.template b/dist/src/main/config/broker.yaml.template
@@ -559,8 +559,8 @@
         # maxQuorumResponseTimeout = 0ms
 
         # Threshold used by the leader to decide between replicating a snapshot or records.
-        # If a follower lags behind by more than the threshold, the leader will prefer replicating
-        # snapshots.
+        # The unit is number of records by which the follower may lag behind before the leader
+        # prefers replicating snapshots instead of records.
         # This setting can also be overridden using the environment variable ZEEBE_BROKER_EXPERIMENTAL_RAFT_PREFERSNAPSHOTREPLICATIONTHRESHOLD.
         # preferSnapshotReplicationThreshold = 100