在Go语言项目中使用Zap日志库的操作过程_Golang

代码地址： https://gitee.com/lymgoforit/golang-trick/tree/master/44-zap

本文将先介绍go语言原生的日志库的使用，然后详细介绍非常流行的uber开源的zap日志库，同时会介绍如何搭配·lumberjack·实现日志的切割和归档。

一、介绍

在许多go语言项目中，一个好的日志记录器一般期望能够提供下面这些功能：

能够将事件记录到文件中，而不是应用程序控制台。
日志切割：能够根据文件大小、时间或间隔等来切割日志文件。
支持不同的日志级别。例如info，debug，error等。
能够打印基本信息，如调用文件/函数名和行号，日志时间等。

二、默认的go logger

在介绍uber-go的zap包之前，让我们先看看go语言提供的基本日志功能。go语言提供的默认日志包是https://golang.org/pkg/log/。

1. 实现go logger

实现一个go语言中的日志记录器非常简单——创建一个新的日志文件，然后设置它为日志的输出位置即可。

2. 设置logger

我们可以像下面的代码一样设置日志记录器

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连接，并将状态代码/错误记录到日志文件中。

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的运行

现在让我们执行上面的代码并查看日志记录器的运行情况。

func main() {
	setuplogger()
	simplehttpget("www.baidu.com")
	simplehttpget("http://www.baidu.com")
}

当我们执行上面的代码，我们能看到一个test.log文件被创建，下面的内容会被添加到这个日志文件中。（因为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的优势和劣势

优势
它最大的优点是使用非常简单。我们可以设置任何io.writer作为日志记录输出并向其发送要写入的日志。

劣势

仅限基本的日志级别
只有一个print选项。不支持info/debug等多个级别。
对于错误日志，它有fatal和panic
- fatal日志通过调用os.exit(1)来结束程序
- panic日志在写入日志消息之后抛出一个panic
- 但是它缺少一个error日志级别，这个级别可以在不抛出panic或退出程序的情况下记录错误
缺乏日志格式化的能力——例如记录调用者的函数名和行号，格式化日期和时间格式。等等。
不提供日志切割的能力。

三、uber-go zap

zap是非常快的、结构化的，分日志级别的go日志库。

1. 为什么选择uber-go zap

它同时提供了结构化日志记录和printf风格的日志记录
它非常的快
根据uber-go zap的文档，它的性能比类似的结构化日志包更好——也比标准库更快。以下是zap发布的基准测试信息

记录一条消息和10个字段:

在这里插入图片描述

记录一个静态字符串，没有任何上下文或printf风格的模板：

在这里插入图片描述

2. 安装

运行下面的命令安装zap

go get -u go.uber.org/zap

3. 配置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界面。

package main
import (
	"net/http"
	"go.uber.org/zap"
)
// 定义全局日志对象，方便后续直接使用
var logger *zap.logger
func main() {
	initlogger()
	// 程序退出时，先将缓冲区的日志也都刷入到磁盘文件中，避免最后的日志丢失
	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()
	}
}

在上面的代码中，我们首先创建了一个logger，然后使用info/ error等logger方法记录消息。

日志记录器方法的语法是这样的：

func (log *logger) methodxxx(msg string, fields ...field)

其中methodxxx是一个可变参数函数，可以是info / error/ debug / panic等。每个方法都接受一个消息字符串和任意数量的zapcore.field参数。

每个zapcore.field其实就是一组键值对参数。

我们执行上面的代码会得到如下输出结果：

在这里插入图片描述

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
现在让我们使用sugared logger来实现相同的功能。

大部分的实现基本都相同。惟一的区别是，我们通过调用主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()
	}
}

当你执行上面的代码会得到如下输出：

