Go sdk 记录器如何以及何时刷新？

Question

我正在尝试确定 default/sdk 记录器 log.PrintYYY() 函数是否在某个时间点、退出时、恐慌时等被刷新。我不确定是否需要找到一种方法来刷新记录器所连接的编写器，尤其是在使用 SetOutput(...) 设置输出编写器时。当然，writer 接口没有 flush() 方法，所以不太确定如何完成。

Go sdk 记录器如何以及何时刷新？

Answer 1

Logger 不应该知道如何刷新数据。您必须刷新在创建记录器时指定的输出编写器（如果它具有这种功能）。

参见 github discussion

中的示例

package main

import (
    "bufio"
    "flag"
    "log"
    "os"
    "strings"
)

func main() {
    var flush bool
    flag.BoolVar(&flush, "flush", false, "if set, will flush the buffered io before exiting")
    flag.Parse()

    br := bufio.NewWriter(os.Stdout)
    logger := log.New(br, "", log.Ldate)
    logger.Printf("%s\n", strings.Repeat("This is a test\n", 5))
    if flush {
        br.Flush()
    }
    logger.Fatalf("exiting now!")
}

您可以阅读与您的问题相关的整个讨论on github

或者，您可以查看具有 flush 的第 3 方记录器。查看 zap logger 有方法 logger.Sync()

Answer 2

log package is not responsible for flushing the underlying io.Writer。 log 包可以执行类型断言以查看当前 io.Writer 是否有 Flush() 方法，如果有则调用它，但不能保证如果多个io.Writer是"chained"，数据最终会刷到最底层

在我看来，log 软件包不刷新的主要原因是性能。我们使用缓冲写入器，因此我们不必在每次向其写入单个字节（或字节片）时都到达底层，但我们可以缓存最近写入的数据，并且当我们达到特定大小时（或特定大小）时间），我们可以立即高效地编写 "batch"。

如果 log 程序包在每个日志语句后刷新，这将使缓冲 IO 变得无用。在小型应用程序的情况下这可能无关紧要，但如果您有一个高流量的 Web 服务器，在每个日志语句（每个请求处理中可能有很多）之后发出刷新将导致严重的性能缺陷。

那么是的，如果应用程序终止，就会出现问题，最后的日志语句可能无法到达底层。正确的解决方案是 正常关闭 ：实施信号处理，当您的应用程序即将终止时，正确刷新并关闭您使用的记录器的底层 io.Writer。详情见：

Is it possible to capture a Ctrl+C signal and run a cleanup function, in a "defer" fashion?

如果——仅为了简单起见——你仍然需要一个在每个日志语句之后刷新的记录器，你可以轻松实现。这是因为 log.Logger 类型保证每条日志消息通过单个 Writer.Write() 调用传送到目的地 io.Writer：

Each logging operation makes a single call to the Writer's Write method. A Logger can be used simultaneously from multiple goroutines; it guarantees to serialize access to the Writer.

所以基本上您需要做的就是创建一个 "wrapper" io.Writer 其 Write() 方法在 "forwarding" Write() 调用其底层作者。

它可能是这样的：

type myWriter struct {
    io.Writer
}

func (m *myWriter) Write(p []byte) (n int, err error) {
    n, err = m.Writer.Write(p)

    if flusher, ok := m.Writer.(interface{ Flush() }); ok {
        flusher.Flush()
    } else if syncer := m.Writer.(interface{ Sync() error }); ok {
        // Preserve original error
        if err2 := syncer.Sync(); err2 != nil && err == nil {
            err = err2
        }
    }
    return
}

此实现检查 Flush() 方法和 os.File's Sync() 方法，并在它们是 "present" 时调用。

这就是如何使用它，以便日志记录语句始终刷新：

f, err := os.Create("log.txt")
if err != nil {
    panic(err)
}
defer f.Close()

log.SetOutput(&myWriter{Writer: f})

log.Println("hi")

查看相关问题：

Go sdk 记录器如何以及何时刷新？

How and when is the Go sdk logger flushed?

go

logging

flush