Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add docs for raft-engine log recycling feature. #10258

Merged
merged 6 commits into from
Sep 6, 2022
Merged

Add docs for raft-engine log recycling feature. #10258

Changes from 3 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
ecff587
Add docs for raft-engine log recycling feature.
LykxSassinator Aug 29, 2022
3be2e0e
Remove redundant descriptions.
LykxSassinator Aug 29, 2022
24c8ef1
Refine the docs on `format-version` and `enable-log-recycle` settings.
LykxSassinator Sep 1, 2022
625019b
Refine annoatations on `enable-log-recycle`.
LykxSassinator Sep 5, 2022
f5d6e5d
Tidy annotations.
LykxSassinator Sep 6, 2022
8cbcd70
Refine style of annotations.
LykxSassinator Sep 6, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
21 changes: 21 additions & 0 deletions tikv-configuration-file.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1495,6 +1495,27 @@ Configuration items related to Raft Engine.
+ When this configuration value is not set, 15% of the available system memory is used.
+ Default value: `Total machine memory * 15%`

### `format-version` <span class="version-mark">New in v6.3.0</span>

> **Warning:**
>
> - After `format-version` with `2` is set, you **cannot** downgrade the TiKV cluster to a version earlier than v6.3.0. Otherwise, data corruption might occur.
LykxSassinator marked this conversation as resolved.
Show resolved Hide resolved

+ Specifies the version of log files in Raft Engine.
+ Value Options:
+ `1`: Default log file version for TiKV earlier than v6.3.0. Can be read by TiKV >= v6.1.0.
+ `2`: Supports log recycling. Can be read by TiKV >= v6.3.0.
+ Default value: `2`

### `enable-log-recycle` <span class="version-mark">New in v6.3.0</span>

> **Note:**
>
> - This configuration item is only available for [`format-version`](#format-version-new-in-v630) >= 2.
LykxSassinator marked this conversation as resolved.
Show resolved Hide resolved

+ Determines whether to recycle stale log files in Raft Engine. When it is enabled, logically purged log files will be reserved for recycling. This feature can reduce the long tail on `write` workloads.
LykxSassinator marked this conversation as resolved.
Show resolved Hide resolved
+ Default value: `true`

## security

Configuration items related to security.
Expand Down