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方法论创建，包括需求定义、架构决策、提示词资产化、执行会话、变更记录和闭环复盘。
161 lines
5.8 KiB
Markdown
161 lines
5.8 KiB
Markdown
# Requirements - 详细日志记录和查询
|
||
|
||
## 需求信息
|
||
|
||
- **需求名称**: 详细日志记录和查询
|
||
- **需求类型**: 功能需求
|
||
- **需求编号**: REQ-010-15
|
||
- **父需求**: 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) - 元数据部署核心功能
|
||
- [REQ-010-14.md](REQ-010-14.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. 日志查询
|
||
|
||
- **需求描述**: 实现日志查询功能，查询作业的执行日志
|
||
- **优先级**: 中
|
||
- **验收标准**:
|
||
- 日志查询功能正常工作
|
||
- 支持按作业ID查询日志
|
||
- 支持按时间范围查询日志
|
||
- 支持按日志级别查询日志
|
||
- 支持按关键词查询日志
|
||
- 支持分页查询
|
||
- 查询性能满足要求
|
||
- **依赖关系**: 依赖于日志记录
|
||
- **实现建议**: 使用MyBatis Plus的QueryWrapper实现多条件查询，使用分页插件实现分页
|
||
|
||
#### 3. 日志导出
|
||
|
||
- **需求描述**: 实现日志导出功能，导出作业的执行日志
|
||
- **优先级**: 中
|
||
- **验收标准**:
|
||
- 日志导出功能正常工作
|
||
- 支持导出为文本文件
|
||
- 支持导出为Excel文件
|
||
- 支持导出为CSV文件
|
||
- 导出内容完整准确
|
||
- 导出性能满足要求
|
||
- **依赖关系**: 依赖于日志查询
|
||
- **实现建议**: 使用文件导出库实现日志导出，使用流式处理大文件导出
|
||
|
||
#### 4. 日志分析
|
||
|
||
- **需求描述**: 实现日志分析功能，分析作业的执行日志
|
||
- **优先级**: 中
|
||
- **验收标准**:
|
||
- 日志分析功能正常工作
|
||
- 支持统计错误日志数量
|
||
- 支持统计警告日志数量
|
||
- 支持统计信息日志数量
|
||
- 支持分析作业执行趋势
|
||
- 分析结果准确
|
||
- **依赖关系**: 依赖于日志查询
|
||
- **实现建议**: 使用聚合查询实现日志统计，使用图表展示分析结果
|
||
|
||
## 约束
|
||
|
||
- **技术栈限制**: 必须基于现有的Spring Boot 3 + Vue 3技术栈
|
||
- **架构约束**: 必须遵循Authentication.canvas中定义的架构和调用关系
|
||
- **模块约束**: 必须在datai-salesforce-metadata模块下实现
|
||
- **数据库约束**: 必须使用MyBatis Plus作为持久层框架
|
||
- **性能约束**: 日志记录和查询性能必须满足要求，不能影响作业执行
|
||
- **依赖约束**: 必须依赖于REQ-010-1, REQ-010-2, REQ-010-6, REQ-010-8, REQ-010-14
|
||
|
||
## Rule Set
|
||
|
||
"请严格参考 @Authentication.canvas 中的状态机转移逻辑，不要自行发挥。"
|
||
|
||
**具体规则**：
|
||
- 必须使用Canvas中定义的类名和方法名
|
||
- 必须遵循Canvas中定义的调用关系
|
||
- 必须参考Canvas中的流程图逻辑
|
||
|
||
## 验收标准
|
||
|
||
- **功能完整性**: 所有日志记录和查询功能能够正常工作
|
||
- **性能指标**: 日志记录和查询性能满足要求，不影响作业执行
|
||
- **完整性**: 日志信息完整详细，能够追溯作业执行过程
|
||
- **代码规范性**: 代码符合项目编码规范，有清晰的注释
|
||
- **可维护性**: 代码结构清晰，易于扩展和维护
|
||
- **可测试性**: 代码易于单元测试和集成测试
|
||
|
||
## 风险
|
||
|
||
- **日志记录风险**: 日志记录失败可能导致日志信息丢失
|
||
- **查询性能风险**: 日志查询性能不佳可能影响用户体验
|
||
- **存储空间风险**: 日志过多可能占用大量存储空间
|
||
- **导出性能风险**: 日志导出性能不佳可能导致导出失败
|
||
- **分析准确性风险**: 日志分析不准确可能导致误判
|
||
|
||
## 需求变更记录
|
||
|
||
| 日期 | 变更内容 | 变更原因 | 变更人 | 审核人 | 状态 |
|
||
|------|---------|---------|--------|--------|------|
|
||
| 2026-01-17 | 创建需求文档 | 初始需求 | 系统管理员 | - | 待审核 |
|
||
|
||
## 相关人员
|
||
|
||
- **需求提出人**: 系统管理员 - 联系方式
|
||
- **需求负责人**: 系统管理员 - 联系方式
|
||
- **技术负责人**: 开发工程师 - 联系方式
|
||
- **测试负责人**: 测试工程师 - 联系方式
|
||
- **其他相关人员**: - 联系方式
|
||
|
||
## 评审信息
|
||
|
||
- **评审日期**: -
|
||
- **评审人员**: -
|
||
- **评审结果**: -
|
||
- **评审意见**: -
|
||
- **修改建议**: -
|