From 3dd623203a646126c471e26554f96362578e36d8 Mon Sep 17 00:00:00 2001 From: nolouch Date: Fri, 16 Sep 2022 14:12:54 +0800 Subject: [PATCH 01/19] pd-ctl: add store label and restore store command documents Signed-off-by: nolouch --- develop/dev-guide-use-follower-read.md | 12 ++++---- pd-control.md | 41 ++++++++++++++++++++++---- 2 files changed, 42 insertions(+), 11 deletions(-) diff --git a/develop/dev-guide-use-follower-read.md b/develop/dev-guide-use-follower-read.md index 0dd85851a446..1163d29e1708 100644 --- a/develop/dev-guide-use-follower-read.md +++ b/develop/dev-guide-use-follower-read.md @@ -1,12 +1,12 @@ --- -title: Follower Read -summary: 使用 Follower Read 在特定情况下加速查询。 +title: Replicas Read - Follower/Leader Read +summary: TiDB 提供多种使用 Follower Read 在特定情况下加速查询, 选择特定副本进行读(Replicas Read). aliases: ['/zh/tidb/dev/use-follower-read'] --- -# Follower Read +# Replicas Read -本章将介绍使用 Follower Read 在特定情况下加速查询的方法。 +本章将介绍 TiDB 读取数据的方式，并且介绍如何切换 Leader/ Follower Read, 在特定情况下加速查询的方法。 ## 简介 @@ -14,7 +14,7 @@ aliases: ['/zh/tidb/dev/use-follower-read'] 默认情况下，TiDB 只会在同一个 Region 的 leader 上读写数据。当系统中存在读取热点 Region 导致 leader 资源紧张成为整个系统读取瓶颈时，启用 Follower Read 功能可明显降低 leader 的负担，并且通过在多个 follower 之间均衡负载，显著地提升整体系统的吞吐能力。 -## 何时使用 +## 何时使用 Follower Read 你可以在 [TiDB Dashboard 流量可视化页面](/dashboard/dashboard-key-visualizer.md)当中通过可视化的方法分析你的应用程序是否存在热点 Region。你可以通过将「指标选择框」选择到 `Read (bytes)` 或 `Read (keys)` 查看是否存在读取热点 Region。 @@ -22,6 +22,8 @@ aliases: ['/zh/tidb/dev/use-follower-read'] 如果读取热点的确无法避免或者改动的成本很大，你可以尝试通过 Follower Read 功能将读取请求更好的负载均衡到 follower region。 +Follower Read 默认情况下是保证强一致性的，因此默认情况下其实是 Follower Strong Read, Follower Storng Read 会产生 Follower 和 Leader 之间的通信校验开销，为了减少与 Leader 的通信，Follower Strong Read 更适合大查询的场景, 即查询读取数据的耗时远远大于 rpc 通信时间。 + ## 开启 Follower Read diff --git a/pd-control.md b/pd-control.md index e245eeb3c129..cfd7acd2f75b 100644 --- a/pd-control.md +++ b/pd-control.md @@ -1232,6 +1232,8 @@ scheduler config balance-hot-region-scheduler // 显示 balance-hot-region 调 ### `store [delete | cancel-delete | label | weight | remove-tombstone | limit ] [--jq=""]` +#### store 查询 + 用于显示 store 信息或者删除指定 store。使用 jq 格式化输出请参考 [jq 格式化 json 输出示例](#jq-格式化-json-输出示例)。示例如下。 显示所有 store 信息： @@ -1261,12 +1263,14 @@ store 1 ...... ``` +### store 下线 + 下线 store id 为 1 的 store： {{< copyable "" >}} ```bash -store delete 1 +store delete 1 // 下线一台 store ``` 撤销已使用 store delete 下线并处于 Offline 状态的 store。撤销后，该 store 会从 Offline 状态变为 Up 状态。注意，该命令无法使 Tombstone 状态的 store 变回 Up 状态。以下示例撤销已使用 store delete 下线的 store，其 store id 为 1： @@ -1274,27 +1278,46 @@ store delete 1 {{< copyable "" >}} ```bash -store cancel-delete 1 +>> store cancel-delete 1 // 取消下线 +>> store remove-tombstone // 删除所有 tombstone 状态的 store ``` > **注意：** > > 若下线过程中切换了 PD leader，需要手动修改 store limit。 +#### store label 命令 + 设置 store id 为 1 的 store 的键为 "zone" 的 label 的值为 "cn"： {{< copyable "" >}} ```bash -store label 1 zone cn +store label 1 zone=cn ``` -清除 store id 为 1 的 label： +更新 store id 为 1 的 label，并添加一个新的 label： {{< copyable "" >}} ```bash -store label 1 --force +store label 1 zone=us disk=hdd +``` + +重写 store id 为 1 的所有 label： + +{{< copyable "" >}} + +```bash +store label 1 region=us-est-1 zone=az1 disk=ssd --rewrite +``` + +删除指定 store 的对应 label： + +{{< copyable "" >}} + +```bash +store label 1 disk --delete ``` > **注意：** @@ -1302,6 +1325,8 @@ store label 1 --force > - store 的 label 更新方法使用的是合并策略。如果修改了 TiKV 配置文件中的 store label，进程重启之后，PD 会将自身存储的 store label 与其进行合并更新，并持久化合并后的结果。 > - 如果希望使用 TiUP 统一管理 store label 的话，可以在集群重启前，使用 PD Control 的 `store label --force` 命令将 PD 存储的 store label 清空。 +#### store weight 命令 + 设置 store id 为 1 的 store 的 leader weight 为 5，Region weight 为 10： {{< copyable "" >}} @@ -1312,8 +1337,12 @@ store weight 1 5 10 {{< copyable "" >}} +### store limit 命令 + +详细解释：[store limit](/configure-store-limit.md) + ```bash ->> store remove-tombstone // 删除所有 tombstone 状态的 store + >> store limit // 显示所有 store 添加和删除 peer 的速度上限 >> store limit add-peer // 显示所有 store 添加 peer 的速度上限 >> store limit remove-peer // 显示所有 store 删除 peer 的速度上限 From 22147a0b1412252fc3b87f26b1f35265d3713501 Mon Sep 17 00:00:00 2001 From: nolouch Date: Fri, 16 Sep 2022 14:17:44 +0800 Subject: [PATCH 02/19] revert non relative Signed-off-by: nolouch --- develop/dev-guide-use-follower-read.md | 12 +++++------- pd-control.md | 5 ++--- 2 files changed, 7 insertions(+), 10 deletions(-) diff --git a/develop/dev-guide-use-follower-read.md b/develop/dev-guide-use-follower-read.md index 1163d29e1708..0dd85851a446 100644 --- a/develop/dev-guide-use-follower-read.md +++ b/develop/dev-guide-use-follower-read.md @@ -1,12 +1,12 @@ --- -title: Replicas Read - Follower/Leader Read -summary: TiDB 提供多种使用 Follower Read 在特定情况下加速查询, 选择特定副本进行读(Replicas Read). +title: Follower Read +summary: 使用 Follower Read 在特定情况下加速查询。 aliases: ['/zh/tidb/dev/use-follower-read'] --- -# Replicas Read +# Follower Read -本章将介绍 TiDB 读取数据的方式，并且介绍如何切换 Leader/ Follower Read, 在特定情况下加速查询的方法。 +本章将介绍使用 Follower Read 在特定情况下加速查询的方法。 ## 简介 @@ -14,7 +14,7 @@ aliases: ['/zh/tidb/dev/use-follower-read'] 默认情况下，TiDB 只会在同一个 Region 的 leader 上读写数据。当系统中存在读取热点 Region 导致 leader 资源紧张成为整个系统读取瓶颈时，启用 Follower Read 功能可明显降低 leader 的负担，并且通过在多个 follower 之间均衡负载，显著地提升整体系统的吞吐能力。 -## 何时使用 Follower Read +## 何时使用 你可以在 [TiDB Dashboard 流量可视化页面](/dashboard/dashboard-key-visualizer.md)当中通过可视化的方法分析你的应用程序是否存在热点 Region。你可以通过将「指标选择框」选择到 `Read (bytes)` 或 `Read (keys)` 查看是否存在读取热点 Region。 @@ -22,8 +22,6 @@ aliases: ['/zh/tidb/dev/use-follower-read'] 如果读取热点的确无法避免或者改动的成本很大，你可以尝试通过 Follower Read 功能将读取请求更好的负载均衡到 follower region。 -Follower Read 默认情况下是保证强一致性的，因此默认情况下其实是 Follower Strong Read, Follower Storng Read 会产生 Follower 和 Leader 之间的通信校验开销，为了减少与 Leader 的通信，Follower Strong Read 更适合大查询的场景, 即查询读取数据的耗时远远大于 rpc 通信时间。 - ## 开启 Follower Read diff --git a/pd-control.md b/pd-control.md index e15deb062323..69f716c485cd 100644 --- a/pd-control.md +++ b/pd-control.md @@ -1278,7 +1278,7 @@ store 1 ...... ``` -### store 下线 +#### store 下线 下线 store id 为 1 的 store： @@ -1352,12 +1352,11 @@ store weight 1 5 10 {{< copyable "" >}} -### store limit 命令 +#### store limit 命令 详细解释：[store limit](/configure-store-limit.md) ```bash - >> store limit // 显示所有 store 添加和删除 peer 的速度上限 >> store limit add-peer // 显示所有 store 添加 peer 的速度上限 >> store limit remove-peer // 显示所有 store 删除 peer 的速度上限 From 9c709d338b301a54fac8579883f860a93c40d5ac Mon Sep 17 00:00:00 2001 From: nolouch Date: Fri, 16 Sep 2022 15:43:10 +0800 Subject: [PATCH 03/19] address comments Signed-off-by: nolouch --- pd-control.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/pd-control.md b/pd-control.md index 69f716c485cd..96ab7da90e1d 100644 --- a/pd-control.md +++ b/pd-control.md @@ -1303,7 +1303,7 @@ store delete 1 // 下线一台 store #### store label 命令 -设置 store id 为 1 的 store 的键为 "zone" 的 label 的值为 "cn"： +添加 label，为 store id 为 1 的 store 添加键为 "zone" 的 label 的值为 "cn" 得 label： {{< copyable "" >}} @@ -1311,20 +1311,20 @@ store delete 1 // 下线一台 store store label 1 zone=cn ``` -更新 store id 为 1 的 label，并添加一个新的 label： +更新 store id 为 1 的 label： {{< copyable "" >}} ```bash -store label 1 zone=us disk=hdd +store label 1 zone=us ``` -重写 store id 为 1 的所有 label： +重写 store id 为 1 的所有 label, 之前有的 label 会被覆盖： {{< copyable "" >}} ```bash -store label 1 region=us-est-1 zone=az1 disk=ssd --rewrite +store label 1 region=us-est-1 disk=ssd --rewrite ``` 删除指定 store 的对应 label： From be1ddda353a7f0503f01d042b880d0c7d0cac70b Mon Sep 17 00:00:00 2001 From: ShuNing Date: Sun, 18 Sep 2022 17:18:45 +0800 Subject: [PATCH 04/19] Update pd-control.md Co-authored-by: Aolin --- pd-control.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/pd-control.md b/pd-control.md index 96ab7da90e1d..e1049adafca7 100644 --- a/pd-control.md +++ b/pd-control.md @@ -1303,7 +1303,9 @@ store delete 1 // 下线一台 store #### store label 命令 -添加 label，为 store id 为 1 的 store 添加键为 "zone" 的 label 的值为 "cn" 得 label： +`store label` 用于管理 store label。 + +为 store id 为 1 的 store 添加键为 `"zone"` 的值为 `"cn"` 的 label： {{< copyable "" >}} From d3d630b230f07be3b1029624f807929f820ac28d Mon Sep 17 00:00:00 2001 From: ShuNing Date: Sun, 18 Sep 2022 17:18:57 +0800 Subject: [PATCH 05/19] Update pd-control.md Co-authored-by: Aolin --- pd-control.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/pd-control.md b/pd-control.md index e1049adafca7..80b38a6eab74 100644 --- a/pd-control.md +++ b/pd-control.md @@ -1247,11 +1247,11 @@ scheduler config balance-hot-region-scheduler // 显示 balance-hot-region 调 ### `store [delete | cancel-delete | label | weight | remove-tombstone | limit ] [--jq=""]` -#### store 查询 +使用 jq 格式化输出请参考 [jq 格式化 json 输出示例](#jq-格式化-json-输出示例)。 -用于显示 store 信息或者删除指定 store。使用 jq 格式化输出请参考 [jq 格式化 json 输出示例](#jq-格式化-json-输出示例)。示例如下。 +#### 查询 store -显示所有 store 信息： +通过 `store` 显示所有 store 信息： {{< copyable "" >}} From d9785a2a649ca8bc461243ba6ff317273f6aad12 Mon Sep 17 00:00:00 2001 From: ShuNing Date: Sun, 18 Sep 2022 17:19:04 +0800 Subject: [PATCH 06/19] Update pd-control.md Co-authored-by: Aolin --- pd-control.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pd-control.md b/pd-control.md index 80b38a6eab74..cb3527b83dce 100644 --- a/pd-control.md +++ b/pd-control.md @@ -1288,7 +1288,7 @@ store 1 store delete 1 // 下线一台 store ``` -撤销已使用 store delete 下线并处于 Offline 状态的 store。撤销后，该 store 会从 Offline 状态变为 Up 状态。注意，该命令无法使 Tombstone 状态的 store 变回 Up 状态。以下示例撤销已使用 store delete 下线的 store，其 store id 为 1： +撤销已使用 `store delete` 下线并处于 Offline 状态的 store。撤销后，该 store 会从 Offline 状态变为 Up 状态。注意，该命令无法使 Tombstone 状态的 store 变回 Up 状态。以下示例撤销已使用 `store delete` 下线的 store id 为 1 的 store，并删除所有 Tombstone 状态的 store： {{< copyable "" >}} From 87fae401988ef9b9929c236390fe0235d1c80a44 Mon Sep 17 00:00:00 2001 From: ShuNing Date: Sun, 18 Sep 2022 17:19:09 +0800 Subject: [PATCH 07/19] Update pd-control.md Co-authored-by: Aolin --- pd-control.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pd-control.md b/pd-control.md index cb3527b83dce..e93e125d19cd 100644 --- a/pd-control.md +++ b/pd-control.md @@ -1356,7 +1356,7 @@ store weight 1 5 10 #### store limit 命令 -详细解释：[store limit](/configure-store-limit.md) +关于 `store limit` 的原理和使用方法，请参考 [`store limit`](/configure-store-limit.md)。 ```bash >> store limit // 显示所有 store 添加和删除 peer 的速度上限 From 4c2d968cf3fcf5d7e9162d6e0b8e691391aac31c Mon Sep 17 00:00:00 2001 From: ShuNing Date: Mon, 19 Sep 2022 13:50:10 +0800 Subject: [PATCH 08/19] Update pd-control.md Co-authored-by: Aolin --- pd-control.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pd-control.md b/pd-control.md index e93e125d19cd..919f92751f0c 100644 --- a/pd-control.md +++ b/pd-control.md @@ -1321,7 +1321,7 @@ store label 1 zone=cn store label 1 zone=us ``` -重写 store id 为 1 的所有 label, 之前有的 label 会被覆盖： +通过 `--rewrite` 重写 store id 为 1 的所有 label，之前有的 label 会被覆盖： {{< copyable "" >}} From 733e8efab054c365d8c5582a195952db9162b2da Mon Sep 17 00:00:00 2001 From: ShuNing Date: Mon, 19 Sep 2022 13:50:21 +0800 Subject: [PATCH 09/19] Update pd-control.md Co-authored-by: Aolin --- pd-control.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pd-control.md b/pd-control.md index 919f92751f0c..3c473140aff9 100644 --- a/pd-control.md +++ b/pd-control.md @@ -1285,7 +1285,7 @@ store 1 {{< copyable "" >}} ```bash -store delete 1 // 下线一台 store +store delete 1 ``` 撤销已使用 `store delete` 下线并处于 Offline 状态的 store。撤销后，该 store 会从 Offline 状态变为 Up 状态。注意，该命令无法使 Tombstone 状态的 store 变回 Up 状态。以下示例撤销已使用 `store delete` 下线的 store id 为 1 的 store，并删除所有 Tombstone 状态的 store： From c586547df4f9ff0a685325b7bf26838bd5fbedc8 Mon Sep 17 00:00:00 2001 From: ShuNing Date: Mon, 19 Sep 2022 13:50:29 +0800 Subject: [PATCH 10/19] Update pd-control.md Co-authored-by: Aolin --- pd-control.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pd-control.md b/pd-control.md index 3c473140aff9..61dd7f7348ce 100644 --- a/pd-control.md +++ b/pd-control.md @@ -1278,7 +1278,7 @@ store 1 ...... ``` -#### store 下线 +#### 下线 store 下线 store id 为 1 的 store： From 2280f2cd862b1ceea9f6d0c079889c700ea72b16 Mon Sep 17 00:00:00 2001 From: ShuNing Date: Mon, 19 Sep 2022 13:51:15 +0800 Subject: [PATCH 11/19] Update pd-control.md Co-authored-by: Ran --- pd-control.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pd-control.md b/pd-control.md index 61dd7f7348ce..2e00c0705300 100644 --- a/pd-control.md +++ b/pd-control.md @@ -1301,7 +1301,7 @@ store delete 1 > > 若下线过程中切换了 PD leader，需要手动修改 store limit。 -#### store label 命令 +#### 管理 store label `store label` 用于管理 store label。 From 3a7365629e303e48837bc7ed9bcea5915d25b485 Mon Sep 17 00:00:00 2001 From: ShuNing Date: Mon, 19 Sep 2022 13:51:21 +0800 Subject: [PATCH 12/19] Update pd-control.md Co-authored-by: Ran --- pd-control.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pd-control.md b/pd-control.md index 2e00c0705300..aa59571e2d18 100644 --- a/pd-control.md +++ b/pd-control.md @@ -1303,7 +1303,7 @@ store delete 1 #### 管理 store label -`store label` 用于管理 store label。 +`store label` 命令用于管理 store label。 为 store id 为 1 的 store 添加键为 `"zone"` 的值为 `"cn"` 的 label： From 16ac837cda54cba73b2c4ab7ae0d295d3e54389c Mon Sep 17 00:00:00 2001 From: ShuNing Date: Mon, 19 Sep 2022 13:52:06 +0800 Subject: [PATCH 13/19] Update pd-control.md Co-authored-by: Ran --- pd-control.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pd-control.md b/pd-control.md index aa59571e2d18..ffaee60e3d4f 100644 --- a/pd-control.md +++ b/pd-control.md @@ -1288,7 +1288,7 @@ store 1 store delete 1 ``` -撤销已使用 `store delete` 下线并处于 Offline 状态的 store。撤销后，该 store 会从 Offline 状态变为 Up 状态。注意，该命令无法使 Tombstone 状态的 store 变回 Up 状态。以下示例撤销已使用 `store delete` 下线的 store id 为 1 的 store，并删除所有 Tombstone 状态的 store： +你可以撤销已使用 `store delete` 下线并处于 Offline 状态的 store。撤销后，该 store 会从 Offline 状态变为 Up 状态。注意，该命令无法使 Tombstone 状态的 store 变回 Up 状态。以下示例撤销已使用 `store delete` 下线的 store id 为 1 的 store，并删除所有 Tombstone 状态的 store： {{< copyable "" >}} From 8d9d5401591f5d1fb5d4ccb4ba0e8b0901bd38da Mon Sep 17 00:00:00 2001 From: ShuNing Date: Mon, 19 Sep 2022 13:52:14 +0800 Subject: [PATCH 14/19] Update pd-control.md Co-authored-by: Aolin --- pd-control.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/pd-control.md b/pd-control.md index ffaee60e3d4f..0266a6ab0671 100644 --- a/pd-control.md +++ b/pd-control.md @@ -1293,8 +1293,8 @@ store delete 1 {{< copyable "" >}} ```bash ->> store cancel-delete 1 // 取消下线 ->> store remove-tombstone // 删除所有 tombstone 状态的 store +store cancel-delete 1 // 取消下线 +store remove-tombstone // 删除所有 Tombstone 状态的 store ``` > **注意：** From d837c41a7ba3c52b7158bc83310e80ef15b93fff Mon Sep 17 00:00:00 2001 From: Aolin Date: Mon, 19 Sep 2022 15:01:29 +0800 Subject: [PATCH 15/19] Apply suggestions from code review --- pd-control.md | 3 --- 1 file changed, 3 deletions(-) diff --git a/pd-control.md b/pd-control.md index 0266a6ab0671..f20325d78252 100644 --- a/pd-control.md +++ b/pd-control.md @@ -1351,9 +1351,6 @@ store label 1 disk --delete ```bash store weight 1 5 10 ``` - -{{< copyable "" >}} - #### store limit 命令 关于 `store limit` 的原理和使用方法，请参考 [`store limit`](/configure-store-limit.md)。 From e3da87480c62408d8d8b25649d2f77abb7c8065a Mon Sep 17 00:00:00 2001 From: Aolin Date: Mon, 19 Sep 2022 15:01:44 +0800 Subject: [PATCH 16/19] Apply suggestions from code review --- pd-control.md | 1 + 1 file changed, 1 insertion(+) diff --git a/pd-control.md b/pd-control.md index f20325d78252..912d1823f0f7 100644 --- a/pd-control.md +++ b/pd-control.md @@ -1351,6 +1351,7 @@ store label 1 disk --delete ```bash store weight 1 5 10 ``` + #### store limit 命令 关于 `store limit` 的原理和使用方法，请参考 [`store limit`](/configure-store-limit.md)。 From 0c8e96883e94c434789ff0ecc417179ad5a7aa45 Mon Sep 17 00:00:00 2001 From: Aolin Date: Mon, 19 Sep 2022 15:04:15 +0800 Subject: [PATCH 17/19] Apply suggestions from code review --- pd-control.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/pd-control.md b/pd-control.md index 912d1823f0f7..ee90e6d07661 100644 --- a/pd-control.md +++ b/pd-control.md @@ -1342,7 +1342,7 @@ store label 1 disk --delete > - store 的 label 更新方法使用的是合并策略。如果修改了 TiKV 配置文件中的 store label，进程重启之后，PD 会将自身存储的 store label 与其进行合并更新，并持久化合并后的结果。 > - 如果希望使用 TiUP 统一管理 store label 的话，可以在集群重启前，使用 PD Control 的 `store label --force` 命令将 PD 存储的 store label 清空。 -#### store weight 命令 +#### `store weight` 命令 设置 store id 为 1 的 store 的 leader weight 为 5，Region weight 为 10： @@ -1352,7 +1352,7 @@ store label 1 disk --delete store weight 1 5 10 ``` -#### store limit 命令 +#### `store limit` 命令 关于 `store limit` 的原理和使用方法，请参考 [`store limit`](/configure-store-limit.md)。 From b9103365ea2feac0612aec8565ddda4fd088573a Mon Sep 17 00:00:00 2001 From: Aolin Date: Mon, 19 Sep 2022 18:30:24 +0800 Subject: [PATCH 18/19] apply suggestions from code review --- pd-control.md | 79 ++++++++++++++++++++++----------------------------- 1 file changed, 34 insertions(+), 45 deletions(-) diff --git a/pd-control.md b/pd-control.md index ee90e6d07661..cf384d3c1408 100644 --- a/pd-control.md +++ b/pd-control.md @@ -1251,9 +1251,7 @@ scheduler config balance-hot-region-scheduler // 显示 balance-hot-region 调 #### 查询 store -通过 `store` 显示所有 store 信息： - -{{< copyable "" >}} +显示所有 store 信息： ```bash store @@ -1266,9 +1264,7 @@ store } ``` -获取 store id 为 1 的 store： - -{{< copyable "" >}} +获取 id 为 1 的 store： ```bash store 1 @@ -1280,79 +1276,72 @@ store 1 #### 下线 store -下线 store id 为 1 的 store： - -{{< copyable "" >}} +下线 id 为 1 的 store： ```bash store delete 1 ``` -你可以撤销已使用 `store delete` 下线并处于 Offline 状态的 store。撤销后，该 store 会从 Offline 状态变为 Up 状态。注意，该命令无法使 Tombstone 状态的 store 变回 Up 状态。以下示例撤销已使用 `store delete` 下线的 store id 为 1 的 store，并删除所有 Tombstone 状态的 store： +执行 `store cancel-delete` 命令，你可以撤销已使用 `store delete` 下线并处于 `Offline` 状态的 store。撤销后，该 store 会从 `Offline` 状态变为 `Up` 状态。注意， `store cancel-delete` 命令无法使 `Tombstone` 状态的 store 变回 `Up` 状态。 -{{< copyable "" >}} +撤销通过 `store delete` 下线 id 为 1 的 store： ```bash -store cancel-delete 1 // 取消下线 -store remove-tombstone // 删除所有 Tombstone 状态的 store +store cancel-delete 1 +``` + +删除所有 Tombstone 状态的 store： + +```bash +store remove-tombstone ``` > **注意：** > -> 若下线过程中切换了 PD leader，需要手动修改 store limit。 +> 若下线过程中切换了 PD leader，需要使用 `store limit` 命令修改 [store 调度限速](#设置-store-调度限速)。 #### 管理 store label `store label` 命令用于管理 store label。 -为 store id 为 1 的 store 添加键为 `"zone"` 的值为 `"cn"` 的 label： - -{{< copyable "" >}} - -```bash -store label 1 zone=cn -``` - -更新 store id 为 1 的 label： - -{{< copyable "" >}} +- 为 id 为 1 的 store 设置键为 `"zone"`、值为 `"cn"` 的 label： -```bash -store label 1 zone=us -``` + ```bash + store label 1 zone=cn + ``` -通过 `--rewrite` 重写 store id 为 1 的所有 label，之前有的 label 会被覆盖： +- 更新 id 为 1 的 store 的 label： -{{< copyable "" >}} + ```bash + store label 1 zone=us + ``` -```bash -store label 1 region=us-est-1 disk=ssd --rewrite -``` +- 通过 `--rewrite` 选项重写 id 为 1 的 store 的所有 label，之前的 label 会被覆盖： -删除指定 store 的对应 label： + ```bash + store label 1 region=us-est-1 disk=ssd --rewrite + ``` -{{< copyable "" >}} +- 删除 id 为 1 的 store 的键为 `"disk"` 的 label ： -```bash -store label 1 disk --delete -``` + ```bash + store label 1 disk --delete + ``` > **注意：** > > - store 的 label 更新方法使用的是合并策略。如果修改了 TiKV 配置文件中的 store label，进程重启之后，PD 会将自身存储的 store label 与其进行合并更新，并持久化合并后的结果。 -> - 如果希望使用 TiUP 统一管理 store label 的话，可以在集群重启前，使用 PD Control 的 `store label --force` 命令将 PD 存储的 store label 清空。 +> - 如果希望使用 TiUP 统一管理 store label，你可以在集群重启前，使用 PD Control 的 `store label --force` 命令将 PD 存储的 store label 清空。 -#### `store weight` 命令 +#### 设置 store weight -设置 store id 为 1 的 store 的 leader weight 为 5，Region weight 为 10： - -{{< copyable "" >}} +将 id 为 1 的 store 的 leader weight 设为 5，Region weight 设为 10： ```bash store weight 1 5 10 ``` -#### `store limit` 命令 +#### 设置 store 调度限速 关于 `store limit` 的原理和使用方法，请参考 [`store limit`](/configure-store-limit.md)。 @@ -1371,7 +1360,7 @@ store weight 1 5 10 > **注意：** > > * `store limit` 命令原有的 `region-add` 和 `region-remove` 子命令已废弃，请使用 `add-peer` 和 `remove-peer` 来替代。 -> * 使用 `pd-ctl` 可以查看 TiKV 节点的状态信息，即 Up，Disconnect，Offline，Down，或 Tombstone。如需查看各个状态之间的关系，请参考 [TiKV Store 状态之间的关系](/tidb-scheduling.md#信息收集)。 +> * 使用 `pd-ctl` 可以查看 TiKV 节点的状态信息，即 `Up`，`Disconnect`，`Offline`，`Down`，或 `Tombstone`。如需查看各个状态之间的关系，请参考 [TiKV Store 状态之间的关系](/tidb-scheduling.md#信息收集)。 ### `log [fatal | error | warn | info | debug]` From 40e32d88bc5b03c7528e55c71a68aebb6a70fb85 Mon Sep 17 00:00:00 2001 From: Aolin Date: Mon, 19 Sep 2022 19:10:00 +0800 Subject: [PATCH 19/19] Apply suggestions from code review Co-authored-by: shichun-0415 <89768198+shichun-0415@users.noreply.github.com> --- pd-control.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pd-control.md b/pd-control.md index cf384d3c1408..970834c02c46 100644 --- a/pd-control.md +++ b/pd-control.md @@ -1343,7 +1343,7 @@ store weight 1 5 10 #### 设置 store 调度限速 -关于 `store limit` 的原理和使用方法，请参考 [`store limit`](/configure-store-limit.md)。 +通过 `store-limit`，你可以设置 store 的调度速度。关于 `store limit` 的原理和使用方法，请参考 [`store limit`](/configure-store-limit.md)。 ```bash >> store limit // 显示所有 store 添加和删除 peer 的速度上限