Add description related to compaction rate limit (#4497)

* Add description related to compaction rate limit Signed-off-by: tabokie <xy.tao@outlook.com> * Update tikv-configuration-file.md Signed-off-by: Xinye Tao <xy.tao@outlook.com> Co-authored-by: TomShawn <41534398+TomShawn@users.noreply.github.com> * Update tikv-control.md Signed-off-by: Xinye Tao <xy.tao@outlook.com> Co-authored-by: TomShawn <41534398+TomShawn@users.noreply.github.com> * Update tikv-configuration-file.md Co-authored-by: TomShawn <41534398+TomShawn@users.noreply.github.com>
pingcap · Dec 30, 2020 · 779e073 · 779e073
1 parent 0e09e83
commit 779e073
Show file tree

Hide file tree

Showing 2 changed files with 24 additions and 2 deletions.
diff --git a/tikv-configuration-file.md b/tikv-configuration-file.md
@@ -750,9 +750,9 @@ Configuration items related to RocksDB
 + Minimum value: `1`
 + Maximum value: `3`
 
-### `rate-limiter-auto-tuned`
+### `rate-limiter-auto-tuned` <span class="version-mark">New in v5.0.0-rc</span>
 
-+ Determines whether to automatically optimize the configuration of the RocksDB's compaction rate limiter
++ Determines whether to automatically optimize the configuration of the RocksDB's compaction rate limiter based on recent workload. When this configuration is enabled, compaction pending bytes will be slightly higher than usual.
 + Default value: `true`
 
 ### `enable-pipelined-write`

diff --git a/tikv-control.md b/tikv-control.md
@@ -376,6 +376,28 @@ tikv-ctl --host ip:port modify-tikv-config -n raftstore.sync-log -v false
 success
 ```
 
+When the compaction rate limit causes accumulated compaction pending bytes, disable the `rate-limiter-auto-tuned` mode or set a higher limit for the compaction flow:
+
+{{< copyable "shell-regular" >}}
+
+```shell
+tikv-ctl --host ip:port modify-tikv-config -n rocksdb.rate-limiter-auto-tuned -v false
+```
+
+```
+success
+```
+
+{{< copyable "shell-regular" >}}
+
+```shell
+tikv-ctl --host ip:port modify-tikv-config -n rocksdb.rate-bytes-per-sec -v "1GB"
+```
+
+```
+success
+```
+
 ### Force Region to recover the service from failure of multiple replicas
 
 Use the `unsafe-recover remove-fail-stores` command to remove the failed machines from the peer list of Regions. Then after you restart TiKV, these Regions can continue to provide services using the other healthy replicas. This command is usually used in circumstances where multiple TiKV stores are damaged or deleted.