当前位置:首页 > 文章列表 > Golang > Go教程 > 用 slog 建立请求级字段并统一 JSON 日志输出

用 slog 建立请求级字段并统一 JSON 日志输出

来源:17golang原创 2026-10-07 14:05:21 0浏览 收藏

如果日志里只有“处理失败”和一串散落的字符串,排查一次请求往往要靠时间和猜测。用 Go 的 log/slog 可以把日志变成统一的 JSON 记录:入口建立 request_id、HTTP 方法和路径,业务层沿用派生出来的 Logger,最终每条记录都能被日志系统按字段检索。

官方资料:https://pkg.go.dev/log/slog

这套方案的关键不是把所有参数塞进 context.Context,而是让“请求级字段”绑定在 Logger 上,让 context 只承担取消、超时和跨层信号。

先把日志出口固定成 JSON

slog 的 Handler 决定输出格式。服务启动时明确创建 JSONHandler,并用 HandlerOptions 设置最低级别;调用 slog.SetDefault 后,包级的 slog.Info、slog.Error 也会走这个出口。

package main

import (
	"log/slog"
	"os"
)

func newLogger() *slog.Logger {
	// 让日志平台按行接收 JSON,Info 以下的调试记录默认不输出。
	opts := &slog.HandlerOptions{Level: slog.LevelInfo}
	logger := slog.New(slog.NewJSONHandler(os.Stdout, opts))
	// 设置默认 logger,兼容仍使用 slog.Info 的旧调用点。
	slog.SetDefault(logger)
	return logger
}

func main() {
	logger := newLogger()
	// 使用结构化属性,避免把字段拼进不可检索的 message。
	logger.Info("service started", slog.String("service", "orders"))
}

输出会是逐行 JSON,例如 {"level":"INFO","msg":"service started","service":"orders"}。生产环境通常把输出交给标准输出采集器;不要在业务代码里再次把 JSON 编码成字符串,否则会得到嵌套转义。

slog JSONHandler、HandlerOptions 与统一日志出口的静态结构说明图
图1:slog JSON 日志出口说明图,展示 HandlerOptions、JSONHandler、默认 Logger 与 JSON 记录之间的静态关系。

把请求字段绑定到派生 Logger

公共字段应该在请求入口一次绑定,而不是由每个业务函数手工重复传入。Logger.With 会返回使用同一 Handler 的新 Logger,之后每条记录都会带上这些属性。

func requestLogger(base *slog.Logger, r *http.Request) *slog.Logger {
	// 真实服务可优先读取网关传入的 request_id,再为缺失请求生成新的值。
	requestID := r.Header.Get("X-Request-ID")
	if requestID == "" {
		requestID = newRequestID()
	}
	// 请求公共字段绑定在 Logger 上,不把业务参数混进 context。
	return base.With(
		slog.String("request_id", requestID),
		slog.String("method", r.Method),
		slog.String("path", r.URL.Path),
	)
}

这里的 newRequestID 只代表项目已有的 ID 生成器,示例不假定某个第三方库。字段名一旦进入日志查询和告警规则,就应当保持稳定;例如不要一会儿叫 request_id,一会儿叫 traceId。

让业务函数接收带上下文的日志器

入口拿到派生 Logger 后,直接把它作为显式依赖传入业务函数。请求的取消信号仍然通过 context.Context 传递,日志公共字段则由 Logger 负责。

func handleOrder(ctx context.Context, logger *slog.Logger, orderID string) error {
	// Context 用于取消和超时;Logger 用于请求级字段与事件属性。
	logger.InfoContext(ctx, "load order", slog.String("order_id", orderID))
	order, err := loadOrder(ctx, orderID)
	if err != nil {
		// 错误对象作为结构化字段保留,消息只描述当前事件。
		logger.ErrorContext(ctx, "load order failed", slog.Any("error", err))
		return err
	}
	logger.InfoContext(ctx, "order loaded", slog.String("state", order.State))
	return nil
}

在 Handler 中可以这样组织边界:logger := requestLogger(slog.Default(), r),然后调用 handleOrder(r.Context(), logger, orderID)。如果需要写入完成状态,再由入口记录 status、duration_ms 等 HTTP 层字段,避免业务层猜测响应状态。

请求入口派生 Logger 并把 request_id、method、path 传到业务日志的静态结构说明图
图2:请求级字段说明图,展示 Request Handler、派生 Logger、Context、业务函数和 JSON Record 的边界关系。

统一分组、级别和敏感字段

字段越来越多时,可以用 WithGroup 给子系统建立命名空间。例如 logger.WithGroup("db") 后,数据库层的 duration_ms 不会和 HTTP 层同名混淆。对接口错误使用 Error,对正常状态使用 Info,需要临时打开的细节使用 Debug,并通过 LevelVar 动态调节级别。

密码、Cookie、访问令牌和完整 Authorization 头不应直接记录。自定义类型可以实现 slog.LogValuer,只返回脱敏后的值;Handler 的 ReplaceAttr 也适合统一删除时间、源文件或敏感键。脱敏要在日志出口完成一次,避免每个调用点各写一套规则。

性能与落地检查清单

