OceanBase诊断工具(OceanBase Diagnostic Tool) 是 原诊断信息收集工具 (OceanBase Diagnosis Gather)的功能升级版，形成了统一的黑屏命令风格，简单易用。 目前包含了对于OceanBase日志、SQL Audit以及OceanBase进程堆栈等信息进行的扫描、收集，可以在OceanBase集群不同的部署模式下（OCP，OBD或用户根据文档手工部署）实现一键执行。
- 执行环境: python >= 3.6.5 或者python > 2.7.5
- 环境依赖：支持zip命令
- 安装依赖包
# 下载安装包并安装
rpm -ivh oceanbase-diagnostic-tool-1.0.0-xxxx.alios7.x86_64.rpm
# 进入安装包
cd oceanbase-diagnostic-tool
说明：如果是OBDIAG升级场景，执行
rpm -Uvh oceanbase-diagnostic-tool-1.0.0-xxxxxx.alios7.x86_64.rpm所有的配置都在conf目录下的config.yml中:
# 配置一：这部分的配置是OBDIAG自身的一些配置，包括自身的日志输出和外置的变量等
OBDIAG:
BASIC:
config_backup_dir: /tmp/oceanbase-diagnostic-tool/conf # 配置文件快速生成的时候会覆写config.yml，为了让用户可查到上一次的配置，每次执行配置更新的时候会保存一份
file_number_limit: 20 # 收集observer的日志的时候单机限制回传的最大文件数量
file_size_limit: 2G # 收集observer的日志的时候单机限制回传的最大文件大小
LOGGER: # OBDIAG本身的日志打印相关配置
log_dir: /tmp/oceanbase-diagnostic-tool/log # OBDIAG日志文件路径
log_filename: obdiag.log # OBDIAG日志文件名
file_handler_log_level: DEBUG # 输出到日志文件中的日志级别
log_level: INFO # OBDIAG日志输出的级别
mode: obdiag
stdout_handler_log_level: DEBUG
# 配置二：属于OCP的配置，有OCP托管的集群可以配置上
OCP:
LOGIN:
url: http://xxx.xxx.xxx.xxx:xxxx
user: xxx
password: xxx
METADB:
ip: xxx.xxx.xxx.xxx
port: xxx
user: xxx
password: xxx
dbname: xxx
# 配置三：收集的集群信息
OBCLUSTER:
cluster_name: xxx
host: xxx.xxx.xxx.xxx
port: xxx
user: xxx
password: xxx
# 配置四：收集的节点的登录信息
NODES:
- ip: xxx.xxx.xxx.xxx
port: xxx
user: xxx
password: xxx
private_key: ''使用的时候需要根据实际情况配置上边的四个配置。其中OBDIAG极少修改，其他三个配置项按需修改，修改部分为"xxx"
Tips: 当有ocp的时候，你如果想要收集ocp托管下某个集群的所有所有主机的上的信息，你也可以通过./obdiag config来快速生成NODES的配置内容,使用方式如下:
./obdiag config -h
usage: ./obdiag config [-h] --cluster cluster_name --cluster_id cluster_id
Quick build config
optional arguments:
-h, --help show this help message and exit
--cluster_name cluster_name
cluster name
--cluster_id cluster_id
cluster id
Example: ./obdiag config --cluster_name demo1 --cluster_id xxx
通过 ./obdiag -h 的命令，可以查看 Oceanbase Diagnostic Tool 的使用帮助。
usage: ./obdiag [-h] {config,gather} ...
Oceanbase Diagnostic Tool
positional arguments:
{config,gather}
config Quick build config
gather Gather logs and other information
optional arguments:
-h, --help show this help message and exit
OceanBase Diagnostic Tool 使用 MulanPSL - 2.0 许可证。 您可以免费复制及使用源代码。当您修改或分发源代码时，请遵守木兰协议。