配置一个仅在错误级别写入输出的自定义 Zap 记录器的方法是什么？

一分耕耘，一分收获！既然都打开这篇《配置一个仅在错误级别写入输出的自定义 Zap 记录器的方法是什么？》，就坚持看下去，学下去吧！本文主要会给大家讲到等等知识点，如果大家对本文有好的建议或者看到有不足之处，非常欢迎大家积极提出！在后续文章我会继续更新Golang相关的内容，希望对大家都有所帮助！

我正在尝试构建一个自定义记录器，它将日志消息保留在缓冲区中的错误级别以下，并仅在遇到错误后刷新缓冲区。

问题是我不知道遇到错误时如何触发日志刷新到输出（sync方法）。

下面的代码是这样做的尝试：

func customlogger() {
   // first, define our level-handling logic.
   lowpriority := zap.levelenablerfunc(func(lvl zapcore.level) bool {
      return lvl < activationlevel
   })
   //define the output of the logs
   customwritesyncer := buffer(os.stdout)

   consoleencoder := zapcore.newconsoleencoder(zap.newdevelopmentencoderconfig())
   zapcore.newjsonencoder(zap.newproductionencoderconfig())

   //creates a core that writes logs to a writesyncer
   core := zapcore.newcore(consoleencoder, customwritesyncer, lowpriority)

   logger := zap.new(core)

   defer logger.sync()
  
   logger = logger
}

type bufferwritersync struct {
   buf *bufio.writer
}

func buffer(ws zapcore.writesyncer) zapcore.writesyncer {
   bw := &bufferwritersync{
      buf: bufio.newwriter(ws),
   }
   ws = zapcore.lock(bw)
   return ws
}
// sync syncs data to output
func (w bufferwritersync) sync() error {
   return w.buf.flush()
}
// write writes data to buffer
func (w bufferwritersync) write(p []byte) (int, error) {
   return w.buf.write(p)
}

示例，执行时：

• logger.info("some info message") 该消息最终出现在 bufio.writer 的缓冲区中，并且 info 消息不显示

• logger.info("some info message2")这条消息最终出现在bufio.writer的缓冲区中并且info消息没有显示

• logger.error("some error message") 仅当遇到错误记录时 根据上述代码，必须将缓冲中的所有累积日志刷新到输出例如，它应该转到 os.stdout

预期输出：

some Info message
some Info message2
some Error message

注意： 我试图实现的功能类似于 php symfony 框架中存在的 fingers_crossed 功能。

解决方案

总的来说，我认为这不是一个好主意。如果您的应用程序从未出现错误，理论上您的缓冲区可能会无限增长。这就是为什么 zap 自己的 bufferedwritesyncer 具有基于大小或基于计时器的刷新的原因：您必须确定性地清除缓冲区。然而：

仅在错误级别打印日志

要仅打印特定级别的日志，您可以使用 zap.NewAtomicLevelAt() 轻松创建自定义核心：

core := zapcore.newcore(
        zapcore.newjsonencoder(zap.newproductionencoderconfig()),
        os.stdout,
        zap.levelenablerfunc(func(level zapcore.level) bool {
            return level == zapcore.errorlevel
        }),
    )
logger := zap.new(core)

logger.info("bar")  // not logged
logger.error("baz") // logged

当然，这对于其他日志级别也同样有效。

仅在错误级别缓冲和刷新

正如我上面所说，您应该支持确定性刷新逻辑。无论如何，如果您可以证明您的缓冲区最终会被清除，那么出于完整性考虑，以下是一个可行的解决方案。这有点尴尬，因为据我所知，没有（合理的）方法可以从 zapcore.writesyncer 访问日志条目详细信息（如日志级别）。

您必须创建自定义核心并实现缓冲。这个想法是在您的自定义结构中嵌入 zapcore.Encoder 并使用缓冲逻辑实现 encoder.encodeentry 。以下是一个演示程序（它并不意味着线程安全、内存高效等......）：

// struct to "remember" buffered entries
type log struct {
    entry zapcore.Entry
    fields []zapcore.Field
}

// custom encoder
type bufferEncoder struct {
    // embeds a zapcore encoder
    zapcore.Encoder

    // the entry buffer itself
    buffer []*log

    // the buffer pool, to return encoded entries
    pool buffer.Pool
}

func (b *bufferEncoder) EncodeEntry(entry zapcore.Entry, fields []zapcore.Field) (*buffer.Buffer, error) {
    // buffer entries
    b.buffer = append(b.buffer, &log{entry, fields})

    // return an empty buffer if the level is not error
    if entry.Level != zap.ErrorLevel {
        return b.pool.Get(), nil
    }
    
    // new buffer
    buf := b.pool.Get()
    for _, log := range b.buffer {
        // encode buffered entries and append them to buf
        encoded, err := b.Encoder.EncodeEntry(log.entry, log.fields)
        if err != nil {
            return nil, err
        }
        buf.AppendString(encoded.String())
    }
    // reset the buffer before returning
    b.buffer = nil
    return buf, nil
}


func main() {
    enc := &bufferEncoder{
        Encoder: zapcore.NewJSONEncoder(zap.NewProductionEncoderConfig()),
        pool: buffer.NewPool(),
    }

    core := zapcore.NewCore(enc, os.Stdout, zap.NewAtomicLevelAt(zap.InfoLevel))
    logger := zap.New(core)

    logger.Info("info")
    fmt.Println("buffered info")
    time.Sleep(500 * time.Millisecond)

    logger.Warn("warn")
    fmt.Println("buffered warn")
    time.Sleep(500 * time.Millisecond)

    logger.Error("error")
    fmt.Println("flushed")
}

今天关于《配置一个仅在错误级别写入输出的自定义 Zap 记录器的方法是什么？》的内容介绍就到此结束，如果有什么疑问或者建议，可以在golang学习网公众号下多多回复交流；文中若有不正之处，也希望回复留言以告知！