{"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结构格式。

在本博客的后面部分，我们将更详细地讨论sugaredlogger，并了解如何进一步配置它。

4. 定制logger

4.1 将日志写入文件而不是终端

我们要做的第一个更改是把日志写入文件，而不是打印到应用程序控制台。

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

func new(core zapcore.core, options ...option) *logger

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()保持不变。

package main
import (
	"net/http"
	"os"
	"go.uber.org/zap"
	"go.uber.org/zap/zapcore"
)
// 定义全局日志对象，方便后续直接使用
var logger *zap.logger
var sugarlogger *zap.sugaredlogger
func main() {
	initlogger()
	// 程序退出时，先将缓冲区的日志也都刷入到磁盘文件中，避免最后的日志丢失
	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函数中的zapcore.addsync方法源码如下，实际就是想把一个io.writer对象包装为zapcore.newcore中需要的zapcore.writesyncer类型

在这里插入图片描述

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

在这里插入图片描述

return zapcore.newconsoleencoder(zap.newproductionencoderconfig())

4.2 将json encoder更改为普通的log encoder

现在，我们希望将编码器从json encoder更改为普通encoder。为此，我们需要将newjsonencoder()更改为newconsoleencoder()。表示打印的格式和控制台打印的一样，而非json格式了，但是内容还是打印到test.log文件中的，并不是说打印到控制台哦。

return zapcore.newconsoleencoder(zap.newproductionencoderconfig())

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

因为我们设置zapcore.writesyncer时，文件句柄指定的是追加方式，所以是在test.log文件后面追加了两行

在这里插入图片描述

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

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

时间是以非人类可读的方式展示，例如1.7097121171450913e+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())

// 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配置调用上述部分的main()函数时，以下输出将打印在文件test.log中。

在这里插入图片描述

4.4 addcallerskip

当我们不是直接使用初始化好的logger实例记录日志，而是将其包装成一个函数时，此时日志的函数调用链会增加，想要获得准确的调用信息就需要通过addcallerskip函数来跳过。可参考本人另两篇博客中记录堆栈信息的方式：
95. go中runtime.caller的使用
96.go设计优雅的错误处理（带堆栈信息）

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的日志文件中。我们可以通过以下方式实现。

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来实现。

目前只支持按文件大小切割，原因是按时间切割效率低且不能保证日志数据不被破坏。详情戳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. 安装

执行下面的命令安装 lumberjack v2 版本。

go get gopkg.in/natefinch/lumberjack.v2

2. zap logger中加入lumberjack

要在zap中加入lumberjack支持，我们需要修改writesyncer代码。我们将按照下面的代码修改getlogwriter()函数：

注意：这种方式每次重新运行都是新建test.log初始文件，因为没有地方指定是内容追加到文件后面

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：保留旧文件的最大个数
maxages：保留旧文件的最大天数
compress：是否压缩/归档旧文件

五、测试所有功能

最终，使用zap/lumberjack logger的完整示例代码如下：

package main
import (
	"net/http"
	"go.uber.org/zap"
	"go.uber.org/zap/zapcore"
	"gopkg.in/natefinch/lumberjack.v2"
)
// 定义全局日志对象，方便后续直接使用
var logger *zap.logger
var sugarlogger *zap.sugaredlogger
func main() {
	initlogger()
	// 程序退出时，先将缓冲区的日志也都刷入到磁盘文件中，避免最后的日志丢失
	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)
}

执行上述代码，下面的内容会输出到文件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函数中循环记录日志，测试日志文件是否会自动切割和归档（日志文件每1mb会切割并且在当前目录下最多保存5个文件）。

func main() {
	initlogger()
	// 程序退出时，先将缓冲区的日志也都刷入到磁盘文件中，避免最后的日志丢失
	defer logger.sync()
	for i := 0; i < 100000; i++ {
		simplehttpget("www.baidu.com")
		simplehttpget("http://www.baidu.com")
	}
}

切割后，新建的日志文件在基础文件名后加创建时间作为文件名

在这里插入图片描述

可以看到，随着日志越来越多，之前较早产生的test-2024-03-06t08-43-10.979.log文件被自动删除了，因为设置的最多保留五个日志文件

在这里插入图片描述

至此，我们总结了如何将zap日志程序集成到go应用程序项目中。

在Go语言项目中使用Zap日志库的操作过程

2024年05月18日 • Golang •我要评论

一、介绍

二、默认的go logger

1. 实现go logger

2. 设置logger

3. 使用logger

4. logger的运行

5. go logger的优势和劣势

三、uber-go zap

1. 为什么选择uber-go zap

2. 安装

3. 配置zap logger

4. 定制logger

4.1 将日志写入文件而不是终端

4.2 将json encoder更改为普通的log encoder

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

4.4 addcallerskip

4.5 将日志输出到多个位置

四、使用lumberjack进行日志切割归档

1. 安装

2. zap logger中加入lumberjack

五、测试所有功能

相关文章:

源码分析Go语言中gofmt实现原理

go使用支付宝沙箱实现支付宝支付的操作步骤

发表评论


验证码：

在Go语言项目中使用Zap日志库的操作过程

2024年05月18日 • Golang •我要评论

一、介绍

二、 默认的go logger

1. 实现go logger

2. 设置logger

3. 使用logger

4. logger的运行

5. go logger的优势和劣势

三、uber-go zap

1. 为什么选择uber-go zap

2. 安装

3. 配置zap logger

4. 定制logger

4.1 将日志写入文件而不是终端

4.2 将json encoder更改为普通的log encoder

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

4.4 addcallerskip

4.5 将日志输出到多个位置

四、使用lumberjack进行日志切割归档

1. 安装

2. zap logger中加入lumberjack

五、测试所有功能

相关文章:

源码分析Go语言中gofmt实现原理

go使用支付宝沙箱实现支付宝支付的操作步骤

发表评论

二、默认的go logger