obdiag
obdiag copied to clipboard
oceanbase
obdiag (OceanBase Diagnostic Tool) is designed to help OceanBase users quickly gather necessary information and analyze the root cause of the problem.
English | 中文版
OceanBase Diagnostic Tool (obdiag)
Overview
OceanBase Diagnostic Tool (obdiag) is a quick diagnostic tool for open-source OceanBase software. The features include gather\analyze\check OceanBase Diagnostic information. It can be executed with one click in different deployment modes of OceanBase clusters (OCP, OBD, or manually deployed by users according to documentation).
Project Value & Vision
Install obdiag
You can install obdiag by using these methods:
Method 1: Install obdiag by using RPM packages
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 /usr/local/oceanbase-diagnostic-tool/init.sh
Method 2: Install obdiag by using the source code
To install obdiag on Python >= 3.8, run these commands:
pip3 install -r requirements3.txt
sh dev_init.sh
source ~/.bashrc
obdiag config
The path of the configuration file for the diagnosed cluster is stored in ~/.obdiag/config.yml .You can directly edit the configuration file or generate the configuration file through the obdiag config <option> command
obdiag config -h <db_host> -u <sys_user> [-p password] [-P port]
obdiag Fuctions
- One-click cluster inspection
- One-click diagnostic analyze
- One-click root cause analysis
- One-click information collection
For more details, please refer to Official docs
Join the Contributing Community
obdiag envisions an open community. We welcome your contributions in any form:
- Report bugs through Issues.
- Participate in or initiate discussions via Discussion.
- Contribute bug fixes or new features through Pull requests.
Roadmap Ahead
| Version | Iteration Period | Release Date | Function |
|---|---|---|---|
| 1.6.0 | 2024.01 | 2024.01.31 |
|
| 2.0.0 | 2024.03 | 2024.04.11 |
|
| 2.1.0 | 2024.04 | 2024.05.13 |
|
| 2.2.0 | 2024.05 | - |
|
| 2.3.0 | 2024.06 | - |
|
| 2.4.0 | 2024.07 | - |
|
| 2.5.0 | 2024.08 | - |
|
| 3.0.0 | 2024.09 | - |
|
| 3.1.0 | 2024.10 | - |
|
| 3.2.0 | 2024.11 | - |
|
| 3.3.0 | 2024.12 | - |
|
Licencing
OceanBase Database is under MulanPubL - 2.0 license. You can freely copy and use the source code. When you modify or distribute the source code, please obey the MulanPubL - 2.0 license.
Support
In case you have any problems when using obdiag, welcome reach out for help:
Join us
Please add the OB community assistant (WeChat ID: obce666) and note "obdiag SIG", and the staff will contact you and guide you on matters related to joining SIG. We look forward to your active participation and valuable contributions!
oceanbase