add warnings for consistency check (pingcap#9526)

shawn0915 · May 18, 2022 · 5ba363f · 5ba363f
1 parent 3938c22
commit 5ba363f
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 1 deletion.
diff --git a/dynamic-config.md b/dynamic-config.md
@@ -147,7 +147,7 @@ show warnings;
 | raftstore.max-leader-missing-duration | 允许副本处于无主状态的最长时间，超过将会向 PD 校验自己是否已经被删除 |
 | raftstore.abnormal-leader-missing-duration | 允许副本处于无主状态的时间，超过将视为异常，标记在 metrics 和日志中 |
 | raftstore.peer-stale-state-check-interval | 触发检验副本是否处于无主状态的时间间隔 |
-| raftstore.consistency-check-interval | 触发一致性检查的时间间隔 |
+| raftstore.consistency-check-interval | 触发一致性检查的时间间隔（不建议使用该配置项，因为与 TiDB GC 操作不兼容）|
 | raftstore.raft-store-max-leader-lease | Region 主可信任期的最长时间 |
 | raftstore.merge-check-tick-interval | 触发 Merge 完成检查的时间间隔 |
 | raftstore.cleanup-import-sst-interval | 触发检查过期 SST 文件的时间间隔 |

diff --git a/tikv-configuration-file.md b/tikv-configuration-file.md
@@ -713,6 +713,10 @@ raftstore 相关的配置项。
 
 ### `consistency-check-interval`
 
+> **警告：**
+>
+> 开启一致性检查对集群性能有影响，并且和 TiDB GC 操作不兼容，不建议在生产环境中使用。
+
 + 触发一致性检查的时间间隔，0 表示不启用。
 + 默认值：0s
 + 最小值：0

diff --git a/tikv-control.md b/tikv-control.md
@@ -373,6 +373,7 @@ DebugClient::check_region_consistency: RpcFailure(RpcStatus { status: Unknown, d
 
 > **注意：**
 >
+> - 目前 consistency-check 与 TiDB GC 操作不兼容，存在误报错误的可能，因此不建议使用该命令。
 > - **该命令只支持远程模式**。
 > - 即使该命令返回了成功信息，也需要检查是否有 TiKV panic 了。因为该命令只是向 Leader 请求进行一致性检查，但整个检查流程是否成功并不能在客户端知道。