本文先介绍了Go语言原生的日志库的使用,然后详细介绍了非常流行的Uber开源的zap日志库,同时介绍了如何搭配Lumberjack实现日志的切割和归档。

在Go语言项目中使用Zap日志库

介绍

在许多Go语言项目中,我们需要一个好的日志记录器能够提供下面这些功能:

  • 能够将事件记录到文件中,而不是应用程序控制台。
  • 日志切割-能够根据文件大小、时间或间隔等来切割日志文件。
  • 支持不同的日志级别。例如INFO,DEBUG,ERROR等。
  • 能够打印基本信息,如调用文件/函数名和行号,日志时间等。

    默认的Go Logger

    在介绍Uber-go的zap包之前,让我们先看看Go语言提供的基本日志功能。Go语言提供的默认日志包是https://golang.org/pkg/log/

    实现Go Logger

    实现一个Go语言中的日志记录器非常简单——创建一个新的日志文件,然后设置它为日志的输出位置。

    设置Logger

    我们可以像下面的代码一样设置日志记录器

    1. func SetupLogger() {
    2. logFileLocation, _ := os.OpenFile("/Users/q1mi/test.log", os.O_CREATE|os.O_APPEND|os.O_RDWR, 0744)
    3. log.SetOutput(logFileLocation)
    4. }

    使用Logger

    让我们来写一些虚拟的代码来使用这个日志记录器。
    在当前的示例中,我们将建立一个到URL的HTTP连接,并将状态代码/错误记录到日志文件中。

    1. func simpleHttpGet(url string) {
    2. resp, err := http.Get(url)
    3. if err != nil {
    4. log.Printf("Error fetching url %s : %s", url, err.Error())
    5. } else {
    6. log.Printf("Status Code for %s : %s", url, resp.Status)
    7. resp.Body.Close()
    8. }
    9. }

    Logger的运行

    现在让我们执行上面的代码并查看日志记录器的运行情况。

    1. func main() {
    2. SetupLogger()
    3. simpleHttpGet("www.google.com")
    4. simpleHttpGet("http://www.google.com")
    5. }

    当我们执行上面的代码,我们能看到一个test.log文件被创建,下面的内容会被添加到这个日志文件中。

    1. 2019/05/24 01:14:13 Error fetching url www.google.com : Get www.google.com: unsupported protocol scheme ""
    2. 2019/05/24 01:14:14 Status Code for http://www.google.com : 200 OK

    Go Logger的优势和劣势

    优势

    它最大的优点是使用非常简单。我们可以设置任何io.Writer作为日志记录输出并向其发送要写入的日志。

    劣势

  • 仅限基本的日志级别

    • 只有一个Print选项。不支持INFO/DEBUG等多个级别。
  • 对于错误日志,它有FatalPanic
    • Fatal日志通过调用os.Exit(1)来结束程序
    • Panic日志在写入日志消息之后抛出一个panic
    • 但是它缺少一个ERROR日志级别,这个级别可以在不抛出panic或退出程序的情况下记录错误
  • 缺乏日志格式化的能力——例如记录调用者的函数名和行号,格式化日期和时间格式。等等。
  • 不提供日志切割的能力。

    Uber-go Zap

    Zap是非常快的、结构化的,分日志级别的Go日志库。

    为什么选择Uber-go zap

  • 它同时提供了结构化日志记录和printf风格的日志记录

  • 它非常的快

根据Uber-go Zap的文档,它的性能比类似的结构化日志包更好——也比标准库更快。 以下是Zap发布的基准测试信息
记录一条消息和10个字段:

Package Time Time % to zap Objects Allocated
⚡️ zap 862 ns/op +0% 5 allocs/op
⚡️ zap (sugared) 1250 ns/op +45% 11 allocs/op
zerolog 4021 ns/op +366% 76 allocs/op
go-kit 4542 ns/op +427% 105 allocs/op
apex/log 26785 ns/op +3007% 115 allocs/op
logrus 29501 ns/op +3322% 125 allocs/op
log15 29906 ns/op +3369% 122 allocs/op

记录一个静态字符串,没有任何上下文或printf风格的模板:

Package Time Time % to zap Objects Allocated
⚡️ zap 118 ns/op +0% 0 allocs/op
⚡️ zap (sugared) 191 ns/op +62% 2 allocs/op
zerolog 93 ns/op -21% 0 allocs/op
go-kit 280 ns/op +137% 11 allocs/op
standard library 499 ns/op +323% 2 allocs/op
apex/log 1990 ns/op +1586% 10 allocs/op
logrus 3129 ns/op +2552% 24 allocs/op
log15 3887 ns/op +3194% 23 allocs/op

安装

运行下面的命令安装zap

  1. go get -u go.uber.org/zap

配置Zap Logger

