在Nunu项目中实现GORM SQL日志链路追踪的方法

背景介绍

在Go语言开发中，GORM是一个非常流行的ORM框架，而Zap则是高性能的日志库。在Nunu项目中，开发者经常需要将GORM的SQL日志输出到Zap中，并且希望能够实现完整的日志链路追踪功能，特别是在微服务架构中，这对于问题排查和系统监控至关重要。

问题分析

默认情况下，使用现有的zapgorm2库将GORM日志输出到Zap时，会发现SQL日志中缺少请求的trace信息，这使得在分布式系统中难以追踪完整的请求链路。这是因为现有的实现没有正确处理context中的日志字段注入。

解决方案

自定义ZapGORM2实现

为了解决这个问题，我们需要自定义一个zapgorm2的实现，主要包含以下关键点：

1. 上下文感知的日志记录器：通过检查context中存储的logger实例，确保能够获取到包含trace信息的logger。

2. Gin框架集成：特别处理Gin框架的context，确保能从请求上下文中获取正确的logger。

3. 调用栈调整：通过分析调用栈，确保日志输出能正确显示调用位置信息。

实现细节

1. Logger结构体：封装Zap logger和GORM相关的配置参数，如慢查询阈值、日志级别等。

2. LogMode方法：实现GORM的LogMode接口，允许动态调整日志级别。

3. 日志级别方法：实现Info、Warn、Error等方法，根据配置的日志级别决定是否输出。

4. Trace方法：核心方法，处理SQL执行跟踪，包括错误日志、慢查询日志和普通SQL日志。

5. logger方法：从context中获取logger实例，如果没有则使用默认logger，并调整调用栈信息。

集成到Nunu项目

1. 将自定义实现放在项目的pkg/zapgorm2目录下。

2. 修改repository层的初始化代码，使用自定义的zapgorm2实现。

3. 确保DB方法正确处理context传递，使得每次数据库操作都能获取到正确的上下文logger。

实现效果

通过这种实现方式，GORM的SQL日志将能够：

• 自动包含请求的trace信息
• 正确显示慢查询警告
• 保持一致的日志格式
• 显示准确的调用位置

最佳实践建议

1. 日志级别配置：在生产环境中，建议将默认日志级别设置为Warn，避免过多日志输出。

2. 慢查询阈值：根据实际业务需求设置合理的慢查询阈值。

3. 错误处理：对于记录未找到的错误(ErrRecordNotFound)，可以根据业务需求选择是否忽略。

4. 性能考虑：在高并发场景下，注意日志输出的性能影响。

总结

通过自定义zapgorm2实现，我们成功解决了Nunu项目中GORM SQL日志缺失trace信息的问题。这种方法不仅适用于Nunu框架，也可以作为其他Go项目中集成GORM和Zap的参考方案。关键在于正确处理context传递和日志字段注入，确保分布式系统中的全链路追踪能力。