Phoenix监控平台技术文档
1. 安装指南
1.1 环境要求
-
运行环境:
- Maven 3+
- JDK ≥1.8(若使用Sigar监控服务器,需使用JDK 1.8.0_131到1.8.0_241版本)
- Lombok插件
- MySQL 5.7+
-
最低资源需求:
- 1核CPU
- 2GB内存
- 5GB磁盘空间
1.2 安装方式
Docker安装(推荐)
bash -c "$(curl -fsSL https://gitee.com/monitoring-platform/phoenix/raw/master/doc/Docker/install.sh)"
要求:Docker 20.10.14及以上版本
Docker Compose安装
bash -c "$(curl -fsSL https://gitee.com/monitoring-platform/phoenix/raw/master/doc/DockerCompose/install.sh)"
要求:Docker Compose 2.0.0及以上版本
源码编译安装
-
从以下仓库下载最新发行版源码:
- GitCode:
monitoring-platform/phoenix - Gitee:
monitoring-platform/phoenix - GitHub:
709343767/phoenix
- GitCode:
-
使用Maven构建项目:
mvn clean package
-
导入数据库脚本(位于
doc/database目录) -
启动各模块:
- 服务端:
phoenix-server/target/phoenix-server.jar - UI端:
phoenix-ui/target/phoenix-ui.jar - 代理端(可选):
phoenix-agent/target/phoenix-agent.jar
- 服务端:
2. 使用说明
2.1 访问系统
- 默认访问地址:
http://服务器IP/phoenix-ui/index - 初始账号:
- 管理员:admin/admin123
- 访客:guest/guest123
2.2 核心功能配置
监控目标配置
-
服务器监控:
- 在目标服务器部署代理端(phoenix-agent)
- 配置服务器IP、SNMP协议(网络设备需开启SNMP)
-
应用程序监控:
- Java应用:集成对应客户端依赖
<!-- SpringBoot应用 --> <dependency> <groupId>com.gitee.pifeng</groupId> <artifactId>phoenix-client-spring-boot-starter</artifactId> <version>1.2.6.RELEASE-CR3</version> </dependency> -
数据库监控:
- 配置数据库连接信息(支持MySQL/Oracle/Redis/Mongo)
告警配置
- 进入"告警定义"页面
- 配置触发条件(如CPU>90%持续5分钟)
- 选择通知方式(邮件/钉钉/企业微信/飞书)
3. API使用文档
3.1 客户端API
心跳接口
- URL:
/phoenix/client/heartbeat - 方法: POST
- 参数:
{ "appName": "应用名称", "instanceId": "实例ID", "ip": "客户端IP" }
服务器信息上报
- URL:
/phoenix/client/server-info - 方法: POST
- 参数:
{ "cpuUsage": 75.2, "memoryUsage": 68.5, "diskInfo": [...] }
3.2 服务端API
告警查询接口
- URL:
/phoenix/server/alarms - 方法: GET
- 参数:
severity(可选): 告警级别(CRITICAL/MAJOR/MINOR)startTime(可选): 开始时间戳endTime(可选): 结束时间戳
4. 项目架构说明
4.1 系统架构
采用分布式设计,包含:
- 客户端:集成到被监控应用
- 代理端:数据收集与转发
- 服务端:核心分析与告警引擎
- UI端:可视化管理系统
4.2 技术栈
- 后端:SpringBoot + MyBatis-Plus
- 前端:Layui + ECharts
- 监控组件:
- Sigar(服务器监控)
- SNMP4J(网络设备)
- Docker-Java(容器监控)
4.3 数据安全
- 传输层加密(HTTPS)
- 敏感配置信息加密存储
- 基于Spring Security的RBAC权限控制
注意事项:
- 开源版本禁止修改Logo和版权信息
- 高级标注功能为付费模块
- 建议生产环境使用Docker部署保证隔离性
- Windows服务器监控需手动部署Sigar库
创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考