Zap提供了两种类型的日志记录器—Sugared LoggerLogger
在性能很好但不是很关键的上下文中,使用SugaredLogger。它比其他结构化日志记录包快4-10倍,并且支持结构化和printf风格的日志记录。
在每一微秒和每一次内存分配都很重要的上下文中,使用Logger。它甚至比SugaredLogger更快,内存分配次数也更少,但它只支持强类型的结构化日志记录。

Logger

  • 通过调用zap.NewProduction()/zap.NewDevelopment()或者zap.Example()创建一个Logger。
  • 上面的每一个函数都将创建一个logger。唯一的区别在于它将记录的信息不同。例如production logger默认记录调用函数信息、日期和时间等。
  • 通过Logger调用Info/Error等。
  • 默认情况下日志都会打印到应用程序的console界面。

    1. var logger *zap.Logger
    2. func main() {
    3. InitLogger()
    4. defer logger.Sync()
    5. simpleHttpGet("www.google.com")
    6. simpleHttpGet("http://www.google.com")
    7. }
    8. func InitLogger() {
    9. logger, _ = zap.NewProduction()
    10. }
    11. func simpleHttpGet(url string) {
    12. resp, err := http.Get(url)
    13. if err != nil {
    14. logger.Error(
    15. "Error fetching url..",
    16. zap.String("url", url),
    17. zap.Error(err))
    18. } else {
    19. logger.Info("Success..",
    20. zap.String("statusCode", resp.Status),
    21. zap.String("url", url))
    22. resp.Body.Close()
    23. }
    24. }

    在上面的代码中,我们首先创建了一个Logger,然后使用Info/ Error等Logger方法记录消息。
    日志记录器方法的语法是这样的:

    1. func (log *Logger) MethodXXX(msg string, fields ...Field)

    其中MethodXXX是一个可变参数函数,可以是Info / Error/ Debug / Panic等。每个方法都接受一个消息字符串和任意数量的zapcore.Field场参数。
    每个zapcore.Field其实就是一组键值对参数。
    我们执行上面的代码会得到如下输出结果:

    1. {"level":"error","ts":1572159218.912792,"caller":"zap_demo/temp.go:25","msg":"Error fetching url..","url":"www.sogo.com","error":"Get www.sogo.com: unsupported protocol scheme \"\"","stacktrace":"main.simpleHttpGet\n\t/Users/q1mi/zap_demo/temp.go:25\nmain.main\n\t/Users/q1mi/zap_demo/temp.go:14\nruntime.main\n\t/usr/local/go/src/runtime/proc.go:203"}
    2. {"level":"info","ts":1572159219.1227388,"caller":"zap_demo/temp.go:30","msg":"Success..","statusCode":"200 OK","url":"http://www.sogo.com"}

    Sugared Logger

    现在让我们使用Sugared Logger来实现相同的功能。

  • 大部分的实现基本都相同。

  • 惟一的区别是,我们通过调用主logger的. Sugar()方法来获取一个SugaredLogger
  • 然后使用SugaredLoggerprintf格式记录语句

下面是修改过后使用SugaredLogger代替Logger的代码:

  1. var sugarLogger *zap.SugaredLogger
  2. func main() {
  3. InitLogger()
  4. defer sugarLogger.Sync()
  5. simpleHttpGet("www.google.com")
  6. simpleHttpGet("http://www.google.com")
  7. }
  8. func InitLogger() {
  9. logger, _ := zap.NewProduction()
  10. sugarLogger = logger.Sugar()
  11. }
  12. func simpleHttpGet(url string) {
  13. sugarLogger.Debugf("Trying to hit GET request for %s", url)
  14. resp, err := http.Get(url)
  15. if err != nil {
  16. sugarLogger.Errorf("Error fetching URL %s : Error = %s", url, err)
  17. } else {
  18. sugarLogger.Infof("Success! statusCode = %s for URL %s", resp.Status, url)
  19. resp.Body.Close()
  20. }
  21. }

当你执行上面的代码会得到如下输出:

  1. {"level":"error","ts":1572159149.923002,"caller":"logic/temp2.go:27","msg":"Error fetching URL www.sogo.com : Error = Get www.sogo.com: unsupported protocol scheme \"\"","stacktrace":"main.simpleHttpGet\n\t/Users/q1mi/zap_demo/logic/temp2.go:27\nmain.main\n\t/Users/q1mi/zap_demo/logic/temp2.go:14\nruntime.main\n\t/usr/local/go/src/runtime/proc.go:203"}
  2. {"level":"info","ts":1572159150.192585,"caller":"logic/temp2.go:29","msg":"Success! statusCode = 200 OK for URL http://www.sogo.com"}

