上传源代码版本
This commit is contained in:
12
.trae/specs/record-request-details/checklist.md
Normal file
12
.trae/specs/record-request-details/checklist.md
Normal file
@@ -0,0 +1,12 @@
|
||||
# 回传接口请求详情记录 - 验证清单
|
||||
|
||||
- [x] 检查SendWebhookToXunTong方法是否记录了请求的JSON数据
|
||||
- [x] 检查日志中是否包含完整的请求JSON数据
|
||||
- [x] 检查SendWebhookToXunTong方法是否记录了请求发起的IP地址
|
||||
- [x] 检查日志中是否包含准确的IP地址信息
|
||||
- [x] 检查记录操作是否不影响接口的正常功能
|
||||
- [x] 检查接口响应时间是否增加不超过10ms
|
||||
- [x] 检查日志格式是否清晰易读
|
||||
- [x] 检查记录的信息是否不包含敏感数据
|
||||
- [x] 运行测试接口,验证所有功能是否正常
|
||||
- [x] 检查代码编译是否通过,无语法错误
|
||||
68
.trae/specs/record-request-details/spec.md
Normal file
68
.trae/specs/record-request-details/spec.md
Normal file
@@ -0,0 +1,68 @@
|
||||
# 回传接口请求详情记录 - 产品需求文档
|
||||
|
||||
## Overview
|
||||
- **Summary**: 在讯通回传接口中添加请求JSON和请求发起IP地址的记录功能,以便更好地追踪和调试接口调用。
|
||||
- **Purpose**: 提高系统的可观测性和可调试性,便于排查接口调用问题。
|
||||
- **Target Users**: 系统运维人员和开发人员。
|
||||
|
||||
## Goals
|
||||
- 记录回传接口的请求JSON数据
|
||||
- 记录请求发起的IP地址
|
||||
- 确保记录的信息完整且准确
|
||||
- 不影响接口的正常功能和性能
|
||||
|
||||
## Non-Goals (Out of Scope)
|
||||
- 不修改接口的核心业务逻辑
|
||||
- 不改变接口的请求和响应格式
|
||||
- 不增加额外的外部依赖
|
||||
|
||||
## Background & Context
|
||||
- 现有的讯通回传接口已经实现了基本的功能,但缺乏对请求详情的记录
|
||||
- 在生产环境中,当接口调用出现问题时,需要更详细的信息来排查问题
|
||||
- 记录请求JSON和IP地址有助于追踪接口调用来源和内容
|
||||
|
||||
## Functional Requirements
|
||||
- **FR-1**: 在SendWebhookToXunTong方法中记录请求的JSON数据
|
||||
- **FR-2**: 在SendWebhookToXunTong方法中记录请求发起的IP地址
|
||||
- **FR-3**: 确保记录的信息包含在日志中,便于查询和分析
|
||||
|
||||
## Non-Functional Requirements
|
||||
- **NFR-1**: 记录操作不影响接口的响应时间,增加的延迟不超过10ms
|
||||
- **NFR-2**: 记录的信息清晰易读,便于分析和调试
|
||||
- **NFR-3**: 确保记录的信息不包含敏感数据
|
||||
|
||||
## Constraints
|
||||
- **Technical**: 使用现有的日志系统,不引入新的日志框架
|
||||
- **Business**: 不增加系统的存储成本和计算成本
|
||||
- **Dependencies**: 依赖现有的HttpClientFactory和日志系统
|
||||
|
||||
## Assumptions
|
||||
- 系统已经配置了合适的日志级别和存储策略
|
||||
- 接口调用的JSON数据大小在合理范围内,不会导致日志过大
|
||||
|
||||
## Acceptance Criteria
|
||||
|
||||
### AC-1: 记录请求JSON
|
||||
- **Given**: 系统调用讯通回传接口
|
||||
- **When**: 接口发送请求前
|
||||
- **Then**: 系统记录请求的JSON数据到日志中
|
||||
- **Verification**: `programmatic`
|
||||
- **Notes**: 日志中应包含完整的请求JSON数据
|
||||
|
||||
### AC-2: 记录请求IP地址
|
||||
- **Given**: 系统调用讯通回传接口
|
||||
- **When**: 接口发送请求前
|
||||
- **Then**: 系统记录请求发起的IP地址到日志中
|
||||
- **Verification**: `programmatic`
|
||||
- **Notes**: 日志中应包含准确的IP地址信息
|
||||
|
||||
### AC-3: 不影响接口功能
|
||||
- **Given**: 系统调用讯通回传接口
|
||||
- **When**: 接口执行过程中
|
||||
- **Then**: 记录操作不影响接口的正常功能和响应时间
|
||||
- **Verification**: `programmatic`
|
||||
- **Notes**: 接口应能正常完成请求,响应时间增加不超过10ms
|
||||
|
||||
## Open Questions
|
||||
- [ ] 系统是否需要记录响应数据?
|
||||
- [ ] 日志级别应设置为INFO还是DEBUG?
|
||||
38
.trae/specs/record-request-details/tasks.md
Normal file
38
.trae/specs/record-request-details/tasks.md
Normal file
@@ -0,0 +1,38 @@
|
||||
# 回传接口请求详情记录 - 实现计划
|
||||
|
||||
## [x] Task 1: 修改SendWebhookToXunTong方法,添加请求JSON记录
|
||||
- **Priority**: P0
|
||||
- **Depends On**: None
|
||||
- **Description**:
|
||||
- 在SendWebhookToXunTong方法中,在发送请求前记录请求的JSON数据
|
||||
- 确保日志中包含完整的请求JSON数据
|
||||
- 使用合适的日志级别(INFO)
|
||||
- **Acceptance Criteria Addressed**: AC-1, AC-3
|
||||
- **Test Requirements**:
|
||||
- `programmatic` TR-1.1: 调用接口后,检查日志中是否包含请求JSON数据
|
||||
- `human-judgement` TR-1.2: 检查日志格式是否清晰易读
|
||||
- **Notes**: 确保JSON数据不包含敏感信息
|
||||
|
||||
## [x] Task 2: 修改SendWebhookToXunTong方法,添加请求IP地址记录
|
||||
- **Priority**: P0
|
||||
- **Depends On**: None
|
||||
- **Description**:
|
||||
- 在SendWebhookToXunTong方法中,记录请求发起的IP地址
|
||||
- 确保IP地址信息准确记录到日志中
|
||||
- **Acceptance Criteria Addressed**: AC-2, AC-3
|
||||
- **Test Requirements**:
|
||||
- `programmatic` TR-2.1: 调用接口后,检查日志中是否包含IP地址信息
|
||||
- `human-judgement` TR-2.2: 检查IP地址格式是否正确
|
||||
- **Notes**: 考虑使用HttpContext获取IP地址
|
||||
|
||||
## [x] Task 3: 验证实现的正确性
|
||||
- **Priority**: P1
|
||||
- **Depends On**: Task 1, Task 2
|
||||
- **Description**:
|
||||
- 运行测试接口,验证请求JSON和IP地址是否正确记录
|
||||
- 检查接口响应时间是否符合要求
|
||||
- **Acceptance Criteria Addressed**: AC-1, AC-2, AC-3
|
||||
- **Test Requirements**:
|
||||
- `programmatic` TR-3.1: 调用TestXunTongWebhook接口,检查日志输出
|
||||
- `programmatic` TR-3.2: 测量接口响应时间,确保增加不超过10ms
|
||||
- **Notes**: 可以使用Postman或curl工具测试
|
||||
Reference in New Issue
Block a user