OceanBase Diagnostic Tool (obdiag) 是一款专门为OceanBase打造的敏捷诊断工具,功能包括诊断信息收集、分析、巡检,可以在OceanBase集群不同的部署模式下(OCP,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
sh /usr/local/oceanbase-diagnostic-tool/init.sh
源码安装需要在python >= 3.8的环境下进行
pip3 install -r requirements3.txt
./dev_init.sh
source ~/.bashrc
配置文件的默认路径是~/.obdiag/config.yml
. 可直接编辑配置文件或者通过obdiag config <option>
命令快速生成配置
obdiag config -h <db_host> -u <sys_user> [-p password] [-P port]
- 一键集群巡检
- 一键诊断分析
- 一键根因分析
- 一键信息采集
obdiag 期望构建一个开放的社区,我们欢迎任何形式的贡献,您可以:
- 通过 Issues 提交 bug。
- 通过 Discussion 参与或发起讨论。
- 通过 Pull requests 提交问题修复或者功能特性。
版本 | 迭代周期 | 发布日期 | 功能点 |
---|---|---|---|
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 | 2024.06.14 |
|
2.3.0 | 2024.06 | 2024.07.24 |
|
2.4.0 | 2024.07 | 2024.09.03 |
|
2.5.0 | 2024.09 | - |
|
3.0.0 | 2024.10 | - |
|
3.1.0 | 2024.11 | - |
|
3.2.0 | 2024.12 | - |
|
4.0.0 | 2025.01 | - |
|
如果您在使用 OceanBase LogProxy 时遇到任何问题,欢迎联系我们寻求帮助:
请添加 OB社区小助手(微信号:obce666)并备注“obdiag SIG”,工作人员会联系并指引您加入 SIG 的相关事宜。期待您的积极参与与宝贵贡献!
- Fork并克隆你的专属副本:在我们的GitHub仓库页面右上角点击“Fork”按钮,这样就在你的账号下创建了一份仓库副本。接下来,使用Git命令将这份副本克隆到你的本地计算机上:
git clone https://github.com/your_username/your_repo_here.git
-
修改代码:无论是修正漏洞还是增添新功能,你的每一份贡献都至关重要。
-
通过 black 工具统一格式化你的代码 🎨
black -S -l 256 {source_file_or_directory}
-
提交你的改动:完成优化后,利用Git提交你的修改。
-
推送到你的Fork仓库:将你的改动推送到GitHub上的Fork仓库中。
-
发起合并请求(PR):回到你的GitHub分叉页面,点击“Open pull request”按钮。对比你的分支与原始仓库的主分支,描述你的改动内容,然后提交PR!
-
🚀 自动化流程接棒此处 🤖
接下来,就交给我们的GitHub Actions流水线:
- 代码检查:PR一旦触发,流水线会自动代码格式化检查以及安全检查。
- 自动构建:PR一旦触发,就会自动将你的改动编译成RPM和DEB两种软件包。
OceanBase Diagnostic Tool 使用 MulanPSL - 2.0 许可证。 您可以免费复制及使用源代码。当您修改或分发源代码时,请遵守木兰协议。