banner
biuaxia

biuaxia

"万物皆有裂痕，那是光进来的地方。"
github
bilibili
tg_channel
首頁封存

【轉載】在Go語言項目中使用Zap日誌庫

123
AI 翻譯
這篇文章透過AI由簡體中文翻譯成繁體中文。查看原文
AI 生成的摘要
本文介紹了在Go語言項目中使用Zap日誌庫的方法。首先介紹了Go語言原生的日誌庫的使用，然後詳細介紹了非常流行的Uber開源的Zap日誌庫，同時介紹了如何搭配Lumberjack實現日誌的切割和歸檔。Zap是一個非常快速、結構化且分級的Go日誌庫，它同時提供了結構化日誌記錄和printf風格的日誌記錄。根據Uber-go Zap的文檔，它的性能比類似的結構化日誌庫更好，也比標準庫更快。文章最後介紹了如何安裝和配置Zap日誌庫。

title: 【轉載】在 Go 語言專案中使用 Zap 日誌庫
date: 2021-08-09 16:37:33
comment: false
toc: true
category:

  • Golang
    tags:
  • 轉載
  • Go
  • zap
  • 日誌

本文轉載自：在 Go 語言專案中使用 Zap 日誌庫 | 李文周的博客

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

在 Go 語言專案中使用 Zap 日誌庫#

介紹#

在許多 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 個字段:

PackageTimeTime % to zapObjects Allocated
⚡️ zap862 ns/op+0%5 allocs/op
⚡️ zap (sugared)1250 ns/op+45%11 allocs/op
zerolog4021 ns/op+366%76 allocs/op
go-kit4542 ns/op+427%105 allocs/op
apex/log26785 ns/op+3007%115 allocs/op
logrus29501 ns/op+3322%125 allocs/op
log1529906 ns/op+3369%122 allocs/op

記錄一個靜態字符串，沒有任何上下文或 printf 風格的模板：

PackageTimeTime % to zapObjects Allocated
⚡️ zap118 ns/op+0%0 allocs/op
⚡️ zap (sugared)191 ns/op+62%2 allocs/op
zerolog93 ns/op-21%0 allocs/op
go-kit280 ns/op+137%11 allocs/op
standard library499 ns/op+323%2 allocs/op
apex/log1990 ns/op+1586%10 allocs/op
logrus3129 ns/op+2552%24 allocs/op
log153887 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/，為了更好理解原文內容稍有更改。

載入中......
此文章數據所有權由區塊鏈加密技術和智能合約保障僅歸創作者所有。