签入版本
This commit is contained in:
@@ -0,0 +1,57 @@
|
||||
# 定时任务日志
|
||||
|
||||
:::tip 说明
|
||||
定时任务日志模块记录定时任务的执行历史,包括执行时间、执行结果、耗时等信息。模块位于 `src/modules/job_log/`,与定时任务模块(`modules/job/`)配合使用。
|
||||
:::
|
||||
|
||||
## 模块结构
|
||||
|
||||
```
|
||||
src/modules/job_log/
|
||||
├── models.py # 日志模型
|
||||
├── schemas.py # 参数验证
|
||||
├── repository.py # 数据访问层
|
||||
├── service.py # 业务逻辑层
|
||||
└── handlers.py # 请求处理器
|
||||
```
|
||||
|
||||
## 数据模型
|
||||
|
||||
```python
|
||||
class JobLog(BaseModel):
|
||||
"""定时任务日志模型"""
|
||||
__tablename__ = "job_log"
|
||||
|
||||
job_id = Column(Integer, nullable=False, comment="任务ID")
|
||||
job_name = Column(String(255), default="", comment="任务名称")
|
||||
job_group = Column(String(255), default="", comment="任务分组")
|
||||
invoke_target = Column(String(500), default="", comment="调用目标")
|
||||
job_message = Column(String(500), default="", comment="日志信息")
|
||||
status = Column(Integer, default=0, comment="状态:0=正常 1=失败")
|
||||
exception_info = Column(Text, default="", comment="异常信息")
|
||||
start_time = Column(String(50), default="", comment="开始时间")
|
||||
end_time = Column(String(50), default="", comment="结束时间")
|
||||
elapsed_time = Column(Integer, default=0, comment="耗时(毫秒)")
|
||||
```
|
||||
|
||||
## API 接口
|
||||
|
||||
| 接口 | 方法 | 权限 | 说明 |
|
||||
|:-----|:-----|:-----|:-----|
|
||||
| `/api/v1/joblog/page` | GET | `sys:joblog:list` | 分页查询 |
|
||||
| `/api/v1/joblog/detail/(\d+)` | GET | `sys:joblog:detail` | 详情查询 |
|
||||
| `/api/v1/joblog/delete/(\d+)` | DELETE | `sys:joblog:delete` | 删除 |
|
||||
| `/api/v1/joblog/batchDelete` | POST | `sys:joblog:delete` | 批量删除 |
|
||||
|
||||
## 与定时任务模块的关系
|
||||
|
||||
| 模块 | 职责 |
|
||||
|:-----|:-----|
|
||||
| `modules/job/` | 定时任务的 CRUD 管理和调度执行 |
|
||||
| `modules/job_log/` | 任务执行日志的记录和查询 |
|
||||
|
||||
任务执行时自动记录日志,包括成功/失败状态、异常信息、执行耗时等。
|
||||
|
||||
## 总结
|
||||
|
||||
定时任务日志模块记录任务执行历史,支持按任务名称、状态、时间范围筛选,支持单条和批量删除,便于任务执行情况的监控和问题排查。
|
||||
Reference in New Issue
Block a user