快捷導(dǎo)航

詳解如何在Go中使用Zap管理日志

更新時間：2023年07月26日 14:08:14 作者：喬克

Zap提供了兩種類型的日志記錄器—Sugared?Logger和Logger，可以更好的管理日志，這篇文章主要為大家介紹了使用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界面。

package main
import (
	"go.uber.org/zap"
	"net/http"
)
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":1585653856.0853302,"caller":"log_test/main.go:21","msg":"Error fetching url..","url":"www.google.com","error":"Get www.goo
gle.com: unsupported protocol scheme \"\"","stacktrace":"main.simpleHttpGet\n\tE:/DEV/Go/src/code.rookieops.com/my_test/log_test/main.go:21\nmai
n.main\n\tE:/DEV/Go/src/code.rookieops.com/my_test/log_test/main.go:12\nruntime.main\n\tD:/software/Go/src/runtime/proc.go:203"}

{"level":"error","ts":1585653877.2866385,"caller":"log_test/main.go:21","msg":"Error fetching url..","url":"http://www.google.com","error":"Get
http://www.google.com: dial tcp 31.13.84.1:80: connectex: A connection attempt failed because the connected party did not properly respond after
a period of time, or established connection failed because connected host has failed to respond.","stacktrace":"main.simpleHttpGet\n\tE:/DEV/Go
/src/code.rookieops.com/my_test/log_test/main.go:21\nmain.main\n\tE:/DEV/Go/src/code.rookieops.com/my_test/log_test/main.go:13\nruntime.main\n\t
D:/software/Go/src/runtime/proc.go:203"}

Sugared Logger

現(xiàn)在讓我們使用Sugared Logger來實現(xiàn)相同的功能。

大部分的實現(xiàn)基本都相同。
惟一的區(qū)別是，我們通過調(diào)用主logger的. Sugar()方法來獲取一個SugaredLogger。
然后使用SugaredLogger以printf格式記錄語句

下面是修改過后使用SugaredLogger代替Logger的代碼：

package main
import (
	"go.uber.org/zap"
	"net/http"
)
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)格式。

定制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())

2、WriterSyncer ：指定日志將寫到哪里去。我們使用zapcore.AddSync()函數(shù)并且將打開的文件句柄傳進去。

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)
}

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)
}

當(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)用者詳細(xì)信息

鑒于我們對配置所做的更改，有下面兩個問題：

時間是以非人類可讀的方式展示，例如1.572161051846623e+09
調(diào)用方函數(shù)的詳細(xì)信息沒有顯示在日志中

我們要做的第一件事是覆蓋默認(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：在進行切割之前，日志文件的最大大?。ㄒ訫B為單位）
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個備份）。

到此這篇關(guān)于詳解如何在Go中使用Zap管理日志的文章就介紹到這了,更多相關(guān)Go Zap管理日志內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: