This is an automated email from the ASF dual-hosted git repository.
szetszwo pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/ratis.git
The following commit(s) were added to refs/heads/master by this push:
new eab143a57 RATIS-1908. Keep configurations doc updated (#938)
eab143a57 is described below
commit eab143a577210e051c5c284969243fa88f1fef93
Author: William Song <[email protected]>
AuthorDate: Fri Oct 20 12:03:34 2023 -0500
RATIS-1908. Keep configurations doc updated (#938)
---
ratis-docs/src/site/markdown/configurations.md | 31 ++++++++++++++++++++++
.../apache/ratis/server/RaftServerConfigKeys.java | 4 +--
2 files changed, 33 insertions(+), 2 deletions(-)
diff --git a/ratis-docs/src/site/markdown/configurations.md
b/ratis-docs/src/site/markdown/configurations.md
index 0500a053a..51c8d65f6 100644
--- a/ratis-docs/src/site/markdown/configurations.md
+++ b/ratis-docs/src/site/markdown/configurations.md
@@ -199,6 +199,16 @@ treat the peer as caught-up. Increase this number when
write throughput is high.
| **Type** | double, ranging from (0.0,1.0) |
| **Default** | 0.9 |
+### Read After Write - Configurations related to read-after-write-consistency
+
+
+| **Property** |
`raft.server.read.read-after-write-consistent.write-index-cache.expiry-time` |
+|:----------------|:-------------------------------------------------------------------------------|
+| **Description** | expiration time for server's memorized last written index
of a specific client |
+| **Type** | TimeDuration
|
+| **Default** | 60s
|
+
+
### Write - Configurations related to write requests.
@@ -454,6 +464,19 @@ The follower's statemachine is responsible for fetching
and installing snapshot
| **Type** | TimeDuration |
| **Default** | 10ms |
+
+| **Property** | `raft.server.log.appender.retry.policy` |
+|:----------------|:----------------------------------------|
+| **Description** | retry policy under error conditions |
+| **Type** | string |
+| **Default** | 1ms,10, 1s,20, 5s,1000 |
+
+"1ms,10, 1s,20, 5s,1000" means
+The min wait time as 1ms (0 is not allowed) for first 10,
+(5 iteration with 2 times grpc client retry),
+next wait 1sec for next 20 retry (10 iteration with 2 times grpc client)
+further wait for 5sec for max times ((5sec*980)/2 times ~= 40min)
+
--------------------------------------------------------------------------------
### Snapshot - Configurations related to snapshot.
@@ -464,6 +487,14 @@ The follower's statemachine is responsible for fetching
and installing snapshot
| **Type** | boolean
|
| **Default** | false, by default let the state machine to decide when to
do checkpoint |
+
+| **Property** | `raft.server.snapshot.trigger-when-stop.enabled` |
+|:----------------|:---------------------------------------------------|
+| **Description** | whether to trigger snapshot when raft server stops |
+| **Type** | boolean |
+| **Default** | true |
+
+
| **Property** | `raft.server.snapshot.creation.gap` |
|:----------------|:-----------------------------------------------------|
| **Description** | the log index gap between to two snapshot creations. |
diff --git
a/ratis-server-api/src/main/java/org/apache/ratis/server/RaftServerConfigKeys.java
b/ratis-server-api/src/main/java/org/apache/ratis/server/RaftServerConfigKeys.java
index eb367a982..b59f25588 100644
---
a/ratis-server-api/src/main/java/org/apache/ratis/server/RaftServerConfigKeys.java
+++
b/ratis-server-api/src/main/java/org/apache/ratis/server/RaftServerConfigKeys.java
@@ -215,9 +215,9 @@ public interface RaftServerConfigKeys {
}
interface ReadAfterWriteConsistent {
- String PREFIX = RaftServerConfigKeys.PREFIX +
".read-after-write-consistent";
+ String PREFIX = Read.PREFIX + ".read-after-write-consistent";
- String WRITE_INDEX_CACHE_EXPIRY_TIME_KEY = PREFIX +
"write-index-cache.expiry-time";
+ String WRITE_INDEX_CACHE_EXPIRY_TIME_KEY = PREFIX +
".write-index-cache.expiry-time";
/** Must be larger than {@link Read#TIMEOUT_DEFAULT}. */
TimeDuration WRITE_INDEX_CACHE_EXPIRY_TIME_DEFAULT =
TimeDuration.valueOf(60, TimeUnit.SECONDS);