你应该注意到的了,到目前为止这两个logger都打印输出JSON结构格式。
在本博客的后面部分,我们将更详细地讨论SugaredLogger,并了解如何进一步配置它。

定制logger

将日志写入文件而不是终端

我们要做的第一个更改是把日志写入文件,而不是打印到应用程序控制台。

  • 我们将使用zap.New(…)方法来手动传递所有配置,而不是使用像zap.NewProduction()这样的预置方法来创建logger。

    1. func New(core zapcore.Core, options ...Option) *Logger

    zapcore.Core需要三个配置——EncoderWriteSyncerLogLevel
    1.Encoder:编码器(如何写入日志)。我们将使用开箱即用的NewJSONEncoder(),并使用预先设置的ProductionEncoderConfig()

    1. zapcore.NewJSONEncoder(zap.NewProductionEncoderConfig())

    2.WriterSyncer :指定日志将写到哪里去。我们使用zapcore.AddSync()函数并且将打开的文件句柄传进去。

    1. file, _ := os.Create("./test.log")
    2. writeSyncer := zapcore.AddSync(file)

    3.Log Level:哪种级别的日志将被写入。
    我们将修改上述部分中的Logger代码,并重写InitLogger()方法。其余方法—main() /SimpleHttpGet()保持不变。

    1. func InitLogger() {
    2. writeSyncer := getLogWriter()
    3. encoder := getEncoder()
    4. core := zapcore.NewCore(encoder, writeSyncer, zapcore.DebugLevel)
    5. logger := zap.New(core)
    6. sugarLogger = logger.Sugar()
    7. }
    8. func getEncoder() zapcore.Encoder {
    9. return zapcore.NewJSONEncoder(zap.NewProductionEncoderConfig())
    10. }
    11. func getLogWriter() zapcore.WriteSyncer {
    12. file, _ := os.Create("./test.log")
    13. return zapcore.AddSync(file)
    14. }

    当使用这些修改过的logger配置调用上述部分的main()函数时,以下输出将打印在文件——test.log中。

    1. {"level":"debug","ts":1572160754.994731,"msg":"Trying to hit GET request for www.sogo.com"}
    2. {"level":"error","ts":1572160754.994982,"msg":"Error fetching URL www.sogo.com : Error = Get www.sogo.com: unsupported protocol scheme \"\""}
    3. {"level":"debug","ts":1572160754.994996,"msg":"Trying to hit GET request for http://www.sogo.com"}
    4. {"level":"info","ts":1572160757.3755069,"msg":"Success! statusCode = 200 OK for URL http://www.sogo.com"}

    将JSON Encoder更改为普通的Log Encoder

    现在,我们希望将编码器从JSON Encoder更改为普通Encoder。为此,我们需要将NewJSONEncoder()更改为NewConsoleEncoder()

    1. return zapcore.NewConsoleEncoder(zap.NewProductionEncoderConfig())

    当使用这些修改过的logger配置调用上述部分的main()函数时,以下输出将打印在文件——test.log中。

    1. 1.572161051846623e+09 debug Trying to hit GET request for www.sogo.com
    2. 1.572161051846828e+09 error Error fetching URL www.sogo.com : Error = Get www.sogo.com: unsupported protocol scheme ""
    3. 1.5721610518468401e+09 debug Trying to hit GET request for http://www.sogo.com
    4. 1.572161052068744e+09 info Success! statusCode = 200 OK for URL http://www.sogo.com

    更改时间编码并添加调用者详细信息

    鉴于我们对配置所做的更改,有下面两个问题:

  • 时间是以非人类可读的方式展示,例如1.572161051846623e+09

  • 调用方函数的详细信息没有显示在日志中

我们要做的第一件事是覆盖默认的ProductionConfig(),并进行以下更改:

  • 修改时间编码器
  • 在日志文件中使用大写字母记录日志级别
    1. func getEncoder() zapcore.Encoder {
    2. encoderConfig := zap.NewProductionEncoderConfig()
    3. encoderConfig.EncodeTime = zapcore.ISO8601TimeEncoder
    4. encoderConfig.EncodeLevel = zapcore.CapitalLevelEncoder
    5. return zapcore.NewConsoleEncoder(encoderConfig)
    6. }
    接下来,我们将修改zap logger代码,添加将调用函数信息记录到日志中的功能。为此,我们将在zap.New(..)函数中添加一个Option
    1. logger := zap.New(core, zap.AddCaller())
    当使用这些修改过的logger配置调用上述部分的main()函数时,以下输出将打印在文件——test.log中。
    1. 2019-10-27T15:33:29.855+0800 DEBUG logic/temp2.go:47 Trying to hit GET request for www.sogo.com
    2. 2019-10-27T15:33:29.855+0800 ERROR logic/temp2.go:50 Error fetching URL www.sogo.com : Error = Get www.sogo.com: unsupported protocol scheme ""
    3. 2019-10-27T15:33:29.856+0800 DEBUG logic/temp2.go:47 Trying to hit GET request for http://www.sogo.com
    4. 2019-10-27T15:33:30.125+0800 INFO logic/temp2.go:52 Success! statusCode = 200 OK for URL http://www.sogo.com

    使用Lumberjack进行日志切割归档

    这个日志程序中唯一缺少的就是日志切割归档功能。

    Zap本身不支持切割归档日志文件