slog 的调用参数会先求值,即使该级别最终被丢弃。因此不要在 Debug 日志参数中提前执行昂贵的序列化或数据库统计。可直接传递结构化值,或让类型实现 LogValuer,在记录真正启用时再计算。对热点路径优先使用 LogAttrs,减少交替键值参数带来的分配。

检查项落地判断
出口服务只配置一个明确的 JSONHandler,日志按行输出
请求字段request_id、method、path 的命名固定,由入口 Logger.With 绑定
跨层Context 传取消信号,Logger 传结构化日志依赖
安全敏感字段有 LogValuer 或 ReplaceAttr 脱敏规则
性能禁用日志级别不会提前执行昂贵计算

相关问题

slog 的请求字段应该放进 context 吗?通常不必。请求 ID 等日志字段放到派生 Logger 更直观;只有需要被多个独立组件读取的请求元数据,才考虑通过 context 传递。

为什么 JSON 日志里出现重复字段?常见原因是入口已经 With 绑定了字段,业务层又用相同键重复写入。应约定公共字段只在入口绑定,业务层只追加本业务事件字段。

什么时候用 InfoContext 而不是 Info?调用点已有请求 context 时优先使用 InfoContext,这样自定义 Handler 能读取 trace 等上下文信息;没有 context 的进程级启动日志再使用 Info。

版本声明
本文转载于:17golang原创 如有侵犯,请联系study_golang@163.com删除
生成器处理百万行 CSV:内存、编码与异常行策略生成器处理百万行 CSV:内存、编码与异常行策略
上一篇
生成器处理百万行 CSV:内存、编码与异常行策略
Stream 并行化前先判断什么:数据规模、拆分与副作用
下一篇
Stream 并行化前先判断什么:数据规模、拆分与副作用
查看更多
最新文章
查看更多
课程推荐
  • 前端进阶之JavaScript设计模式
    前端进阶之JavaScript设计模式
    设计模式是开发人员在软件开发过程中面临一般问题时的解决方案,代表了最佳的实践。本课程的主打内容包括JS常见设计模式以及具体应用场景,打造一站式知识长龙服务,适合有JS基础的同学学习。
    543次学习
  • GO语言核心编程课程
    GO语言核心编程课程
    本课程采用真实案例,全面具体可落地,从理论到实践,一步一步将GO核心编程技术、编程思想、底层实现融会贯通,使学习者贴近时代脉搏,做IT互联网时代的弄潮儿。
    516次学习
  • 简单聊聊mysql8与网络通信
    简单聊聊mysql8与网络通信
    如有问题加微信:Le-studyg;在课程中,我们将首先介绍MySQL8的新特性,包括性能优化、安全增强、新数据类型等,帮助学生快速熟悉MySQL8的最新功能。接着,我们将深入解析MySQL的网络通信机制,包括协议、连接管理、数据传输等,让
    500次学习
  • JavaScript正则表达式基础与实战
    JavaScript正则表达式基础与实战
    在任何一门编程语言中,正则表达式,都是一项重要的知识,它提供了高效的字符串匹配与捕获机制,可以极大的简化程序设计。
    487次学习
  • 从零制作响应式网站—Grid布局
    从零制作响应式网站—Grid布局
    本系列教程将展示从零制作一个假想的网络科技公司官网,分为导航,轮播,关于我们,成功案例,服务流程,团队介绍,数据部分,公司动态,底部信息等内容区块。网站整体采用CSSGrid布局,支持响应式,有流畅过渡和展现动画。
    485次学习
查看更多
AI推荐
  • PubMedQA数据集详解:生物医学问答基准、功能与应用指南
    PubMedQA
    深入了解PubMedQA生物医学问答数据集,涵盖其核心功能、使用方法及在临床决策、药物研发等场景的应用,助力提升NLP模型性能。
    365次使用
  • H2O EvalGPT:开源LLM大模型评估与排行榜工具
    H2O EvalGPT
    H2O EvalGPT是H2O.ai推出的开源LLM评估平台,提供详细的大模型性能排行榜、行业特定基准测试及A/B测试功能,助您快速选择最适合项目的高性能大语言模型。
    420次使用
  • LMArena是什么?伯克利AI模型评估平台使用指南与功能解析
    LMArena
    LMArena是加州大学伯克利分校推出的AI模型匿名评测平台。通过盲测投票机制,用户可对比不同大模型回答并生成实时排行榜,助力开发者优化模型及用户选择最佳AI工具。
    435次使用
  • 斯坦福HELM:大语言模型Holistic Evaluation整体评估框架详解
    HELM
    深入了解斯坦福推出的HELM(Holistic Evaluation of Language Models)大模型评测体系。本文解析其核心功能、安装配置步骤及应用场景,涵盖准确性、公平性、鲁棒性等多维度指标,助力开发者全面优化语言模型性能。
    387次使用
  • MMBench详解:多模态大模型基准测试、功能特点与使用指南
    MMBench
    MMBench是由上海人工智能实验室等机构联合推出的多模态基准测试平台,提供细粒度能力评估、大规模数据集及VLMEvalKit工具。本文详细介绍其核心功能、安装使用方法及应用场景,助力开发者全面评估多模态模型性能。
    214次使用
微信登录更方便
  • 密码登录
  • 注册账号
登录即同意 用户协议 和 隐私政策
返回登录
  • 重置密码