Go mod 好菜系列 - 0x04 zap 让日志终于像日志

详细讲 zap 为什么在 Go 项目里很常见、结构化日志怎么写、字段日志有什么价值,以及它通常应该放在哪一层。

很多人刚开始写 Go 服务时,日志基本靠 fmt.Printlnlog.Println 撑着。小项目当然能跑,但只要一上环境、接口一多、并发一高,你很快就会发现:日志不只是“有没有输出”,而是“能不能拿来排查问题”。

zap 为什么常见

因为它在 Go 生态里属于那种比较典型的“工程味日志库”:

  • 结构化
  • 性能不错
  • 输出格式清晰
  • 生态使用广

也就是说,它不是为了让日志看起来花,而是让日志更容易被程序和人一起消费。

结构化日志到底好在哪

先看普通文本日志:

user login failed, id=42, ip=1.2.3.4

看着也不是不能懂,但如果你想按用户 id、按 IP、按错误类型去筛选,它就开始显得不够规整了。

结构化日志更像这样:

logger.Info("user login failed",
    zap.Int("user_id", 42),
    zap.String("ip", "1.2.3.4"),
    zap.String("reason", "password mismatch"),
)

这样输出以后,不管是你自己 grep,还是日志平台做索引分析,都更容易。

最常见的初始化

logger, err := zap.NewProduction()
if err != nil {
    return err
}
defer logger.Sync()

NewProduction() 基本就是“先上车再说”的那种默认方案。开发环境也可以用 zap.NewDevelopment(),会更适合人肉阅读。

字段日志怎么理解

zap 最有代表性的就是那组字段函数:

  • zap.String
  • zap.Int
  • zap.Duration
  • zap.Error
logger.Info("request done",
    zap.String("path", "/api/users"),
    zap.Int("status", 200),
    zap.Duration("cost", 35*time.Millisecond),
)

这种写法在中间件、数据库耗时、第三方接口调用这些场景里特别有用。它不是在写文章,而是在给未来的排查留抓手。

错误日志别只打一串 err

if err != nil {
    logger.Error("create user failed",
        zap.Error(err),
        zap.String("email", req.Email),
    )
    return err
}

单纯把 err 打出来当然也能看,但带上一点关键上下文,价值会高很多。以后你遇到线上问题,往往不是缺“错误发生了”这个事实,而是缺“它是带着什么条件发生的”。

zap 最适合放在哪

它其实是个横切工具,不是某一层专属的。比较常见的用法是:

  • 服务启动时初始化一个全局或注入式 logger
  • 中间件里打请求日志
  • service / repository 层打关键错误和耗时
  • 后台任务也统一用它

核心原则不是“哪里都打”,而是“关键节点打得足够有信息量”。

常见坏味道

  • 日志太多,全是噪音
  • 字段名乱写,后期分析全靠猜
  • 业务日志和错误日志混成一锅
  • 既然是结构化日志,最后 message 还写成一整段小说

日志不是越多越专业,越能回答问题才越专业。

小结

zap 常见不是因为它酷,而是因为它很适合现代服务里的日志需求:

  • 结构化字段比纯文本日志更适合排查和分析
  • 初始化简单,性能也比较能打
  • 日志要记录上下文,而不是只喊一句“出错了”
  • 它适合做全项目统一日志方案的一部分

下一篇我们讲 viper。日志说人话以后,配置也该像样一点,不要再到处散着环境变量和写死常量了。

Read more

序章:长夜之后

后来的历史书把那一天称为“长夜之后”。 这个名字并不准确。事情发生在地球上的许多个白天和夜晚之间,发生在不同经度的清晨、午后、傍晚,发生在地下库房、山体掩体、海军基地、荒原试验场和无人值守的材料贮存井里。它既不是一场战争,也不是一次统一指挥的袭击。没有人按下那个能够解释一切的按钮。 但历史需要一个名称。 “长夜之后”最终被保留下来,是因为调查者在追溯事件源头时,不得不一次又一次回到海王星。回到那颗距离太阳太远、光照近乎吝啬的蓝色行星。回到六名中国宇航员死去的地方。回到一艘核动力科考船熄灭后的漫长黑暗。 在联合调查委员会公开的第一版报告中,事件时间线被压缩成了一页表格。 2030年9月,问海一号在海王星附近失联。 2034年11月,问海二号抵达失事区域,确认问海一号全员死亡。 2035年1月,问海二号完成样本封装,开始返航。 2038年6月,海王星样本进入地球高等级隔离实验室。 2038年7月,全球多个核材料设施发生不可逆事故,部分核电站进入最高级别应急。 2038年8月,所有已知核武库事实上失效,全球核电装机大规模停运。 这张表格后来被反复引用,因为它足够冷静,也

