使用 PLAN REPLAYER 保存和恢复集群现场信息

用户在定位排查 TiDB 集群问题时，经常需要提供系统和查询计划相关的信息。为了帮助用户更方便地获取相关信息，更高效地排查集群问题，TiDB 在 v5.3.0 中引入了 PLAN REPLAYER 命令，用于“一键”保存和恢复现场问题的相关信息，提升查询计划问题诊断的效率，同时方便将问题归档管理。

PLAN REPLAYER 主要功能如下：

  • 导出排查现场 TiDB 集群的相关信息，导出为 ZIP 格式的文件用于保存。
  • 在任意 TiDB 集群上导入另一 TiDB 集群现场信息的 ZIP 文件。

使用 PLAN REPLAYER 导出集群信息

你可以使用 PLAN REPLAYER 来保存 TiDB 集群的现场信息。导出接口如下：

1. PLAN REPLAYER DUMP EXPLAIN [ANALYZE] sql-statement;

TiDB 根据 sql-statement 整理出以下集群现场信息：

  • TiDB 版本信息
  • TiDB 配置信息
  • TiDB Session 系统变量
  • TiDB 执行计划绑定信息（SQL Binding）
  • sql-statement 中所包含的表结构
  • sql-statement 中所包含表的统计信息
  • EXPLAIN [ANALYZE] sql-statement 的结果

注意：

PLAN REPLAYER 不会导出表中数据

PLAN REPLAYER 导出示例

1. use test;
2. create table t(a int, b int);
3. insert into t values(1,1), (2, 2), (3, 3);
4. analyze table t;

6. plan replayer dump explain select * from t;

PLAN REPLAYER DUMP 会将以上信息打包整理成 ZIP 文件，并返回文件标识作为执行结果。该文件为一次性文件，被下载后 TiDB 会将其删除。

注意：

ZIP 文件最多会在 TiDB 集群中保存一个小时，超时后 TiDB 会将其删除。

1. MySQL [test]> plan replayer dump explain select * from t;
2. +------------------------------------------------------------------+
3. | Dump_link                                                        |
4. +------------------------------------------------------------------+
5. | replayer_single_JOGvpu4t7dssySqJfTtS4A==_1635750890568691080.zip |
6. +------------------------------------------------------------------+
7. 1 row in set (0.015 sec)

因为 MySQL Client 无法下载文件，所以需要通过 TiDB HTTP 接口和文件标识下载文件：

1. http://${tidb-server-ip}:${tidb-server-status-port}/plan_replayer/dump/${file_token}

其中，${tidb-server-ip}:${tidb-server-status-port} 是集群中任意 TiDB server 的地址。示例如下：

1. curl http://127.0.0.1:10080/plan_replayer/dump/replayer_single_JOGvpu4t7dssySqJfTtS4A==_1635750890568691080.zip > plan_replayer.zip

使用 PLAN REPLAYER 导入集群信息

警告：

PLAN REPLAYER 在一个 TiDB 集群上导入另一集群的现场信息，会修改导入集群的 TiDB Session 系统变量、执行计划绑定信息、表结构和统计信息。

有 PLAN REPLAYER 导出的 ZIP 文件后，用户便可以通过 PLAN REPLAYER 导入接口在任意 TiDB 集群上恢复另一集群地现场信息。语法如下：

1. PLAN REPLAYER LOAD 'file_name';

以上语句中，file_name 为要导入的 ZIP 文件名。

示例如下：

1. PLAN REPLAYER LOAD 'plan_replayer.zip';

导入完毕后，该 TiDB 集群就载入了所需要的表结构、统计信息等其他影响构造 Plan 所需要的信息。你可以通过以下方式查看执行计划以及验证统计信息:

1. mysql> desc t;
2. +-------+---------+------+------+---------+-------+
3. | Field | Type    | Null | Key  | Default | Extra |
4. +-------+---------+------+------+---------+-------+
5. | a     | int(11) | YES  |      | NULL    |       |
6. | b     | int(11) | YES  |      | NULL    |       |
7. +-------+---------+------+------+---------+-------+
8. 2 rows in set (0.01 sec)

10. mysql> explain select * from t where a = 1 or b =1;
11. +-------------------------+---------+-----------+---------------+--------------------------------------+
12. | id                      | estRows | task      | access object | operator info                        |
13. +-------------------------+---------+-----------+---------------+--------------------------------------+
14. | TableReader_7           | 0.01    | root      |               | data:Selection_6                     |
15. | └─Selection_6           | 0.01    | cop[tikv] |               | or(eq(test.t.a, 1), eq(test.t.b, 1)) |
16. |   └─TableFullScan_5     | 6.00    | cop[tikv] | table:t       | keep order:false, stats:pseudo       |
17. +-------------------------+---------+-----------+---------------+--------------------------------------+
18. 3 rows in set (0.00 sec)

20. mysql> show stats_meta;
21. +---------+------------+----------------+---------------------+--------------+-----------+
22. | Db_name | Table_name | Partition_name | Update_time         | Modify_count | Row_count |
23. +---------+------------+----------------+---------------------+--------------+-----------+
24. | test    | t          |                | 2022-08-26 15:52:07 |            3 |         6 |
25. +---------+------------+----------------+---------------------+--------------+-----------+
26. 1 row in set (0.04 sec)

加载并还原所需现场后，即可在该现场诊断和改进执行计划。