使用Uber-go Zap日志库

傅元龙

2023-12-01

使用Uber-go Zap日志库

Zap库简介

Zap日志库的性能比类似的结构化日志包更好——也比标准库更快。

安装

运行下面的命令安装zap

go get 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":1648135107.8875203,"caller":"Logger/main.go:24","msg":"Error fetching url..","url":"www.google.com","error":"Get \"www.google.com\": unsupported protocol scheme \"\"","stacktrace":"main.simpleHttpGet\n\tF:/GoProject/Gin/ginDemo1/9Zap/Logger/main.go:24\nmain.main\n\tF:/GoProject/Gin/ginDemo1/9Zap/Logger/main.go:13\nruntime.main\n\tD:/2Software/Go_SDK/go1.17.2/src/runtime/proc.go:255"}
{"level":"error","ts":1648135128.9561973,"caller":"Logger/main.go:24","msg":"Error fetching url..","url":"http://www.google.com","error":"Get \"http://www.google.com\": dial tcp 108.160.166.253: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\tF:/GoProject/Gin/ginDemo1/9Zap/Logger/main.go:24\nmain.main\n\tF:/GoProject/Gin/ginDemo1/9Zap/Logger/main.go:14\nruntime.main\n\tD:/2Software/Go_SDK/go1.17.2/src/runtime/proc.go:255"}

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":1648135405.6220138,"caller":"SugaredLogger/main.go:26","msg":"Error fetching URL www.google.com : Error = Get \"www.google.com\": unsupported protocol scheme \"\"","stacktrace":"main.simpleHttpGet\n\tF:/GoProject/Gin/ginDemo1/9Zap/SugaredLogger/main.go:26\nmain.main\n\tF:/GoProject/Gin/ginDemo1/9Zap/SugaredLogger/main.go:13\nruntime.main\n\tD:/2Software/Go_SDK/go1.17.2/src/runtime/proc.go:255"}
{"level":"error","ts":1648135426.6874094,"caller":"SugaredLogger/main.go:26","msg":"Error fetching URL http://www.google.com : Error = Get \"http://www.google.com\": dial tcp 104.244.43.231: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\tF:/GoProject/Gin/ginDemo1/9Zap/SugaredLogger/main.go:26\nmain.main\n\tF:/GoProject/Gin/ginDemo1/9Zap/SugaredLogger/main.go:14\nruntime.main\n\tD:/2Software/Go_SDK/go1.17.2/src/runtime/proc.go:255"}

定制logger

将日志写入文件

我们将使用zap.New(…)方法来手动传递所有配置，而不是使用像zap.NewProduction()这样的预置方法来创建logger。

func New(core zapcore.Core, options ...Option) *Logger

zapcore.Core需要三个配置——Encoder，WriteSyncer，LogLevel。

Encoder:编码器(如何写入日志)。我们将使用开箱即用的NewJSONEncoder()，并使用预先设置的ProductionEncoderConfig()
```
zapcore.NewJSONEncoder(zap.NewProductionEncoderConfig())
```
WriterSyncer ：指定日志将写到哪里去。我们使用zapcore.AddSync()函数并且将打开的文件句柄传进去。
```
   file, _ := os.Create("./test.log")
   writeSyncer := zapcore.AddSync(file)
```
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":1648135861.6140504,"msg":"Trying to hit GET request for www.google.com"}
{"level":"error","ts":1648135861.6145635,"msg":"Error fetching URL www.google.com : Error = Get \"www.google.com\": unsupported protocol scheme \"\""}
{"level":"debug","ts":1648135861.6145635,"msg":"Trying to hit GET request for http://www.google.com"}
{"level":"error","ts":1648135882.6579533,"msg":"Error fetching URL http://www.google.com : Error = Get \"http://www.google.com\": dial tcp 173.244.209.150: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."}

将JSON Encoder更改为普通的Log Encoder

现在，我们希望将编码器从JSON Encoder更改为普通Encoder。为此，我们需要将NewJSONEncoder()更改为NewConsoleEncoder()。

return zapcore.NewConsoleEncoder(zap.NewProductionEncoderConfig())

当使用这些修改过的logger配置调用上述部分的main()函数时，以下输出将打印在文件 – test.log中。

1.6481360001523538e+09	debug	Trying to hit GET request for www.google.com
1.6481360001529512e+09	error	Error fetching URL www.google.com : Error = Get "www.google.com": unsupported protocol scheme ""
1.6481360001529512e+09	debug	Trying to hit GET request for http://www.google.com
1.6481360211995306e+09	error	Error fetching URL http://www.google.com : Error = Get "http://www.google.com": dial tcp 173.244.209.150: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.

更改时间编码并添加调用者详细信息

鉴于我们对配置所做的更改，有下面两个问题：

时间是以非人类可读的方式展示，例如1.572161051846623e+09
调用方函数的详细信息没有显示在日志中

我们要做的第一件事是覆盖默认的ProductionConfig()，并进行以下更改:

修改时间编码器
在日志文件中使用大写字母记录日志级别

func getEncoder() zapcore.Encoder {
	encoderConfig := zap.NewProductionEncoderConfig()
	encoderConfig.EncodeTime = zapcore.RFC3339TimeEncoder
	encoderConfig.EncodeLevel = zapcore.CapitalLevelEncoder
	return zapcore.NewConsoleEncoder(encoderConfig)
}

接下来，我们将修改zap logger代码，添加将调用函数信息记录到日志中的功能。为此，我们将在zap.New(..)函数中添加一个Option。

logger := zap.New(core, zap.AddCaller())

当使用这些修改过的logger配置调用上述部分的main()函数时，以下输出将打印在文件——test.log中。

2022-03-24T23:38:57+08:00	DEBUG	SugaredLogger/main.go:42	Trying to hit GET request for www.google.com
2022-03-24T23:38:57+08:00	ERROR	SugaredLogger/main.go:45	Error fetching URL www.google.com : Error = Get "www.google.com": unsupported protocol scheme ""
2022-03-24T23:38:57+08:00	DEBUG	SugaredLogger/main.go:42	Trying to hit GET request for http://www.google.com
2022-03-24T23:39:18+08:00	ERROR	SugaredLogger/main.go:45	Error fetching URL http://www.google.com : Error = Get "http://www.google.com": dial tcp 108.160.162.102: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.

请看下文：

使用Lumberjack进行日志切割归档

参考资料：

https://www.liwenzhou.com/posts/Go/zap/

使用Uber-go Zap日志库

使用Uber-go Zap日志库

Zap库简介

安装

使用Zap Logger

Logger

Sugared Logger

定制logger

将日志写入文件

将JSON Encoder更改为普通的Log Encoder

更改时间编码并添加调用者详细信息

相关阅读

相关文章

相关问答

相关文档