By Fuyu Jia

第一章:四小时以前的地球

林予舟第一次听见“问海一号”的最后通信,是在距离地面三百九十公里的轨道上。 那不是一个适合听遗言的地方。 舷窗外,地球从飞船腹侧缓慢转过去,云层像被谁铺平的白色金属屑,青藏高原的阴影压在晨昏线上。太阳还没有完全越出地平线,近地轨道的黑暗因此显得很薄,像一层马上要被擦掉的墨。 “链路稳定。”林予舟说。 他的声音被舱内麦克风收进去,压缩,打包,送进中继卫星,再落回海南深空任务中心。延迟不到一秒。这样奢侈的实时感,在他们离开地月系统后会迅速消失。等飞船抵达海王星附近,地球说一句话,要四个小时左右才能抵达;他们回一句,地球也要再等四个小时。 对话会变成考古。 控制台上方的状态灯一排排亮着,绿色多得几乎让人不安。问海二号还在近地轨道泊位上,推进舱、居住舱、通信桁架和补给舱刚完成最后一次组合检查。它不像公众宣传片里那样优雅。现实中的深空飞船更像一串被迫相互妥协的工程物:银灰色隔热层、外露管线、姿控喷口、展开到一半的高增益天线,所有东西都为了质量、功耗、散热和冗余让步。 它也不像一艘该去海王星的船。 至少不像一艘该去救援核动力深空飞船的船。 问海二号没有主反应堆。 这件事在公开报

By Fuyu Jia

第二章:没有核反应堆的船

发射前四十分钟,林予舟收到了一条来自地面的私人通信。 通信被压在任务数据包后面,标记为低优先级。它随着推进剂温度曲线、姿态平台校准结果、医学监测基线和最后一版逃逸窗口修正量一起进入问海二号的主机,像一枚被夹在工具箱里的薄纸片。 林予舟本来不该在这个时候打开它。 发射前四十分钟,人的每一个动作都应当有明确目的。检查阀门状态,确认加压序列,复诵逃逸程序,核对地面口令。人的情绪如果在这个时候出现,就应该被折叠起来,放进某个不影响任务的地方。 他还是点开了。 画面里是母亲的厨房。抽油烟机没有开,镜头被热气熏得微微发白。桌上摆着一碗面,青菜、荷包蛋和切得很薄的牛肉。母亲没有出镜,只在画面外说:“我知道你现在不能吃,等回来再吃也一样。” 林予舟看着那碗面,隔了几秒才意识到自己没有呼吸。 “怎么了?”沈从越问。 “私人包。” “家里?” “嗯。” “看完删掉。”沈从越说,“别让它留在主屏缓存里。发射时系统会重排任务窗口,乱七八糟的东西越少越好。” 他语气平淡,不像关心,也不像责备。沈从越说话常常这样,像把所有情绪都预先压成了流程。林予舟关掉视频,把它转存进私人存储区。那碗面从

By Fuyu Jia

第三章:地球变成录音

离开地月系统后的第十九天,林予舟第一次觉得,地球不是一个地方,而是一种延迟。 最初的几天,通信仍然近乎实时。地面问,他们答;他们报数,地面确认。贺岚的声音穿过中继链路抵达舱内时,还带着地球上办公室的秩序感:清晰、稳定、克制。林予舟甚至能从她停顿的长度判断总控大厅里有多少人在看同一块屏幕。 后来,停顿被拉长。 五秒。 十七秒。 一分钟。 再后来,地球的每一句话都像从更早的时间里寄来。母亲发来的第二条视频在一个姿态修正段后抵达。她说北京降温了,问他那边冷不冷。林予舟看着舷窗外没有温度的黑暗,忽然不知道该怎么回答。 他当然冷。 但那不是气温。 “私人日志,任务日二十。”他说,“今天第一次做梦,梦见自己回到地面,站在厨房里。锅里有水,水一直不开。母亲在旁边说火太小,我低头看,灶台下面接着的是问海二号的离子推进器。” 他说完后,自己笑了一下。 笑声在舱内很短,很快被风机吞掉。 沈从越从设备舱飘过,听见最后半句:“梦境记录?” “心理监测要求。” “别把自己写得太正常。

By Fuyu Jia