当前位置:首页 > 文章列表 > Golang > Go教程 > Go 日志怎么输出结构化 JSON 并区分用户字段

Go 日志怎么输出结构化 JSON 并区分用户字段

来源:17golang原创 2026-09-07 20:16:06 0浏览 收藏

Go 日志要输出结构化 JSON,核心不是把字符串拼成一行,而是让 log/slogJSONHandler 统一负责编码,再用分组字段区分请求、用户和业务数据。用户字段建议放进 user 对象,令牌、密码等敏感值则在 Handler 层统一替换,避免每个调用点各写一套判断。

最稳妥的组合是:一个共享的 JSONHandler,用 requestuser 分组表达上下文,用 ReplaceAttr 做最后一道敏感字段边界。
要点速览
  • NewJSONHandler 负责把记录编码为 JSON,WithGroup 负责稳定字段层级。
  • 用户可检索字段与系统字段分开放,优先使用有业务含义的短键名。
  • passwordtoken 等键在 Handler 层脱敏,调用方不要记录原始值。

先把日志输出边界固定成 JSON 和分组字段

JSONHandler 默认会写出 timelevelmsg 等记录字段;业务字段可以继续作为属性附加。下面的入口只创建一次,业务函数拿到同一个 logger 使用:

package main

import (
    "os"
    "log/slog"
)

func newLogger() *slog.Logger {
    // 统一从标准错误输出 JSON,便于采集器逐行读取。
    handler := slog.NewJSONHandler(os.Stderr, &slog.HandlerOptions{
        Level: slog.LevelInfo,
    })
    // 共享一个入口,避免不同模块自行决定文本或 JSON 格式。
    return slog.New(handler)
}

func main() {
    logger := newLogger()
    // 业务字段使用稳定的键名,不把整段用户对象直接塞进日志。
    logger.Info("订单已创建", "order_id", "o-2048", "status", "paid")
}

这里的重点是格式和字段契约分离:日志采集端只需要解析 JSON,应用端再决定哪些字段值得记录。不要把一整段拼接字符串放进 msg,否则订单号、状态等信息又退回不可检索的文本里。

Go slog JSONHandler、Logger、request 与 user 分组之间的静态字段关系
图1:查看 Logger、JSONHandler 与 request/user 分组的静态关系,理解系统字段和业务字段为何要分层。

用 request 和 user 分组区分业务字段

“区分用户字段”不等于给每个字段加一套随意前缀。推荐用对象分组表达语义边界,让日志查询可以写成 user.idrequest.trace_idWithGroup 会返回带有分组上下文的新 logger:

func logOrder(logger *slog.Logger, traceID, userID string) {
    // request 和 user 是 JSON 中的两个稳定对象。
    scoped := logger.With(
        slog.Group("request", slog.String("trace_id", traceID)),
        slog.Group("user", slog.String("id", userID)),
    )
    // 订单字段留在根记录,避免把业务对象误当成用户属性。
    scoped.Info("订单已创建", "order_id", "o-2048", "amount_cent", 12900)
}

当一组字段会伴随多条日志时,也可以使用 logger.WithGroup("user").With("id", userID)。字段名尽量表达含义:id 放在 user 下没有歧义,但订单对象下更适合用 order_id。同一条记录不要同时写根级 iduser.id,否则查询规则会变得含糊。

在 HandlerOptions 中处理密码、令牌等敏感字段

调用方即使约定“不记录密码”,也可能在异常分支把参数误传给日志。把最后的防线放在 HandlerOptions.ReplaceAttr 中,按属性键名替换值;这段策略不需要知道业务函数在哪里产生日志。

func newSafeLogger() *slog.Logger {
    // ReplaceAttr 统一处理最终记录中的敏感键。
    redact := func(_ []string, attr slog.Attr) slog.Attr {
        switch attr.Key {
        case "password", "token", "authorization":
            // 保留字段名,隐藏原值,方便发现误记录的位置。
            return slog.String(attr.Key, "[REDACTED]")
        default:
            return attr
        }
    }
    options := &slog.HandlerOptions{ReplaceAttr: redact}
    return slog.New(slog.NewJSONHandler(os.Stderr, options))
}

