Skip to content

Commit

Permalink
Add a note to some tikv configs (#9357) (#9370)
Browse files Browse the repository at this point in the history
  • Loading branch information
ti-chi-bot authored Jun 27, 2022
1 parent 107ca49 commit d0f2f85
Showing 1 changed file with 28 additions and 0 deletions.
28 changes: 28 additions & 0 deletions tikv-configuration-file.md
Original file line number Diff line number Diff line change
Expand Up @@ -432,43 +432,71 @@ Configuration items related to Raftstore

### `raft-base-tick-interval`

> **Note:**
>
> This configuration item cannot be queried via SQL statements but can be configured in the configuration file.
+ The time interval at which the Raft state machine ticks
+ Default value: `"1s"`
+ Minimum value: greater than `0`

### `raft-heartbeat-ticks`

> **Note:**
>
> This configuration item cannot be queried via SQL statements but can be configured in the configuration file.
+ The number of passed ticks when the heartbeat is sent. This means that a heartbeat is sent at the time interval of `raft-base-tick-interval` * `raft-heartbeat-ticks`.
+ Default value: `2`
+ Minimum value: greater than `0`

### `raft-election-timeout-ticks`

> **Note:**
>
> This configuration item cannot be queried via SQL statements but can be configured in the configuration file.
+ The number of passed ticks when Raft election is initiated. This means that if Raft group is missing the leader, a leader election is initiated approximately after the time interval of `raft-base-tick-interval` * `raft-election-timeout-ticks`.
+ Default value: `10`
+ Minimum value: `raft-heartbeat-ticks`

### `raft-min-election-timeout-ticks`

> **Note:**
>
> This configuration item cannot be queried via SQL statements but can be configured in the configuration file.
+ The minimum number of ticks during which the Raft election is initiated. If the number is `0`, the value of `raft-election-timeout-ticks` is used. The value of this parameter must be greater than or equal to `raft-election-timeout-ticks`.
+ Default value: `0`
+ Minimum value: `0`

### `raft-max-election-timeout-ticks`

> **Note:**
>
> This configuration item cannot be queried via SQL statements but can be configured in the configuration file.
+ The maximum number of ticks during which the Raft election is initiated. If the number is `0`, the value of `raft-election-timeout-ticks` * `2` is used.
+ Default value: `0`
+ Minimum value: `0`

### `raft-max-size-per-msg`

> **Note:**
>
> This configuration item cannot be queried via SQL statements but can be configured in the configuration file.
+ The soft limit on the size of a single message packet
+ Default value: `"1MB"`
+ Minimum value: `0`
+ Unit: MB

### `raft-max-inflight-msgs`

> **Note:**
>
> This configuration item cannot be queried via SQL statements but can be configured in the configuration file.
+ The number of Raft logs to be confirmed. If this number is exceeded, log sending slows down.
+ Default value: `256`
+ Minimum value: greater than `0`
Expand Down

0 comments on commit d0f2f85

Please sign in to comment.