如何配置仅在错误级别写入输出的自定义 zap 记录器？

Posted 2023-02-18

【中文标题】如何配置仅在错误级别写入输出的自定义 zap 记录器？

【英文标题】：How to configure a custom zap logger that writes to output only at error level?

【发布时间】：2020-05-22 06:20:47

【问题描述】：

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

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

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

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 framework 中的 fingers_crossed 功能。

【参考方案1】：

总的来说，我认为这不是一个好主意。如果您的应用程序从来没有错误，理论上您的缓冲区可能会无限增长。这就是 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

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

仅在错误级别缓冲和刷新

正如我上面所说，您应该支持确定性刷新逻辑。无论如何，如果您可以证明您的缓冲区最终会清除，为了完整起见，以下是一个可行的解决方案。这有点尴尬，因为 AFAIK 没有（理智的）方法可以从 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, &logentry, 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")