---
title: "obdiag 配置 - 敏捷诊断工具 V1.2.1 | OceanBase 文档中心"
description: "obdiag 配置 本文将介绍 obdiag 配置文件。 前提条件 请确保已经安装 obdiag，详细信息，请参见 安装 obdiag 。 配置说明 所有的配置都在 {obdiag_install_path}/conf/ 目录下的 config.yml 中，配置文件的默认路径为 /usr/local/oceanbas…"
image: https://mdn.alipayobjects.com/huamei_22khvb/afts/img/A*OSPzQ6GUQF4AAAAAQHAAAAgAeiGDAQ/original
---
切换语言

- 中文站 - 简体中文
- International - English
- 日本站 - 日本語

文档反馈![](https://mdn.alipayobjects.com/huamei_22khvb/afts/img/A*5ZXST55u540AAAAAAAAAAAAADiGDAQ/original) 敏捷诊断工具V 1.2.1

# obdiag 配置

更新时间：2023-11-16 11:06:09

[编辑](https://github.com/oceanbase/odt-doc/edit/V1.2.1/zh-CN/300.obdiag-config-guide.md)  

本文将介绍 obdiag 配置文件。

## 前提条件

请确保已经安装 obdiag，详细信息，请参见 [安装 obdiag](https://www.oceanbase.com/docs/common-obdiag-cn-1000000000164123) 。

## 配置说明

所有的配置都在 `{obdiag_install_path}/conf/` 目录下的 `config.yml` 中，配置文件的默认路径为 `/usr/local/oceanbase-diagnostic-tool/conf/config.yml`，请直接修改该配置文件。

分为四个配置块，具体信息如下：

```yaml
# 配置一：这部分的配置是 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 本身的日志打印相关配置
    file_handler_log_level: DEBUG # 输出到日志文件中的日志级别
    log_dir: /tmp/oceanbase-diagnostic-tool/log # obdiag 日志文件路径
    log_filename: odt.log # obdiag 日志文件名
    log_level: INFO # obdiag 日志输出的级别
    mode: obdiag
    stdout_handler_log_level: DEBUG

# 配置二：属于 OCP 的配置，有 OCP 托管的集群可以配置上, 没有 OCP 的话直接不填即可
OCP:
  LOGIN: # OCP 白屏的登录信息
    password: xxxx
    url: http://xxx.xxx.xxx.xxx:xxxx
    user: xxx
  METADB:
    dbname: xxx
    ip: xxx.xxx.xxx.xxx
    password: xxxx
    port: xxx
    user: xxx

# 配置三：需要收集的集群连接信息，用于查看 gather plan_monitor 的时候使用，如不需要该命令可不填该配置
OBCLUSTER:
  cluster_name: xxx
  host: xxx.xxx.xxx.xxx
  password: xxx
  port: xxx
  user: xxx

# 配置四：收集的节点的登录信息
NODES:
- ip: xxx.xxx.xxx.xxx
  password: xxx
  port: xxx
  private_key: ''
  user: xxx

```

使用时需根据实际情况配置上述的四个配置。其中 obdiag 极少修改，其他三个配置项按需修改。

当存在 OCP 托管的集群时，如果需要收集某个集群下的所有主机的，可通过 `./obdiag config` 来快速生成需要采集的节点配置内容,使用方式如下:

```yaml
./obdiag config --cluster_name cluster_name --cluster_id cluster_id

Example: ./obdiag config --cluster_name demo1 --cluster_id 1

```

选项说明如下：

| 参数名称 | 是否必须 | 说明 |
| --- | --- | --- |
| -h | 否 | 使用帮助 |
| --cluster_name | 是 | OCP 白屏界面上的集群名称 |
| --cluster_id | 是 | OCP 界面上的集群 ID |

#### 说明

- 使用 `config` 命令需确保配置二已经设置好。
 - 执行 `./obdiag config --cluster_name cluster_name --cluster_id cluster_id` 时候会进入到交互界面来选择你需要采集的节点，按 **空格** 键选中或取消机器，按 **上下键**可移动 `*` 号选中的机器，按 **回车键** 将会执行配置的快速获取。
 - 至少需要选择一台机器。

```shell
press SPACE to mark, ENTER to continue
   xxx.xxx.xxx.11
   xxx.xxx.xxx.12
 * xxx.xxx.xxx.13
   xxx.xxx.xxx.14

```

执行完成后会更新 `conf` 目录下的 `config.yml` 中 `NODES` 部分的配置，在 yaml 中展示需要采集的主机列表。

 上一篇 下一篇 ![有帮助](https://gw.alipayobjects.com/mdn/ob_asset/afts/img/A*y6ocSqN8cqsAAAAAAAAAAAAAARQnAQ)![无帮助](https://gw.alipayobjects.com/mdn/ob_asset/afts/img/A*BG9IQJyLHF8AAAAAAAAAAAAAARQnAQ)![反馈](https://gw.alipayobjects.com/mdn/ob_asset/afts/img/A*eTWdQKCRKHwAAAAAAAAAAAAAARQnAQ)[AI](https://www.oceanbase.com/obi) 咨询热线