诊断工具命令组 - 安装部署工具 OBD V4.0.0

诊断工具命令组

更新时间：2026-01-11 11:34:25

OceanBase Diagnostic Tool（简称: obdiag）是一款适用于 OceanBase 的黑屏诊断工具，obdiag 现有功能包含了对于 OceanBase 日志、SQL Audit 以及 OceanBase 进程堆栈等信息进行的扫描、收集和分析，可以在 OceanBase 集群不同的部署模式下（OCP，obd 或用户根据文档手工部署）实现一键执行，完成诊断信息的展示、收集和分析。obdiag 代码完全开源，详细 obdiag 信息可参见 obdiag GitHub 仓库。

obd 集成了 obdiag 工具，支持通过 obd obdiag 命令实现一键诊断，执行 obd tool install obdiag 命令安装 obdiag 后即可使用。命令执行时需配置的选项与 obdiag 原本选项一致，不同点在于：执行命令时需在 obdiag 字段前加上 obd 字段，且需在命令中指定集群部署名（可执行 obd cluster list 命令查看，Name 列输出即为集群部署名），如 obd obdiag rca run <deploy_name>。

obdiag 支持的命令和功能介绍可参见官网 OceanBase 敏捷诊断工具（obdiag）文档。

说明

obd obdiag 命令仅支持对 obd 管理的集群进行操作，obd 部署的集群默认由 obd 管理，非 obd 部署的集群可执行接管操作进行接管，具体操作可参见使用 obd 接管集群。

使用示例

说明

此处仅介绍简单操作，更多示例可参见集群诊断一文。

安装 obdiag

obd tool install obdiag
source ~/oceanbase-diagnostic-tool/init.sh

查看 obd 管理的集群列表

obd cluster list

输出如下：

+------------------------------------------------------------------+
|                          Cluster List                            |
+-------------+----------------------------------+-----------------+
| Name        | Configuration Path               | Status (Cached) |
+-------------+----------------------------------+-----------------+
| obtest      | /home/admin/.obd/cluster/obtest  | running         |
| demo        | /home/admin/.obd/cluster/demo    | running         |
+-------------+----------------------------------+-----------------+

收集集群日志

此处以收集 obtest 集群最近三十分钟的日志为例，且指定在 observer 日志中查询关键字 STORAGE。

obd obdiag gather log obtest --since=30m --scope observer --grep STORAGE

输出如下：

Open ssh connection ok
obdiag version: 3.6.0
gather_log start ...
gather log from_time: 2025-08-07 17:00:16, to_time: 2025-08-07 17:31:16
gather start ok
+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
|                                                    Gather observer Log Summary on 2025-08-07 17:30:17                                                     |
+------------+---------+--------+---------------------------------------------------------------------------------------------------------------------------+
|  Node      |  Status |  Size  |                                                            info                                                           |
+------------+---------+--------+---------------------------------------------------------------------------------------------------------------------------+
| 10.10.10.2 | Success | 3.389M | file save in ./obdiag_gather_pack_20250807173016/observer_log_local_20250807170016_20250807173116_696697_pid_11453.tar.gz |
+------------+---------+--------+---------------------------------------------------------------------------------------------------------------------------+

For result details, please run cmd ' cat ./obdiag_gather_pack_20250807173016/result_summary.txt '

Trace ID: 2096447e-7371-11f0-8219-00163e56c732
If you want to view detailed obdiag logs, please run: /home/admin/.obd/repository/oceanbase-diagnostic-tool/3.6.0/3dc41c5f31647397b7cf32c50af1b7508a84bf3e/   obdiag display-trace 2096447e-7371-11f0-8219-00163e56c732

See https://www.oceanbase.com/product/ob-deployer/error-codes .
Trace ID: 1ff1ff90-7371-11f0-a5b3-00163e56c732
If you want to view detailed obd logs, please run: obd display-trace 1ff1ff90-7371-11f0-a5b3-00163e56c732