如何访问 zap Hooks 中的字段？

Question

如何访问 uber-zap 挂钩中有关日志记录事件的完整信息？

例如，我试图zapcore.Field向日志记录事件添加一个，但它没有显示在zapcore.Entry.

如果不可能，我至少可以以某种方式拥有完全格式化的字符串吗？目标是在出现错误时发送电子邮件/自动消息/哨兵/等。

package main

import (
    "log"

    "github.com/davecgh/go-spew/spew"
    "go.uber.org/zap"
    "go.uber.org/zap/zapcore"
)

func main() {
    prodLogger, err := zap.NewProduction(zap.Hooks(func(entry zapcore.Entry) error {
        if entry.Level == zapcore.ErrorLevel {
            spew.Dump(entry) // fancy console printer
        }

        return nil
    }))

    if err != nil {
        log.Fatal(err)
    }

    prodLogger.
        Named("logger_name").
        Error("something happened", zap.String("foo", "bar"))
}

foo输出 - 没有或的痕迹bar：

{"level":"error","ts":1640722252.899601,"logger":"logger_name","caller":"awesomep2/main.go:23","msg":"something happened","foo":"bar","stacktrace":"main.main\n\t/Users/xxx/GitHub/awesomep2/main.go:23\nruntime.main\n\t/usr/local/go/src/runtime/proc.go:255"}
(zapcore.Entry) {
 Level: (zapcore.Level) error,
 Time: (time.Time) 2021-12-28 13:10:52.899601 -0700 MST m=+0.000629089,
 LoggerName: (string) (len=11) "logger_name",
 Message: (string) (len=18) "something happened",
 Caller: (zapcore.EntryCaller) /Users/xxx/GitHub/awesomep2/main.go:23,
 Stack: (string) (len=103) "main.main\n\t/Users/xxx/GitHub/awesomep2/main.go:23\nruntime.main\n\t/usr/local/go/src/runtime/proc.go:255"
}

Answer 1

Zap 挂钩中的字段不可用。的文档zap.Hooks明确说明了这一点：

[...] 钩子对于简单的副作用很有用，例如捕获发出的日志数量的指标。更复杂的副作用，包括任何需要访问 Entry 的结构化字段的内容，都应该作为 zapcore.Core 实现。[...]

因此，要使用 go-spew 转储日志，您需要一个自定义核心。您有两个主要选择。

带有定制编码器的定制核心

这样做的优点是允许更多定制。

该条目的字段在 中可用zapcore.Encoder.EncodeEntry。像往常一样，策略是将 a 嵌入zapcore.Encoder到您的结构中并重新实现EncodeEntry：

type spewDumpEncoder struct {
    zapcore.Encoder
}

func (e *spewDumpEncoder) EncodeEntry(entry zapcore.Entry, fields []zapcore.Field) (*buffer.Buffer, error) {
    if entry.Level == zapcore.ErrorLevel {
        spew.Dump(entry, fields)
    }
    return e.Encoder.EncodeEntry(entry, fields)
}

Clone()如果您计划使用结构化日志记录，请记住也要实施。

定制核心Write

这样做的优点是可以更简单地进行初始化。

与第一个选项类似，zapcore.Core它也是一个接口，因此您可以通过嵌入到结构中来实现它，并且仅重新实现Write：

type MyCore struct {
    zapcore.Core
}

func (c *MyCore) Check(entry zapcore.Entry, checked *zapcore.CheckedEntry) *zapcore.CheckedEntry {
    if c.Enabled(entry.Level) {
        return checked.AddCore(entry, c)
    }
    return checked
}

func (c *MyCore) Write(entry zapcore.Entry, fields []zapcore.Field) error {
    if entry.Level == zapcore.ErrorLevel {
        spew.Dump(entry, fields)
    }
    return c.Core.Write(entry, fields)
}

并通过从默认 zap 记录器获取现有核心来实例化它：

    l, _ := zap.NewProduction()
    logger := zap.New(&MyCore{Core: l.Core()})