在Go語言項目中使用Zap日志庫

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

我們可以像下面的代碼一樣設置日志記錄器

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

使用Logger

讓我們來寫一些虛擬的代碼來使用這個日志記錄器。

在當前的示例中，我們將建立一個到URL的HTTP連接，並將狀態代碼/錯誤記錄到日志文件中。

func simpleHttpGet(url string) {
	resp, err := http.Get(url)
	if err != nil {
		log.Printf("Error fetching url %s : %s", url, err.Error())
	} else {
		log.Printf("Status Code for %s : %s", url, resp.Status)
		resp.Body.Close()
	}
}

Logger的運行

現在讓我們執行上面的代碼並查看日志記錄器的運行情況。

func main() {
	SetupLogger()
	simpleHttpGet("www.google.com")
	simpleHttpGet("http://www.google.com")
}

當我們執行上面的代碼，我們能看到一個test.log文件被創建，下面的內容會被添加到這個日志文件中。

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

三、Go Logger的優勢和劣勢

優勢

它最大的優點是使用非常簡單。我們可以設置任何io.Writer作為日志記錄輸出並向其發送要寫入的日志。

劣勢

• 僅限基本的日志級別

  • 只有一個Print選項。不支持INFO/DEBUG等多個級別。

• 對於錯誤日志，它有

  Fatal
  

  和

  Panic
  

  • 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

go get -u go.uber.org/zap

六、配置Zap Logger

Zap提供了兩種類型的日志記錄器—Sugared Logger和Logger。

在性能很好但不是很關鍵的上下文中，使用SugaredLogger。它比其他結構化日志記錄包快4-10倍，並且支持結構化和printf風格的日志記錄。

在每一微秒和每一次內存分配都很重要的上下文中，使用Logger。它甚至比SugaredLogger更快，內存分配次數也更少，但它只支持強類型的結構化日志記錄。

Logger

• 通過調用zap.NewProduction()/zap.NewDevelopment()或者zap.Example()創建一個Logger。
• 上面的每一個函數都將創建一個logger。唯一的區別在於它將記錄的信息不同。例如production logger默認記錄調用函數信息、日期和時間等。
• 通過Logger調用Info/Error等。
• 默認情況下日志都會打印到應用程序的console界面。

var logger *zap.Logger

func main() {
	InitLogger()
  defer logger.Sync()
	simpleHttpGet("www.google.com")
	simpleHttpGet("http://www.google.com")
}

func InitLogger() {
	logger, _ = zap.NewProduction()
}

func simpleHttpGet(url string) {
	resp, err := http.Get(url)
	if err != nil {
		logger.Error(
			"Error fetching url..",
			zap.String("url", url),
			zap.Error(err))
	} else {
		logger.Info("Success..",
			zap.String("statusCode", resp.Status),
			zap.String("url", url))
		resp.Body.Close()
	}
}

在上面的代碼中，我們首先創建了一個Logger，然后使用Info/ Error等Logger方法記錄消息。

日志記錄器方法的語法是這樣的：

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

其中MethodXXX是一個可變參數函數，可以是Info / Error/ Debug / Panic等。每個方法都接受一個消息字符串和任意數量的zapcore.Field場參數。

每個zapcore.Field其實就是一組鍵值對參數。

我們執行上面的代碼會得到如下輸出結果：

