Ever-Gauzy 项目中全局日志系统的设计与实现

背景与需求分析

在现代企业级应用开发中，完善的日志系统是保障系统可靠性和可维护性的关键基础设施。Ever-Gauzy 作为一个开源的企业管理平台，其时间追踪功能作为核心模块之一，需要建立全面的请求-响应日志机制。

传统的日志记录方式往往分散在各个模块中，缺乏统一标准和全局视角。为了解决这个问题，我们需要设计一个集中式的日志系统，能够自动捕获所有API调用的关键信息，包括请求路径、方法、头部、正文、响应状态等元数据。

技术方案设计

数据库表结构

系统采用专门的api_call_log表来存储日志数据，其核心字段包括：

• 请求信息：URL路径、HTTP方法(GET/POST等)、请求头、请求正文
• 响应信息：响应状态码、响应头、响应正文
• 上下文信息：关联ID(CorrelationId)、时间戳(请求时间和响应时间)
• 路由信息：匹配的控制器路径和处理方法

技术实现要点

1. NestJS中间件拦截：利用NestJS的中间件机制，在请求进入控制器前和响应返回客户端后插入日志记录逻辑。

2. 敏感信息过滤：设计自动过滤机制，确保密码等敏感字段不会明文记录在日志中。

3. 环境适配：通过配置系统实现不同环境(开发/测试/生产)的日志级别控制。

4. 性能优化：采用异步非阻塞方式写入日志，避免影响主业务流程的响应速度。

5. 上下文追踪：通过CorrelationId实现跨API调用的全链路追踪。

实现细节

日志中间件实现

日志中间件需要处理以下关键流程：

1. 请求到达时：

   • 生成唯一CorrelationId
   • 记录请求开始时间
   • 提取并存储请求元数据

2. 响应返回时：

   • 计算请求处理耗时
   • 捕获响应状态和内容
   • 异步写入数据库

数据存储策略

考虑到日志数据量可能很大，系统采用以下优化策略：

• 结构化存储：将JSON格式的头部和正文合理分解存储
• 大小限制：对过大的请求/响应正文进行截断处理
• 归档机制：定期归档旧日志释放存储空间

系统集成考量

新日志系统需要与现有架构无缝集成：

1. 与现有日志框架兼容：保持与Winston等日志框架的协同工作
2. 监控告警集成：基于日志数据建立异常检测机制
3. 审计追踪支持：满足企业级审计合规要求

实际应用价值

该日志系统的实施为Ever-Gauzy平台带来多重收益：

1. 故障排查：快速定位API调用问题，缩短故障恢复时间
2. 性能分析：通过请求耗时统计识别性能瓶颈
3. 使用分析：了解API调用模式，指导产品优化
4. 安全审计：提供完整的行为记录，支持安全事件调查

总结

全局日志系统是企业级应用不可或缺的基础设施。Ever-Gauzy通过系统化的设计和实现，建立了覆盖全面的API调用日志机制，不仅提升了系统的可观测性和可维护性，也为后续的性能优化、安全审计等功能扩展奠定了坚实基础。这种设计思路对于其他类似项目的日志系统建设也具有参考价值。