登录
推荐 文章 Go 技术 课程 下载 专题 AI
首页 >  Golang >  Go问答

Go 日志日志 Handler 过滤后关键字段消失怎么办

来源:17golang原创

时间:2026-10-18 09:42:39 417浏览 收藏

如果 slog.Logger.With("request_id", "r-42") 之后,输出里只剩下消息和级别,先不要怀疑 With 没有生效。Go 的 log/slog 中,字段消失最常见的原因是 HandlerOptions.ReplaceAttr 返回了零值 slog.Attr{},或者自定义 Handler 在 WithAttrs、WithGroup 中没有把状态传给下一个 Handler。

官方文档入口:https://pkg.go.dev/log/slog。排查时把链路拆成“Logger 产生属性—Handler 处理属性—输出字段”三段,很快就能看出是哪一层主动丢了字段。

先确认过滤发生在哪一层

ReplaceAttr 会在属性准备输出前收到每个非分组属性;它返回零值 Attr 时,该属性会被丢弃。于是下面这种写法不是“只保留 request_id”,而是“删除所有不是 request_id 的字段”,包括业务字段和可能需要保留的内置字段。

opts := &slog.HandlerOptions{
    ReplaceAttr: func(groups []string, a slog.Attr) slog.Attr {
        // 这个条件会把除 request_id 外的所有键都变成零值 Attr。
        if a.Key != "request_id" {
            return slog.Attr{}
        }
        return a
    },
}

正确的判断应该从“明确禁止哪些键”出发,而不是列出一个白名单后把其余属性全部清空。还要注意 groups:同名键可能位于不同的分组路径中,不能只看键名就误删。

Logger、ReplaceAttr 与输出字段之间的静态过滤关系
图1:过滤边界说明图,查看 ReplaceAttr 如何决定普通 Attr 是否进入输出;这是静态结构图,不是运行截图。

让 ReplaceAttr 只删除明确的敏感键

如果目标只是隐藏令牌、密码或内部标识,可以保留默认行为,只在根级或指定分组下删除目标键。其余属性原样返回,分组属性的内容也会继续按照 Handler 的规则处理。

package main

import (
    "context"
    "log/slog"
    "os"
)

func main() {
    handler := slog.NewJSONHandler(os.Stdout, &slog.HandlerOptions{
        ReplaceAttr: func(groups []string, a slog.Attr) slog.Attr {
            // 只隐藏根级 token,避免误删 http 组里的同名业务字段。
            if len(groups) == 0 && a.Key == "token" {
                return slog.Attr{}
            }
            // 其它字段必须原样返回,零值 Attr 才表示丢弃。
            return a
        },
    })

    logger := slog.New(handler).With("request_id", "r-42")
    // 这里的 status 位于 http 分组,过滤函数可以通过 groups 区分它。
    logger.LogAttrs(context.Background(), slog.LevelInfo, "request handled",
        slog.Group("http", slog.Int("status", 200)),
        slog.String("token", "hidden"),
    )
}

按代码语义,request_id 和 http.status 应保留,根级 token 才被删除。示例输出只用于说明字段关系,并不是本文制作过程中的运行记录。若要连同时间、级别或来源一起改写,也应逐个写出规则,不要用一个宽泛的“非白名单全部删除”条件代替。

WithAttrs 和 WithGroup 为什么会让字段看不见

如果没有配置 ReplaceAttr,问题往往出在自定义 Handler。Logger.With 会调用 Handler 的 WithAttrs,Logger.WithGroup 会调用 WithGroup。这两个方法应返回带有新状态的新 Handler;直接返回原对象,或创建新对象却忘记把旧 Handler 链进去,都会让字段在后续 Handle 前消失。

type forwardingHandler struct {
    next slog.Handler
}

func (h *forwardingHandler) Enabled(ctx context.Context, level slog.Level) bool {
    // 级别判断交给被包装的 Handler,保持原有过滤策略。
    return h.next.Enabled(ctx, level)
}

func (h *forwardingHandler) Handle(ctx context.Context, r slog.Record) error {
    // 不在包装层重建 Record,避免意外丢失已有属性。
    return h.next.Handle(ctx, r)
}

func (h *forwardingHandler) WithAttrs(attrs []slog.Attr) slog.Handler {
    // 返回新包装器,并把属性交给下游 Handler 保存。
    return &forwardingHandler{next: h.next.WithAttrs(attrs)}
}

func (h *forwardingHandler) WithGroup(name string) slog.Handler {
    // 分组同样必须沿链传递,不能只改当前对象的临时字段。
    return &forwardingHandler{next: h.next.WithGroup(name)}
}

这个包装器没有自行过滤字段,只负责保持 Handler 契约。真正要过滤时,可以在下游使用 ReplaceAttr,或在包装层明确重建记录;但后一种做法必须同时处理分组、已绑定属性和并发调用,复杂度更高。

Logger.With、Handler.WithAttrs、WithGroup 与输出字段的静态关系
图2:Handler 状态关系图,查看属性和分组如何传入 Handle;这是静态结构图,不是运行截图。

用最小诊断记录检查边界

排查时先临时换成标准库 Handler,并只记录三个互不相同的信号:根级属性、分组属性和一个明确要过滤的键。这样可以把“过滤函数写错”和“自定义 Handler 没传状态”分开。

logger := slog.New(handler).
    With("request_id", "r-42").
    WithGroup("http")

// 根级 request_id 与 http 组字段用于区分两类状态。
logger.Info("probe",
    slog.Int("status", 200),
    slog.String("token", "hidden"),
)
  • 只有普通字段消失:优先检查 ReplaceAttr 是否返回了零值 Attr。
  • 通过 With 绑定的字段消失:检查包装 Handler 的 WithAttrs 是否调用了下游。
  • 分组内字段消失:检查 WithGroup 和 groups 路径判断,不要只比较裸键名。
  • 整条日志没有输出:再看 Enabled 的级别判断,以及实际使用的 Logger 是否仍指向这个 Handler。

这个诊断记录不需要改生产过滤策略;确认层次后,应把临时代码撤掉,并把允许保留、明确删除的键名写成可读规则。

两个容易混淆的问题

返回空 Attr 是不是等于空字符串? 不是。零值 Attr 表示该属性不进入输出;如果只是想输出空字符串,应返回带有原键名的字符串 Attr。

WithAttrs 能不能直接修改当前 Handler? 不建议。Handler 可能被多个 Logger 共享,接口语义要求返回一个带新属性的 Handler;修改接收者会让不同 Logger 之间互相污染。

归根结底,先查 ReplaceAttr 的返回值,再查 WithAttrs、WithGroup 是否沿链返回新 Handler。过滤规则只删除明确键名,字段消失的问题通常就能被限定在一个很小的范围内。

声明:本文转载于:17golang原创 如有侵犯,请联系study_golang@163.com删除
相关阅读
更多>
最新阅读
更多>
课程推荐
更多>