如何访问 zap Hooks 中的字段？

欢迎各位小伙伴来到golang学习网，相聚于此都是缘哈哈哈！今天我给大家带来《如何访问 zap Hooks 中的字段？》，这篇文章主要讲到等等知识，如果你对Golang相关的知识非常感兴趣或者正在自学，都可以关注我，我会持续更新相关文章！当然，有什么建议也欢迎在评论留言提出！一起学习！

如何访问 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"
}

正确答案

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

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

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

带有自定义编码器的自定义核心

这具有允许更多定制的优点。

条目的字段在 zapcore.encoder.encodeentry 中可用。像往常一样，策略是将 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()})

以上就是《如何访问 zap Hooks 中的字段？》的详细内容，更多关于的资料请关注golang学习网公众号！