obdiag 安装

本文将介绍安装 obdiag 的方法。在线体验请移步 在线体验。

环境要求

1. obdiag 支持在 Linux 环境上运行。
2. 源码安装需 Python >= 3.11。

前提条件

obdiag 在执行信息采集、集群巡检、根因分析、在线日志分析及全链路诊断时需连接被诊断主机，请确保 obdiag 所在机器与 OceanBase 集群网络可达。

安装步骤

obdiag 可独立部署或通过 obd 使用，以下方式任选其一。

方式一：RPM/DEB 包安装（独立部署）

适用于待诊断集群非 obd 部署的场景。

• 在线部署（可访问外网）

  sudo yum install -y yum-utils
  sudo yum-config-manager --add-repo https://mirrors.aliyun.com/oceanbase/OceanBase.repo
  sudo yum install -y oceanbase-diagnostic-tool
  sh /opt/oceanbase-diagnostic-tool/init.sh
  

  说明

  在线 YUM 方式支持 CentOS 7/8，暂不支持 CentOS 9；CentOS 9 请使用下方离线部署或源码安装。

• 离线部署（不可访问外网）

  从 OceanBase 官网 下载页 下载最新版 OceanBase 敏捷诊断工具（obdiag）。

  yum localinstall -y oceanbase-diagnostic-tool*.rpm
  sh /opt/oceanbase-diagnostic-tool/init.sh
  

• Debian 系（如 Ubuntu）

  从 下载页 下载 obdiag 的 RPM 包后，转换为 DEB 并安装：

  apt-get update
  apt-get install alien -y
  alien --scripts --to-deb oceanbase-diagnostic-tool*.rpm
  dpkg -i oceanbase-diagnostic-tool*.deb
  sh /opt/oceanbase-diagnostic-tool/init.sh
  

方式二：源码安装

适用于需要从源码构建或定制 obdiag 的场景，要求 Python >= 3.11。

# 在 obdiag 源码根目录下执行
make init
source ~/.bashrc

执行完成后可直接使用 obdiag 命令。

方式三：obd 部署

若待诊断集群由 obd 部署，建议将 obd 升级至 V2.5.0 及以上，通过 obd 命令直接使用 obdiag，无需单独配置 ~/.obdiag/config.yml。详细命令参见 诊断工具命令组。

• 在线部署

  obd mirror enable remote
  obd obdiag deploy
  

• 离线部署

  从 下载页 下载 obdiag 的 RPM 包后：

  obd mirror clone oceanbase-diagnostic-tool-*.rpm
  obd obdiag deploy