README-CN.md

OceanBase Diagnostic Tool (obdiag)

简介

OceanBase Diagnostic Tool (obdiag) 是一款专门OceanBase打造的敏捷诊断工具，功能包括诊断信息收集、分析、巡检，可以在OceanBase集群不同的部署模式下（OCP，OBD或用户根据文档手工部署）实现一键执行。

项目价值 & 愿景

安装 obdiag

可通过如下方式安装obdiag

方式一: 通过rpm包安装

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
sh dev_init.sh
source ~/.bashrc

obdiag config

配置文件的默认路径是~/.obdiag/config.yml . 可直接编辑配置文件或者通过obdiag config <option> 命令快速生成配置

obdiag config -h <db_host> -u <sys_user> [-p password] [-P port]

obdiag 功能

• 一键集群巡检
• 一键诊断分析
• 一键根因分析
• 一键信息采集

参与贡献

obdiag 期望构建一个开放的社区，我们欢迎任何形式的贡献，您可以：

• 通过 Issues 提交 bug。
• 通过 Discussion 参与或发起讨论。
• 通过 Pull requests 提交问题修复或者功能特性。

Roadmap Ahead

版本	迭代周期	发布日期	功能点
1.6.0	2024.01	2024.01.31	场景化信息采集 场景化根因分析
2.0.0	2024.03	2024.04.11	context改造，场景化扩展能力增强 支持在线更新巡检、采集的task 根因分析二期
2.1.0	2024.04	2024.05.13	根因分析场景扩展 新增 ash 报告 采集
2.2.0	2024.05	-	根因分析场景扩展
2.3.0	2024.06	-	根因分析场景扩展 支持 SQL 诊断
2.4.0	2024.07	-	根因分析场景扩展 适配两款内核的诊断工具
2.5.0	2024.08	-	根因分析场景扩展 支持 OMS 诊断
3.0.0	2024.09	-	根因分析场景扩展 服务化改造
3.1.0	2024.10	-	根因分析场景扩展 支持巡检报告比对
3.2.0	2024.11	-	根因分析场景扩展 SQL 诊断二期，支持SQL问题的根因分析
3.3.0	2024.12	-	AI 化探索

许可证

OceanBase Diagnostic Tool 使用 MulanPSL - 2.0 许可证。 您可以免费复制及使用源代码。当您修改或分发源代码时，请遵守木兰协议。

支持

如果您在使用 OceanBase LogProxy 时遇到任何问题，欢迎联系我们寻求帮助：

• GitHub Issue
• 官方网站

加入我们

请添加 OB社区小助手（微信号：obce666）并备注“obdiag SIG”，工作人员会联系并指引您加入 SIG 的相关事宜。期待您的积极参与与宝贵贡献！