golang默認Logger日志庫在項目中使用Zap日志庫
在Go語言項目中使用Zap日志庫介紹
在許多Go語言項目中，我們需要一個好的日志記錄器能夠提供下面這些功能：
- 能夠?qū)⑹录涗浀轿募?，而不是?yīng)用程序控制臺。
- 日志切割-能夠根據(jù)文件大小、時間或間隔等來切割日志文件。
- 支持不同的日志級別。例如INFO，DEBUG，ERROR等。
- 能夠打印基本信息，如調(diào)用文件/函數(shù)名和行號，日志時間等。
默認的Go Logger日志庫
在介紹Uber-go的zap包之前，讓我們先看看Go語言提供的基本日志功能。Go語言提供的默認日志包是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
讓我們來寫一些虛擬的代碼來使用這個日志記錄器。
在當前的示例中，我們將建立一個到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")
}
當我們執(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或退出程序的情況下記錄錯誤
缺乏日志格式化的能力——例如記錄調(diào)用者的函數(shù)名和行號，格式化日期和時間格式。等等。
不提供日志切割的能力。
Uber-go Zap日志庫
Zap是非常快的、結(jié)構(gòu)化的，分日志級別的Go日志庫。
為什么選擇Uber-go zap
- 它同時提供了結(jié)構(gòu)化日志記錄和printf風格的日志記錄
- 它非常的快
根據(jù)Uber-go Zap的文檔，它的性能比類似的結(jié)構(gòu)化日志包更好——也比標準庫更快。 以下是Zap發(fā)布的基準測試信息
記錄一條消息和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風格的模板：
| 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風格的日志記錄。
在每一微秒和每一次內(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默認記錄調(diào)用函數(shù)信息、日期和時間等。
- 通過Logger調(diào)用Info/Error等。
- 默認情況下日志都會打印到應(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()
}
}
當你執(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需要三個配置
1.Encoder:編碼器(如何寫入日志)。我們將使用開箱即用的NewJSONEncoder()，并使用預(yù)先設(shè)置的ProductionEncoderConfig()。
zapcore.NewJSONEncoder(zap.NewProductionEncoderConfig())
2.WriterSyncer ：指定日志將寫到哪里去。我們使用zapcore.AddSync()函數(shù)并且將打開的文件句柄傳進去。
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配置調(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())
當使用這些修改過的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ù)的詳細信息沒有顯示在日志中
我們要做的第一件事是覆蓋默認的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())
當使用這些修改過的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會切割并且在當前目錄下最多保存5個備份）。
至此，我們總結(jié)了如何將Zap日志程序集成到Go應(yīng)用程序項目中。
以上就是golang默認Logger日志庫在項目中使用Zap日志庫的詳細內(nèi)容，更多關(guān)于golang Zap和Logger日志庫的資料請關(guān)注腳本之家其它相關(guān)文章！
相關(guān)文章
這篇文章主要介紹了GoLang中的sync包Once使用執(zhí)行示例，沒有學(xué)習(xí)Once前，大家可能想到 聲明一個標識，表示是否初始化過，然后初始化這個標識加鎖，更新這個標識，Once包主要用于在并發(fā)執(zhí)行代碼的時候，某部分代碼只會被執(zhí)行一次2023-03-03
本文主要介紹了golang?waitgroup的具體使用，文中通過示例代碼介紹的非常詳細，對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值，需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧2023-07-07
使用Go語言創(chuàng)建靜態(tài)文件服務(wù)器問題
這篇文章主要介紹了使用Go語言創(chuàng)建靜態(tài)文件服務(wù)器,本文通過試了代碼給大家介紹的非常詳細，對大家的學(xué)習(xí)或工作具有一定的參考借鑒價值，需要的朋友可以參考下2020-03-03
這篇文章主要介紹了為什么?Go?語言?struct?要使用?tags,在本文中，我們將探討為什么 Go 語言中需要使用 struct tags，以及 struct tags 的使用場景和優(yōu)勢，需要的朋友可以參考下2023-03-03
這篇文章主要給大家介紹了關(guān)于Go語言中多字節(jié)字符的處理方法，文中通過示例代碼介紹的非常詳細，對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值，需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧2018-10-10
這篇文章主要介紹了Go泛型應(yīng)用工廠方法及泛型使用，結(jié)合工廠方法+泛型方法來看一下泛型到底是如何在業(yè)務(wù)場景中使用的，需要的小伙伴可以參考一下2022-07-07
這篇文章主要為大家介紹了Go gin權(quán)限驗證實現(xiàn)過程詳解，有需要的朋友可以借鑒參考下，希望能夠有所幫助，祝大家多多進步，早日升職加薪2023-01-01
這篇文章主要介紹了Go語言共享內(nèi)存讀寫方法,實例分析了共享內(nèi)存的原理與讀寫技巧,具有一定參考借鑒價值,需要的朋友可以參考下2015-02-02
這篇文章主要介紹了golang 字符串切片去重實例，具有很好的參考價值，希望對大家有所幫助。一起跟隨小編過來看看吧2020-12-12
本文主要介紹了golang與pgsql交互的實現(xiàn)，文中通過示例代碼介紹的非常詳細，對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值，需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧2023-03-03