使用Uber-go Zap日志库

已于 2022-03-24 23:52:07 修改
阅读量865 收藏 1
点赞数 1
分类专栏： go 文章标签： golang
于 2022-03-24 23:40:41 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_49723651/article/details/123724413
版权

使用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。

  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":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/

jenrain
关注
专栏目录
go zap日志库的使用
qq_42665165的博客
10-22 1055
Zap是非常快的、结构化的，分日志级别的Go日志库。 1.安装 go get -u go.uber.org/zap 2.配置 Zap提供了两种类型的日志记录器—Sugared Logger和Logger。 在性能很好但不是很关键的上下文中，使用SugaredLogger。它比其他结构化日志记录包快4-10倍，并且支持结构化和printf风格的日志记录。 在每一微秒和每一次内存分配都很重要的上下文中，使用Logger。它甚至比SugaredLogger更快，内存分配次数也更少，但它只支持强类型的结构化日志记录
golang日志库
dosecin的博客
08-16 354
golang日志库
go日志库log/zap/logrus
General_zy的博客
05-22 2901
logrus 默认的logger在并发写的时候是被mutex保护的，比如当同时调用hook和写log时mutex就会被请求，有另外一种情况，文件是以appending mode打开的， 此时的并发操作就是安全的，可以用logger.SetNoLock()来关闭它。其中，通过r.Use(logger.GinLogger(), logger.GinRecovery(true))注册中间件来使用zap接收gin框架自身的日志，在项目中需要的地方通过使用zap.L().Xxx()方法来记录自定义日志信息。
一文搞懂 Golang 高性能日志库 - Zap
rubys007的博客
02-02 2811
到目前为止，我们已经展示了如何通过 Zap 提供的生产和开发预设来使用默认配置。现在让我们来看看如何使用自定义配置选项创建一个实例。使用Zap创建自定义Logger有两种主要方法。第一种方法是使用其Configimport ("os""stderr",},"stderr",},},")上面的函数返回一个新的zap.Logger，它的功能类似于Logger，但有一些不同之处。我们将 Zap 的生产配置作为我们自定义日志记录器的基础，通过调用并稍微修改它，将ts字段更改为。
go 日志库 zap
Jzin的博客
10-03 388
go 日志库 zap
开源项目-uber-go-zap.zip
10-22
开源项目Uber的Go zap日志库是一个高效、结构化、等级分明的日志处理工具，专为Go编程语言设计。在Go社区中，zap已经成为许多大型项目首选的日志框架，其性能出色，API简洁，便于集成到各种应用中。在"uber-go-zap....
Go-Golang异步日志库支持异步批量写入按天或者小时自动切割错误等级多文件等
08-14
本文将深入探讨一个专为Go语言设计的异步日志库，该库支持异步批量写入、按天或小时自动切割、错误等级分类以及多文件管理等功能。我们将讨论这些特性的实现原理以及它们在实际开发中的应用。 首先，异步日志写入是...
zap-examples:使用Uber的zap Go日志记录库的示例
05-16
使用zap日志记录库 该存储库提供了一些使用 Go日志记录库的示例 在尝试示例之前，请安装zap库： $ source env.sh $ go get -u go.uber.org/zap $ go run src/simple1/main.go 例子
2024年Go最全Go日志库——logrus，Golang原生开发如何深入进阶
最新发布
2401_84920041的博客
05-11 403
【代码】2024年Go最全Go日志库——logrus，Golang原生开发如何深入进阶。
golang-日志库
flowerxxxxx的博客
08-22 395
需求分析
Go-log一个简单快速的Go日志库
08-14
log 一个简单快速的Go日志库
Go-gclog是一个go日志管理库
08-14
gclog是一个go日志管理库，基于go标准库的log创建，拥有动态变更级别、自动切分、自动删除过期日志等功能
Go日志库——logrus
成长之路
07-17 4230
go日志库学习-logrus
GO语言使用Zap日志库（小白文）
weixin_59801183的博客
05-06 2336
本文介绍了GO语言如何快速使用zap日志库进行日志打印
Go语言之log库
等风来也chen
04-01 742
GO语言之log库使用标准logger的配置日志前缀日志输出位置自建logger 使用 GO语言内置的log包实现了简单的日志服务。以下主要介绍log的基本使用 package main import "log" func main() { log.Println("这是一条很普通的日志。") v := "不正常的" log.Printf("这是一条%s日志。\n", v) log.Fa...
Go日志库——log和logrus
Harris-H的博客
10-20 1417
Go日志库——log和logrus
Go 日志
无风的雨
12-15 2358
golang 的log包使用起来挺简单，这里做一些简单介绍。 示例： package main import ( "log" ) func main() { arr := []int{1, 2} log.Print("Print array ", arr, "\n") log.Println("Println array", arr) log.Printf("Pri...
Go语言标准库之log
weixin_30390075的博客
07-09 205
Go语言标准库log介绍 无论是软件开发的调试阶段还是软件上线之后的运行阶段，日志一直都是非常重要的一个环节，我们也应该养成在程序中记录日志的好习惯。 log Go语言内置的log包实现了简单的日志服务。本文介绍了标准库log的基本使用。 使用Logger log包定义了Logger类型，该类型提供了一些格式化输出的方法。本包也提供了一个预定义的“标准”logger，可以通...
Go的日志库Logrus
寻找到底哪里有蓝天
02-23 258
一 logrus介绍 文章转载于：https://www.cnblogs.com/liuqingzheng/p/16244545.html 1.1 log标准库优缺点 优点 Go标准库的log日志库非常简单 可以便设置任何io.Writer作为日志输出位置 缺点 1 仅仅提供了print，panic和fatal三个函数，不支持info/debug等多个级别 2 记录错误有Fatal和P...
Golang Zap日志库深度解析：文件切割与级别管理
在Golang中，zap日志库是Uber开发的一个高性能、快速且强大的日志库。它提供了丰富的功能，如多级别日志记录、自定义输出和高效编码。针对日志处理的常见需求，zap提供了以下解决方案： 1. 按级别分文件存储： ...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值