Skip to content

Commit

Permalink
move tikv configure item pd.enable-forwarding to correct place (#16067
Browse files Browse the repository at this point in the history
) (#16107)
  • Loading branch information
ti-chi-bot authored Jan 11, 2024
1 parent e87f3f1 commit ab26be0
Showing 1 changed file with 31 additions and 7 deletions.
38 changes: 31 additions & 7 deletions tikv-configuration-file.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,13 +94,6 @@ This document only describes the parameters that are not included in command-lin
+ If the configuration item is set to a value other than `0`, TiKV keeps at most the number of old log files specified by `max-backups`. For example, if the value is set to `7`, TiKV keeps up to 7 old log files.
+ Default value: `0`

### `pd.enable-forwarding` <span class="version-mark">New in v5.0.0</span>

+ Controls whether the PD client in TiKV forwards requests to the leader via the followers in the case of possible network isolation.
+ Default value: `false`
+ If the environment might have isolated network, enabling this parameter can reduce the window of service unavailability.
+ If you cannot accurately determine whether isolation, network interruption, or downtime has occurred, using this mechanism has the risk of misjudgment and causes reduced availability and performance. If network failure has never occurred, it is not recommended to enable this parameter.

## server

+ Configuration items related to the server.
Expand Down Expand Up @@ -487,6 +480,37 @@ Configuration items related to the I/O rate limiter.
+ Optional value: `"write-only"`
+ Default value: `"write-only"`

## pd

### `enable-forwarding` <span class="version-mark">New in v5.0.0</span>

+ Controls whether the PD client in TiKV forwards requests to the leader via the followers in the case of possible network isolation.
+ Default value: `false`
+ If the environment might have isolated network, enabling this parameter can reduce the window of service unavailability.
+ If you cannot accurately determine whether isolation, network interruption, or downtime has occurred, using this mechanism has the risk of misjudgment and causes reduced availability and performance. If network failure has never occurred, it is not recommended to enable this parameter.

### `endpoints`

+ The endpoints of PD. When multiple endpoints are specified, you need to separate them using commas.
+ Default value: `["127.0.0.1:2379"]`

### `retry-interval`

+ The interval for retrying the PD connection.
+ Default value: `"300ms"`

### `retry-log-every`

+ Specified the frequency at which the PD client skips reporting errors when the client observes errors. For example, when the value is `5`, after the PD client observes errors, the client skips reporting errors every 4 times and reports errors every 5th time.
+ To disable this feature, set the value to `1`.
+ Default value: `10`

### `retry-max-count`

+ The maximum number of times to retry to initialize PD connection
+ To disable the retry, set its value to `0`. To release the limit on the number of retries, set the value to `-1`.
+ Default value: `-1`

## raftstore

Configuration items related to Raftstore.
Expand Down

0 comments on commit ab26be0

Please sign in to comment.