KingbaseES 数据库智能巡检工具

一键生成 KingbaseES 数据库健康巡检报告（Word 格式），支持单机/批量巡检、系统资源采集、性能分析、安全检测等 30+ 项核心指标。

本工具是对 KingbaseES 官方 check_db.sh 脚本的 Python 重写与增强，通过执行 SQL 采集数据库状态、配置、性能、对象统计等信息，并自动生成结构化的 Word 报告。适用于数据库管理员进行日常健康检查、性能评估、安全审计等场景。

✅ 全自动采集 ：自动检测数据库版本（V8R3/V8R6/V9），适配 sys 或 pg 系统表前缀。
✅ 系统资源监控：采集主机 CPU、内存、磁盘使用情况（支持本地或 SSH 远程）。
✅ 数据库配置检查：列出所有非缺省参数、归档/自动清理设置。
✅ 性能分析：连接数统计、缓存命中率、BGWriter、死锁、复制延迟、长事务等。
✅ 对象统计：数据类型字段数、对象种类分布、大对象 TOP 20、表空间使用。
✅ 安全审计：用户密码过期时间、锁等待、未使用索引、非法对象名、继承关系。
✅ 插件管理：列出所有可用及已安装的扩展插件。
✅ Word 报告 ：自动生成带有表格的 .docx 报告，结构清晰，可直接阅读或归档。
✅ 多种运行模式 ：
- 单机巡检：交互式输入连接信息，立即执行。
- 批量巡检（Excel）：通过 Excel 模板配置多个数据库实例，一键批量巡检。
- 模板生成：自动生成 Excel 配置模板，方便填写。

bash 复制代码

pip3 install psycopg2-binary python-docx psutil

可选：如需 SSH 远程采集系统信息，还需安装 paramiko（工具已内置支持，但需手动安装）
bash 复制代码
pip3 install paramiko

bash 复制代码

git clone https://github.com/yourusername/kingbase-inspector.git
cd kingbase-inspector
chmod +x main_kingbase.py

bash 复制代码

python3 main_kingbase.py

按提示依次输入：

等待采集完成，报告将生成在 reports/ 目录下，文件名格式：KingbaseES巡检报告_IP_时间戳.docx

生成的 Word 报告包含以下章节：

所有数据均以表格呈现，清晰易读。

需要存在一个名为 test 的数据库（工具默认连接该库执行采集）。如果不存在，请手动创建：
sql 复制代码
```
CREATE DATABASE test;
```
建议使用具有足够权限的数据库用户（推荐 system 或 kingbase），至少需要以下权限：
- 查询系统表/视图（pg_*, sys_*）
- 执行系统函数（pg_read_file 可选，用于获取配置文件 md5）
- 读取 pg_stat_* 统计信息

如果不需要采集操作系统信息，可以在提示时选择不配置 SSH，工具将只采集数据库内部信息。

问题	可能原因	解决方法
`NameError: name 'prefix' is not defined`	代码中使用 `f-string` 导致变量未定义	请确保使用最新版脚本（已修复）
`psycopg2.OperationalError: FATAL: database "test" does not exist`	缺少 test 数据库	登录任意数据库执行 `CREATE DATABASE test;`
部分采集步骤失败（如 license）	该函数在当前版本不存在	不影响整体报告，工具已自动忽略
`ModuleNotFoundError: No module named 'docx'`	缺少 python-docx	执行 `pip3 install python-docx`
Word 报告打开乱码	字体不支持中文	使用 WPS 或 Microsoft Word 打开，一般可正常显示

欢迎提交 Issue 和 Pull Request。

本项目采用 MIT 许可证，允许自由使用、修改和分发。

如有任何问题，欢迎通过 GitHub Issues 交流，或邮件联系作者。

如果觉得这个工具有用，请给个 ⭐ Star 支持一下！