200.install‐and‐deploy‐obdiag

obdiag 安装

本文将介绍安装 obdiag 的方法。

环境要求

1. obdiag 支持在 Linux 环境上运行。

前提条件

obdiag 采集故障信息、集群巡检、根因分析和在线分析日志以及在线全链路诊断的时候需要连接到被采集主机上，请确保 obdiag 所在的机器和 OceanBase 集群网络可达。

安装步骤

obdiag 工具可以独立部署使用也可以通过 OBD 来使用，以下方式二选一。

方式一：obdiag 独立部署使用

如果您的待诊断集群是通过其他方式部署(非 OBD 部署)，可以下面的方式进行安装部署 obdiag。

• 在线部署(可访问外网的情况下可选择)

  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
  source /usr/local/oceanbase-diagnostic-tool/init.sh

说明

• 在线部署的方式支持 centos7/8 暂不支持centos9, 如果是 centos9 请参照下面的离线部署方式

• 离线部署(不可访问外网的情况下可选择) OceanBase官网 下载页 下载新版的 OceanBase 数据库定制的敏捷诊断工具（obdiag）。

  yum install -y oceanbase-diagnostic-tool*.rpm
  source /usr/local/oceanbase-diagnostic-tool/init.sh

• debian系（如 Ubuntu）部署 OceanBase官网 下载页 下载新版的 OceanBase 数据库定制的敏捷诊断工具（obdiag）。

  apt-get update
  apt-get install alien -y
  alien --scripts --to-deb  oceanbase-diagnostic-tool*.rpm #转为deb包
  dpkg -i oceanbase-diagnostic-tool*.deb
  source /usr/local/oceanbase-diagnostic-tool/init.sh

方式二：OBD 部署方式

如果你的待诊断集群是 OBD 部署的，建议升级 OBD 到 V2.5.0 及以上版本，可通过 OBD 的命令直接使用 obdiag 工具，无需配置 ~/.obdiag/config.yml 文件，详细命令可参考 诊断工具命令组。

• 在线部署(可访问外网的情况下可选择)

  # 开启 OBD 远程镜像拉取模式
  obd mirror enable remote
  # 通过 OBD 部署 obdiag
  obd obdiag deploy

• 离线部署(不可访问外网的情况下可选择)

  OceanBase官网 下载页 下载新版的 OceanBase 数据库定制的敏捷诊断工具（obdiag）。

  # 将离线的 obdiag 包拷贝到 OBD 的镜像仓库中
  obd mirror clone oceanbase-diagnostic-tool-xxxxxxxx.rpm
  # 通过 OBD 部署 obdiag
  obd obdiag deploy