在Go語言項目中使用Zap日志庫的操作過程
代碼地址: https://gitee.com/lymgoforIT/golang-trick/tree/master/44-zap
本文將先介紹
Go語言原生的日志庫的使用,然后詳細介紹非常流行的Uber開源的zap日志庫,同時會介紹如何搭配·Lumberjack·實現(xiàn)日志的切割和歸檔。
一、介紹
在許多Go語言項目中,一個好的日志記錄器一般期望能夠提供下面這些功能:
- 能夠?qū)⑹录涗浀轿募?,而不是應用程序控制臺。
- 日志切割:能夠根據(jù)文件大小、時間或間隔等來切割日志文件。
- 支持不同的日志級別。例如
INFO,DEBUG,ERROR等。 - 能夠打印基本信息,如調(diào)用文件/函數(shù)名和行號,日志時間等。
二、 默認的Go Logger
在介紹Uber-go的zap包之前,讓我們先看看Go語言提供的基本日志功能。Go語言提供的默認日志包是https://golang.org/pkg/log/。
1. 實現(xiàn)Go Logger
實現(xiàn)一個Go語言中的日志記錄器非常簡單——創(chuàng)建一個新的日志文件,然后設(shè)置它為日志的輸出位置即可。
2. 設(shè)置Logger
我們可以像下面的代碼一樣設(shè)置日志記錄器
func SetupLogger() {
logFileLocation, _ := os.OpenFile("/Users/lym/test.log", os.O_CREATE|os.O_APPEND|os.O_RDWR, 0744)
log.SetOutput(logFileLocation)
}3. 使用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()
}
}4. Logger的運行
現(xiàn)在讓我們執(zhí)行上面的代碼并查看日志記錄器的運行情況。
func main() {
SetupLogger()
simpleHttpGet("www.baidu.com")
simpleHttpGet("http://www.baidu.com")
}當我們執(zhí)行上面的代碼,我們能看到一個test.log文件被創(chuàng)建,下面的內(nèi)容會被添加到這個日志文件中。(因為www.baidu.com谷歌沒有帶http://開頭,所以訪問失敗,但是http://www.baidu.com訪問成功)
2024/03/06 15:14:13 Error fetching url www.google.com : Get www.baidu.com: unsupported protocol scheme "" 2024/03/06 15:14:14 Status Code for http://www.baidu.com : 200 OK
5. 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日志庫。
1. 為什么選擇Uber-go zap
- 它同時提供了結(jié)構(gòu)化日志記錄和
printf風格的日志記錄 - 它非常的快
- 根據(jù)
Uber-go Zap的文檔,它的性能比類似的結(jié)構(gòu)化日志包更好——也比標準庫更快。 以下是Zap發(fā)布的基準測試信息
記錄一條消息和10個字段:

記錄一個靜態(tài)字符串,沒有任何上下文或printf風格的模板:

2. 安裝
運行下面的命令安裝zap
go get -u go.uber.org/zap
3. 配置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等。 - 默認情況下日志都會打印到應用程序的
console界面。
package main
import (
"net/http"
"go.uber.org/zap"
)
// 定義全局日志對象,方便后續(xù)直接使用
var logger *zap.Logger
func main() {
InitLogger()
// 程序退出時,先將緩沖區(qū)的日志也都刷入到磁盤文件中,避免最后的日志丟失
defer logger.Sync()
simpleHttpGet("www.baidu.com")
simpleHttpGet("http://www.baidu.com")
}
// InitLogger 初始化logger對象
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)) // key為error
} 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é)果:

