Kris
2e6f087732
- 完成REQ-010-17（性能优化和限流处理）的所有6个阶段 - 创建ADR文档：0026-performance-optimization.md - 创建Prompt文档：027-performance-optimization.md - 创建会话记录：20260119-performance-optimization.md - 创建变更记录：20260119-performance-optimization.md - 创建复盘报告：20260119-performance-optimization-retro.md - 更新index.md和CHANGELOG.md - 完成REQ-010-2（基础实体类和Mapper创建）的前3个阶段 - 更新ADR文档：0011-entity-mapper-create.md - 创建Prompt文档：002-entity-mapper-create.md - 更新index.md 所有文档均按照SSOT方法论创建，包括需求定义、架构决策、提示词资产化、执行会话、变更记录和闭环复盘。
167 lines
5.9 KiB
Markdown
167 lines
5.9 KiB
Markdown
# Requirements - 作业执行监控
|
||
|
||
## 需求信息
|
||
|
||
- **需求名称**: 作业执行监控
|
||
- **需求类型**: 功能需求
|
||
- **需求编号**: REQ-010-14
|
||
- **父需求**: REQ-010
|
||
- **创建日期**: 2026-01-17
|
||
- **需求版本**: v1.0.0
|
||
- **需求提出人**: 系统管理员
|
||
- **需求状态**: 待审核
|
||
|
||
## 输入引用
|
||
|
||
引用相关的 docs 文档链接：
|
||
|
||
- [REQ-010.md](REQ-010.md) - Salesforce元数据拉取和部署主需求文档
|
||
- [REQ-010-1.md](REQ-010-1.md) - 数据库表结构设计和创建
|
||
- [REQ-010-2.md](REQ-010-2.md) - 基础实体类和Mapper创建
|
||
- [REQ-010-6.md](REQ-010-6.md) - 元数据拉取核心功能
|
||
- [REQ-010-8.md](REQ-010-8.md) - 元数据部署核心功能
|
||
- [010-metadata-retrieve-deploy-sub-requirements.md](010-metadata-retrieve-deploy-sub-requirements.md) - REQ-010子需求拆分文档
|
||
- [metadata-module.md](../reference-code/com/docs/metadata-module.md) - Salesforce Metadata API 模块说明（唯一真源）
|
||
- [index.md](../reference-code/com/docs/index.md) - Salesforce SOAP API Java 客户端参考文档（唯一真源）
|
||
|
||
## Context Maps
|
||
|
||
强制列出本次需求依赖的 Canvas 文件：
|
||
|
||
- [Authentication.canvas](../Authentication.canvas) - 项目架构视觉化展示
|
||
- **相关节点**: [集成核心](node_integration_core) - 提供与Salesforce的各种连接方式
|
||
|
||
## 需求目标
|
||
|
||
实现作业执行监控功能，监控拉取和部署作业的执行状态、进度、耗时等。
|
||
|
||
## 需求描述
|
||
|
||
### 概述
|
||
|
||
本需求旨在实现作业执行监控功能，包括作业状态监控、作业进度监控、作业耗时统计、作业失败告警等。
|
||
|
||
### 详细需求
|
||
|
||
#### 1. 作业状态监控
|
||
|
||
- **需求描述**: 实现作业状态监控功能，监控作业的执行状态
|
||
- **优先级**: 中
|
||
- **验收标准**:
|
||
- 作业状态监控正常工作
|
||
- 支持监控拉取作业状态
|
||
- 支持监控部署作业状态
|
||
- 支持监控Quick Deploy作业状态
|
||
- 支持监控Destructive Changes作业状态
|
||
- 状态更新及时
|
||
- **依赖关系**: 依赖于REQ-010-1, REQ-010-2, REQ-010-6, REQ-010-8
|
||
- **实现建议**: 使用轮询机制检查作业状态，使用状态机管理作业状态
|
||
|
||
#### 2. 作业进度监控
|
||
|
||
- **需求描述**: 实现作业进度监控功能，监控作业的执行进度
|
||
- **优先级**: 中
|
||
- **验收标准**:
|
||
- 作业进度监控正常工作
|
||
- 支持监控拉取作业进度
|
||
- 支持监控部署作业进度
|
||
- 进度信息准确
|
||
- 支持进度百分比显示
|
||
- **依赖关系**: 依赖于作业状态监控
|
||
- **实现建议**: 使用轮询机制获取进度，使用缓存提高查询性能
|
||
|
||
#### 3. 作业耗时统计
|
||
|
||
- **需求描述**: 实现作业耗时统计功能，统计作业的执行时间
|
||
- **优先级**: 中
|
||
- **验收标准**:
|
||
- 作业耗时统计正常工作
|
||
- 支持统计拉取作业耗时
|
||
- 支持统计部署作业耗时
|
||
- 耗时统计准确
|
||
- 支持耗时分析
|
||
- **依赖关系**: 依赖于作业状态监控
|
||
- **实现建议**: 使用时间戳记录作业开始和结束时间，计算作业耗时
|
||
|
||
#### 4. 作业失败告警
|
||
|
||
- **需求描述**: 实现作业失败告警功能，作业失败时发送告警通知
|
||
- **优先级**: 中
|
||
- **验收标准**:
|
||
- 作业失败告警正常工作
|
||
- 支持多种告警方式（邮件、短信、钉钉等）
|
||
- 告警信息详细
|
||
- 告警发送及时
|
||
- 支持告警配置
|
||
- **依赖关系**: 依赖于作业状态监控
|
||
- **实现建议**: 使用消息队列发送告警，使用配置文件管理告警配置
|
||
|
||
#### 5. 作业列表查询
|
||
|
||
- **需求描述**: 实现作业列表查询功能，查询所有作业的执行记录
|
||
- **优先级**: 中
|
||
- **验收标准**:
|
||
- 作业列表查询成功
|
||
- 支持分页查询
|
||
- 支持条件查询
|
||
- 支持排序
|
||
- 查询性能满足要求
|
||
- **依赖关系**: 依赖于作业状态监控
|
||
- **实现建议**: 使用MyBatis Plus的BaseMapper实现作业列表查询，使用分页插件实现分页
|
||
|
||
## 约束
|
||
|
||
- **技术栈限制**: 必须基于现有的Spring Boot 3 + Vue 3技术栈
|
||
- **架构约束**: 必须遵循Authentication.canvas中定义的架构和调用关系
|
||
- **模块约束**: 必须在datai-salesforce-metadata模块下实现
|
||
- **数据库约束**: 必须使用MyBatis Plus作为持久层框架
|
||
- **性能约束**: 作业监控性能必须满足要求，不能影响作业执行
|
||
- **依赖约束**: 必须依赖于REQ-010-1, REQ-010-2, REQ-010-6, REQ-010-8
|
||
|
||
## Rule Set
|
||
|
||
"请严格参考 @Authentication.canvas 中的状态机转移逻辑，不要自行发挥。"
|
||
|
||
**具体规则**：
|
||
- 必须使用Canvas中定义的类名和方法名
|
||
- 必须遵循Canvas中定义的调用关系
|
||
- 必须参考Canvas中的流程图逻辑
|
||
|
||
## 验收标准
|
||
|
||
- **功能完整性**: 所有作业执行监控功能能够正常工作
|
||
- **性能指标**: 作业监控性能满足要求，不影响作业执行
|
||
- **实时性**: 作业状态和进度更新及时
|
||
- **代码规范性**: 代码符合项目编码规范，有清晰的注释
|
||
- **可维护性**: 代码结构清晰，易于扩展和维护
|
||
- **可测试性**: 代码易于单元测试和集成测试
|
||
|
||
## 风险
|
||
|
||
- **监控性能风险**: 监控性能不佳可能影响作业执行
|
||
- **状态同步风险**: 状态同步不及时可能导致状态不一致
|
||
- **告警发送风险**: 告警发送失败可能导致无法及时发现问题
|
||
- **查询性能风险**: 作业列表查询性能不佳可能影响用户体验
|
||
|
||
## 需求变更记录
|
||
|
||
| 日期 | 变更内容 | 变更原因 | 变更人 | 审核人 | 状态 |
|
||
|------|---------|---------|--------|--------|------|
|
||
| 2026-01-17 | 创建需求文档 | 初始需求 | 系统管理员 | - | 待审核 |
|
||
|
||
## 相关人员
|
||
|
||
- **需求提出人**: 系统管理员 - 联系方式
|
||
- **需求负责人**: 系统管理员 - 联系方式
|
||
- **技术负责人**: 开发工程师 - 联系方式
|
||
- **测试负责人**: 测试工程师 - 联系方式
|
||
- **其他相关人员**: - 联系方式
|
||
|
||
## 评审信息
|
||
|
||
- **评审日期**: -
|
||
- **评审人员**: -
|
||
- **评审结果**: -
|
||
- **评审意见**: -
|
||
- **修改建议**: -
|