# OpsCheck **Repository Path**: franckielee85/ops-check ## Basic Information - **Project Name**: OpsCheck - **Description**: 一个轻量级、无 Agent 的服务器资产与批量巡检工具。 - **Primary Language**: Unknown - **License**: Not specified - **Default Branch**: main - **Homepage**: None - **GVP Project**: No ## Statistics - **Stars**: 0 - **Forks**: 0 - **Created**: 2026-06-11 - **Last Updated**: 2026-06-11 ## Categories & Tags **Categories**: Uncategorized **Tags**: None ## README # OpsCheck OpsCheck 是一个轻量级、无 Agent 的服务器资产与批量巡检工具,功能设计参考了 Spug 的主机管理和批量执行思路,但聚焦在“服务器资产管理 + SSH 连通测试 + 批量巡检 + 报告沉淀”这条主线。 ## 功能特性 - 服务器资产管理:维护主机名、IP、端口、用户名、环境、标签、备注等信息。 - SSH 连接测试:支持单台服务器 SSH 连通性验证。 - SSH 密码加密:密码使用 `cryptography.Fernet` 加密后保存到本地数据库。 - SSH 私钥认证:支持私钥登录,私钥文件可在页面上传并加密保存。 - 巡检模板:通过 JSON 定义巡检命令、检查项名称和简单告警匹配规则。 - 批量服务器巡检:选择多台服务器并发执行巡检任务。 - 巡检结果保存:保存任务、服务器、命令三个层级的执行结果。 - 巡检详情查看:查看每台服务器、每条命令的状态和输出。 - Markdown 报告生成:按巡检任务生成 Markdown 格式报告。 - Dashboard 概览:展示服务器、巡检任务、定时任务、异常项等关键指标。 - 异常项汇总:集中查看最近巡检中的失败和警告项。 - 定时巡检:按固定分钟间隔自动触发批量巡检。 - 企业微信 / 钉钉推送:巡检完成后可按成功、警告、失败状态推送机器人通知。 - 操作日志:记录资产、模板、巡检、定时任务、通知配置等关键操作。 ## 界面截图 ### Dashboard 概览 ![Dashboard 概览](docs/images/dashboard.png) ### 巡检任务详情 ![巡检任务详情](docs/images/inspection.png) ### 通知推送配置 ![通知推送配置](docs/images/notification.png) ## 运行方式 先安装依赖: ```powershell pip install -r requirements.txt ``` 启动服务: ```powershell python app.py ``` 然后在浏览器打开: ```text http://127.0.0.1:8000 ``` ## 数据存储 OpsCheck 默认使用 SQLite,本地运行时会自动创建数据目录: ```text data/opscheck.db ``` 主要数据表: - `hosts`:服务器资产和加密后的 SSH 凭据。 - `inspection_templates`:巡检模板。 - `inspection_runs`:巡检任务。 - `inspection_host_results`:单台服务器巡检结果。 - `inspection_command_results`:单条巡检命令执行结果。 - `inspection_schedules`:定时巡检配置。 - `notification_settings`:企业微信 / 钉钉通知配置。 - `operation_logs`:操作日志。 ## 安全说明 - `data/` 已加入 `.gitignore`,不会提交数据库、密钥、服务器密码或私钥。 - SSH 密码、SSH 私钥和通知 Webhook 都会加密保存。 - 本地加密密钥保存在: ```text data/secret.key ``` 请妥善保管 `data/secret.key`。如果删除或丢失该文件,旧数据库中已加密的密码、私钥和 Webhook 将无法解密。 ## 定时任务说明 当前定时巡检由 `python app.py` 进程内置调度器负责执行,因此只有服务运行期间才会触发定时任务。 如果用于长期运行,建议后续通过 Windows 服务、systemd、Docker 或进程守护工具托管该服务。 ## 项目定位 OpsCheck 当前更适合作为轻量级服务器巡检台或个人 / 小团队运维工具。它不是完整 CMDB,也不是完整监控系统,后续可以继续扩展: - 用户登录与权限控制 - 巡检报告导出 PDF / HTML - 巡检结果趋势分析 - 主机分组和标签筛选增强 - 更完善的告警规则和命令输出解析 - Docker 化部署