var sugarLogger *zap.SugaredLogger
func main() {
InitLogger()
defer sugarLogger.Sync()
simpleHttpGet("www.baidu.com")
simpleHttpGet("http://www.baidu.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()
}
}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.baidu.com")
simpleHttpGet("http://www.baidu.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":1709710774.730964,"caller":"44-zap/main.go:58","msg":"Error fetching URL www.baidu.com : Error = Get \"www.baidu.com\": unsupported protocol scheme \"\"","stacktrace":"main.simpleHttpGet\n\tD:/Users/lym/GolandProjects/golang-trick/44-zap/main.go:58\nmain.main\n\tD:/Users/lym/GolandProjects/golang-trick/44-zap/main.go:45\nruntime.main\n\tC:/Program Files/Go/src/runtime/proc.go:267"}
{"level":"info","ts":1709710774.7849257,"caller":"44-zap/main.go:60","msg":"Success! statusCode = 200 OK for URL http://www.baidu.com"}
你應該注意到的了,到目前為止這兩個logger都打印輸出JSON結(jié)構(gòu)格式。
在本博客的后面部分,我們將更詳細地討論SugaredLogger,并了解如何進一步配置它。
4. 定制logger
4.1 將日志寫入文件而不是終端
我們要做的第一個更改是把日志寫入文件,而不是打印到應用程序控制臺。
我們將使用zap.New(…)方法來手動傳遞所有配置,而不是使用像zap.NewProduction()這樣的預置方法來創(chuàng)建logger。
func New(core zapcore.Core, options ...Option) *Logger
1.Encoder:編碼器(如何寫入日志)。我們將使用開箱即用的NewJSONEncoder(),并使用預先設(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()保持不變。
package main
import (
"net/http"
"os"
"go.uber.org/zap"
"go.uber.org/zap/zapcore"
)
// 定義全局日志對象,方便后續(xù)直接使用
var logger *zap.Logger
var sugarLogger *zap.SugaredLogger
func main() {
InitLogger()
// 程序退出時,先將緩沖區(qū)的日志也都刷入到磁盤文件中,避免最后的日志丟失
defer logger.Sync()
simpleHttpGet("www.baidu.com")
simpleHttpGet("http://www.baidu.com")
}
func simpleHttpGet(url string) {
resp, err := http.Get(url)
if err != nil {
logger.Error(
"Error fetching url..",
zap.String("url", url),
zap.Error(err)) // key為error
} else {
logger.Info("Success..",
zap.String("statusCode", resp.Status),
zap.String("url", url))
resp.Body.Close()
}
}
// InitLogger 初始化logger對象
func InitLogger() {
writeSyncer := getLogWriter()
encoder := getEncoder()
core := zapcore.NewCore(encoder, writeSyncer, zapcore.DebugLevel)
logger = zap.New(core)
sugarLogger = logger.Sugar()
}
func getLogWriter() zapcore.WriteSyncer {
file, _ := os.OpenFile("44-zap/test.log",os.O_CREATE|os.O_APPEND|os.O_RDWR, 0744)
return zapcore.AddSync(file)
}
func getEncoder() zapcore.Encoder {
return zapcore.NewJSONEncoder(zap.NewProductionEncoderConfig())
}注:上面代碼getLogWriter函數(shù)中的zapcore.AddSync方法源碼如下,實際就是想把一個io.Writer對象包裝為zapcore.NewCore中需要的zapcore.WriteSyncer類型

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

return zapcore.NewConsoleEncoder(zap.NewProductionEncoderConfig())
4.2 將JSON Encoder更改為普通的Log Encoder
現(xiàn)在,我們希望將編碼器從JSON Encoder更改為普通Encoder。為此,我們需要將NewJSONEncoder()更改為NewConsoleEncoder()。表示打印的格式和控制臺打印的一樣,而非json格式了,但是內(nèi)容還是打印到test.log文件中的,并不是說打印到控制臺哦。
return zapcore.NewConsoleEncoder(zap.NewProductionEncoderConfig())
當使用這些修改過的logger配置調(diào)用上述部分的main()函數(shù)時,以下輸出將打印在文件test.log中。
因為我們設(shè)置zapcore.WriteSyncer時,文件句柄指定的是追加方式,所以是在test.log文件后面追加了兩行

4.3 更改時間編碼并添加調(diào)用者詳細信息
鑒于我們對配置所做的更改,有下面兩個問題:
- 時間是以非人類可讀的方式展示,例如
1.7097121171450913e+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())
// InitLogger 初始化logger對象
func InitLogger() {
writeSyncer := getLogWriter()
encoder := getEncoder()
core := zapcore.NewCore(encoder, writeSyncer, zapcore.DebugLevel)
logger = zap.New(core, zap.AddCaller())
sugarLogger = logger.Sugar()
}當使用這些修改過的logger配置調(diào)用上述部分的main()函數(shù)時,以下輸出將打印在文件test.log中。

