Skip to content

Commit

Permalink
Apply suggestions from code review
Browse files Browse the repository at this point in the history
Co-authored-by: Grace Cai <[email protected]>
  • Loading branch information
Oreoxmt and qiancai authored Sep 18, 2024
1 parent 2a88558 commit 5e8c420
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 8 deletions.
8 changes: 6 additions & 2 deletions tiproxy/tiproxy-command-line-flags.md
Original file line number Diff line number Diff line change
Expand Up @@ -166,7 +166,9 @@ level = 'warning'
- `--output`:(必填)指定流量文件存放的目录。
- `--duration`:(必填)指定捕获的时长。可选单位为 `m`(分钟)、`h`(小时)或 `d`(天)。例如 `--duration=1h` 指定捕获一小时的流量。

例如,以下命令连接到 TiProxy 实例 `10.0.1.10:3080`,捕获一小时的流量,并保存到 TiProxy 实例的 `/tmp/traffic` 目录下:
示例:

以下命令连接到 TiProxy 实例 `10.0.1.10:3080`,捕获一小时的流量,并保存到 TiProxy 实例的 `/tmp/traffic` 目录下:

```shell
tiproxyctl traffic capture --host 10.0.1.10 --port 3080 --output="/tmp/traffic" --duration=1h
Expand All @@ -183,7 +185,9 @@ tiproxyctl traffic capture --host 10.0.1.10 --port 3080 --output="/tmp/traffic"
- `--input`:(必填)指定流量文件存放的目录。
- `--speed`:(可选)指定回放速率的倍数,范围为 `[0.1, 10]`,默认为 1,表示原速回放。

例如,如下命令通过用户名 `u1` 和密码 `123456` 连接到 TiProxy 实例 `10.0.1.10:3080`,并从 TiProxy 实例的 `/tmp/traffic` 目录下读取流量文件,以 2 倍速率回放流量:
示例:

以下命令通过用户名 `u1` 和密码 `123456` 连接到 TiProxy 实例 `10.0.1.10:3080`,并从 TiProxy 实例的 `/tmp/traffic` 目录下读取流量文件,以 2 倍速率回放流量:

```shell
tiproxyctl traffic replay --host 10.0.1.10 --port 3080 --username="u1" --password="123456" --input="/tmp/traffic" --speed=2
Expand Down
12 changes: 6 additions & 6 deletions tiproxy/tiproxy-traffic-replay.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,10 @@ summary: 介绍 TiProxy 的流量回放的使用场景和使用步骤。

流量回放适用于以下场景:

- TiDB 版本升级前验证:在新版本的测试集群上回放生产流量,验证新版本 TiDB 能否成功执行所有 SQL 语句。
- 执行变更前影响评估:在测试集群上使用生产流量模拟,验证变更对集群的影响。例如变更配置项或系统变量、变更表结构、使用 TiDB 的新功能前,先在测试集群验证效果。
- TiDB 扩缩容前性能验证:在新规模的测试集群上按对应速率回放流量,验证新规模集群的性能是否满足要求。例如,为了节省成本要将集群规模缩容到 1/2 时, 1/2 速率回放流量,验证缩容后 SQL 延迟是否满足要求。
- 性能上限测试:在相同规模的测试集群上多次回放流量,每次调大回放速率,测试该规模集群的吞吐量上限,以评估性能是否满足未来业务增长需求。
- **TiDB 版本升级前验证**:在新版本的测试集群上回放生产流量,验证新版本 TiDB 能否成功执行所有 SQL 语句。
- **执行变更前影响评估**:在测试集群上使用生产流量模拟,验证变更对集群的影响。例如在变更配置项或系统变量、变更表结构、使用 TiDB 的新功能前,先在测试集群验证效果。
- **TiDB 扩缩容前性能验证**:在新规模的测试集群上按对应速率回放流量,验证新规模集群的性能是否满足要求。例如,为了节省成本要将集群规模缩容到 1/2 时,可以按 1/2 速率回放流量,验证缩容后 SQL 延迟是否满足要求。
- **性能上限测试**:在相同规模的测试集群上多次回放流量,每次调大回放速率,测试该规模下集群的吞吐量上限,以评估性能是否满足未来业务增长需求。

流量回放不适用于以下场景:

Expand All @@ -33,7 +33,7 @@ summary: 介绍 TiProxy 的流量回放的使用场景和使用步骤。

1. 创建测试集群,详情参考[使用 TiUP 部署 TiDB 集群](/production-deployment-using-tiup.md)
2. 同步生产集群的数据到测试集群,详情参考[数据迁移概述](/migration-overview.md)
3. 在测试集群中运行 [`ANALYZE`](/sql-statements/sql-statement-analyze-table.md) 更新统计信息
3. 在测试集群中运行 [`ANALYZE`](/sql-statements/sql-statement-analyze-table.md) 更新统计信息

2. 使用 [`tiproxyctl traffic capture`](/tiproxy/tiproxy-command-line-flags.md#traffic-capture) 命令连接到生产集群的 TiProxy 实例,开始捕获流量。

Expand Down Expand Up @@ -103,7 +103,7 @@ summary: 介绍 TiProxy 的流量回放的使用场景和使用步骤。

如果需要测试集群的吞吐量,可以使用 `--speed` 选项调整回放的速率。

例如,`--speed=2` 会使 SQL 语句以 2 倍速率执行,总回放时间缩短一半:
例如,`--speed=2` 会使 SQL 语句以两倍速率执行,总回放时间缩短一半:

```shell
tiproxyctl traffic replay --host 10.0.1.10 --port 3080 --username="u1" --password="123456" --input="/tmp/traffic" --speed=2
Expand Down

0 comments on commit 5e8c420

Please sign in to comment.