当前位置:首页 > 文章列表 > Golang > Go教程 > Go slog 怎样给结构化日志加入请求字段

Go slog 怎样给结构化日志加入请求字段

来源:17golang原创 2026-10-22 23:39:43 0浏览 收藏

给 Go slog 日志加入请求字段,最短路径是用 base.With(...) 得到请求专属 Logger,再把它交给业务函数。请求标识、方法和路由只绑定一次,事件名称、条数等变化字段留在具体日志调用处。本文围绕“字段没出现”与“不同请求串号”两个现象说明这种写法。

官方文档地址:https://pkg.go.dev/log/slog

字段丢失时先看调用的是哪个 Logger

常见情况是入口已经执行 With,业务函数却仍调用顶层 slog.Info。顶层调用使用默认 Logger,不会自动继承某个局部变量中的属性。另一种情况是忽略 With 返回值,后面依旧拿原来的 base 写日志。

本例把属性分成三个层级:服务级 service 固定为 report-demo;请求级 request 分组包含 id、method、route;事件级 event、rows、status 随每条记录变化。这个划分是示例的接口约定,不是 slog 自动识别出来的分类。

为请求创建独立的日志器

把以下原创示例保存为 main.go。它只依赖标准库,使用 slog 基础接口,面向 Go 1.21 及以上环境。代码和后面的观察条件是供读者尝试的方案,未在本文制作过程中启动服务器或执行测试。

package main

import (
    "context"
    "crypto/rand"
    "encoding/hex"
    "log/slog"
    "net/http"
    "os"
)

func writeReport(ctx context.Context, logger *slog.Logger) {
    // 业务函数使用请求日志器,不退回全局 slog.Info。
    logger.InfoContext(ctx, "report prepared",
        slog.String("event", "report_ready"),
        slog.Int("rows", 12))
}

func reportHandler(base *slog.Logger) http.Handler {
    return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
        var token [16]byte
        // 标识由本服务生成;失败时不产生空标识的正常业务日志。
        if _, err := rand.Read(token[:]); err != nil {
            base.ErrorContext(r.Context(), "request id failed",
                slog.String("error", err.Error()))
            http.Error(w, "internal error", http.StatusInternalServerError)
            return
        }
        requestID := hex.EncodeToString(token[:])
        // 接收 With 的返回值;仅绑定白名单字段,不写查询串或认证头。
        logger := base.With(slog.Group("request",
            slog.String("id", requestID),
            slog.String("method", r.Method),
            slog.String("route", "/report")))
        w.Header().Set("X-Request-ID", requestID)
        writeReport(r.Context(), logger)
        logger.InfoContext(r.Context(), "report response selected",
            slog.Int("status", http.StatusNoContent))
        w.WriteHeader(http.StatusNoContent)
    })
}

func main() {
    // 初始化服务级日志器;本示例不切换进程的默认 Logger。
    base := slog.New(slog.NewJSONHandler(os.Stdout, nil)).
        With(slog.String("service", "report-demo"))
    mux := http.NewServeMux()
    mux.Handle("/report", reportHandler(base))
    server := &http.Server{Addr: "127.0.0.1:8080", Handler: mux}
    // 示例聚焦字段归属,实际部署另行配置超时、关闭与访问控制。
    if err := server.ListenAndServe(); err != nil && err != http.ErrServerClosed {
        base.Error("server failed", slog.String("error", err.Error()))
        os.Exit(1)
    }
}

这里的 requestID 来自随机字节,适合演示关联标识生成,不代表业务主键、用户身份或绝对唯一性证明。route 写固定模板而不记录原始 URL,避免把查询参数直接送入日志。返回头允许调用方取得当前标识,但生产代理是否转发这个头需要自行配置。

writeReport 里的 rows=12 只是固定示例数据,并没有实际查询报表。status=204 记录的是本 Handler 选择的响应码,不能据此宣称客户端已经成功收完响应。示例不包装 ResponseWriter,也不是通用访问日志中间件。

服务日志器与请求日志器以及业务事件的静态关联结构
图1:静态结构说明图。服务属性属于 base,请求分组绑定在派生日志器,业务函数持有该日志器;连线表示归属与引用,不表示执行时间。

Context 和分组分别负责什么

代码同时传入 r.Context() 和 logger,前者承载请求上下文,后者承载已经绑定的日志属性。InfoContext 把 Context 交给 Handler;内置 JSONHandler 不会任意遍历 Context.Value 并把其中内容变成字段。需要输出的 request.id 在这里由 With 明确加入。

如果团队坚持把 Logger 放入 Context,应提供私有键类型和统一取值函数,并保证每层使用该函数;那属于另一种传参约定,不是 slog 的默认功能。本文直接传 *slog.Logger,便于看到哪里丢失了关联。

使用 slog.Group("request", ...) 是为了把三项请求属性组织在同一个对象下。JSONHandler 将其呈现为 request 对象;使用 TextHandler 时则采用带点号的限定名。本文不在请求日志器上调用 WithGroup("request"),否则后续业务字段也会落入该分组范围,容易与想保留在顶层的 status、event 混淆。

上下文、显式请求属性与事件属性的分离关系
图2:静态关系说明图。请求属性来自显式绑定,Context 作为调用参数传给 Handler;两者不是自动字段提取关系。

