本文先介紹了Go語言原生的日志庫的使用,然后詳細介紹了非常流行的Uber開源的zap日志庫锤窑,同時介紹了如何搭配Lumberjack實現(xiàn)日志的切割和歸檔甚淡。
在Go語言項目中使用Uber-go的Zap Logger
介紹
在許多Go語言項目中,我們需要一個好的日志記錄器能夠提供下面這些功能:
- 能夠?qū)⑹录涗浀轿募胸罢皇菓?yīng)用程序控制臺避乏。
- 日志切割-能夠根據(jù)文件大小、時間或間隔等來切割日志文件汗捡。
- 支持不同的日志級別淑际。例如INFO,DEBUG扇住,ERROR等春缕。
- 能夠打印基本信息,如調(diào)用文件/函數(shù)名和行號艘蹋,日志時間等锄贼。
默認(rèn)的Go Logger
在介紹Uber-go的zap包之前,讓我們先看看Go語言提供的基本日志功能女阀。Go語言提供的默認(rèn)日志包是https://golang.org/pkg/log/宅荤。
實現(xiàn)Go Logger
實現(xiàn)一個Go語言中的日志記錄器非常簡單——創(chuàng)建一個新的日志文件,然后設(shè)置它為日志的輸出位置浸策。
設(shè)置Logger
我們可以像下面的代碼一樣設(shè)置日志記錄器
func SetupLogger() {
logFileLocation, _ := os.OpenFile("/Users/q1mi/test.log", os.O_CREATE|os.O_APPEND|os.O_RDWR, 0744)
log.SetOutput(logFileLocation)
}
使用Logger
讓我們來寫一些虛擬的代碼來使用這個日志記錄器冯键。
在當(dāng)前的示例中,我們將建立一個到URL的HTTP連接庸汗,并將狀態(tài)代碼/錯誤記錄到日志文件中惫确。
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的運行
現(xiàn)在讓我們執(zhí)行上面的代碼并查看日志記錄器的運行情況。
func main() {
SetupLogger()
simpleHttpGet("www.google.com")
simpleHttpGet("http://www.google.com")
}
當(dāng)我們執(zhí)行上面的代碼蚯舱,我們能看到一個test.log
文件被創(chuàng)建改化,下面的內(nèi)容會被添加到這個日志文件中。
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的優(yōu)勢和劣勢
優(yōu)勢
它最大的優(yōu)點是使用非常簡單枉昏。我們可以設(shè)置任何io.Writer
作為日志記錄輸出并向其發(fā)送要寫入的日志陈肛。
劣勢
- 僅限基本的日志級別
- 只有一個
Print
選項。不支持INFO
/DEBUG
等多個級別兄裂。
- 只有一個
- 對于錯誤日志句旱,它有
Fatal
和Panic
- Fatal日志通過調(diào)用
os.Exit(1)
來結(jié)束程序 - Panic日志在寫入日志消息之后拋出一個panic
- 但是它缺少一個ERROR日志級別阳藻,這個級別可以在不拋出panic或退出程序的情況下記錄錯誤
- Fatal日志通過調(diào)用
- 缺乏日志格式化的能力——例如記錄調(diào)用者的函數(shù)名和行號,格式化日期和時間格式前翎。等等稚配。
- 不提供日志切割的能力。
Uber-go Zap
Zap是非掣刍快的道川、結(jié)構(gòu)化的,分日志級別的Go日志庫立宜。
為什么選擇Uber-go zap
- 它同時提供了結(jié)構(gòu)化日志記錄和printf風(fēng)格的日志記錄
- 它非常的快
根據(jù)Uber-go Zap的文檔冒萄,它的性能比類似的結(jié)構(gòu)化日志包更好——也比標(biāo)準(zhǔn)庫更快。 以下是Zap發(fā)布的基準(zhǔn)測試信息
記錄一條消息和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 |
記錄一個靜態(tài)字符串橙数,沒有任何上下文或printf風(fēng)格的模板:
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
尊流。
在性能很好但不是很關(guān)鍵的上下文中,使用SugaredLogger
灯帮。它比其他結(jié)構(gòu)化日志記錄包快4-10倍崖技,并且支持結(jié)構(gòu)化和printf風(fēng)格的日志記錄。
在每一微秒和每一次內(nèi)存分配都很重要的上下文中钟哥,使用Logger
迎献。它甚至比SugaredLogger
更快,內(nèi)存分配次數(shù)也更少腻贰,但它只支持強類型的結(jié)構(gòu)化日志記錄吁恍。
Logger
- 通過調(diào)用
zap.NewProduction()
/zap.NewDevelopment()
或者zap.Example()
創(chuàng)建一個Logger。 - 上面的每一個函數(shù)都將創(chuàng)建一個logger播演。唯一的區(qū)別在于它將記錄的信息不同冀瓦。例如production logger默認(rèn)記錄調(diào)用函數(shù)信息、日期和時間等写烤。
- 通過Logger調(diào)用Info/Error等翼闽。
- 默認(rèn)情況下日志都會打印到應(yīng)用程序的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()
}
}
在上面的代碼中洲炊,我們首先創(chuàng)建了一個Logger感局,然后使用Info/ Error等Logger方法記錄消息。
日志記錄器方法的語法是這樣的:
func (log *Logger) MethodXXX(msg string, fields ...Field)
其中MethodXXX
是一個可變參數(shù)函數(shù)选浑,可以是Info / Error/ Debug / Panic等蓝厌。每個方法都接受一個消息字符串和任意數(shù)量的zapcore.Field
場參數(shù)玄叠。
每個zapcore.Field
其實就是一組鍵值對參數(shù)古徒。
我們執(zhí)行上面的代碼會得到如下輸出結(jié)果:
{"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
現(xiàn)在讓我們使用Sugared Logger來實現(xiàn)相同的功能。
- 大部分的實現(xiàn)基本都相同读恃。
- 惟一的區(qū)別是隧膘,我們通過調(diào)用主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()
}
}
當(dāng)你執(zhí)行上面的代碼會得到如下輸出:
{"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"}
你應(yīng)該注意到的了,到目前為止這兩個logger都打印輸出JSON結(jié)構(gòu)格式疹吃。
在本博客的后面部分蹦疑,我們將更詳細地討論SugaredLogger,并了解如何進一步配置它萨驶。
定制logger
將日志寫入文件而不是終端
我們要做的第一個更改是把日志寫入文件歉摧,而不是打印到應(yīng)用程序控制臺露该。
- 我們將使用
zap.New(…)
方法來手動傳遞所有配置稠项,而不是使用像zap.NewProduction()
這樣的預(yù)置方法來創(chuàng)建logger窜锯。
func New(core zapcore.Core, options ...Option) *Logger
zapcore.Core
需要三個配置——Encoder
币他,WriteSyncer
暑中,LogLevel
屡立。
1.Encoder:編碼器(如何寫入日志)荒辕。我們將使用開箱即用的NewJSONEncoder()
策泣,并使用預(yù)先設(shè)置的ProductionEncoderConfig()
谤草。
zapcore.NewJSONEncoder(zap.NewProductionEncoderConfig())
-
WriterSyncer :指定日志將寫到哪里去跟束。我們使用
zapcore.AddSync()
函數(shù)并且將打開的文件句柄傳進去。
file, _ := os.Create("./test.log")
writeSyncer := zapcore.AddSync(file)
- 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)
}
當(dāng)使用這些修改過的logger配置調(diào)用上述部分的main()
函數(shù)時花鹅,以下輸出將打印在文件——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
現(xiàn)在枫浙,我們希望將編碼器從JSON Encoder更改為普通Encoder刨肃。為此,我們需要將NewJSONEncoder()
更改為NewConsoleEncoder()
箩帚。
return zapcore.NewConsoleEncoder(zap.NewProductionEncoderConfig())
當(dāng)使用這些修改過的logger配置調(diào)用上述部分的main()
函數(shù)時真友,以下輸出將打印在文件——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
更改時間編碼并添加調(diào)用者詳細信息
鑒于我們對配置所做的更改紧帕,有下面兩個問題:
- 時間是以非人類可讀的方式展示盔然,例如1.572161051846623e+09
- 調(diào)用方函數(shù)的詳細信息沒有顯示在日志中
我們要做的第一件事是覆蓋默認(rèn)的ProductionConfig()
,并進行以下更改:
- 修改時間編碼器
- 在日志文件中使用大寫字母記錄日志級別
func getEncoder() zapcore.Encoder {
encoderConfig := zap.NewProductionEncoderConfig()
encoderConfig.EncodeTime = zapcore.ISO8601TimeEncoder
encoderConfig.EncodeLevel = zapcore.CapitalLevelEncoder
return zapcore.NewConsoleEncoder(encoderConfig)
}
接下來是嗜,我們將修改zap logger代碼愈案,添加將調(diào)用函數(shù)信息記錄到日志中的功能。為此鹅搪,我們將在zap.New(..)
函數(shù)中添加一個Option
站绪。
logger := zap.New(core, zap.AddCaller())
當(dāng)使用這些修改過的logger配置調(diào)用上述部分的main()
函數(shù)時,以下輸出將打印在文件——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來實現(xiàn)。
安裝
執(zhí)行下面的命令安裝Lumberjack
go get -u github.com/natefinch/lumberjack
zap logger中加入Lumberjack
要在zap中加入Lumberjack支持馁筐,我們需要修改WriteSyncer
代碼涂召。我們將按照下面的代碼修改getLogWriter()
函數(shù):
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:保留舊文件的最大個數(shù)
- MaxAges:保留舊文件的最大天數(shù)
- 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()
}
}
執(zhí)行上述代碼,下面的內(nèi)容會輸出到文件——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
函數(shù)中循環(huán)記錄日志,測試日志文件是否會自動切割和歸檔(日志文件每1MB會切割并且在當(dāng)前目錄下最多保存5個備份)队萤。
至此轮锥,我們總結(jié)了如何將Zap日志程序集成到Go應(yīng)用程序項目中。