Skip to content

Commit 5a7a3a9

Browse files
authored
tikv: add missing tikv configs (#20566) (#20628)
1 parent 05fb57b commit 5a7a3a9

File tree

1 file changed

+58
-1
lines changed

1 file changed

+58
-1
lines changed

tikv-configuration-file.md

+58-1
Original file line numberDiff line numberDiff line change
@@ -501,6 +501,11 @@ Configuration items related to storage.
501501
> - API V1 and API V2 are different from each other in the storage format. You can enable or disable API V2 directly **only** when TiKV contains only TiDB data. In other scenarios, you need to deploy a new cluster, and migrate data using [RawKV Backup & Restore](https://tikv.org/docs/latest/concepts/explore-tikv-features/backup-restore/).
502502
> - After API V2 is enabled, you **cannot** downgrade the TiKV cluster to a version earlier than v6.1.0. Otherwise, data corruption might occur.
503503
504+
## `txn-status-cache-capacity` <span class="version-mark">New in v7.6.0</span>
505+
506+
+ Sets the capacity of the transaction status cache in TiKV. Do not modify this parameter.
507+
+ Default value: `5120000`
508+
504509
## storage.block-cache
505510

506511
Configuration items related to the sharing of block cache among multiple RocksDB Column Families (CF).
@@ -1053,6 +1058,42 @@ Configuration items related to Raftstore.
10531058
+ Limits the maximum CPU usage rate for TiKV periodic full compaction.
10541059
+ Default value: `0.1`, which means that the maximum CPU usage for periodic compaction processes is 10%.
10551060

1061+
### `follower-read-max-log-gap` <span class="version-mark">New in v7.4.0</span>
1062+
1063+
+ The maximum number of logs a follower is allowed to lag behind when processing read requests. If this limit is exceeded, the read request is rejected.
1064+
+ Default value: `100`
1065+
1066+
### `inspect-cpu-util-thd` <span class="version-mark">New in v7.6.0</span>
1067+
1068+
+ The CPU utilization threshold for determining whether a TiKV node is busy during slow node detection.
1069+
+ Value range: `[0, 1]`
1070+
+ Default value: `0.4`, which means `40%`.
1071+
1072+
### `inspect-kvdb-interval` <span class="version-mark">New in v8.1.2</span>
1073+
1074+
+ The interval and timeout for checking the KV disk during slow node detection in TiKV. If KVDB and RaftDB share the same mount path, this value is overridden by `0` (no detection).
1075+
+ Default value: `2s`
1076+
1077+
### `min-pending-apply-region-count` <span class="version-mark">New in v8.0.0</span>
1078+
1079+
+ The maximum number of Regions in the busy state of applying Raft logs when TiKV starts. Raftstore accepts leader transfers only when the number of such Regions is below this value, reducing availability degradation during rolling restarts.
1080+
+ Default value: `10`
1081+
1082+
### `request-voter-replicated-index-interval` <span class="version-mark">New in v6.6.0</span>
1083+
1084+
+ Controls the interval at which the Witness node periodically retrieves the replicated Raft log position from voter nodes.
1085+
+ Default value: `5m`, which means 5 minutes.
1086+
1087+
### `slow-trend-unsensitive-cause` <span class="version-mark">New in v6.6.0</span>
1088+
1089+
+ When TiKV uses the SlowTrend detection algorithm, this configuration item controls the sensitivity of latency detection. A higher value indicates lower sensitivity.
1090+
+ Default value: `10`
1091+
1092+
### `slow-trend-unsensitive-result` <span class="version-mark">New in v6.6.0</span>
1093+
1094+
+ When TiKV uses the SlowTrend detection algorithm, this configuration item controls the sensitivity of QPS detection. A higher value indicates lower sensitivity.
1095+
+ Default value: `0.5`
1096+
10561097
## coprocessor
10571098

10581099
Configuration items related to Coprocessor.
@@ -1355,6 +1396,11 @@ Configuration items related to RocksDB
13551396
+ `true`: records information about WAL files in the MANIFEST file and verifies the integrity of WAL files during startup.
13561397
+ `false`: does not record information about WAL files in the MANIFEST file and does not verify the integrity of WAL files during startup.
13571398

1399+
### `enable-multi-batch-write` <span class="version-mark">New in v6.2.0</span>
1400+
1401+
+ Controls whether to enable RocksDB write optimization, allowing the contents of WriteBatch to be written concurrently to the memtable, reducing write latency.
1402+
+ Default value: None. However, it is enabled by default unless explicitly set to `false` or if `rocksdb.enable-pipelined-write` or `rocksdb.enable-unordered-write` is enabled.
1403+
13581404
## rocksdb.titan
13591405

13601406
Configuration items related to Titan.
@@ -1386,7 +1432,7 @@ Configuration items related to Titan.
13861432
+ Default value: `4`
13871433
+ Minimum value: `1`
13881434

1389-
## rocksdb.defaultcf | rocksdb.writecf | rocksdb.lockcf
1435+
## rocksdb.defaultcf | rocksdb.writecf | rocksdb.lockcf | rocksdb.raftcf
13901436

13911437
Configuration items related to `rocksdb.defaultcf`, `rocksdb.writecf`, and `rocksdb.lockcf`.
13921438

@@ -1645,6 +1691,11 @@ Configuration items related to `rocksdb.defaultcf`, `rocksdb.writecf`, and `rock
16451691
+ Default value: `"0s"`, meaning that periodic compaction is disabled by default.
16461692
+ Unit: s(second)|h(hour)|d(day)
16471693

1694+
### `max-compactions` <span class="version-mark">New in v6.6.0</span>
1695+
1696+
+ The maximum number of concurrent compaction tasks. The value `0` means no limit.
1697+
+ Default value: `0`
1698+
16481699
## rocksdb.defaultcf.titan
16491700

16501701
> **Note:**
@@ -2014,6 +2065,12 @@ Configuration items related to Raft Engine.
20142065
+ Determines whether to generate empty log files for log recycling in Raft Engine. When it is enabled, Raft Engine will automatically fill a batch of empty log files for log recycling during initialization, making log recycling effective immediately after initialization.
20152066
+ Default value: `false`
20162067

2068+
### `compression-level` <span class="version-mark">New in v7.4.0</span>
2069+
2070+
+ Sets the compression efficiency of the LZ4 algorithm used by Raft Engine when writing Raft log files. A lower value indicates faster compression speed but lower compression ratio.
2071+
+ Range: `[1, 16]`
2072+
+ Default value: `1`
2073+
20172074
## security
20182075

20192076
Configuration items related to security.

0 commit comments

Comments
 (0)