feat: 添加系统监控和系统助手功能截图并更新文档
添加监控配置、操作日志和接口日志相关的功能截图 更新系统监控和系统助手的文档内容,补充截图说明
This commit is contained in:
@@ -9,6 +9,10 @@
|
||||
- 操作日志查询:记录用户的系统操作行为,支持按用户、IP、时间等条件查询
|
||||
- 接口日志查询:记录与设备对接的接口交互日志,支持按IP、接口名称等条件查询
|
||||
|
||||
**功能对应截图** :
|
||||
|
||||

|
||||
|
||||
## 2. 术语说明
|
||||
|
||||
#### 2.1.1 日志相关术语
|
||||
@@ -19,6 +23,8 @@
|
||||
| 接口日志 | 系统与外部设备/系统的交互记录 | 包括设备对接、数据传输等 |
|
||||
| 托盘号(tray) | 设备托盘的唯一标识 | 用于设备对接追踪 |
|
||||
| 批次号(batch) | 生产批次的唯一标识 | 用于生产流程追踪 |
|
||||
| 电池条码 | 电池条码的唯一标识 | 用于生产流程追踪 |
|
||||
| 工序编码 | 工序编码的唯一标识 | 用于生产流程追踪 |
|
||||
| 接口状态码 | 接口调用的返回状态 | 0表示成功,4001/4002表示失败 |
|
||||
|
||||
## 3. 操作日志
|
||||
@@ -42,6 +48,10 @@
|
||||
2. 在顶部查询区域设置查询条件
|
||||
3. 点击【查询】按钮获取操作日志列表
|
||||
|
||||
**功能对应截图** :
|
||||
|
||||

|
||||

|
||||
### 3.2 操作日志字段说明
|
||||
|
||||
| 字段 | 说明 |
|
||||
@@ -93,6 +103,10 @@
|
||||
2. 在顶部查询区域设置查询条件
|
||||
3. 点击【查询】按钮获取接口日志列表
|
||||
|
||||
**功能对应截图** :
|
||||
|
||||

|
||||
|
||||
### 4.2 接口日志字段说明
|
||||
|
||||
| 字段 | 说明 |
|
||||
@@ -113,71 +127,17 @@
|
||||
| 数据4 | 扩展字段1 |
|
||||
| 数据5 | 扩展字段2 |
|
||||
|
||||
### 4.3 接口状态码说明
|
||||
### 4.3 查看接口详情
|
||||
|
||||
| 状态码 | 说明 |
|
||||
|--------|------|
|
||||
| 0 | 接口调用成功 |
|
||||
| 4001 | 接口调用失败 |
|
||||
| 4002 | 接口超时 |
|
||||
**操作步骤:**
|
||||
|
||||
## 5. 后台API接口
|
||||
1. 点击接口日志列表中的查看响应按钮
|
||||
2. 查看接口调用的详细信息,包括请求参数、返回结果、状态码等
|
||||
|
||||
### 5.1 操作日志接口
|
||||
**功能对应截图** :
|
||||
|
||||
| API路径 | 方法 | 功能描述 | 所属文件 |
|
||||
|---------|------|---------|---------|
|
||||
| `/api/background/v1/system_settings/system_assistant/operate_log/list` | GET | 获取操作日志列表 | OperateLogService.php:31 |
|
||||

|
||||
|
||||
### 5.2 接口日志接口
|
||||
|
||||
| API路径 | 方法 | 功能描述 | 所属文件 |
|
||||
|---------|------|---------|---------|
|
||||
| `/api/background/v1/system_settings/system_assistant/interface_log/list` | GET | 获取接口日志列表 | InterfaceLogService.php:31 |
|
||||
|
||||
## 6. 数据模型
|
||||
|
||||
### 6.1 操作日志表
|
||||
|
||||
| 字段名 | 类型 | 说明 |
|
||||
|--------|------|------|
|
||||
| id | int | 日志唯一标识 |
|
||||
| user_id | int | 用户ID |
|
||||
| username | varchar | 用户名 |
|
||||
| path | varchar | 请求路径 |
|
||||
| controller_action | varchar | 控制器和方法 |
|
||||
| ip | varchar | 操作IP |
|
||||
| status | tinyint | 操作状态 |
|
||||
| params | text | 请求参数(JSON) |
|
||||
| result | text | 返回结果(JSON) |
|
||||
| action | varchar | 操作类型 |
|
||||
| action_name | varchar | 操作名称 |
|
||||
| tray | varchar | 托盘号 |
|
||||
| batch | varchar | 批次号 |
|
||||
| create_time | datetime | 创建时间 |
|
||||
|
||||
### 6.2 接口日志表
|
||||
|
||||
| 字段名 | 类型 | 说明 |
|
||||
|--------|------|------|
|
||||
| id | int | 日志唯一标识 |
|
||||
| unit | varchar | 设备单元 |
|
||||
| client_ip | varchar | 客户端IP |
|
||||
| data1 | varchar | 数据字段1(工序代码) |
|
||||
| data2 | varchar | 数据字段2(托盘号) |
|
||||
| data3 | varchar | 数据字段3(电池ID) |
|
||||
| data4 | varchar | 数据字段4 |
|
||||
| data5 | varchar | 数据字段5 |
|
||||
| create_time | datetime | 创建时间 |
|
||||
| insterface_time | datetime | 接口调用时间 |
|
||||
| status | int | 接口状态码 |
|
||||
| class | varchar | 接口类别 |
|
||||
| type | varchar | 接口类型 |
|
||||
| params | text | 请求参数(JSON) |
|
||||
| result | text | 返回结果(JSON) |
|
||||
|
||||
## 7. 注意事项
|
||||
|
||||
**【提示】** 操作日志和接口日志默认只保留最近一周的数据,如需查看更早的数据,请调整时间范围。
|
||||
## 5. 注意事项
|
||||
|
||||
**【注意】** 接口日志中的数据字段(data1-data5)用途根据接口类型不同而有所差异,具体含义需要结合业务场景理解。
|
||||
Reference in New Issue
Block a user