Install obdiag|V2.3.0|OceanBase Diagnostic Tool |docs|OceanBase Documentations

This topic describes how to install OceanBase Diagnostic Tool (obdiag).

Environment requirements

The server where obdiag is to be installed runs on Linux.

Prerequisites

To collect fault information, inspect a cluster, perform root cause analysis, analyze logs online, and perform online end-to-end diagnostics, network access must be available between the server where obdiag is to be installed and the host of the target OceanBase cluster whose information is to be collected.

Procedure

You can use obdiag independently or in combination with OceanBase Deployer (obd).

Method 1: Use obdiag independently

If the cluster to be diagnosed is not deployed by using OBD, you can run the following commands to install and deploy obdiag:

Online deployment (when Internet access is available)

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

Note

The online deployment method is supported on CentOS 7 and 8. If you use CentOS 9, perform the following operations for offline deployment.

Offline deployment (when Internet access is unavailable) Download the obdiag package of the latest version from OceanBase Download Center.
```
yum install -y oceanbase-diagnostic-tool*.rpm
source /usr/local/oceanbase-diagnostic-tool/init.sh
```

Deployment on a Debian-based system, such as Ubuntu Download the obdiag package of the latest version from OceanBase Download Center.

apt-get update
apt-get install alien -y
alien --scripts --to-deb  oceanbase-diagnostic-tool*.rpm # Convert the RPM package to a DEB package.
dpkg -i oceanbase-diagnostic-tool*.deb
source /usr/local/oceanbase-diagnostic-tool/init.sh

Method 2: Use obdiag in combination with OBD

If the cluster to be diagnosed is deployed by using OBD, we recommend that you upgrade OBD to V2.5.0 or later. Then, you can directly run obdiag commands on OBD without the need to configure the ~/.obdiag/config.yml file. For more information about the commands, see obdiag commands.

Online deployment (when Internet access is available)

# Enable OBD to pull remote images.
obd mirror enable remote
# Deploy obdiag by using OBD.
obd obdiag deploy

Offline deployment (when Internet access is unavailable)

Download the obdiag package of the latest version from OceanBase Download Center.

# Copy the offline obdiag package to the image repository of OBD.
obd mirror clone oceanbase-diagnostic-tool-xxxxxxxx.rpm
# Deploy obdiag by using OBD.
obd obdiag deploy