{"level":"error","ts":1640824641.9490447,"caller":"06zap/01zap.go:24","msg":"Error fetching url..","url":"www.google.com","error":"Get \"www.goog
le.com\": unsupported protocol scheme \"\"","stacktrace":"main.simpleHttpGet\n\tG:/goproject/go/bubble/demo/06zap/01zap.go:24\nmain.main\n\tG:/go
project/go/bubble/demo/06zap/01zap.go:13\nruntime.main\n\tD:/software/go/src/runtime/proc.go:255"}
{"level":"error","ts":1640824663.003711,"caller":"06zap/01zap.go:24","msg":"Error fetching url..","url":"http://www.google.com","error":"Get \"ht
tp://www.google.com\": dial tcp 66.220.146.94:80: connectex: A connection attempt failed because the connected party did not properly respond aft
er a period of time, or established connection failed because connected host has failed to respond.","stacktrace":"main.simpleHttpGet\n\tG:/gopro
ject/go/bubble/demo/06zap/01zap.go:24\nmain.main\n\tG:/goproject/go/bubble/demo/06zap/01zap.go:14\nruntime.main\n\tD:/software/go/src/runtime/pro
c.go:255"}
PS G:\goproject\go\bubble\demo\06zap> go run .\01zap.go
{"level":"error","ts":1640824771.067722,"caller":"06zap/01zap.go:25","msg":"Error fetching url..","url":"www.google.com","error":"Get \"www.googl
e.com\": unsupported protocol scheme \"\"","stacktrace":"main.simpleHttpGet\n\tG:/goproject/go/bubble/demo/06zap/01zap.go:25\nmain.main\n\tG:/gop
roject/go/bubble/demo/06zap/01zap.go:13\nruntime.main\n\tD:/software/go/src/runtime/proc.go:255"}
{"level":"error","ts":1640824792.119109,"caller":"06zap/01zap.go:25","msg":"Error fetching url..","url":"http://www.google.com","error":"Get \"ht
tp://www.google.com\": dial tcp 108.160.165.173:80: connectex: A connection attempt failed because the connected party did not properly respond a
fter a period of time, or established connection failed because connected host has failed to respond.","stacktrace":"main.simpleHttpGet\n\tG:/gop
roject/go/bubble/demo/06zap/01zap.go:25\nmain.main\n\tG:/goproject/go/bubble/demo/06zap/01zap.go:14\nruntime.main\n\tD:/software/go/src/runtime/p
roc.go:255"}
{"level":"info","ts":1640824792.1496365,"caller":"06zap/01zap.go:30","msg":"Success..","statusCode":"200 OK","url":"http://www.baidu.com"}

Sugared Logger

現在讓我們使用Sugared Logger來實現相同的功能。

• 大部分的實現基本都相同。
• 惟一的區別是，我們通過調用主logger的. Sugar()方法來獲取一個SugaredLogger。
• 然后使用SugaredLogger以printf格式記錄語句

下面是修改過后使用SugaredLogger代替Logger的代碼：

var sugarLogger *zap.SugaredLogger

func main() {
	InitLogger()
	defer sugarLogger.Sync()
	simpleHttpGet("www.google.com")
	simpleHttpGet("http://www.google.com")
}

func InitLogger() {
  logger, _ := zap.NewProduction()
	sugarLogger = logger.Sugar()
}

func simpleHttpGet(url string) {
	sugarLogger.Debugf("Trying to hit GET request for %s", url)
	resp, err := http.Get(url)
	if err != nil {
		sugarLogger.Errorf("Error fetching URL %s : Error = %s", url, err)
	} else {
		sugarLogger.Infof("Success! statusCode = %s for URL %s", resp.Status, url)
		resp.Body.Close()
	}
}

當你執行上面的代碼會得到如下輸出：

{"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"}
{"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。

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

zapcore.Core需要三個配置——Encoder，WriteSyncer，LogLevel。

1.Encoder:編碼器(如何寫入日志)。我們將使用開箱即用的NewJSONEncoder()，並使用預先設置的ProductionEncoderConfig()。

   zapcore.NewJSONEncoder(zap.NewProductionEncoderConfig())

2.WriterSyncer ：指定日志將寫到哪里去。我們使用zapcore.AddSync()函數並且將打開的文件句柄傳進去。

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

3.Log Level：哪種級別的日志將被寫入。

我們將修改上述部分中的Logger代碼，並重寫InitLogger()方法。其余方法—main() /SimpleHttpGet()保持不變。

func InitLogger() {
	writeSyncer := getLogWriter()
	encoder := getEncoder()
	core := zapcore.NewCore(encoder, writeSyncer, zapcore.DebugLevel)

	logger := zap.New(core)
	sugarLogger = logger.Sugar()
}

func getEncoder() zapcore.Encoder {
	return zapcore.NewJSONEncoder(zap.NewProductionEncoderConfig())
}

func getLogWriter() zapcore.WriteSyncer {
	file, _ := os.Create("./test.log")
	return zapcore.AddSync(file)
}

當使用這些修改過的logger配置調用上述部分的main()函數時，以下輸出將打印在文件——test.log中。

1.6408266589135118e+09	error	Error fetching url..{url 15 0 www.google.com <nil>} {error 26 0  Get "www.google.com": unsupported protocol scheme ""}
1.640826679977637e+09	error	Error fetching url..{url 15 0 http://www.google.com <nil>} {error 26 0  Get "http://www.google.com": dial tcp 31.13.78.66:80: connectex: A connection attempt failed because the connected party did not properly respond after a period of time, or established connection failed because connected host has failed to respond.}
1.6408266800141683e+09	info	Success..{statusCode 15 0 200 OK <nil>} {url 15 0 http://www.baidu.com <nil>}

將JSON Encoder更改為普通的Log Encoder

現在，我們希望將編碼器從JSON Encoder更改為普通Encoder。為此，我們需要將NewJSONEncoder()更改為NewConsoleEncoder()。

return zapcore.NewConsoleEncoder(zap.NewProductionEncoderConfig())

當使用這些修改過的logger配置調用上述部分的main()函數時，以下輸出將打印在文件——test.log中。

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

更改時間編碼並添加調用者詳細信息

鑒於我們對配置所做的更改，有下面兩個問題：

• 時間是以非人類可讀的方式展示，例如1.572161051846623e+09
• 調用方函數的詳細信息沒有顯示在日志中

我們要做的第一件事是覆蓋默認的ProductionConfig()，並進行以下更改:

• 修改時間編碼器
• 在日志文件中使用大寫字母記錄日志級別

func getEncoder() zapcore.Encoder {
	encoderConfig := zap.NewProductionEncoderConfig()
    // 時間函數可以自定義
	encoderConfig.EncodeTime = zapcore.ISO8601TimeEncoder
	encoderConfig.EncodeLevel = zapcore.CapitalLevelEncoder
	return zapcore.NewConsoleEncoder(encoderConfig)
}

接下來，我們將修改zap logger代碼，添加將調用函數信息記錄到日志中的功能。為此，我們將在zap.New(..)函數中添加一個Option。

logger := zap.New(core, zap.AddCaller())

當使用這些修改過的logger配置調用上述部分的main()函數時，以下輸出將打印在文件——test.log中。

2021-12-31T08:40:25.965+0800	ERROR	Error fetching url..{url 15 0 www.google.com <nil>} {error 26 0  Get "www.google.com": unsupported protocol scheme ""}
2021-12-31T08:40:47.054+0800	ERROR	Error fetching url..{url 15 0 http://www.google.com <nil>} {error 26 0  Get "http://www.google.com": dial tcp 108.160.169.54:80: connectex: A connection attempt failed because the connected party did not properly respond after a period of time, or established connection failed because connected host has failed to respond.}
2021-12-31T08:40:47.092+0800	INFO	Success..{statusCode 15 0 200 OK <nil>} {url 15 0 http://www.baidu.com <nil>}
2021-12-31T08:43:31.462+0800	ERROR	01zap/03customLoggerZap.go:62	Error fetching url..{url 15 0 www.google.com <nil>} {error 26 0  Get "www.google.com": unsupported protocol scheme ""}
2021-12-31T08:43:52.524+0800	ERROR	01zap/03customLoggerZap.go:62	Error fetching url..{url 15 0 http://www.google.com <nil>} {error 26 0  Get "http://www.google.com": dial tcp 69.63.186.30:80: connectex: A connection attempt failed because the connected party did not properly respond after a period of time, or established connection failed because connected host has failed to respond.}
2021-12-31T08:43:52.553+0800	INFO	01zap/03customLoggerZap.go:67	Success..{statusCode 15 0 200 OK <nil>} {url 15 0 http://www.baidu.com <nil>}

八、使用Lumberjack進行日志切割歸檔

這個日志程序中唯一缺少的就是日志切割歸檔功能。

Zap本身不支持切割歸檔日志文件

為了添加日志切割歸檔功能，我們將使用第三方庫Lumberjack來實現。

九、安裝

執行下面的命令安裝Lumberjack

go get -u github.com/natefinch/lumberjack

十、zap logger中加入Lumberjack

要在zap中加入Lumberjack支持，我們需要修改WriteSyncer代碼。我們將按照下面的代碼修改getLogWriter()函數：

// 保存文件日志切割
func getLogWriter() zapcore.WriteSyncer {
	lumberJackLogger := &lumberjack.Logger{
		Filename:   "./test.log", // 日志名稱
		MaxSize:    1,            // 文件內容大小, MB
		MaxBackups: 5,            // 保留舊文件最大個數
		MaxAge:     30,           // 保留舊文件最大天數
		Compress:   false,        // 文件是否壓縮
	}
	return zapcore.AddSync(lumberJackLogger)
}

Lumberjack Logger采用以下屬性作為輸入:

• Filename: 日志文件的位置
• MaxSize：在進行切割之前，日志文件的最大大小（以MB為單位）
• MaxBackups：保留舊文件的最大個數
• MaxAges：保留舊文件的最大天數
• Compress：是否壓縮/歸檔舊文件

十一、測試所有功能

最終，使用Zap/Lumberjack logger的完整示例代碼如下：

package main

import (
	"net/http"

	"github.com/natefinch/lumberjack"
	"go.uber.org/zap"
	"go.uber.org/zap/zapcore"
)

var sugarLogger *zap.SugaredLogger

func main() {
	InitLogger()
	defer sugarLogger.Sync()
	simpleHttpGet("www.sogo.com")
	simpleHttpGet("http://www.sogo.com")
}

func InitLogger() {
	writeSyncer := getLogWriter()
	encoder := getEncoder()
	core := zapcore.NewCore(encoder, writeSyncer, zapcore.DebugLevel)
	// 打印函數行數
	logger := zap.New(core, zap.AddCaller())
	sugarLogger = logger.Sugar()
}

func getEncoder() zapcore.Encoder {
	encoderConfig := zap.NewProductionEncoderConfig()
    // 格式化時間 可自定義
	encoderConfig.EncodeTime = zapcore.ISO8601TimeEncoder
	encoderConfig.EncodeLevel = zapcore.CapitalLevelEncoder
	return zapcore.NewConsoleEncoder(encoderConfig)
}

// 保存文件日志切割
func getLogWriter() zapcore.WriteSyncer {
	lumberJackLogger := &lumberjack.Logger{
		Filename:   "./test.log", // 日志名稱
		MaxSize:    1,            // 文件內容大小, MB
		MaxBackups: 5,            // 保留舊文件最大個數
		MaxAge:     30,           // 保留舊文件最大天數
		Compress:   false,        // 文件是否壓縮
	}
	return zapcore.AddSync(lumberJackLogger)
}

func simpleHttpGet(url string) {
	sugarLogger.Debugf("Trying to hit GET request for %s", url)
	resp, err := http.Get(url)
	if err != nil {
		sugarLogger.Errorf("Error fetching URL %s : Error = %s", url, err)
	} else {
		sugarLogger.Infof("Success! statusCode = %s for URL %s", resp.Status, url)
		resp.Body.Close()
	}
}

執行上述代碼，下面的內容會輸出到文件——test.log中。

2021-12-31T08:55:32.924+0800	ERROR	01zap/03customLoggerZap.go:74	Error fetching url..{url 15 0 www.google.com <nil>} {error 26 0  Get "www.google.com": unsupported protocol scheme ""}
2021-12-31T08:55:53.998+0800	ERROR	01zap/03customLoggerZap.go:74	Error fetching url..{url 15 0 http://www.google.com <nil>} {error 26 0  Get "http://www.google.com": dial tcp 199.96.63.53:80: connectex: A connection attempt failed because the connected party did not properly respond after a period of time, or established connection failed because connected host has failed to respond.}
2021-12-31T08:55:54.029+0800	INFO	01zap/03customLoggerZap.go:79	Success..{statusCode 15 0 200 OK <nil>} {url 15 0 http://www.baidu.com <nil>}

同時，可以在main函數中循環記錄日志，測試日志文件是否會自動切割和歸檔（日志文件每1MB會切割並且在當前目錄下最多保存5個備份）。

至此，我們總結了如何將Zap日志程序集成到Go應用程序項目中。

翻譯自https://dev-journal.in/2019/05/27/adding-uber-go-zap-logger-to-golang-project/，為了更好理解原文內容稍有更改。