# 下载源代码
git clone https://github.com/oceanbase/oceanbase-diagnostic-tool.git

# 编译(编译过程是拉取python依赖包放到编译目录下)
cd oceanbase-diagnostic-tool && sh ./build/build.sh

# 编译后会在./build/生成一个tar.gz的包
cd ./build/
ls
oceanbase-diagnostic-tool-1.0.0-yyyyMMddHHmmss.tar.gz

tar zxvf oceanbase-diagnostic-tool-1.0.0-yyyyMMddHHmmss.tar.gz

# 配置一：这部分的配置是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 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

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