为了添加日志切割归档功能,我们将使用第三方库Lumberjack来实现。

安装

执行下面的命令安装Lumberjack

  1. go get -u github.com/natefinch/lumberjack

zap logger中加入Lumberjack

要在zap中加入Lumberjack支持,我们需要修改WriteSyncer代码。我们将按照下面的代码修改getLogWriter()函数:

  1. func getLogWriter() zapcore.WriteSyncer {
  2. lumberJackLogger := &lumberjack.Logger{
  3. Filename: "./test.log",
  4. MaxSize: 10,
  5. MaxBackups: 5,
  6. MaxAge: 30,
  7. Compress: false,
  8. }
  9. return zapcore.AddSync(lumberJackLogger)
  10. }

Lumberjack Logger采用以下属性作为输入:

  • Filename: 日志文件的位置
  • MaxSize:在进行切割之前,日志文件的最大大小(以MB为单位)
  • MaxBackups:保留旧文件的最大个数
  • MaxAges:保留旧文件的最大天数
  • Compress:是否压缩/归档旧文件

    测试所有功能

    最终,使用Zap/Lumberjack logger的完整示例代码如下:
    1. package main
    2. import (
    3. "net/http"
    4. "github.com/natefinch/lumberjack"
    5. "go.uber.org/zap"
    6. "go.uber.org/zap/zapcore"
    7. )
    8. var sugarLogger *zap.SugaredLogger
    9. func main() {
    10. InitLogger()
    11. defer sugarLogger.Sync()
    12. simpleHttpGet("www.sogo.com")
    13. simpleHttpGet("http://www.sogo.com")
    14. }
    15. func InitLogger() {
    16. writeSyncer := getLogWriter()
    17. encoder := getEncoder()
    18. core := zapcore.NewCore(encoder, writeSyncer, zapcore.DebugLevel)
    19. logger := zap.New(core, zap.AddCaller())
    20. sugarLogger = logger.Sugar()
    21. }
    22. func getEncoder() zapcore.Encoder {
    23. encoderConfig := zap.NewProductionEncoderConfig()
    24. encoderConfig.EncodeTime = zapcore.ISO8601TimeEncoder
    25. encoderConfig.EncodeLevel = zapcore.CapitalLevelEncoder
    26. return zapcore.NewConsoleEncoder(encoderConfig)
    27. }
    28. func getLogWriter() zapcore.WriteSyncer {
    29. lumberJackLogger := &lumberjack.Logger{
    30. Filename: "./test.log",
    31. MaxSize: 1,
    32. MaxBackups: 5,
    33. MaxAge: 30,
    34. Compress: false,
    35. }
    36. return zapcore.AddSync(lumberJackLogger)
    37. }
    38. func simpleHttpGet(url string) {
    39. sugarLogger.Debugf("Trying to hit GET request for %s", url)
    40. resp, err := http.Get(url)
    41. if err != nil {
    42. sugarLogger.Errorf("Error fetching URL %s : Error = %s", url, err)
    43. } else {
    44. sugarLogger.Infof("Success! statusCode = %s for URL %s", resp.Status, url)
    45. resp.Body.Close()
    46. }
    47. }
    执行上述代码,下面的内容会输出到文件——test.log中。
    1. 2019-10-27T15:50:32.944+0800 DEBUG logic/temp2.go:48 Trying to hit GET request for www.sogo.com
    2. 2019-10-27T15:50:32.944+0800 ERROR logic/temp2.go:51 Error fetching URL www.sogo.com : Error = Get www.sogo.com: unsupported protocol scheme ""
    3. 2019-10-27T15:50:32.944+0800 DEBUG logic/temp2.go:48 Trying to hit GET request for http://www.sogo.com
    4. 2019-10-27T15:50:33.165+0800 INFO logic/temp2.go:53 Success! statusCode = 200 OK for URL http://www.sogo.com
    同时,可以在main函数中循环记录日志,测试日志文件是否会自动切割和归档(日志文件每1MB会切割并且在当前目录下最多保存5个备份)。
    至此,我们总结了如何将Zap日志程序集成到Go应用程序项目中。
    翻译自https://dev-journal.in/2019/05/27/adding-uber-go-zap-logger-to-golang-project/,为了更好理解原文内容稍有更改。