4.4 AddCallerSkip
當我們不是直接使用初始化好的logger實例記錄日志,而是將其包裝成一個函數(shù)時,此時日志的函數(shù)調(diào)用鏈會增加,想要獲得準確的調(diào)用信息就需要通過AddCallerSkip函數(shù)來跳過??蓞⒖急救肆韮善┛椭杏涗浂褩P畔⒌姆绞剑?br />95. Go中runtime.Caller的使用
96.Go設(shè)計優(yōu)雅的錯誤處理(帶堆棧信息)
logger = zap.New(core, zap.AddCaller(), zap.AddCallerSkip(1))
4.5 將日志輸出到多個位置
我們可以將日志同時輸出到文件和終端。
func getLogWriter() zapcore.WriteSyncer {
file, _ := os.OpenFile("44-zap/test.log", os.O_CREATE|os.O_APPEND|os.O_RDWR, 0744)
// 利用io.MultiWriter支持文件和終端兩個輸出目標
ws := io.MultiWriter(file, os.Stdout)
return zapcore.AddSync(ws)
}將err日志單獨輸出到文件
有時候我們除了將全量日志輸出到xx.log文件中之外,還希望將ERROR級別的日志單獨輸出到一個名為xx.err.log的日志文件中。我們可以通過以下方式實現(xiàn)。
func InitLogger() {
encoder := getEncoder()
// test.log記錄全量日志
logF, _ := os.OpenFile("44-zap/test.log", os.O_CREATE|os.O_APPEND|os.O_RDWR, 0744)
c1 := zapcore.NewCore(encoder, zapcore.AddSync(logF), zapcore.DebugLevel)
// test.err.log記錄ERROR級別的日志
errF, _ := os.OpenFile("44-zap/test.err.log", os.O_CREATE|os.O_APPEND|os.O_RDWR, 0744)
c2 := zapcore.NewCore(encoder, zapcore.AddSync(errF), zap.ErrorLevel)
// 使用NewTee將c1和c2合并到core
core := zapcore.NewTee(c1, c2)
logger = zap.New(core, zap.AddCaller())
}四、使用Lumberjack進行日志切割歸檔
這個日志程序中唯一缺少的就是日志切割歸檔功能。
Zap本身不支持切割歸檔日志文件,但我們可以使用第三方庫Lumberjack來實現(xiàn)。
目前只支持按文件大小切割,原因是按時間切割效率低且不能保證日志數(shù)據(jù)不被破壞。詳情戳https://github.com/natefinch/lumberjack/issues/54。
想按日期切割可以使用github.com/lestrrat-go/file-rotatelogs這個庫,雖然目前不維護了,但也夠用了。
// 使用file-rotatelogs按天切割日志 import rotatelogs "github.com/lestrrat-go/file-rotatelogs" l, _ := rotatelogs.New( filename+".%Y%m%d%H%M", rotatelogs.WithMaxAge(30*24*time.Hour), // 最長保存30天 rotatelogs.WithRotationTime(time.Hour*24), // 24小時切割一次 ) zapcore.AddSync(l)
1. 安裝
執(zhí)行下面的命令安裝 Lumberjack v2 版本。
go get gopkg.in/natefinch/lumberjack.v2
2. zap logger中加入Lumberjack
要在zap中加入Lumberjack支持,我們需要修改WriteSyncer代碼。我們將按照下面的代碼修改getLogWriter()函數(shù):
注意:這種方式每次重新運行都是新建test.log初始文件,因為沒有地方指定是內(nèi)容追加到文件后面
func getLogWriter() zapcore.WriteSyncer {
lumberJackLogger := &lumberjack.Logger{
Filename: "44-zap/test.log",
MaxSize: 1,
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"
"go.uber.org/zap"
"go.uber.org/zap/zapcore"
"gopkg.in/natefinch/lumberjack.v2"
)
// 定義全局日志對象,方便后續(xù)直接使用
var logger *zap.Logger
var sugarLogger *zap.SugaredLogger
func main() {
InitLogger()
// 程序退出時,先將緩沖區(qū)的日志也都刷入到磁盤文件中,避免最后的日志丟失
defer logger.Sync()
simpleHttpGet("www.baidu.com")
simpleHttpGet("http://www.baidu.com")
}
func simpleHttpGet(url string) {
resp, err := http.Get(url)
if err != nil {
logger.Error(
"Error fetching url..",
zap.String("url", url),
zap.Error(err)) // key為error
} else {
logger.Info("Success..",
zap.String("statusCode", resp.Status),
zap.String("url", url))
resp.Body.Close()
}
}
// InitLogger 初始化logger對象
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: "44-zap/test.log",
MaxSize: 1,
MaxBackups: 5,
MaxAge: 30,
Compress: false,
}
return zapcore.AddSync(lumberJackLogger)
}執(zhí)行上述代碼,下面的內(nèi)容會輸出到文件test.log中。
4-03-06T16:35:49.023+0800 ERROR 44-zap/main.go:26 Error fetching url.. {"url": "www.baidu.com", "error": "Get \"www.baidu.com\": unsupported protocol scheme \"\""}
2024-03-06T16:35:49.135+0800 INFO 44-zap/main.go:31 Success.. {"statusCode": "200 OK", "url": "http://www.baidu.com"}
同時,可以在main函數(shù)中循環(huán)記錄日志,測試日志文件是否會自動切割和歸檔(日志文件每1MB會切割并且在當前目錄下最多保存5個文件)。
func main() {
InitLogger()
// 程序退出時,先將緩沖區(qū)的日志也都刷入到磁盤文件中,避免最后的日志丟失
defer logger.Sync()
for i := 0; i < 100000; i++ {
simpleHttpGet("www.baidu.com")
simpleHttpGet("http://www.baidu.com")
}
}切割后,新建的日志文件在基礎(chǔ)文件名后加創(chuàng)建時間作為文件名

