From 438735b3b293fd25fcf89c34dea1838a05b51e93 Mon Sep 17 00:00:00 2001 From: szywilliam Date: Mon, 30 Oct 2023 11:04:35 +0800 Subject: [PATCH] add docs for all ratis configs --- .../Master/Reference/Common-Config-Manual.md | 46 ++++++++++++++++++ .../Master/Reference/Common-Config-Manual.md | 47 +++++++++++++++++++ 2 files changed, 93 insertions(+) diff --git a/src/UserGuide/Master/Reference/Common-Config-Manual.md b/src/UserGuide/Master/Reference/Common-Config-Manual.md index 2e5da885..7e4c57ee 100644 --- a/src/UserGuide/Master/Reference/Common-Config-Manual.md +++ b/src/UserGuide/Master/Reference/Common-Config-Manual.md @@ -1845,6 +1845,25 @@ Different configuration parameters take effect in the following three ways: | Default | 10s | | Effective | After restarting system | +* ratis\_first\_election\_timeout\_min\_ms + +| Name | ratis\_first\_election\_timeout\_min\_ms | +|:------:|:----------------------------------------------------------------| +| Description | minimal first election timeout for RatisConsensus | +| Type | int64 | +| Default | 50 (ms) | +| Effective | After restarting system | + +* ratis\_first\_election\_timeout\_max\_ms + +| Name | ratis\_first\_election\_timeout\_max\_ms | +|:------:|:----------------------------------------------------------------| +| Description | maximal first election timeout for RatisConsensus | +| Type | int64 | +| Default | 150 (ms) | +| Effective | After restarting system | + + * config\_node\_ratis\_preserve\_logs\_num\_when\_purge | Name | config\_node\_ratis\_preserve\_logs\_num\_when\_purge | @@ -1872,6 +1891,33 @@ Different configuration parameters take effect in the following three ways: | Default | 1000 | | Effective | After restarting system | +* config\_node\_ratis\_log\_max\_size + +| Name | config\_node\_ratis\_log\_max\_size | +|:------:|:----------------------------------------------------------------| +| Description | Max file size of in-disk Raft Log for config node | +| Type | int64 | +| Default | 2147483648 (2GB) | +| Effective | After restarting system | + +* schema\_region\_ratis\_log\_max\_size + +| Name | schema\_region\_ratis\_log\_max\_size | +|:------:|:----------------------------------------------------------------| +| Description | Max file size of in-disk Raft Log for schema region | +| Type | int64 | +| Default | 2147483648 (2GB) | +| Effective | After restarting system | + +* data\_region\_ratis\_log\_max\_size + +| Name | data\_region\_ratis\_log\_max\_size | +|:------:|:----------------------------------------------------------------| +| Description | Max file size of in-disk Raft Log for data region | +| Type | int64 | +| Default | 21474836480 (20GB) | +| Effective | After restarting system | + * config\_node\_ratis\_periodic\_snapshot\_interval | Name | config\_node\_ratis\_periodic\_snapshot\_interval | diff --git a/src/zh/UserGuide/Master/Reference/Common-Config-Manual.md b/src/zh/UserGuide/Master/Reference/Common-Config-Manual.md index 09860b08..59e74947 100644 --- a/src/zh/UserGuide/Master/Reference/Common-Config-Manual.md +++ b/src/zh/UserGuide/Master/Reference/Common-Config-Manual.md @@ -1867,6 +1867,25 @@ IoTDB ConfigNode 和 DataNode 的公共配置参数位于 `conf` 目录下。 | 默认值 | 10s | | 改后生效方式 | 重启生效 | +* ratis\_first\_election\_timeout\_min\_ms + +| Name | ratis\_first\_election\_timeout\_min\_ms | +|:------:|:----------------------------------------------------------------| +| 描述 | Ratis协议首次选举最小超时时间 | +| 类型 | int64 | +| 默认值 | 50 (ms) | +| 改后生效方式 | 重启生效 | + +* ratis\_first\_election\_timeout\_max\_ms + +| Name | ratis\_first\_election\_timeout\_max\_ms | +|:------:|:----------------------------------------------------------------| +| 描述 | Ratis协议首次选举最大超时时间 | +| 类型 | int64 | +| 默认值 | 150 (ms) | +| 改后生效方式 | 重启生效 | + + * config\_node\_ratis\_preserve\_logs\_num\_when\_purge | 名字 | config\_node\_ratis\_preserve\_logs\_num\_when\_purge | @@ -1894,6 +1913,34 @@ IoTDB ConfigNode 和 DataNode 的公共配置参数位于 `conf` 目录下。 | 默认值 | 1000 | | 改后生效方式 | 重启生效 | +* config\_node\_ratis\_log\_max\_size + +| Name | config\_node\_ratis\_log\_max\_size | +|:------:|:----------------------------------------------------------------| +| 描述 | config node磁盘Raft Log最大占用空间 | +| 类型 | int64 | +| 默认值 | 2147483648 (2GB) | +| 改后生效方式 | 重启生效 | + +* schema\_region\_ratis\_log\_max\_size + +| Name | schema\_region\_ratis\_log\_max\_size | +|:------:|:----------------------------------------------------------------| +| 描述 | schema region 磁盘Raft Log最大占用空间 | +| 类型 | int64 | +| 默认值 | 2147483648 (2GB) | +| 改后生效方式 | 重启生效 | + +* data\_region\_ratis\_log\_max\_size + +| Name | data\_region\_ratis\_log\_max\_size | +|:------:|:----------------------------------------------------------------| +| 描述 | data region 磁盘Raft Log最大占用空间| +| 类型 | int64 | +| 默认值 | 21474836480 (20GB) | +| 改后生效方式 | 重启生效 | + + * config\_node\_ratis\_periodic\_snapshot\_interval | 名字 | config\_node\_ratis\_periodic\_snapshot\_interval |