refactor: 后端日志系统重构
- 新增模块化日志器(pkg/logger/module.go) - 新增 GORM 日志适配器 - 统一日志入口,移除所有 zap.L() 全局 logger 调用 - 字段标准化 - 启动阶段使用结构化日志 - 更新所有相关测试
This commit is contained in:
92
openspec/specs/gorm-logging/spec.md
Normal file
92
openspec/specs/gorm-logging/spec.md
Normal file
@@ -0,0 +1,92 @@
|
||||
# GORM Logging
|
||||
|
||||
## Purpose
|
||||
|
||||
定义 GORM 日志适配器规范,将 GORM 日志桥接到 zap,实现数据库操作日志统一格式和请求追踪。
|
||||
|
||||
## Requirements
|
||||
|
||||
### Requirement: GORM 日志适配器
|
||||
|
||||
系统 SHALL 提供 GORM 日志适配器,桥接到 zap。
|
||||
|
||||
#### Scenario: 适配器实现
|
||||
|
||||
- **WHEN** 初始化数据库连接
|
||||
- **THEN** SHALL 使用 `logger.NewGormLogger(zapLogger)` 作为 GORM logger
|
||||
- **THEN** 适配器 SHALL 实现 `gorm.logger.Interface` 接口
|
||||
|
||||
#### Scenario: 日志级别映射
|
||||
|
||||
- **WHEN** GORM 记录日志
|
||||
- **THEN** GORM Silent SHALL 映射到不输出
|
||||
- **THEN** GORM Error SHALL 映射到 `zap.ErrorLevel`
|
||||
- **THEN** GORM Warn SHALL 映射到 `zap.WarnLevel`
|
||||
- **THEN** GORM Info SHALL 映射到 `zap.DebugLevel`
|
||||
|
||||
#### Scenario: SQL 查询日志
|
||||
|
||||
- **WHEN** GORM 执行 SQL 查询
|
||||
- **THEN** SHALL 使用 zap Debug 级别记录
|
||||
- **THEN** SHALL 包含 SQL 语句
|
||||
- **THEN** SHALL 包含执行耗时
|
||||
- **THEN** SHALL 包含影响行数(如有)
|
||||
|
||||
### Requirement: Request ID 关联
|
||||
|
||||
GORM 日志 SHALL 支持 request_id 关联。
|
||||
|
||||
#### Scenario: 从 Context 提取 request_id
|
||||
|
||||
- **WHEN** GORM 记录日志
|
||||
- **THEN** SHALL 从 `context.Context` 提取 request_id
|
||||
- **THEN** 日志 SHALL 包含 request_id 字段
|
||||
|
||||
#### Scenario: Context 传播
|
||||
|
||||
- **WHEN** 使用 GORM 进行数据库操作
|
||||
- **THEN** SHALL 使用 `db.WithContext(ctx)` 传递 context
|
||||
- **THEN** GORM 日志 SHALL 自动包含 request_id
|
||||
|
||||
### Requirement: 模块标识
|
||||
|
||||
GORM 日志 SHALL 包含模块标识。
|
||||
|
||||
#### Scenario: 数据库模块标识
|
||||
|
||||
- **WHEN** GORM 记录日志
|
||||
- **THEN** SHALL 包含 `logger: database` 标识
|
||||
- **THEN** Console 格式 SHALL 输出为 `[database]`
|
||||
|
||||
### Requirement: 单行输出
|
||||
|
||||
GORM 日志 SHALL 单行输出。
|
||||
|
||||
#### Scenario: SQL 单行输出
|
||||
|
||||
- **WHEN** 记录 SQL 查询日志
|
||||
- **THEN** SHALL 单行输出
|
||||
- **THEN** SQL 语句中的换行 SHALL 替换为空格(除非保留原始格式)
|
||||
|
||||
#### Scenario: 错误日志单行
|
||||
|
||||
- **WHEN** 记录数据库错误日志
|
||||
- **THEN** SHALL 单行输出
|
||||
- **THEN** 错误详情 SHALL 作为字段值
|
||||
|
||||
### Requirement: 日志字段标准化
|
||||
|
||||
GORM 日志 SHALL 使用标准化字段。
|
||||
|
||||
#### Scenario: SQL 日志字段
|
||||
|
||||
- **WHEN** 记录 SQL 查询
|
||||
- **THEN** SHALL 使用 `sql` 字段记录 SQL 语句
|
||||
- **THEN** SHALL 使用 `rows_affected` 字段记录影响行数
|
||||
- **THEN** SHALL 使用 `latency` 字段记录执行耗时
|
||||
|
||||
#### Scenario: 错误日志字段
|
||||
|
||||
- **WHEN** 记录数据库错误
|
||||
- **THEN** SHALL 使用 `zap.Error(err)` 记录错误
|
||||
- **THEN** SHALL NOT 使用 `zap.String("error", err.Error())`
|
||||
140
openspec/specs/module-logging/spec.md
Normal file
140
openspec/specs/module-logging/spec.md
Normal file
@@ -0,0 +1,140 @@
|
||||
# Module Logging
|
||||
|
||||
## Purpose
|
||||
|
||||
定义模块化日志器规范,支持模块标识和 Context 传播,实现日志来源快速定位和请求追踪链完整性。
|
||||
|
||||
## Requirements
|
||||
|
||||
### Requirement: 模块标识注入
|
||||
|
||||
系统 SHALL 支持通过构造函数注入带模块标识的 logger。
|
||||
|
||||
#### Scenario: 构造函数注入模块 logger
|
||||
|
||||
- **WHEN** 创建需要记录日志的组件
|
||||
- **THEN** 构造函数 SHALL 接受 `*zap.Logger` 参数
|
||||
- **THEN** SHALL 使用 `logger.Named("module.name")` 绑定模块标识
|
||||
- **THEN** SHALL 将 logger 存储在结构体字段中
|
||||
|
||||
#### Scenario: 模块标识格式
|
||||
|
||||
- **WHEN** 绑定模块标识
|
||||
- **THEN** 单一职责包 SHALL 使用包名(如 `database`)
|
||||
- **THEN** 多实体包 SHALL 使用 `包名.实体名`(如 `handler.proxy`)
|
||||
- **THEN** 子包 SHALL 使用 `包名.子包名`(如 `handler.middleware`)
|
||||
|
||||
#### Scenario: 模块标识输出
|
||||
|
||||
- **WHEN** 记录日志
|
||||
- **THEN** Console 格式 SHALL 输出为 `[module.name]`
|
||||
- **THEN** JSON 格式 SHALL 包含 `"logger":"module.name"` 字段
|
||||
|
||||
### Requirement: 禁止全局 logger
|
||||
|
||||
系统 SHALL 禁止在业务代码中使用全局 logger。
|
||||
|
||||
#### Scenario: 移除 zap.L() 调用
|
||||
|
||||
- **WHEN** 重构现有代码
|
||||
- **THEN** SHALL 移除所有 `zap.L()` 调用
|
||||
- **THEN** SHALL 通过构造函数注入 logger
|
||||
- **THEN** 允许仅在测试代码中使用 `zap.L()` 或 `zap.NewNop()`
|
||||
|
||||
#### Scenario: 移除 zap.L() fallback
|
||||
|
||||
- **WHEN** 构造函数 logger 参数为 nil
|
||||
- **THEN** SHALL NOT 使用 `zap.L()` 作为默认值
|
||||
- **THEN** 调用方 SHALL 必须传入有效的 logger
|
||||
|
||||
### Requirement: Request ID 传播
|
||||
|
||||
系统 SHALL 通过 Context 传播 request_id。
|
||||
|
||||
#### Scenario: Context 注入 request_id
|
||||
|
||||
- **WHEN** 中间件生成 request_id
|
||||
- **THEN** SHALL 存储到 `context.Context` 中
|
||||
- **THEN** SHALL 使用类型安全的 context key
|
||||
|
||||
#### Scenario: 从 Context 提取 request_id
|
||||
|
||||
- **WHEN** 业务层需要记录日志
|
||||
- **THEN** SHALL 从 `gin.Context` 提取 request_id
|
||||
- **THEN** SHALL 使用 `logger.With(zap.String("request_id", id))` 创建带 request_id 的 logger
|
||||
- **THEN** 日志 SHALL 自动包含 request_id 字段
|
||||
|
||||
#### Scenario: Request ID 辅助函数
|
||||
|
||||
- **WHEN** 使用 request_id
|
||||
- **THEN** `pkg/logger` SHALL 提供 `RequestIDFromContext(ctx)` 辅助函数
|
||||
- **THEN** 辅助函数 SHALL 返回 `zap.Field` 类型
|
||||
|
||||
### Requirement: 单行输出
|
||||
|
||||
系统 SHALL 保证所有日志单行输出。
|
||||
|
||||
#### Scenario: Console 单行输出
|
||||
|
||||
- **WHEN** 记录日志到 stdout
|
||||
- **THEN** SHALL 单行输出
|
||||
- **THEN** 字段之间 SHALL 使用空格分隔
|
||||
|
||||
#### Scenario: JSON 单行输出
|
||||
|
||||
- **WHEN** 记录日志到文件
|
||||
- **THEN** SHALL 单行紧凑输出
|
||||
- **THEN** SHALL NOT 使用美化缩进
|
||||
|
||||
#### Scenario: 多行数据保留
|
||||
|
||||
- **WHEN** 日志数据本身包含多行(如堆栈跟踪、SQL 换行)
|
||||
- **THEN** SHALL 保留原始多行格式
|
||||
|
||||
### Requirement: 模块命名规范
|
||||
|
||||
系统 SHALL 遵循模块命名规范。
|
||||
|
||||
#### Scenario: Handler 层命名
|
||||
|
||||
- **WHEN** 创建 handler 层 logger
|
||||
- **THEN** ProxyHandler SHALL 使用 `handler.proxy`
|
||||
- **THEN** ProviderHandler SHALL 使用 `handler.provider`
|
||||
- **THEN** ModelHandler SHALL 使用 `handler.model`
|
||||
- **THEN** StatsHandler SHALL 使用 `handler.stats`
|
||||
- **THEN** Middleware SHALL 使用 `handler.middleware`
|
||||
|
||||
#### Scenario: Provider 层命名
|
||||
|
||||
- **WHEN** 创建 provider 层 logger
|
||||
- **THEN** Client SHALL 使用 `provider.client`
|
||||
|
||||
#### Scenario: Conversion 层命名
|
||||
|
||||
- **WHEN** 创建 conversion 层 logger
|
||||
- **THEN** Engine SHALL 使用 `conversion.engine`
|
||||
- **THEN** OpenAI Adapter SHALL 使用 `conversion.openai`
|
||||
- **THEN** Anthropic Adapter SHALL 使用 `conversion.anthropic`
|
||||
|
||||
#### Scenario: Service 层命名
|
||||
|
||||
- **WHEN** 创建 service 层 logger
|
||||
- **THEN** RoutingCache SHALL 使用 `service.routing_cache`
|
||||
- **THEN** StatsBuffer SHALL 使用 `service.stats_buffer`
|
||||
- **THEN** ProviderService SHALL 使用 `service.provider`
|
||||
- **THEN** ModelService SHALL 使用 `service.model`
|
||||
- **THEN** RoutingService SHALL 使用 `service.routing`
|
||||
- **THEN** StatsService SHALL 使用 `service.stats`
|
||||
|
||||
#### Scenario: Repository 层命名
|
||||
|
||||
- **WHEN** 创建 repository 层 logger
|
||||
- **THEN** ProviderRepository SHALL 使用 `repository.provider`
|
||||
- **THEN** ModelRepository SHALL 使用 `repository.model`
|
||||
- **THEN** StatsRepository SHALL 使用 `repository.stats`
|
||||
|
||||
#### Scenario: Infrastructure 层命名
|
||||
|
||||
- **WHEN** 创建基础设施层 logger
|
||||
- **THEN** Database SHALL 使用 `database`
|
||||
- **THEN** Config SHALL 使用 `config`
|
||||
@@ -15,7 +15,7 @@
|
||||
- **WHEN** 应用启动
|
||||
- **THEN** SHALL 初始化 zap logger
|
||||
- **THEN** SHALL 根据配置设置日志级别
|
||||
- **THEN** SHALL 配置日志输出格式为 JSON
|
||||
- **THEN** SHALL 配置日志输出格式为 JSON(文件)和 Console(stdout)
|
||||
|
||||
#### Scenario: 日志字段
|
||||
|
||||
@@ -27,9 +27,9 @@
|
||||
#### Scenario: 日志注入
|
||||
|
||||
- **WHEN** 创建需要记录日志的组件
|
||||
- **THEN** SHALL 通过构造函数注入 *zap.Logger
|
||||
- **THEN** SHALL 允许 logger 参数为 nil,此时使用全局 logger zap.L()
|
||||
- **THEN** SHALL NOT 直接使用全局 logger zap.L()(除非在构造函数默认值中)
|
||||
- **THEN** SHALL 通过构造函数注入 `*zap.Logger`
|
||||
- **THEN** 调用方 SHALL 必须传入有效的 logger
|
||||
- **THEN** SHALL NOT 使用全局 logger `zap.L()`(测试代码除外)
|
||||
|
||||
### Requirement: 支持日志滚动
|
||||
|
||||
@@ -76,7 +76,8 @@
|
||||
#### Scenario: 日志关联请求 ID
|
||||
|
||||
- **WHEN** 记录请求相关的日志
|
||||
- **THEN** SHALL 自动包含请求 ID 字段
|
||||
- **THEN** SHALL 从 Context 提取 request_id
|
||||
- **THEN** SHALL 自动包含 request_id 字段
|
||||
- **THEN** SHALL 支持通过请求 ID 检索日志
|
||||
|
||||
### Requirement: 记录请求日志
|
||||
@@ -116,7 +117,7 @@
|
||||
|
||||
- **WHEN** 配置为生产模式
|
||||
- **THEN** SHALL 使用 info 级别
|
||||
- **THEN** SHALL 仅输出到文件
|
||||
- **THEN** SHALL 输出到控制台和文件
|
||||
|
||||
### Requirement: 日志存储位置
|
||||
|
||||
@@ -141,12 +142,77 @@ ConversionEngine SHALL 通过依赖注入获取 logger。
|
||||
#### Scenario: ConversionEngine 构造函数
|
||||
|
||||
- **WHEN** 创建 ConversionEngine 实例
|
||||
- **THEN** 构造函数 SHALL 接受 *zap.Logger 参数
|
||||
- **THEN** 参数为 nil 时 SHALL 使用 zap.L() 作为默认值
|
||||
- **THEN** 构造函数 SHALL 接受 `*zap.Logger` 参数
|
||||
- **THEN** 调用方 SHALL 必须传入有效的 logger
|
||||
- **THEN** SHALL 将 logger 存储在结构体字段中
|
||||
|
||||
#### Scenario: ConversionEngine 日志使用
|
||||
|
||||
- **WHEN** ConversionEngine 记录日志
|
||||
- **THEN** SHALL 使用注入的 logger 字段
|
||||
- **THEN** SHALL NOT 直接调用 zap.L()
|
||||
- **THEN** SHALL NOT 直接调用 `zap.L()`
|
||||
|
||||
### Requirement: 字段标准化
|
||||
|
||||
系统 SHALL 使用标准化字段定义。
|
||||
|
||||
#### Scenario: 标准字段常量
|
||||
|
||||
- **WHEN** 记录日志字段
|
||||
- **THEN** SHALL 使用 `pkg/logger/field.go` 中定义的常量
|
||||
- **THEN** 字段名 SHALL 包括:`request_id`、`provider_id`、`model_name`、`method`、`path`、`status`、`latency`
|
||||
|
||||
#### Scenario: 错误字段统一
|
||||
|
||||
- **WHEN** 记录错误日志
|
||||
- **THEN** SHALL 使用 `zap.Error(err)`
|
||||
- **THEN** SHALL NOT 使用 `zap.String("error", err.Error())`
|
||||
|
||||
#### Scenario: 字段构造函数
|
||||
|
||||
- **WHEN** 构造日志字段
|
||||
- **THEN** SHALL 优先使用 `pkg/logger` 提供的辅助函数
|
||||
- **THEN** 辅助函数 SHALL 返回 `zap.Field` 类型
|
||||
|
||||
### Requirement: 启动日志统一
|
||||
|
||||
系统 SHALL 在启动阶段使用结构化日志。
|
||||
|
||||
#### Scenario: 最小化 logger 初始化
|
||||
|
||||
- **WHEN** 应用启动时配置加载前
|
||||
- **THEN** SHALL 初始化最小化 logger(仅 stdout,console 格式)
|
||||
- **THEN** SHALL 支持记录启动错误
|
||||
|
||||
#### Scenario: Logger 升级
|
||||
|
||||
- **WHEN** 配置加载完成
|
||||
- **THEN** SHALL 升级为完整 logger(文件 + stdout)
|
||||
- **THEN** SHALL 应用配置的日志级别和轮转策略
|
||||
|
||||
#### Scenario: 配置摘要结构化
|
||||
|
||||
- **WHEN** 打印配置摘要
|
||||
- **THEN** SHALL 使用结构化日志记录
|
||||
- **THEN** SHALL NOT 使用 `fmt.Printf` 或 `fmt.Println`
|
||||
|
||||
### Requirement: 单行输出
|
||||
|
||||
系统 SHALL 保证所有日志单行输出。
|
||||
|
||||
#### Scenario: Console 单行
|
||||
|
||||
- **WHEN** 输出到 stdout
|
||||
- **THEN** SHALL 单行输出
|
||||
- **THEN** 字段之间 SHALL 使用空格分隔
|
||||
|
||||
#### Scenario: JSON 单行
|
||||
|
||||
- **WHEN** 输出到文件
|
||||
- **THEN** SHALL 单行紧凑 JSON
|
||||
- **THEN** SHALL NOT 使用美化缩进
|
||||
|
||||
#### Scenario: 多行数据保留
|
||||
|
||||
- **WHEN** 日志数据本身包含多行(堆栈跟踪、SQL 换行等)
|
||||
- **THEN** SHALL 保留原始多行格式
|
||||
|
||||
Reference in New Issue
Block a user