Skip to content

Commit c3b294a

Browse files
SzyWilliamSzyWilliam
authored
[IOTDB-6197] Add docs about Ratis snapshot configs (#111)
1 parent 0745a4c commit c3b294a

File tree

2 files changed

+148
-0
lines changed

2 files changed

+148
-0
lines changed

‎src/UserGuide/Master/Reference/Common-Config-Manual.md‎

Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1974,6 +1974,25 @@ Different configuration parameters take effect in the following three ways:
19741974
| Default | 10s |
19751975
| Effective | After restarting system |
19761976

1977+
* ratis\_first\_election\_timeout\_min\_ms
1978+
1979+
| Name | ratis\_first\_election\_timeout\_min\_ms |
1980+
|:------:|:----------------------------------------------------------------|
1981+
| Description | minimal first election timeout for RatisConsensus |
1982+
| Type | int64 |
1983+
| Default | 50 (ms) |
1984+
| Effective | After restarting system |
1985+
1986+
* ratis\_first\_election\_timeout\_max\_ms
1987+
1988+
| Name | ratis\_first\_election\_timeout\_max\_ms |
1989+
|:------:|:----------------------------------------------------------------|
1990+
| Description | maximal first election timeout for RatisConsensus |
1991+
| Type | int64 |
1992+
| Default | 150 (ms) |
1993+
| Effective | After restarting system |
1994+
1995+
19771996
* config\_node\_ratis\_preserve\_logs\_num\_when\_purge
19781997

19791998
| Name | config\_node\_ratis\_preserve\_logs\_num\_when\_purge |
@@ -2001,6 +2020,60 @@ Different configuration parameters take effect in the following three ways:
20012020
| Default | 1000 |
20022021
| Effective | After restarting system |
20032022

2023+
* config\_node\_ratis\_log\_max\_size
2024+
2025+
| Name | config\_node\_ratis\_log\_max\_size |
2026+
|:------:|:----------------------------------------------------------------|
2027+
| Description | Max file size of in-disk Raft Log for config node |
2028+
| Type | int64 |
2029+
| Default | 2147483648 (2GB) |
2030+
| Effective | After restarting system |
2031+
2032+
* schema\_region\_ratis\_log\_max\_size
2033+
2034+
| Name | schema\_region\_ratis\_log\_max\_size |
2035+
|:------:|:----------------------------------------------------------------|
2036+
| Description | Max file size of in-disk Raft Log for schema region |
2037+
| Type | int64 |
2038+
| Default | 2147483648 (2GB) |
2039+
| Effective | After restarting system |
2040+
2041+
* data\_region\_ratis\_log\_max\_size
2042+
2043+
| Name | data\_region\_ratis\_log\_max\_size |
2044+
|:------:|:----------------------------------------------------------------|
2045+
| Description | Max file size of in-disk Raft Log for data region |
2046+
| Type | int64 |
2047+
| Default | 21474836480 (20GB) |
2048+
| Effective | After restarting system |
2049+
2050+
* config\_node\_ratis\_periodic\_snapshot\_interval
2051+
2052+
| Name | config\_node\_ratis\_periodic\_snapshot\_interval |
2053+
|:------:|:----------------------------------------------------------------|
2054+
| Description | duration interval of config-node periodic snapshot |
2055+
| Type | int64 |
2056+
| Default | 86400 (seconds) |
2057+
| Effective | After restarting system |
2058+
2059+
* schema\_region\_ratis\_periodic\_snapshot\_interval
2060+
2061+
| Name | schema\_region\_ratis\_preserve\_logs\_num\_when\_purge |
2062+
|:------:|:----------------------------------------------------------------|
2063+
| Description | duration interval of schema-region periodic snapshot |
2064+
| Type | int64 |
2065+
| Default | 86400 (seconds) |
2066+
| Effective | After restarting system |
2067+
2068+
* data\_region\_ratis\_periodic\_snapshot\_interval
2069+
2070+
| Name | data\_region\_ratis\_preserve\_logs\_num\_when\_purge |
2071+
|:------:|:----------------------------------------------------------------|
2072+
| Description | duration interval of data-region periodic snapshot |
2073+
| Type | int64 |
2074+
| Default | 86400 (seconds) |
2075+
| Effective | After restarting system |
2076+
20042077
### Procedure Configuration
20052078

20062079
* procedure\_core\_worker\_thread\_count

‎src/zh/UserGuide/Master/Reference/Common-Config-Manual.md‎

Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1974,6 +1974,25 @@ IoTDB ConfigNode 和 DataNode 的公共配置参数位于 `conf` 目录下。
19741974
| 默认值 | 10s |
19751975
| 改后生效方式 | 重启生效 |
19761976

1977+
* ratis\_first\_election\_timeout\_min\_ms
1978+
1979+
| 名字 | ratis\_first\_election\_timeout\_min\_ms |
1980+
|:------:|:----------------------------------------------------------------|
1981+
| 描述 | Ratis协议首次选举最小超时时间 |
1982+
| 类型 | int64 |
1983+
| 默认值 | 50 (ms) |
1984+
| 改后生效方式 | 重启生效 |
1985+
1986+
* ratis\_first\_election\_timeout\_max\_ms
1987+
1988+
| 名字 | ratis\_first\_election\_timeout\_max\_ms |
1989+
|:------:|:----------------------------------------------------------------|
1990+
| 描述 | Ratis协议首次选举最大超时时间 |
1991+
| 类型 | int64 |
1992+
| 默认值 | 150 (ms) |
1993+
| 改后生效方式 | 重启生效 |
1994+
1995+
19771996
* config\_node\_ratis\_preserve\_logs\_num\_when\_purge
19781997

19791998
| 名字 | config\_node\_ratis\_preserve\_logs\_num\_when\_purge |
@@ -2001,6 +2020,62 @@ IoTDB ConfigNode 和 DataNode 的公共配置参数位于 `conf` 目录下。
20012020
| 默认值 | 1000 |
20022021
| 改后生效方式 | 重启生效 |
20032022

2023+
* config\_node\_ratis\_log\_max\_size
2024+
2025+
| 名字 | config\_node\_ratis\_log\_max\_size |
2026+
|:------:|:----------------------------------------------------------------|
2027+
| 描述 | config node磁盘Raft Log最大占用空间 |
2028+
| 类型 | int64 |
2029+
| 默认值 | 2147483648 (2GB) |
2030+
| 改后生效方式 | 重启生效 |
2031+
2032+
* schema\_region\_ratis\_log\_max\_size
2033+
2034+
| 名字 | schema\_region\_ratis\_log\_max\_size |
2035+
|:------:|:----------------------------------------------------------------|
2036+
| 描述 | schema region 磁盘Raft Log最大占用空间 |
2037+
| 类型 | int64 |
2038+
| 默认值 | 2147483648 (2GB) |
2039+
| 改后生效方式 | 重启生效 |
2040+
2041+
* data\_region\_ratis\_log\_max\_size
2042+
2043+
| 名字 | data\_region\_ratis\_log\_max\_size |
2044+
|:------:|:----------------------------------------------------------------|
2045+
| 描述 | data region 磁盘Raft Log最大占用空间|
2046+
| 类型 | int64 |
2047+
| 默认值 | 21474836480 (20GB) |
2048+
| 改后生效方式 | 重启生效 |
2049+
2050+
2051+
* config\_node\_ratis\_periodic\_snapshot\_interval
2052+
2053+
| 名字 | config\_node\_ratis\_periodic\_snapshot\_interval |
2054+
|:------:|:----------------------------------------------------------------|
2055+
| 描述 | config node定期snapshot的间隔时间 |
2056+
| 类型 | int64 |
2057+
| 默认值 | 86400 (秒) |
2058+
| 改后生效方式 | 重启生效 |
2059+
2060+
* schema\_region\_ratis\_periodic\_snapshot\_interval
2061+
2062+
| 名字 | schema\_region\_ratis\_preserve\_logs\_num\_when\_purge |
2063+
|:------:|:----------------------------------------------------------------|
2064+
| 描述 | schema region定期snapshot的间隔时间 |
2065+
| 类型 | int64 |
2066+
| 默认值 | 86400 (秒) |
2067+
| 改后生效方式 | 重启生效 |
2068+
2069+
* data\_region\_ratis\_periodic\_snapshot\_interval
2070+
2071+
| 名字 | data\_region\_ratis\_preserve\_logs\_num\_when\_purge |
2072+
|:------:|:----------------------------------------------------------------|
2073+
| 描述 | data region定期snapshot的间隔时间 |
2074+
| 类型 | int64 |
2075+
| 默认值 | 86400 (秒) |
2076+
| 改后生效方式 | 重启生效 |
2077+
2078+
20042079
#### Procedure 配置
20052080

20062081
* procedure\_core\_worker\_thread\_count

0 commit comments

Comments
 (0)