收集集群基础信息 - 敏捷诊断工具 V3.6.0

收集集群基础信息

更新时间：2025-08-24 16:20:32

本文适用于独立部署 obdiag 的场景，可以一键执行将集群的基本信息捞回来，注意收集回来的都是 SQL 相关的结果，并不会收集日志等信息, 常用于像论坛或者前线支持人员求助的时候提供给对方集群信息。

使用说明

obdiag gather scene run --scene=observer.base [options]

选项说明如下：

选项名	是否必选	数据类型	默认值	说明
--scene	是	string	默认为空	场景名，可以通过obdiag gather scene list 查看当前版本支持哪些场景
--store_dir	否	string	默认为命令执行的当前路径	存储结果的本地路径。
-c	否	string	`~/.obdiag/config.yml`	配置文件路径。
--inner_config	否	string	默认为空	obdiag 自用的配置。
--config	否	string	默认为空	需被 obdiag 诊断的集群的配置，固定样式：--config key1=value1 --config key2=value2。说明支持通过该选项配置的参数可参见 obdiag 配置。
--config_password	否	string	默认为空	obdiag 使用加密的配置文件时，需通过该选项传入对应的密码。说明详情可参见配置文件加密。

使用示例

方式一：无配置文件使用（开箱即用）

# 集群基本信息收集
obdiag gather scene run --scene=observer.base \
    --config db_host=xx.xx.xx.xx \
    --config db_port=xxxx \
    --config tenant_sys.user=root@sys \
    --config tenant_sys.password=***

方式二：有配置文件使用

需要确保已经在 obdiag 配置文件 config.yml 中配置好需要收集节点的登录信息。相关的详细配置介绍，参见 obdiag 配置。

# 集群基本信息收集
obdiag gather scene run --scene=observer.base

结果解读

命令执行后在指定目录下会生成一个文件夹，文件夹形如: obdiag_gather_pack_20240808105846

#tree
.
└── sql_result.txt # 集群基本信息

实践案例

案例：用户发生备份问题，需要排查，直接执行如下命令将诊断所需的信息打包好，发给社区论坛或者前线支持人员

obdiag gather scene run --scene=observer.base \
    --config db_host=xx.xx.xx.xx \
    --config db_port=xxxx \
    --config tenant_sys.user=root@sys \
    --config tenant_sys.password=***