Files
HF-MES-manual/system_settings/system_monitoring.md

119 lines
3.9 KiB
Markdown
Raw Normal View History

# 系统监控
## 1. 功能概述
系统监控模块用于配置和管理系统监控参数,实现对服务器资源的实时监控和告警设置。
**核心功能:**
- 监控配置管理:创建、编辑、删除监控配置
- 资源告警设置配置CPU、磁盘、内存的告警阈值
- 监控刷新设置:配置监控数据的刷新间隔
- 监控列表查询:支持按名称和编号筛选
## 2. 术语说明
#### 2.1.1 监控相关术语
| 术语 | 定义 | 说明 |
|------|------|------|
| 监控编号 | 监控配置的唯一标识 | 用于区分不同的监控目标 |
| 刷新间隔 | 监控数据更新的时间间隔 | 单位通常为秒 |
| CPU告警阈值 | CPU使用率的告警界限 | 超过此值触发告警 |
| 磁盘告警阈值 | 磁盘使用率的告警界限 | 超过此值触发告警 |
| 内存告警阈值 | 内存使用率的告警界限 | 超过此值触发告警 |
## 3. 监控设置管理
### 3.1 监控配置查询
**查询条件:**
| 查询条件 | 说明 |
|---------|------|
| 名称 | 按监控名称模糊查询 |
| 编号 | 按监控编号模糊查询 |
**操作步骤:**
1. 进入【系统设置】→【系统监控】→【监控设置】
2. 在顶部查询区域设置查询条件
3. 点击【查询】按钮获取监控配置列表
### 3.2 新增监控配置
**操作步骤:**
1. 点击【新增】按钮
2. 填写监控配置信息
3. 点击【确定】完成新增
**字段说明:**
| 字段 | 说明 | 必填 |
|------|------|------|
| 监控编号 | 监控的唯一标识代码 | 是 |
| 监控名称 | 监控的中文名称 | 是 |
| IP地址 | 被监控服务器的IP地址 | 是 |
| 端口 | 监控服务端口 | 是 |
| 刷新间隔 | 数据刷新间隔(秒) | 是 |
| CPU告警阈值 | CPU使用率告警阈值(%) | 是 |
| 磁盘告警阈值 | 磁盘使用率告警阈值(%) | 是 |
| 内存告警阈值 | 内存使用率告警阈值(%) | 是 |
| 版本 | 监控服务版本号 | 否 |
**【提示】** 监控编号和监控名称不能重复。
### 3.3 编辑监控配置
**操作步骤:**
1. 在监控列表中点击需要编辑的配置
2. 修改配置信息
3. 点击【确定】保存更改
### 3.4 删除监控配置
**操作步骤:**
1. 在监控列表中选择需要删除的配置
2. 点击【删除】按钮
3. 在确认对话框中点击【确定】
**【提示】** 支持批量删除多个监控配置。
## 4. 后台API接口
| API路径 | 方法 | 功能描述 | 所属文件 |
|---------|------|---------|---------|
| `/api/background/v1/system_settings/system_monitoring/monitoring_setting/list` | GET | 获取监控配置列表 | MonitoringSettingService.php:31 |
| `/api/background/v1/system_settings/system_monitoring/monitoring_setting/create` | POST | 创建监控配置 | MonitoringSettingService.php:84 |
| `/api/background/v1/system_settings/system_monitoring/monitoring_setting/edit` | POST | 编辑监控配置 | MonitoringSettingService.php:145 |
| `/api/background/v1/system_settings/system_monitoring/monitoring_setting/delete` | POST | 删除监控配置 | MonitoringSettingService.php:201 |
## 5. 数据模型
### 5.1 监控配置表
| 字段名 | 类型 | 说明 |
|--------|------|------|
| id | int | 配置唯一标识 |
| code | varchar | 监控编号 |
| name | varchar | 监控名称 |
| port | int | 监控端口 |
| ip | varchar | 服务器IP地址 |
| refresh_interval | int | 刷新间隔(秒) |
| cpu_warning | int | CPU告警阈值(%) |
| disk_warning | int | 磁盘告警阈值(%) |
| mem_warning | int | 内存告警阈值(%) |
| version | varchar | 版本号 |
| sort | int | 排序序号 |
| create_time | datetime | 创建时间 |
## 6. 注意事项
**【提示】** 告警阈值建议设置在合理范围,避免过于频繁的告警通知。
**【注意】** 监控配置删除后无法恢复,请谨慎操作。
**【重要】** 确保配置的IP地址和端口可以正常访问否则监控数据无法获取。