首批通过分布式安全可靠测评，为关键业务系统打造
一键常规信息收集
更新时间：2024-02-02 14:24:25
编辑
分享
本文适用于独立部署 obdiag 的场景，使用 obdiag gather 命令可帮助 OceanBase 数据库相关的诊断信息收集。
如果是 OBD 部署的集群，可直接通过 OBD 侧诊断命令组对所选集群进行信息收集，详细命令可参考 诊断工具命令组。
前提条件
采集信息回传的时候会用到目标主机的 zip 工具进行压缩，所以需要到被采集主机上安装 zip 工具。
gather 命令组总览
obdiag gather <gather type> [options]
gather type 包含如下：
log：一键收集所属 OceanBase 集群的日志。
sysstat：一键收集所属 OceanBase 集群主机信息。
clog：一键收集所属 OceanBase 集群的 clog 日志。
slog：一键收集所属 OceanBase 集群的 slog 日志。
plan_monitor：一键收集所属 OceanBase 集群指定 trace_id 的并行 SQL 的执行详情信息。
stack：一键收集所属 OceanBase 集群的堆栈信息。
perf：一键收集所属 OceanBase 集群的 perf 信息。
obproxy_log：一键收集所属 OceanBase 集群所依赖的 ODP 的日志。
all：一键统一收集所属 OceanBase 集群的诊断信息，包括收集 OceanBase 集群日志、主机信息、OceanBase 集群堆栈信息、OceanBase 集群 perf 信息。
obdiag gather log
使用该命令可以一键收集所属 OceanBase 集群的日志。
说明
需要确保已经在 obdiag 配置文件 config.yml 中配置好需要收集节点的登录信息。相关的详细配置介绍，参见 obdiag 配置。
obdiag gather log [options]
选项说明如下：
| 选项名 | 是否必选 | 数据类型 | 默认值 | 说明 |
|---|---|---|---|---|
| --from | 否 | string | 默认为空 | 日志收集的开始时间，格式为: yyyy-mm-dd hh:mm:ss，不需要加引号，例如 1970-01-01 12:00:00。 |
| --to | 否 | string | 默认为空 | 日志收集的结束时间，格式为: yyyy-mm-dd hh:mm:ss，不需要加引号，例如 1970-01-01 13:00:00。 |
| --since | 否 | string | 默认为空 | 日志收集最近的某段时间，格式为: \<n> <m\|h\|d>，其中，n 表示待输入的时间数字，m 表示分钟，h 表示小时，d 表示天，例如 30m 表示收集最近 30 分钟的日志。 |
| --scope | 否 | string | all | 选择收集的 OceanBase 集群日志类型，可配置值为 observer、election、rootservice、all。 |
| --grep | 否 | string | 默认为空 | 选择查询的关键字。 |
| --encrypt | 否 | string | false | 指定回传的文件是否加密，可配置为 true 或 false，默认为 false。 |
| --store_dir | 否 | string | 默认为命令执行的当前路径 | 存储结果的本地路径。 |
| -c | 否 | string | ~/.obdiag/config.yml |
配置文件路径 |
示例：
obdiag gather log --scope observer --from 2022-06-30 16:25:00 --to 2022-06-30 18:30:00 --grep STORAGE --encrypt true
...
ZipFileInfo:
+-------------------+-----------+
| Node | LogSize |
+===================+===========+
| xxx.xxx.xxx.xxx | 36.184M |
+-------------------+-----------+
...
ZipFileInfo:
+-------------------+-----------+
| Node | LogSize |
+===================+===========+
| xxx.xxx.xxx.xxx | 44.176M |
+-------------------+-----------+
...
Summary:
+-------------------+-----------+----------+------------------+--------+------------------------------------------------------------------------+
| Node | Status | Size | Password | Time | PackPath |
+===================+===========+==========+==================+========+========================================================================+
| xxx.xxx.xxx.xxx | Completed | 36.762M | HYmVourcUyRNP8Om | 19 s | gather_pack_20220701183246/result_xxx.xxx.xxx.xxx_20220701183247.zip |
+-------------------+-----------+----------+------------------+--------+------------------------------------------------------------------------+
| xxx.xxx.xxx.xxx | Completed | 638.200M | 1RicMaiLUUNfemnj | 718 s | gather_pack_20220701183246/result_xxx.xxx.xxx.xxx_20220701183918.zip |
+-------------------+-----------+----------+------------------+--------+------------------------------------------------------------------------+
注意
如果选择加密模式，对于收集到的日志压缩的时候进行了加密处理，Password 是 zip 包解压缩的密码。默认是不加密的模式。
快捷收集最近一段时间的日志：
# 收集最近一小时的日志 obdiag gather log --since 1h # 收集最近 30 分钟的日志 obdiag gather log --since 30m # 收集最近 30 分钟的日志 并且指定了配置文件 obdiag gather log --since 30m -c /root/config.yml
obdiag gather sysstat
使用该命令可以一键收集所属 OceanBase 集群主机信息（主机 dmesg 信息、主机 CPU 信息、主机内存信息）。
说明
需要确保已经在 obdiag 配置文件 config.yml 中配置好需要收集节点的登录信息。相关的详细配置介绍，参见 obdiag 配置。
obdiag gather sysstat [options]
选项说明如下：
| 选项名 | 是否必选 | 数据类型 | 默认值 | 说明 |
|---|---|---|---|---|
| --store_dir | 否 | string | 默认为命令执行的当前路径 | 存储结果的本地路径。 |
| -c | 否 | string | ~/.obdiag/config.yml |
配置文件路径 |
示例：
Example: obdiag gather sysstat
结果：
Summary:
+-------------------+-----------+---------+--------+-------------------------------------------------------------------------+
| Node | Status | Size | Time | PackPath |
+===================+===========+=========+========+=========================================================================+
| xxx.xxx.xxx.xxx | Completed | 45.209K | 5 s | gather_pack_20220729164233/sysstat_xxx.xxx.xxx.xxx_20220729164233.zip |
+-------------------+-----------+---------+--------+-------------------------------------------------------------------------+
| xxx.xxx.xxx.xxx | Completed | 42.170K | 5 s | gather_pack_20220729164233/sysstat_xxx.xxx.xxx.xxx_20220729164233.zip |
+-------------------+-----------+---------+--------+-------------------------------------------------------------------------+
obdiag gather clog
使用 obdiag gather clog 会通过 obdiag 工具调用收集机器上的 ob_admin 解析 clog 文件，并对所选时间范围内的 clog 进行一键收集。
说明
需要确保已经在 obdiag 配置文件 config.yml 中配置好需要收集节点的登录信息。相关的详细配置介绍，参见 obdiag 配置。
obdiag gather clog [options]
选项说明如下：
| 选项名 | 是否必选 | 数据类型 | 默认值 | 说明 |
|---|---|---|---|---|
| --from | 否 | string | 默认为空 | 日志收集的开始时间，格式为: yyyy-mm-dd hh:mm:ss，不需要加引号，例如 1970-01-01 12:00:00。 |
| --to | 否 | string | 默认为空 | 日志收集的结束时间，格式为: yyyy-mm-dd hh:mm:ss，不需要加引号，例如 1970-01-01 13:00:00 。 |
| --since | 否 | string | 默认为空 | 日志收集最近的某段时间，格式为: \<n> <m\|h\|d>，其中，n 表示待输入的时间数字，m 表示分钟，h 表示小时，d 表示天，例如 30m 表示收集最近 30 分钟的日志。 |
| --encrypt | 否 | string | false | 指定回传的文件是否加密，可配置为 true 或 false，默认为 false |
| --store_dir | 否 | string | 默认为命令执行的当前路径 | 存储结果的本地路径 |
| -c | 否 | string | ~/.obdiag/config.yml |
配置文件路径 |
示例:
obdiag gather clog --from 2023-01-16 18:25:00 --to 2023-01-17 01:30:00
Gather clog Summary:
+-------------------+-----------+---------+--------+-----------------------------------------------------------------------+
| Node | Status | Size | Time | PackPath |
+===================+===========+=========+========+=======================================================================+
| xxx.xxx.xxx.xxx | Completed | 15.762K | 6 s | gather_pack_20230118002457/obadmin_xxx.xxx.xxx.xxx_20230118002458.zip |
+-------------------+-----------+---------+--------+-----------------------------------------------------------------------+
obdiag gather slog
使用 obdiag gather slog 会通过 obdiag 工具调用收集机器上的 ob_admin 解析 slog 文件，并对所选时间范围内的 slog 进行一键收集。
说明
需要确保已经在 obdiag 配置文件 config.yml 中配置好需要收集节点的登录信息。相关的详细配置介绍，参见 obdiag 配置。
obdiag gather slog [options]
选项说明如下：
| 选项名 | 是否必选 | 数据类型 | 默认值 | 说明 |
|---|---|---|---|---|
| --from | 否 | string | 默认为空 | 日志收集的开始时间，格式为: yyyy-mm-dd hh:mm:ss，不需要加引号，例如 1970-01-01 12:00:00。 |
| --to | 否 | string | 默认为空 | 日志收集的结束时间，格式为: yyyy-mm-dd hh:mm:ss，不需要加引号，例如 1970-01-01 13:00:00。 |
| --since | 否 | string | 默认为空 | 日志收集最近的某段时间，格式为: \<n> <m\|h\|d>，其中，n 表示待输入的时间数字，m 表示分钟，h 表示小时，d 表示天，例如 30m 表示收集最近 30 分钟的日志。 |
| --encrypt | 否 | string | false | 指定回传的文件是否加密，可配置为 true 或 false，默认为 false。 |
| --store_dir | 否 | string | 默认为命令执行的当前路径 | 存储结果的本地路径。 |
| -c | 否 | string | ~/.obdiag/config.yml |
配置文件路径 |
示例:
obdiag gather slog --from 2023-01-16 18:25:00 --to 2023-01-17 01:30:00
Gather slog Summary:
+-------------------+-----------+---------+--------+-----------------------------------------------------------------------+
| Node | Status | Size | Time | PackPath |
+===================+===========+=========+========+=======================================================================+
| xxx.xxx.xxx.xxx | Completed | 15.762K | 6 s | gather_pack_20230118002457/obadmin_xxx.xxx.xxx.xxx_20230118002458.zip |
+-------------------+-----------+---------+--------+-----------------------------------------------------------------------+
obdiag gather plan_monitor
该命令可以一键收集所属 OceanBase 集群指定 trace_id 的并行 SQL 的执行详情信息，便于在 AP 场景下 SQL 执行慢时分析算子层面的原因。
说明
- 该功能仅支持 OceanBase 数据库 V3.0 及以上版本。
- 需要确保已经在 obdiag 配置文件
config.yml中配置好需要收集的集群连接信息。相关的详细配置介绍，参见 obdiag 配置。
obdiag gather plan_monitor [options]
选项说明如下：
| 选项名 | 是否必选 | 数据类型 | 默认值 | 说明 |
|---|---|---|---|---|
| --trace_id | 是 | string | 默认为空 | OceanBase 数据库 V4.0.0 以下版本可从 gv$sql_audit 中查看 trace_id，OceanBase 数据库 V4.0.0 及以上版本可从 gv$ob_sql_audit 中查看 trace_id。 |
| --store_dir | 否 | string | 默认为命令执行的当前路径 | 存储结果的本地路径。 |
| -c | 否 | string | ~/.obdiag/config.yml |
配置文件路径 |
示例：
obdiag gather plan_monitor --trace_id YB420BA2D99B-0005EBBFC45D5A00-0-0
Gather ob_admin Summary:
+-----------+--------+----------------------------------------------------------------------+
| Status | Time | PackPath |
+===========+========+======================================================================+
| Completed | 6 s | gather_pack_20230118002457 |
+-----------+--------+----------------------------------------------------------------------+
obdiag gather stack
该命令可以一键收集所属 OceanBase 集群的堆栈信息，该采集项暂不支持 ARM 版本的 OceanBase 集群 stack 信息采集。
说明
需要确保已经在 obdiag 配置文件 config.yml 中配置好需要收集节点的登录信息。相关的详细配置介绍，参见 obdiag 配置。
obdiag gather stack [options]
选项说明如下：
| 选项名 | 是否必选 | 数据类型 | 默认值 | 说明 |
|---|---|---|---|---|
| --store_dir | 否 | string | 默认为命令执行的当前路径 | 存储结果的本地路径。 |
| -c | 否 | string | ~/.obdiag/config.yml |
配置文件路径 |
示例：
Example: obdiag gather stack
结果：
Summary:
+-------------------+-----------+---------+--------+--------------------------------------------------------------------------+
| Node | Status | Size | Time | PackPath |
+===================+===========+=========+========+==========================================================================+
| xxx.xxx.xxx.xxx | Completed | 19.926K | 10 s | gather_pack_20220729163951/obstack2_xxx.xxx.xxx.xxx_20220729163951.zip |
+-------------------+-----------+---------+--------+--------------------------------------------------------------------------+
| xxx.xxx.xxx.xxx | Completed | 22.803K | 12 s | gather_pack_20220729163951/obstack2_xxx.xxx.xxx.xxx_20220729163951.zip |
+-------------------+-----------+---------+--------+--------------------------------------------------------------------------+
obdiag gather perf
该命令可以一键收集所属 OceanBase 集群的 perf 信息。
说明
需要确保已经在 obdiag 配置文件 config.yml 中配置好需要收集节点的登录信息。相关的详细配置介绍，参见 obdiag 配置。
obdiag gather perf [options]
选项说明如下：
| 选项名 | 是否必选 | 数据类型 | 默认值 | 说明 |
|---|---|---|---|---|
| --scope | 否 | string | all | 用于选择性地收集指定的 perf 信息，可配置值为：sample、flame、pstack、all。 |
| --store_dir | 否 | string | 默认为命令执行的当前路径 | 存储结果的本地路径。 |
| -c | 否 | string | ~/.obdiag/config.yml |
配置文件路径 |
示例：
obdiag gather perf
Gather Perf Summary:
+-------------------+-----------+----------+--------+----------------------------------------------------------------------+
| Node | Status | Size | Time | PackPath |
+===================+===========+==========+========+======================================================================+
| xxx.xxx.xxx.xxx | Completed | 368.178K | 90 s | gather_pack_20230117140836/perf_xxx.xxx.xxx.xxx_20230117140836.zip |
+-------------------+-----------+----------+--------+----------------------------------------------------------------------+
| xxx.xxx.xxx.xxx | Completed | 368.178K | 90 s | gather_pack_20230117140836/perf_xxx.xxx.xxx.xxx_20230117140836.zip |
+-------------------+-----------+----------+--------+----------------------------------------------------------------------+
obdiag gather obproxy_log
使用该命令可以一键收集所属 OceanBase 集群所依赖的 ODP 的日志。
说明
需要确保已经在 obdiag 配置文件 config.yml 中配置好需要收集节点的登录信息。相关的详细配置介绍，参见 obdiag 配置。
obdiag gather obproxy_log [options]
选项说明如下：
| 选项名 | 是否必选 | 数据类型 | 默认值 | 说明 |
|---|---|---|---|---|
| --from | 否 | string | 默认为空 | 日志收集的开始时间，格式为: yyyy-mm-dd hh:mm:ss，不需要加引号，例如 1970-01-01 12:00:00。 |
| --to | 否 | string | 默认为空 | 日志收集的结束时间，格式为: yyyy-mm-dd hh:mm:ss，不需要加引号，例如 1970-01-01 13:00:00。 |
| --since | 否 | string | 默认为空 | 日志收集最近的某段时间，格式为: \<n> <m\|h\|d>，其中，n 表示待输入的时间数字，m 表示分钟，h 表示小时，d 表示天，例如 30m 表示收集最近 30 分钟的日志。 |
| --scope | 否 | string | all | 选择查询的 ODP 日志类型，可配置值为 obproxy、obproxy_digest、obproxy_stat、obproxy_slow、obproxy_limit、all。 |
| --grep | 否 | string | 默认为空 | 选择查询的关键字。 |
| --encrypt | 否 | string | false | 指定回传的文件是否加密，可配置为 true 或 false，默认为 false。 |
| --store_dir | 否 | string | 默认为命令执行的当前路径 | 存储结果的本地路径。 |
| -c | 否 | string | ~/.obdiag/config.yml |
配置文件路径 |
示例：
obdiag gather obproxy_log --scope obproxy --from 2022-06-25 10:25:00 --to 2022-06-25 18:30:00 --encrypt true
...
ZipFileInfo:
+------------------+-----------+
| Node | LogSize |
+==================+===========+
| xxx.xxx.xxx.xxx | 36.184M |
+------------------+-----------+
...
ZipFileInfo:
+-------------------+-----------+
| Node | LogSize |
+===================+===========+
| xxx.xxx.xxx.xxx | 44.176M |
+-------------------+-----------+
...
Gather ObProxy Log Summary:
+-------------------+-----------+----------+------------------+--------+-----------------------------------------------------------------------------+
| Node | Status | Size | Password | Time | PackPath |
+===================+===========+==========+==================+========+=============================================================================+
| xxx.xxx.xxx.xxx | Completed | 36.762M | HYmVourcUyRNP8Om | 19 s | gather_pack_20220701183246/obproxy_log_xxx.xxx.xxx.xxx_20220701183247.zip |
+-------------------+-----------+----------+------------------+--------+-----------------------------------------------------------------------------+
| xxx.xxx.xxx.xxx | Completed | 638.200M | 1RicMaiLUUNfemnj | 718 s | gather_pack_20220701183246/obproxy_log_xxx.xxx.xxx.xxx_20220701183918.zip |
+-------------------+-----------+----------+------------------+--------+-----------------------------------------------------------------------------+
obdiag gather all
使用该命令可以一键统一收集所属 OceanBase 集群的诊断信息，包括收集 OceanBase 集群日志、主机信息、OceanBase 集群堆栈信息、OceanBase 集群 perf 信息。
说明
需要确保已经在 obdiag 配置文件 config.yml 中配置好需要收集节点的登录信息。相关的详细配置介绍，参见 obdiag 配置。
obdiag gather all [options]
选项说明如下：
| 选项名 | 是否必选 | 数据类型 | 默认值 | 说明 |
|---|---|---|---|---|
| --from | 否 | string | 默认为空 | 日志收集的开始时间，格式为: yyyy-mm-dd hh:mm:ss，不需要加引号，例如 1970-01-01 12:00:00。 |
| --to | 否 | string | 默认为空 | 日志收集的结束时间，格式为: yyyy-mm-dd hh:mm:ss，不需要加引号，例如 1970-01-01 13:00:00。 |
| --since | 否 | string | 默认为空 | 日志收集最近的某段时间，格式为: \<n> <m\|h\|d>，其中，n 表示待输入的时间数字，m 表示分钟，h 表示小时，d 表示天，例如 30m 表示收集最近 30 分钟的日志。 |
| --scope | 否 | string | all | 选择收集的 OceanBase 集群日志类型，可配置值为 observer、election、rootservice、all。 |
| --grep | 否 | string | 默认为空 | 选择查询的关键字。 |
| --encrypt | 否 | string | false | 指定回传的文件是否加密，可配置为 true 或 false，默认为 false。 |
| --store_dir | 否 | string | 默认为命令执行的当前路径 | 存储结果的本地路径。 |
| -c | 否 | string | ~/.obdiag/config.yml |
配置文件路径 |
示例:
快速收集最近一段时间的集群性能报告、observer日志、主机日志、主机cpu/内存信息、observer的堆栈信息、火焰图。
obdiag gather all --from 2022-07-28 16:25:00 --to 2022-07-28 18:30:00 --encrypt true
...
ZipFileInfo:
+------------------+-----------+
| Node | LogSize |
+==================+===========+
| xxx.xxx.xxx.xxx | 29.874M |
+------------------+-----------+
...
ZipFileInfo:
+------------------+-----------+
| Node | LogSize |
+==================+===========+
| xxx.xxx.xxx.xxx | 143.229M |
+------------------+-----------+
...
...
# 指定时间段内日志收集汇总
Summary:
+-------------------+-----------+----------+------------------+--------+---------------------------------------------------------------------------------------+
| Node | Status | Size | Password | Time | PackPath |
+===================+===========+==========+==================+========+=======================================================================================+
| xxx.xxx.xxx.xxx | Completed | 29.874M | fB7FrrzTGl4EK5Hl | 20 s | gather_pack_20220729170718/result_xxx.xxx.xxx.xxx_20220729222724_20220730003224.zip |
+-------------------+-----------+----------+------------------+--------+---------------------------------------------------------------------------------------+
| xxx.xxx.xxx.xxx | Completed | 143.229M | SGRbXvMyA7lrnFW1 | 74 s | gather_pack_20220729170718/result_xxx.xxx.xxx.xxx_20220729222724_20220730003224.zip |
+-------------------+-----------+----------+------------------+--------+---------------------------------------------------------------------------------------+
...
# observer所在主机当前时间的主机信息收集汇总
Summary:
+-------------------+-----------+---------+--------+-------------------------------------------------------------------------+
| Node | Status | Size | Time | PackPath |
+===================+===========+=========+========+=========================================================================+
| xxx.xxx.xxx.xxx | Completed | 45.276K | 5 s | gather_pack_20220729170856/os_info_xxx.xxx.xxx.xxx_20220729170856.zip |
+-------------------+-----------+---------+--------+-------------------------------------------------------------------------+
| xxx.xxx.xxx.xxx | Completed | 42.152K | 6 s | gather_pack_20220729170856/os_info_xxx.xxx.xxx.xxx_20220729170856.zip |
+-------------------+-----------+---------+--------+-------------------------------------------------------------------------+
# observer当前的堆栈信息
Summary:
+-------------------+-----------+---------+--------+--------------------------------------------------------------------------+
| Node | Status | Size | Time | PackPath |
+===================+===========+=========+========+==========================================================================+
| xxx.xxx.xxx.xxx | Completed | 22.693K | 13 s | gather_pack_20220729170902/obstack2_xxx.xxx.xxx.xxx_20220729170902.zip |
+-------------------+-----------+---------+--------+--------------------------------------------------------------------------+
| xxx.xxx.xxx.xxx | Completed | 19.902K | 13 s | gather_pack_20220729170902/obstack2_xxx.xxx.xxx.xxx_20220729170902.zip |
+-------------------+-----------+---------+--------+--------------------------------------------------------------------------+
Gather Perf Summary:
+-------------------+-----------+----------+--------+----------------------------------------------------------------------+
| Node | Status | Size | Time | PackPath |
+===================+===========+==========+========+======================================================================+
| xxx.xxx.xxx.xxx | Completed | 368.178K | 90 s | gather_pack_20230117140836/perf_xxx.xxx.xxx.xxx_20230117140836.zip |
+-------------------+-----------+----------+--------+----------------------------------------------------------------------+
| xxx.xxx.xxx.xxx | Completed | 368.178K | 90 s | gather_pack_20230117140836/perf_xxx.xxx.xxx.xxx_20230117140836.zip |
+-------------------+-----------+----------+--------+----------------------------------------------------------------------+
# 收集最近2小时的数据
obdiag gather all --since 2h