可以看到,隨著日志越來越多,之前較早產(chǎn)生的test-2024-03-06T08-43-10.979.log文件被自動刪除了,因為設(shè)置的最多保留五個日志文件

至此,我們總結(jié)了如何將Zap日志程序集成到Go應用程序項目中。
相關(guān)文章
Go語言之使用pprof工具查找goroutine(協(xié)程)泄漏
這篇文章主要介紹了Go語言之使用pprof工具查找goroutine(協(xié)程)泄漏,具有很好的參考價值,希望對大家有所幫助,如有錯誤或未考慮完全的地方,望不吝賜教2024-01-01
協(xié)同開發(fā)巧用gitignore中間件避免網(wǎng)絡(luò)請求攜帶登錄信息
這篇文章主要為大家介紹了協(xié)同開發(fā)巧用gitignore中間件避免網(wǎng)絡(luò)請求攜帶登錄信息2022-06-06
golang判斷chan channel是否關(guān)閉的方法
這篇文章主要介紹了golang判斷chan channel是否關(guān)閉的方法,結(jié)合實例形式對比分析了Go語言判斷chan沒有關(guān)閉的后果及關(guān)閉的方法,需要的朋友可以參考下2016-07-07
Golang連接并操作PostgreSQL數(shù)據(jù)庫基本操作
PostgreSQL是常見的免費的大型關(guān)系型數(shù)據(jù)庫,具有豐富的數(shù)據(jù)類型,也是軟件項目常用的數(shù)據(jù)庫之一,下面這篇文章主要給大家介紹了關(guān)于Golang連接并操作PostgreSQL數(shù)據(jù)庫基本操作的相關(guān)資料,需要的朋友可以參考下2022-09-09