脱敏策略要覆盖实际使用的键名和嵌套分组;只检查 token 而漏掉 access_token,保护就不完整。另一方面,不要把邮箱、手机号等所有用户字段都粗暴删除:能安全用于排障的业务标识可以保留,真正敏感的值应明确替换或哈希。

Go ReplaceAttr、Attr.Key、敏感字段和脱敏 JSON 之间的静态处理边界
图2:查看 ReplaceAttr 与 Attr.Key、敏感字段和脱敏 JSON 的关系,确定敏感值应停留在 Handler 边界内。

字段错位时按这张检查表排查

现象优先检查处理方式
用户字段跑到根级是否调用了 Group统一使用 slog.Group("user", ...)
同名键难以查询是否混用了根级 id按对象命名,如 user.id
敏感值仍可见真实键名是否覆盖补充 ReplaceAttr 的匹配集合
JSON 变成普通文本是否仍在使用 TextHandler检查初始化处是否为 NewJSONHandler

最后做一次人工抽查:查看一条成功日志、一条错误日志和一条鉴权失败日志,分别确认字段类型、分组层级和脱敏结果。结构化日志的价值在于长期稳定,临时加一个字段之前先问清楚它属于哪个对象。

常见问题

JSONHandler 会自动把用户对象嵌套成 user 吗?

不会。只有显式使用 slog.Group("user", ...)WithGroup("user"),用户字段才会形成稳定分组。

ReplaceAttr 能替换分组里的敏感字段吗?

可以,处理时会带着分组路径;策略至少要按键名覆盖真实使用的令牌、密码和授权字段。

日志里要不要保存用户手机号?

只在排障确实需要且符合业务规则时保存,优先使用内部用户编号或不可逆摘要,不要把原始手机号当作通用日志字段。

版本声明
本文转载于:17golang原创 如有侵犯,请联系study_golang@163.com删除
灰紫雾中松枝手机壁纸怎么做出安静纵深灰紫雾中松枝手机壁纸怎么做出安静纵深
上一篇
灰紫雾中松枝手机壁纸怎么做出安静纵深
Java 结构化并发预览特性适合替代哪些任务编排
下一篇
Java 结构化并发预览特性适合替代哪些任务编排
查看更多
最新文章
查看更多
课程推荐
  • 前端进阶之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推荐
  • SuperCLUE中文大模型评测基准:功能、能力维度与应用指南
    SuperCLUE
    SuperCLUE是权威的中文大语言模型综合评测基准,涵盖语言理解、知识应用、AI Agent智能体及安全性等12项核心能力。通过多轮对话与客观测试,定期发布榜单与技术报告,为模型研发、优化及行业选型提供科学依据。
    173次使用
  • C-Eval中文评测基准:大语言模型多学科能力评估指南
    C-Eval
    深入了解C-Eval中文评估套件,涵盖52个学科与4级难度。本文详解其功能特点、Zero-shot/Few-shot使用方法及代码示例,助您全面评测LLM中文理解与泛化能力。
    104次使用
  • AI Prompt Library:免费AI提示词库,助力ChatGPT高效创作与营销
    AI Prompt Library
    探索AI Prompt Library免费资源库,涵盖营销、写作及多场景AI提示词。兼容ChatGPT、Claude等工具,一键复制优化输出,提升工作效率。
    31次使用
  • LangGPT提示词框架:结构化Prompt设计方法与开源工具指南
    LangGPT
    LangGPT是一种受编程语言启发的结构化提示词设计工具,提供双层框架、模块化模板及变量功能,帮助用户高效编写高质量Prompt。该项目已在GitHub免费开源,适用于内容创作、编程辅助等多场景。
    41次使用
  • ClickPrompt:AI提示词生成与优化工具,支持Stable Diffusion、ChatGPT及代码辅助
    ClickPrompt
    ClickPrompt是一款专为AI提示词编写者设计的开源在线工具,支持Stable Diffusion绘图、ChatGPT对话及GitHub Copilot代码辅助。提供Prompt自动生成、一键运行、社区分享及可视化优化功能,帮助用户高效获取精准AI输出。
    77次使用
微信登录更方便
  • 密码登录
  • 注册账号
登录即同意 用户协议隐私政策
返回登录
  • 重置密码