技术分享 | MySQL Shell 收集 MySQL 诊断报告（上）

1. 手动写脚本收集。

2. Percona-toolkit 工具集里自带的 pt-stalk 。

3. MySQL 的 sys 库自带存储过程 diagnostics 。

4. MySQL Shell 工具的 util 组件（需升级到 MySQL 8.0.31 最新版才能体验全部诊断程序）

util 组件的诊断程序是由 debug 属性自带的几个内置函数实现的。目前有三个诊断函数：

1. collect_diagnostics 用来收集MySQL单实例、副本集、InnoDB Cluster 的诊断数据。（旧版本8.0.30 也可以用，不过功能不是很全面）

2. collect_high_load_diagnostics 用来循环多次收集，并找出负载异常的诊断数据。

3. collect_slow_query_diagnostics 用来对函数 collect_diagnostics 收集到的慢日志做进一步分析。

今天我们先来介绍第一个函数 collect_diagnostics 如何使用：

1. 无主键的表
2. 死索引的表
3. MySQL 错误日志
4. 二进制日志元数据
5. 副本集状态（包含主库和从库）
6. InnoDB Cluster 监控数据
7. 表锁、行锁等数据
8. 当前连接会话数据
9. 当前内存数据
10. 当前状态变量数据
11. 当前 MySQL 慢日志（需主动开启开关）
12. OS 数据（CPU、内存、IO、网络、MySQL 进程严重错误日志过滤等）

以下是常用调用示例：

1. 只传递参数1，指定诊断数据打包输出路径，诊断报告会整体打包为 tmp/cd1.zip 。

util.debug.collect_diagnostics('/tmp/cd1')

1. 激活慢日志抓取（必需条件：MySQL 慢日志开关开启、日志输出格式为 TABLE），诊断报告会整体打包为 tmp/cd2.zip ，并且包含慢日志诊断报告。

util.debug.collect_diagnostics('/tmp/cd2',{"slowQueries":True})

1. 定制执行 SQL ：收集预置诊断报告同时也收集指定的 SQL 语句执行结果。

util.debug.collect_diagnostics('/tmp/cd3',{"customSql":["select * from ytt.t1 order by id desc limit 100"]})

1. 定制执行 SHELL 命令：收集预置诊断报告同时也收集指定的 SHELL 命令执行结果。

util.debug.collect_diagnostics('/tmp/cd4',{"customShell":["ps aux | grep mysqld"]})

1. 收集所有成员诊断数据（副本集或者 InnoDB Cluster）。

util.debug.collect_diagnostics('/tmp/cd5',{"allMembers":True})

分别执行以上5条命令，在 tmp 目录下会生成如下文件：以下5个打包文件即是我们运行的5条命令的结果。

root@ytt-pc:/tmp# ll cd*
-rw------- 1 root root  893042 1月   5 10:31 cd1.zip
-rw------- 1 root root  818895 1月   5 10:55 cd2.zip
-rw------- 1 root root  819183 1月   5 11:02 cd3.zip
-rw------- 1 root root  835387 1月   5 11:06 cd4.zip
-rw------- 1 root root 2040913 1月   5 11:31 cd5.zip

要查看具体诊断报告，得先解压这些文件。先来看下 cd2.zip 解压后的内容：对于收集的诊断数据，有 tsv 和 yaml 两种格式的报告文件，报告文件以数字0开头，表示这个诊断报告来自一台单实例 MySQL 。

root@ytt-pc:/tmp/cd/cd2# ls|more
0.error_log
0.global_variables.tsv
0.global_variables.yaml
0.information_schema.innodb_metrics.tsv
0.information_schema.innodb_metrics.yaml
0.information_schema.innodb_trx.tsv
0.information_schema.innodb_trx.yaml
0.instance
0.metrics.tsv
0.performance_schema.events_waits_current.tsv
0.performance_schema.events_waits_current.yaml
0.performance_schema.host_cache.tsv
0.performance_schema.host_cache.yaml
0.performance_schema.metadata_locks.tsv
0.performance_schema.metadata_locks.yaml
...

比如查看此实例的连接字符串：

root@ytt-pc:/tmp/cd/cd2# cat 0.uri 
mysql://root@localhost:3306

以下为对应的慢日志报告：分别为慢日志数据、95分位慢日志数据以及根据扫描行数排序的慢日志数据。

root@ytt-pc:/tmp/cd/cd2# ls *slow*
0.slow_log.tsv   0.slow_queries_in_95_pctile.tsv   0.slow_queries_summary_by_rows_examined.tsv
0.slow_log.yaml  0.slow_queries_in_95_pctile.yaml  0.slow_queries_summary_by_rows_examined.yaml

比如查看副本集里3个成员的连接字符串：

root@ytt-pc:/tmp/cd/cd5# cat {1,2,3}.uri
mysql://root@127.0.0.1:3310?ssl-mode=required
mysql://root@127.0.0.1:3311?ssl-mode=required
mysql://root@127.0.0.1:3312?ssl-mode=required

目前副本集的拓扑：3310 为主，3311，3312为从，可以在主库上执行 show replicas 命令得到从库列表。

 MySQL  localhost:3310 ssl  SQL > show replicas;
+------------+-----------+------+------------+--------------------------------------+
| Server_Id  | Host      | Port | Source_Id  | Replica_UUID                         |
+------------+-----------+------+------------+--------------------------------------+
| 2736952196 | 127.0.0.1 | 3312 | 4023085694 | 0824a675-8ca9-11ed-a719-0800278da4ac |
| 3604736168 | 127.0.0.1 | 3311 | 4023085694 | 0526130e-8ca9-11ed-b797-0800278da4ac |
+------------+-----------+------+------------+--------------------------------------+
2 rows in set (0.0002 sec)

从诊断报告里查看实例 3310 的从库列表：

root@ytt-pc:/tmp/cd/cd5# cat 1.SHOW_REPLICAS.yaml

...

#
Host: 127.0.0.1
Port: 3312
Replica_UUID: 0824a675-8ca9-11ed-a719-0800278da4ac
Server_Id: 2736952196

Source_Id: 4023085694
---

Host: 127.0.0.1
Port: 3311
Replica_UUID: 0526130e-8ca9-11ed-b797-0800278da4ac
Server_Id: 3604736168
Source_Id: 4023085694

结语：

MySQL Shell 8.0.31 带来的增强版收集诊断报告功能，能更好的弥补 MySQL 在这一块的空缺，避免安装第三方工具，从而简化 DBA 的学习成本。

本文关键字：#MySQL Shell# #MySQL 诊断报告收集#