按字段归属排查串号与重复键

现象应查位置修复动作
入口有 request,业务日志没有业务函数是否改用了 slog.Info传入当前请求的 logger 并在内部使用
执行 With 后字段仍缺失是否忽略返回值使用 logger := base.With(...) 保存派生对象
请求标识互相串用是否把派生对象赋给共享变量或逐请求 SetDefault服务级 base 保持固定,每次在局部变量中派生
同名字段出现两次是否在 With 与单次日志重复写同一键明确字段归属,不依赖重复键覆盖顺序
只有 Debug 不出现Handler 最低级别设置在合适环境明确启用 Debug,而不是更换 request.id

不要用“同一个键后写的必然覆盖前面的”作为业务契约。日志采集器、JSON 解析器及索引规则对重复键的处置可能不同。本例用 request.id 与事件字段分离,从源头减少歧义。

字段白名单应在绑定时执行。不要整包记录 Header、Cookie、认证令牌或请求体,也不要把任意对象交给 slog.Any 后假设它已经脱敏。本例只绑定不可变字符串,避免传入可变 map 或指针后又并发修改其内容。

用两组请求做反向确认

读者可在独立示例目录中尝试下列命令。先启动服务,再在另一个终端发起两次请求;这些命令尚未在本文中执行,没有附上伪造的运行记录。

# 在保存 main.go 的目录启动示例,完成后用 Ctrl+C 停止。
go run main.go
# 在另一个终端分别发起请求,并观察各自响应头中的 X-Request-ID。
curl -i http://127.0.0.1:8080/report
curl -i http://127.0.0.1:8080/report

按代码逻辑,正常路径下同一次请求的两条业务记录应共享 request.id、method、route 和 service;只有 report prepared 带 event 与 rows,另一条带 status。两次请求预期获得不同随机标识;若看到相同值,应检查标识生成与采集链路,不能仅凭两次观察证明全局唯一。

可以临时把 writeReport 中的 logger.InfoContext 改成 slog.Info,观察那条记录是否失去请求属性。这是定位传参断点的反向操作,完成后应恢复。再检查实际查询路径是否使用 request.id,而不是误把 request 当作字符串字段搜索。

一定要自定义 Handler 才能加入请求标识吗?

不需要。本例用显式 With 与参数传递完成。只有要按团队约定从 Context 提取特定值时,才考虑包装 Handler,并承担额外实现和维护成本。

应该在每个请求里调用 SetDefault 吗?

不应该用这种方式传播请求字段。进程默认 Logger 是共享入口,不适合担当某个请求的局部状态。

Logger 可以传给后台任务吗?

可以显式传递作为关联信息,但要先定义任务自己的生命周期与 task.id,不要把 HTTP 请求的取消时点等同于后台任务结束;也不要把整个 Request 长期保存在任务对象中。

最终清单很短:保存 With 返回值、局部派生、显式传递、固定字段归属、避免敏感原始对象,并根据实际日志格式检查嵌套查询路径。

接口语义参考:Logger.With、Contexts、Group。示例业务和排查方案为原创组织。

版本声明
本文转载于:17golang原创 如有侵犯,请联系study_golang@163.com删除
Go url.JoinPath 怎样避免手写斜杠错误Go url.JoinPath 怎样避免手写斜杠错误
上一篇
Go url.JoinPath 怎样避免手写斜杠错误
Go log/slog Value.Resolve 怎样展开延迟计算字段
下一篇
Go log/slog Value.Resolve 怎样展开延迟计算字段
查看更多
最新文章
查看更多
课程推荐
  • 前端进阶之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模型性能。
    594次使用
  • H2O EvalGPT:开源LLM大模型评估与排行榜工具
    H2O EvalGPT
    H2O EvalGPT是H2O.ai推出的开源LLM评估平台,提供详细的大模型性能排行榜、行业特定基准测试及A/B测试功能,助您快速选择最适合项目的高性能大语言模型。
    633次使用
  • LMArena是什么?伯克利AI模型评估平台使用指南与功能解析
    LMArena
    LMArena是加州大学伯克利分校推出的AI模型匿名评测平台。通过盲测投票机制,用户可对比不同大模型回答并生成实时排行榜,助力开发者优化模型及用户选择最佳AI工具。
    665次使用
  • 斯坦福HELM:大语言模型Holistic Evaluation整体评估框架详解
    HELM
    深入了解斯坦福推出的HELM(Holistic Evaluation of Language Models)大模型评测体系。本文解析其核心功能、安装配置步骤及应用场景,涵盖准确性、公平性、鲁棒性等多维度指标,助力开发者全面优化语言模型性能。
    633次使用
  • MMBench详解:多模态大模型基准测试、功能特点与使用指南
    MMBench
    MMBench是由上海人工智能实验室等机构联合推出的多模态基准测试平台,提供细粒度能力评估、大规模数据集及VLMEvalKit工具。本文详细介绍其核心功能、安装使用方法及应用场景,助力开发者全面评估多模态模型性能。
    450次使用
微信登录更方便
  • 密码登录
  • 注册账号
登录即同意 用户协议 和 隐私政策
返回登录
  • 重置密码