golang默認(rèn)Logger日志庫(kù)在項(xiàng)目中使用Zap日志庫(kù)
在Go語(yǔ)言項(xiàng)目中使用Zap日志庫(kù)介紹
在許多Go語(yǔ)言項(xiàng)目中，我們需要一個(gè)好的日志記錄器能夠提供下面這些功能：
- 能夠?qū)⑹录涗浀轿募校皇菓?yīng)用程序控制臺(tái)。
- 日志切割-能夠根據(jù)文件大小、時(shí)間或間隔等來(lái)切割日志文件。
- 支持不同的日志級(jí)別。例如INFO，DEBUG，ERROR等。
- 能夠打印基本信息，如調(diào)用文件/函數(shù)名和行號(hào)，日志時(shí)間等。
默認(rèn)的Go Logger日志庫(kù)
在介紹Uber-go的zap包之前，讓我們先看看Go語(yǔ)言提供的基本日志功能。Go語(yǔ)言提供的默認(rèn)日志包是https://golang.org/pkg/log/。
實(shí)現(xiàn)Go Logger
實(shí)現(xiàn)一個(gè)Go語(yǔ)言中的日志記錄器非常簡(jiǎn)單——創(chuàng)建一個(gè)新的日志文件，然后設(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
讓我們來(lái)寫(xiě)一些虛擬的代碼來(lái)使用這個(gè)日志記錄器。
在當(dāng)前的示例中，我們將建立一個(gè)到URL的HTTP連接，并將狀態(tài)代碼/錯(cuò)誤記錄到日志文件中。
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的運(yùn)行
現(xiàn)在讓我們執(zhí)行上面的代碼并查看日志記錄器的運(yùn)行情況。
func main() {
SetupLogger()
simpleHttpGet("www.google.com")
simpleHttpGet("http://www.google.com")
}
當(dāng)我們執(zhí)行上面的代碼，我們能看到一個(gè)test.log文件被創(chuàng)建，下面的內(nèi)容會(huì)被添加到這個(gè)日志文件中。
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)勢(shì)和劣勢(shì)
優(yōu)勢(shì)
它最大的優(yōu)點(diǎn)是使用非常簡(jiǎn)單。我們可以設(shè)置任何io.Writer作為日志記錄輸出并向其發(fā)送要寫(xiě)入的日志。
劣勢(shì)
僅限基本的日志級(jí)別
只有一個(gè)Print選項(xiàng)。不支持INFO/DEBUG等多個(gè)級(jí)別。
對(duì)于錯(cuò)誤日志，它有fatal和Panic
- Fatal日志通過(guò)調(diào)用
os.Exit(1)來(lái)結(jié)束程序 - Panic日志在寫(xiě)入日志消息之后拋出一個(gè)panic
- 但是它缺少一個(gè)ERROR日志級(jí)別，這個(gè)級(jí)別可以在不拋出panic或退出程序的情況下記錄錯(cuò)誤
缺乏日志格式化的能力——例如記錄調(diào)用者的函數(shù)名和行號(hào)，格式化日期和時(shí)間格式。等等。
不提供日志切割的能力。
Uber-go Zap日志庫(kù)
Zap是非?？斓?、結(jié)構(gòu)化的，分日志級(jí)別的Go日志庫(kù)。
為什么選擇Uber-go zap
- 它同時(shí)提供了結(jié)構(gòu)化日志記錄和printf風(fēng)格的日志記錄
- 它非常的快
根據(jù)Uber-go Zap的文檔，它的性能比類(lèi)似的結(jié)構(gòu)化日志包更好——也比標(biāo)準(zhǔn)庫(kù)更快。 以下是Zap發(fā)布的基準(zhǔn)測(cè)試信息
記錄一條消息和10個(gè)字段:
| 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 |
記錄一個(gè)靜態(tài)字符串，沒(mé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 |
安裝
運(yùn)行下面的命令安裝zap
go get -u go.uber.org/zap
配置Zap Logger
Zap提供了兩種類(lèi)型的日志記錄器—Sugared Logger和Logger。
在性能很好但不是很關(guān)鍵的上下文中，使用SugaredLogger。它比其他結(jié)構(gòu)化日志記錄包快4-10倍，并且支持結(jié)構(gòu)化和printf風(fēng)格的日志記錄。
在每一微秒和每一次內(nèi)存分配都很重要的上下文中，使用Logger。它甚至比SugaredLogger更快，內(nèi)存分配次數(shù)也更少，但它只支持強(qiáng)類(lèi)型的結(jié)構(gòu)化日志記錄。
Logger
- 通過(guò)調(diào)用
zap.NewProduction()/zap.NewDevelopment()或者zap.Example()創(chuàng)建一個(gè)Logger。 - 上面的每一個(gè)函數(shù)都將創(chuàng)建一個(gè)logger。唯一的區(qū)別在于它將記錄的信息不同。例如production logger默認(rèn)記錄調(diào)用函數(shù)信息、日期和時(shí)間等。
- 通過(guò)Logger調(diào)用Info/Error等。
- 默認(rèn)情況下日志都會(huì)打印到應(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)建了一個(gè)Logger，然后使用Info/ Error等Logger方法記錄消息。
日志記錄器方法的語(yǔ)法是這樣的：
func (log *Logger) MethodXXX(msg string, fields ...Field)
其中MethodXXX是一個(gè)可變參數(shù)函數(shù)，可以是Info / Error/ Debug / Panic等。每個(gè)方法都接受一個(gè)消息字符串和任意數(shù)量的zapcore.Field場(chǎng)參數(shù)。
每個(gè)zapcore.Field其實(shí)就是一組鍵值對(duì)參數(shù)。
我們執(zhí)行上面的代碼會(huì)得到如下輸出結(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來(lái)實(shí)現(xiàn)相同的功能。
- 大部分的實(shí)現(xiàn)基本都相同。
- 惟一的區(qū)別是，我們通過(guò)調(diào)用主logger的
. Sugar()方法來(lái)獲取一個(gè)SugaredLogger。 - 然后使用
SugaredLogger以printf格式記錄語(yǔ)句
下面是修改過(guò)后使用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í)行上面的代碼會(huì)得到如下輸出：
{"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)該注意到的了，到目前為止這兩個(gè)logger都打印輸出JSON結(jié)構(gòu)格式。
在本博客的后面部分，我們將更詳細(xì)地討論SugaredLogger，并了解如何進(jìn)一步配置它。
定制logger
將日志寫(xiě)入文件而不是終端
我們要做的第一個(gè)更改是把日志寫(xiě)入文件，而不是打印到應(yīng)用程序控制臺(tái)。
我們將使用zap.New(…)方法來(lái)手動(dòng)傳遞所有配置，而不是使用像zap.NewProduction()這樣的預(yù)置方法來(lái)創(chuàng)建logger。
func New(core zapcore.Core, options ...Option) *Logger
zapcore.Core需要三個(gè)配置
1.Encoder:編碼器(如何寫(xiě)入日志)。我們將使用開(kāi)箱即用的NewJSONEncoder()，并使用預(yù)先設(shè)置的ProductionEncoderConfig()。
zapcore.NewJSONEncoder(zap.NewProductionEncoderConfig())
2.WriterSyncer ：指定日志將寫(xiě)到哪里去。我們使用zapcore.AddSync()函數(shù)并且將打開(kāi)的文件句柄傳進(jìn)去。
file, _ := os.Create("./test.log")
writeSyncer := zapcore.AddSync(file)
3.Log Level：哪種級(jí)別的日志將被寫(xiě)入。
我們將修改上述部分中的Logger代碼，并重寫(xiě)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)使用這些修改過(guò)的logger配置調(diào)用上述部分的main()函數(shù)時(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)使用這些修改過(guò)的logger配置調(diào)用上述部分的main()函數(shù)時(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
更改時(shí)間編碼并添加調(diào)用者詳細(xì)信息
鑒于我們對(duì)配置所做的更改，有下面兩個(gè)問(wèn)題：
- 時(shí)間是以非人類(lèi)可讀的方式展示，例如1.572161051846623e+09
- 調(diào)用方函數(shù)的詳細(xì)信息沒(méi)有顯示在日志中
我們要做的第一件事是覆蓋默認(rèn)的ProductionConfig()，并進(jìn)行以下更改:
- 修改時(shí)間編碼器
- 在日志文件中使用大寫(xiě)字母記錄日志級(jí)別
func getEncoder() zapcore.Encoder {
encoderConfig := zap.NewProductionEncoderConfig()
encoderConfig.EncodeTime = zapcore.ISO8601TimeEncoder
encoderConfig.EncodeLevel = zapcore.CapitalLevelEncoder
return zapcore.NewConsoleEncoder(encoderConfig)
}
接下來(lái)，我們將修改zap logger代碼，添加將調(diào)用函數(shù)信息記錄到日志中的功能。為此，我們將在zap.New(..)函數(shù)中添加一個(gè)Option。
logger := zap.New(core, zap.AddCaller())
當(dāng)使用這些修改過(guò)的logger配置調(diào)用上述部分的main()函數(shù)時(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進(jìn)行日志切割歸檔
這個(gè)日志程序中唯一缺少的就是日志切割歸檔功能。
Zap本身不支持切割歸檔日志文件
為了添加日志切割歸檔功能，我們將使用第三方庫(kù)Lumberjack來(lái)實(shí)現(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：在進(jìn)行切割之前，日志文件的最大大小（以MB為單位）
MaxBackups：保留舊文件的最大個(gè)數(shù)
MaxAges：保留舊文件的最大天數(shù)
Compress：是否壓縮/歸檔舊文件
測(cè)試所有功能
最終，使用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)容會(huì)輸出到文件——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
同時(shí)，可以在main函數(shù)中循環(huán)記錄日志，測(cè)試日志文件是否會(huì)自動(dòng)切割和歸檔（日志文件每1MB會(huì)切割并且在當(dāng)前目錄下最多保存5個(gè)備份）。
至此，我們總結(jié)了如何將Zap日志程序集成到Go應(yīng)用程序項(xiàng)目中。
以上就是golang默認(rèn)Logger日志庫(kù)在項(xiàng)目中使用Zap日志庫(kù)的詳細(xì)內(nèi)容，更多關(guān)于golang Zap和Logger日志庫(kù)的資料請(qǐng)關(guān)注腳本之家其它相關(guān)文章！
相關(guān)文章
這篇文章主要介紹了GoLang中的sync包Once使用執(zhí)行示例，沒(méi)有學(xué)習(xí)Once前，大家可能想到 聲明一個(gè)標(biāo)識(shí)，表示是否初始化過(guò)，然后初始化這個(gè)標(biāo)識(shí)加鎖，更新這個(gè)標(biāo)識(shí)，Once包主要用于在并發(fā)執(zhí)行代碼的時(shí)候，某部分代碼只會(huì)被執(zhí)行一次2023-03-03
本文主要介紹了golang?waitgroup的具體使用，文中通過(guò)示例代碼介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值，需要的朋友們下面隨著小編來(lái)一起學(xué)習(xí)學(xué)習(xí)吧2023-07-07
使用Go語(yǔ)言創(chuàng)建靜態(tài)文件服務(wù)器問(wèn)題
這篇文章主要介紹了使用Go語(yǔ)言創(chuàng)建靜態(tài)文件服務(wù)器,本文通過(guò)試了代碼給大家介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或工作具有一定的參考借鑒價(jià)值，需要的朋友可以參考下2020-03-03
這篇文章主要介紹了為什么?Go?語(yǔ)言?struct?要使用?tags,在本文中，我們將探討為什么 Go 語(yǔ)言中需要使用 struct tags，以及 struct tags 的使用場(chǎng)景和優(yōu)勢(shì)，需要的朋友可以參考下2023-03-03
這篇文章主要給大家介紹了關(guān)于Go語(yǔ)言中多字節(jié)字符的處理方法，文中通過(guò)示例代碼介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值，需要的朋友們下面隨著小編來(lái)一起學(xué)習(xí)學(xué)習(xí)吧2018-10-10
這篇文章主要介紹了Go泛型應(yīng)用工廠方法及泛型使用，結(jié)合工廠方法+泛型方法來(lái)看一下泛型到底是如何在業(yè)務(wù)場(chǎng)景中使用的，需要的小伙伴可以參考一下2022-07-07
Go gin權(quán)限驗(yàn)證實(shí)現(xiàn)過(guò)程詳解
這篇文章主要為大家介紹了Go gin權(quán)限驗(yàn)證實(shí)現(xiàn)過(guò)程詳解，有需要的朋友可以借鑒參考下，希望能夠有所幫助，祝大家多多進(jìn)步，早日升職加薪2023-01-01
Go語(yǔ)言共享內(nèi)存讀寫(xiě)實(shí)例分析
這篇文章主要介紹了Go語(yǔ)言共享內(nèi)存讀寫(xiě)方法,實(shí)例分析了共享內(nèi)存的原理與讀寫(xiě)技巧,具有一定參考借鑒價(jià)值,需要的朋友可以參考下2015-02-02
這篇文章主要介紹了golang 字符串切片去重實(shí)例，具有很好的參考價(jià)值，希望對(duì)大家有所幫助。一起跟隨小編過(guò)來(lái)看看吧2020-12-12
本文主要介紹了golang與pgsql交互的實(shí)現(xiàn)，文中通過(guò)示例代碼介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值，需要的朋友們下面隨著小編來(lái)一起學(xué)習(xí)學(xué)習(xí)吧2023-03-03