本文先介紹了Go語言原生的日志庫的使用，然后詳細介紹了非常流行的Uber開源的zap日志庫，同時介紹了如何搭配Lumberjack實作日志的切割和歸檔，

在Go語言專案中使用Uber-go的Zap Logger

介紹

在許多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":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"}
{"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，
然后使用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中，

{"level":"debug","ts":1572160754.994731,"msg":"Trying to hit GET request for www.sogo.com"}
{"level":"error","ts":1572160754.994982,"msg":"Error fetching URL www.sogo.com : Error = Get www.sogo.com: unsupported protocol scheme \"\""}
{"level":"debug","ts":1572160754.994996,"msg":"Trying to hit GET request for http://www.sogo.com"}
{"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()，

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中，

2019-10-27T15:33:29.855+0800	DEBUG	logic/temp2.go:47	Trying to hit GET request for www.sogo.com
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 ""
2019-10-27T15:33:29.856+0800	DEBUG	logic/temp2.go:47	Trying to hit GET request for http://www.sogo.com
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

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:    10,
		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,
		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中，

2019-10-27T15:50:32.944+0800	DEBUG	logic/temp2.go:48	Trying to hit GET request for www.sogo.com
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 ""
2019-10-27T15:50:32.944+0800	DEBUG	logic/temp2.go:48	Trying to hit GET request for http://www.sogo.com
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/，為了更好理解原文內容稍有更改，

轉載請註明出處，本文鏈接：https://www.uj5u.com/houduan/45050.html

標籤：Go

上一篇：Cookie和Session

下一篇：Go第三方日志庫logrus

Go語言專案中使用zap日志庫（翻譯）

在Go語言專案中使用Uber-go的Zap Logger

介紹

默認的Go Logger

實作Go Logger

設定Logger

使用Logger

Logger的運行

Go Logger的優勢和劣勢

優勢

劣勢

Uber-go Zap

為什么選擇Uber-go zap

安裝

配置Zap Logger

Logger

Sugared Logger

定制logger

將日志寫入檔案而不是終端

將JSON Encoder更改為普通的Log Encoder

更改時間編碼并添加呼叫者詳細資訊

使用Lumberjack進行日志切割歸檔

安裝

zap logger中加入Lumberjack

測驗所有功能