Go log/slog.Logger 怎样保留错误信息

使用 log/slog 记录错误时，关键不是把 error 塞进消息字符串，而是给它一个稳定的属性名：logger.Error("读取配置失败", "error", err)，或使用更明确的 slog.Any("error", err)。这样 TextHandler 和 JSONHandler 都能保留错误文本，同时还能继续检索 op、path 等上下文。

先把 error 放进有名字的属性

Logger.Error 的参数是消息加可变参数。可变参数支持 Attr，也支持“字符串键+值”的交替写法。错误值如果直接作为最后一个参数传入，没有对应的键，slog 会把它当作异常的无键值并使用 !BADKEY。

package main

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

func main() {
    logger := slog.New(slog.NewTextHandler(os.Stdout, nil))
    err := errors.New("配置文件不存在")

    // 错误值必须有稳定的属性名，便于日志系统检索。
    logger.Error("读取配置失败", "error", err)
    // Attr 写法更清晰，适合字段较多或需要固定类型的场景。
    logger.Error("读取配置失败", slog.Any("error", err))
}

两种写法的语义相同：消息描述“发生了什么”，error 字段描述“底层原因是什么”。不要只写 err.Error() 到消息里，否则后续查询很难区分普通文本和错误字段。

错误日志要和返回值各负其责

日志只负责记录，不能替代错误传播。服务边界通常在记录时补充操作和资源字段，然后用 %w 继续包装原错误；上层仍可以用 errors.Is 或 errors.As 判断。

func loadConfig(ctx context.Context, logger *slog.Logger, path string) error {
    data, err := os.ReadFile(path)
    if err != nil {
        // 结构化字段保留排查上下文；返回值保留可判断的原始错误链。
        logger.ErrorContext(ctx, "读取配置失败",
            slog.String("op", "load-config"),
            slog.String("path", path),
            slog.Any("error", err),
        )
        return fmt.Errorf("load config %q: %w", path, err)
    }

    _ = data // 示例只关注错误记录与返回边界。
    return nil
}

生产代码中还应避免把密码、令牌或完整请求头作为属性写入日志。path、资源 ID、重试次数和业务操作名通常比把整段错误拼进消息更有用。

TextHandler 能保留什么，不能替你展开什么

使用 JSONHandler 时，命名的错误字段会出现在 JSON 对象中；使用 TextHandler 时，它会以键值形式输出。两者都能保留 err.Error() 的文本，但不会自动把 fmt.Errorf("...: %w", err) 的每一层包装转换成可查询的错误对象。

需要字段化错误时显式定义 LogValuer

如果日志平台需要按照错误类型或业务码聚合，可以让自定义错误实现 slog.LogValuer，返回一个 Group。这个做法只改变日志呈现，不会改变 error 的 Unwrap、Is 和 As 行为；敏感字段也应在这里主动删减。

type AppError struct {
    Code string
    Op   string
    Err  error
}

func (e AppError) Error() string { return e.Op + ": " + e.Err.Error() }
func (e AppError) Unwrap() error { return e.Err }

func (e AppError) LogValue() slog.Value {
    // 只输出可检索字段，不把内部对象或敏感数据交给日志处理器。
    return slog.GroupValue(
        slog.String("code", e.Code),
        slog.String("op", e.Op),
        slog.String("message", e.Err.Error()),
    )
}

调用时仍使用 slog.Any("error", appErr)。若只是想记录一条普通错误文本，不必为了“保留错误”增加自定义类型；命名属性和清晰上下文已经足够。

常见问题

为什么日志里出现 !BADKEY？

通常是把 err 作为没有键名的最后一个参数传给了 Info、Error 等方法。改成 "error", err 即可。

slog 会自动保存完整的 errors 链吗？

不会。默认处理器主要记录错误的文本表示；需要错误类型、业务码或包装层级时，应显式提供字段或实现 LogValuer。

记录 error 后还要 return 吗？

要。日志用于观测，返回值用于控制流程和让上层判断。通常在合适的边界记录一次，再用 %w 保留可判断的错误链。