使用结构化日志记录Go错误,推荐zap等库输出JSON格式日志,补充请求ID、用户ID等上下文信息,通过%w封装错误链,区分Error、Warn等日志级别并采样,避免重复打印和敏感信息泄露,提升可维护性与安全性。

在Go语言开发中,日志记录是排查问题、监控程序运行状态的重要手段,尤其是错误信息的记录。合理的日志实践能显著提升系统的可维护性。以下是记录Golang错误信息的一些最佳实践。
使用结构化日志
传统的字符串拼接日志难以解析和检索。推荐使用结构化日志(如JSON格式),便于后期分析和集中处理。
常用库包括 zap、logrus 等,它们支持字段化输出。例如使用 zap:
logger, _ := zap.NewProduction()defer logger.Sync()
logger.Error("数据库连接失败",
zap.String("host", "localhost"),
zap.Int("port", 5432),
zap.Error(err),
)
这样日志包含可解析的字段,方便在ELK或Loki等系统中查询。
立即学习“go语言免费学习笔记(深入)”;
记录足够的上下文信息
仅记录 err.Error() 往往不够。应补充发生错误时的上下文,比如请求ID、用户ID、操作类型、输入参数等。
建议方式:
- 在错误传递过程中,通过 errors.Wrap 或 fmt.Errorf("%w: %s", err, context) 添加上下文
- 使用 github.com/pkg/errors 包增强错误链(注意:Go 1.13+ 支持 %w 语法)
- 避免重复打印同一错误,防止日志冗余
示例:
if err != nil {return fmt.Errorf("处理用户请求失败: user_id=%d, action=save: %w", userID, err)
}
区分错误级别并合理采样
日志应分级别记录,常见为 Debug、Info、Warn、Error、Fatal。
关键点:
- 只在真正出错且无法继续时使用 Error 级别
- 预期中的失败(如参数校验)可用 Warn 或 Info
- 高频率错误可做限流或采样,避免刷屏
- 生产环境避免开启 Debug 日志
避免记录敏感信息
日志可能包含密码、token、身份证号等敏感数据,必须过滤。
做法:
- 不要直接打印完整请求体或 header
- 对敏感字段打码,如 "token": "****"
- 使用中间件或封装函数统一脱敏
基本上就这些。关键是让每条错误日志都能快速定位问题,又不泄露信息、不影响性能。










