golang 日志库ZAP[uber-go zap]详解

最新推荐文章于 2024-09-18 17:12:55 发布
最新推荐文章于 2024-09-18 17:12:55 发布
阅读量1.1k 收藏 10
点赞数 38
分类专栏： golang 文章标签： golang 开发语言 后端 logger 个人开发
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/nbplus_007/article/details/140269673
版权

golang 日志库ZAP[uber-go zap]

1. 简要说明

zap 是 uber 开源的 Go 高性能日志库，支持不同的日志级别， 能够打印基本信息等，但不支持日志的分割，这里我们可以使用 lumberjack 也是 zap 官方推荐用于日志分割，结合这两个库我们就可以实现以下功能的日志机制：

  • 能够将事件记录到文件中，而不是应用程序控制台；
  • 日志切割能够根据文件大小、时间或间隔等来切割日志文件；
  • 支持不同的日志级别，例如 DEBUG ， INFO ， WARN ， ERROR 等；
  • 能够打印基本信息，如调用文件、函数名和行号，日志时间等；
  • 官网地址：https://github.com/uber-go/zap

福利彩蛋：没有好玩的 API 接口？上百款免费接口等你来，免费 API，免费 API 大全

2. 下载安装

// 初始化go mod 通过mod管理扩展包
go mod init zaplog

//使用下面命令安装
go get -u go.uber.org/zap

//如果下载失败，则使用以下命令重新下载安装
go get github.com/uber-go/zap

//下载安装成功后还有如下提示：
package github.com/uber-go/zap: code in directory 
src/github.com/uber-go/zap expects import "go.uber.org/zap"

3. 配置 zap Logger

zap 提供了两种类型的日志记录器—和 Logger 和 Sugared Logger 。两者之间的区别是：

  • 在每一微秒和每一次内存分配都很重要的上下文中，使用Logger。它甚至比SugaredLogger更快，内存分配次数也更少，但它只支持强类型的结构化日志记录。
  • 在性能很好但不是很关键的上下文中，使用SugaredLogger。它比其他结构化日志记录包快 4-10 倍，并且支持结构化和 printf 风格的日志记录。
  • 所以一般场景下我们使用 Sugared Logger 就足够了。

3.1 Logger

  • 通过调用zap.NewProduction()/zap.NewDevelopment()或者zap.NewExample()创建一个 Logger 。
  • 上面的每一个函数都将创建一个 logger 。唯一的区别在于它将记录的信息不同。例如 production logger 默认记录调用函数信息、日期和时间等。
  • 通过 Logger 调用 INFO 、 ERROR 等。
  • 默认情况下日志都会打印到应用程序的 console 界面。
3.1.1 NewExample
//代码示例：

package main

import (
	"go.uber.org/zap"
)

func main() {
	log := zap.NewExample()
	log.Debug("this is debug message")
	log.Info("this is info message")
	log.Info("this is info message with fileds",
		zap.Int("age", 24), zap.String("agender", "man"))
	log.Warn("this is warn message")
	log.Error("this is error message")
	log.Panic("this is panic message")

}

//输出结果：

{"level":"debug","msg":"this is debug message"}
{"level":"info","msg":"this is info message"}
{"level":"info","msg":"this is info message with fileds","age":24,"agender":"man"}
{"level":"warn","msg":"this is warn message"}
{"level":"error","msg":"this is error message"}
{"level":"panic","msg":"this is panic message"}
panic: this is panic message
3.1.2 NewDevelopment
//代码示例：

func main() {
	log, _ := zap.NewDevelopment()
	log.Debug("this is debug message")
	log.Info("this is info message")
	log.Info("this is info message with fileds",
		zap.Int("age", 24), zap.String("agender", "man"))
	log.Warn("this is warn message")
	log.Error("this is error message") 
	// log.DPanic("This is a DPANIC message")	
	// log.Panic("this is panic message")
	// log.Fatal("This is a FATAL message")

}

//输出结果：

2020-06-12T18:51:11.457+0800	DEBUG	task/main.go:9	this is debug message
2020-06-12T18:51:11.457+0800	INFO	task/main.go:10	this is info message
2020-06-12T18:51:11.457+0800	INFO	task/main.go:11	this is info message with fileds	{"age": 24, "agender": "man"}
2020-06-12T18:51:11.457+0800	WARN	task/main.go:13	this is warn message
main.main
	/home/wohu/GoCode/src/task/main.go:13
runtime.main
	/usr/local/go/src/runtime/proc.go:200
2020-06-12T18:51:11.457+0800	ERROR	task/main.go:14	this is error message
main.main
	/home/wohu/GoCode/src/task/main.go:14
runtime.main
	/usr/local/go/src/runtime/proc.go:200
3.1.3 NewProduction
代码示例：

func main() {
	log, _ := zap.NewProduction()
	log.Debug("this is debug message")
	log.Info("this is info message")
	log.Info("this is info message with fileds",
		zap.Int("age", 24), zap.String("agender", "man"))
	log.Warn("this is warn message")
	log.Error("this is error message") 
	// log.DPanic("This is a DPANIC message")	
	// log.Panic("this is panic message")
	// log.Fatal("This is a FATAL message")
}

输出结果：

{"level":"info","ts":1591959367.316352,"caller":"task/main.go:10","msg":"this is info message"}
{"level":"info","ts":1591959367.3163702,"caller":"task/main.go:11","msg":"this is info message with fileds","age":24,"agender":"man"}
{"level":"warn","ts":1591959367.3163917,"caller":"task/main.go:13","msg":"this is warn message"}
{"level":"error","ts":1591959367.3163974,"caller":"task/main.go:14","msg":"this is error message","stacktrace":"main.main\n\t/home/wohu/GoCode/src/task/main.go:14\nruntime.main\n\t/usr/local/go/src/runtime/proc.go:200"}
3.1.4 对比总结

Example和Production使用的是 json 格式输出，Development 使用行的形式输出

  • Development
    • 从警告级别向上打印到堆栈中来跟踪
    • 始终打印包/文件/行（方法）
    • 在行尾添加任何额外字段作为 json 字符串
    • 以大写形式打印级别名称
    • 以毫秒为单位打印 ISO8601 格式的时间戳
  • Production
    • 调试级别消息不记录
    • Error , Dpanic 级别的记录，会在堆栈中跟踪文件， Warn 不会
    • 始终将调用者添加到文件中
    • 以时间戳格式打印日期
    • 以小写形式打印级别名称
    • 在上面的代码中，我们首先创建了一个 Logger ，然后使用 Info / Error 等 Logger 方法记录消息。

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

func (log *Logger) MethodXXX(msg string, fields ...Field)

其中 MethodXXX 是一个可变参数函数，可以是 Info / Error / Debug / Panic 等。每个方法都接受一个消息字符串和任意数量的 zapcore.Field 长参数。

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

3.2 Sugared Logger

默认的 zap 记录器需要结构化标签，即对每个标签，需要使用特定值类型的函数。

log.Info("this is info message with fileds",zap.Int("age", 24), zap.String("agender", "man"))

虽然会显的很长，但是对性能要求较高的话，这是最快的选择。也可以使用suger logger, 它基于 printf 分割的反射类型检测，提供更简单的语法来添加混合类型的标签。

我们使用 Sugared Logger 来实现相同的功能。

  • 大部分的实现基本都相同；
  • 惟一的区别是，我们通过调用主 logger 的.Sugar()方法来获取一个SugaredLogger；
  • 然后使用SugaredLogger以printf格式记录语句；
func main() {
	logger, _ := zap.NewDevelopment()
	slogger := logger.Sugar()

	slogger.Debugf("debug message age is %d, agender is %s", 19, "man")
	slogger.Info("Info() uses sprint")
	slogger.Infof("Infof() uses %s", "sprintf")
	slogger.Infow("Infow() allows tags", "name", "Legolas", "type", 1)

}

//输出结果：

2020-06-12T19:23:54.184+0800	DEBUG	task/main.go:11	debug message age is 19, agender is man
2020-06-12T19:23:54.185+0800	INFO	task/main.go:12	Info() uses sprint
2020-06-12T19:23:54.185+0800	INFO	task/main.go:13	Infof() uses sprintf
2020-06-12T19:23:54.185+0800	INFO	task/main.go:14	Infow() allows tags	{"name": "Legolas", "type": 1}

如果需要，可以随时使用记录器上的 .Desugar() 方法从 sugar logger 切换到标准记录器。

log := slogger.Desugar()

log.Info("After Desugar; INFO message")
log.Warn("After Desugar; WARN message")
log.Error("After Desugar; ERROR message")

4. 将日志写入文件

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

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

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

  • Encoder ：编码器(如何写入日志)。我们将使用开箱即用的 NewConsoleEncoder() ，并使用预先设置的 ProductionEncoderConfig() 。
zapcore.NewConsoleEncoder(zap.NewProductionEncoderConfig())
  • WriterSyncer ：指定日志将写到哪里去。我们使用 zapcore.AddSync() 函数并且将打开的文件句柄传进去。
file, _ := os.Create("./test.log") 
writeSyncer := zapcore.AddSync(file)
  • Log Level ：哪种级别的日志将被写入。
// 代码示例：

package main

import (
	"os"

	"go.uber.org/zap"
	"go.uber.org/zap/zapcore"
)

var sugarLogger *zap.SugaredLogger

func InitLogger() {

	encoder := getEncoder()
	writeSyncer := getLogWriter()
	core := zapcore.NewCore(encoder, writeSyncer, zapcore.DebugLevel)

	// zap.AddCaller()  添加将调用函数信息记录到日志中的功能。
	logger := zap.New(core, zap.AddCaller())
	sugarLogger = logger.Sugar()
}

func getEncoder() zapcore.Encoder {
	encoderConfig := zap.NewProductionEncoderConfig()
	encoderConfig.EncodeTime = zapcore.ISO8601TimeEncoder // 修改时间编码器

	// 在日志文件中使用大写字母记录日志级别
	encoderConfig.EncodeLevel = zapcore.CapitalLevelEncoder
	// NewConsoleEncoder 打印更符合人们观察的方式
	return zapcore.NewConsoleEncoder(encoderConfig)
}

func getLogWriter() zapcore.WriteSyncer {
	file, _ := os.Create("./test.log")
	return zapcore.AddSync(file)
}

func main() {
	InitLogger()
	sugarLogger.Info("this is info message")
	sugarLogger.Infof("this is %s, %d", "aaa", 1234)
	sugarLogger.Error("this is error message")
	sugarLogger.Info("this is info message")
}

// 输出日志文件：

2020-06-16T09:01:06.192+0800	INFO	task/main.go:40	this is info message
2020-06-16T09:01:06.192+0800	INFO	task/main.go:41	this is aaa, 1234
2020-06-16T09:01:06.192+0800	ERROR	task/main.go:42	this is error message
2020-06-16T09:01:06.192+0800	INFO	task/main.go:43	this is info message

福利彩蛋：没有好玩的 API 接口？上百款免费接口等你来，免费 API，免费 API 大全

nbplus_007
关注
专栏目录
Go 学习笔记（54）— Go 第三方库之 uber-go/zap/lumberjack（记录日志到文件、支持自动分割日志、支持日志级别、打印调用文件、函数和行号）
wohu1104的专栏
07-13 1万+
1. 简要说明 zap 是 uber 开源的 Go 高性能日志库，支持不同的日志级别， 能够打印基本信息等，但不支持日志的分割，这里我们可以使用 lumberjack 也是 zap 官方推荐用于日志分割，结合这两个库我们就可以实现以下功能的日志机制： 能够将事件记录到文件中，而不是应用程序控制台； 日志切割能够根据文件大小、时间或间隔等来切割日志文件； 支持不同的日志级别，例如 DEBUG ， INFO ， WARN ， ERROR 等； 能够打印基本信息，如调用文件、函数名和行号，日志时间等；
go zap日志库的使用
qq_42665165的博客
10-22 1089
Zap是非常快的、结构化的，分日志级别的Go日志库。 1.安装 go get -u go.uber.org/zap 2.配置 Zap提供了两种类型的日志记录器—Sugared Logger和Logger。 在性能很好但不是很关键的上下文中，使用SugaredLogger。它比其他结构化日志记录包快4-10倍，并且支持结构化和printf风格的日志记录。 在每一微秒和每一次内存分配都很重要的上下文中，使用Logger。它甚至比SugaredLogger更快，内存分配次数也更少，但它只支持强类型的结构化日志记录
一文搞懂 Golang 高性能日志库 - Zap
rubys007的博客
02-02 2963
到目前为止，我们已经展示了如何通过 Zap 提供的生产和开发预设来使用默认配置。现在让我们来看看如何使用自定义配置选项创建一个实例。使用Zap创建自定义Logger有两种主要方法。第一种方法是使用其Configimport ("os""stderr",},"stderr",},},")上面的函数返回一个新的zap.Logger，它的功能类似于Logger，但有一些不同之处。我们将 Zap 的生产配置作为我们自定义日志记录器的基础，通过调用并稍微修改它，将ts字段更改为。
高性能日志库 Zap：Go 开发者的必备工具
最新发布
spiker_的博客
09-18 1075
在现代微服务架构中，日志不仅是系统运行状态的记录，更是调试、分析问题的重要手段。Go 语言中有不少优秀的日志库，其中 **Zap** 凭借其 **高性能** 和 **灵活性**，成为了众多开发者的首选工具。 本篇文章将详细介绍 Zap 的核心功能、优势及如何在项目中使用它来提高日志处理的效率。
Golang zap日志库使用
baidu_41388533的博客
06-01 586
在gin项目中使用zap
Golang zap 日志库快速使用
clearloe的博客
06-27 470
在go项目中，日志记录是必不可少的一部分，可以帮助开发者调试和排查问题以及为系统的运行状况提供数据。本文介绍了go业内非常流行的zap日志库，同时结合Lumberjack实现日志的切割和归档。
golang常用库之-日志框架包 zap库、go-log 库、golong 日志框架选型 logrus还是uber zap？
西京刀客
05-31 1364
在 Go 项目开发中，我们可以通过修改一些优秀的开源日志包，来实现项目的日志包。Go 生态中有很多优秀的开源日志包，例如标准库 log 包、glog、logrus、zap、seelog、zerolog、log15、apex/log、go-logging 等。其中，用得比较多的是标准库 log 包、glog、logrus 和 zap。
Go-Golang异步日志库支持异步批量写入按天或者小时自动切割错误等级多文件等
08-14
本文将深入探讨一个专为Go语言设计的异步日志库，该库支持异步批量写入、按天或小时自动切割、错误等级分类以及多文件管理等功能。我们将讨论这些特性的实现原理以及它们在实际开发中的应用。 首先，异步日志写入是...
go.uber.org/zap日志库
weixin_52690231的博客
05-20 1962
go.uber.org/zap日志库
zap-applicationinsights-writer:将uber-gozap中的日志消息作为跟踪信息写入Application Insights
05-17
将来自go.uber.org/zap的日志消息作为跟踪信息写入应用程序见解。 使用应用程序见解集成来设置zap的完整示例： package main import ( "time" "go.uber.org/zap" "github....
【GO】24.golang 日志库 zap
chen_peng7的博客
07-09 900
下载库 go get go.uber.org/zap 快速开始代码 package main import ( "go.uber.org/zap" "time" ) func main() { url := "http://www.google.com" //print format log loggerDev, _ := zap.NewDevelopme...
【golang】zap日志库使用
qq_38858546的博客
04-22 534
app.log error.log package main import ( "time" "go.uber.org/zap" "go.uber.org/zap/zapcore" "gopkg.in/natefinch/lumberjack.v2" ) func main() { var logger *zap.Logger //func NewCore(enc Encoder, ws WriteSyncer, enab LevelEnabler) Core //func N.
golang整合日志zap
weixin_49132888的博客
08-09 796
和，这 3 个方法通过单个函数调用就可以构建一个日志计记录器，也可以简单配置Config 配置项源码// 动态改变日志级别，在运行时你可以安全改变日志级别// 将日志记录器设置为开发模式，在 WarnLevel 及以上级别日志会包含堆栈跟踪信息// 在日志中停止调用函数所在文件名、行数// 完全禁止自动堆栈跟踪。默认情况下，在 development 中，warnlevel及以上日志级别会自动捕获堆栈跟踪信息// 在 production 中，ErrorLevel 及以上也会自动捕获堆栈信息。
Golang一日一库之 日志库 zap
有什么问题回复不及时，可以私聊我。也可以加我的星球：知识爬行者
04-12 1050
简介 在开发过程中 会使用到日志库去记录错误的日志，尤其是golang中 有无穷无尽的error 如果不记录，当你的代码出错，就无从排错了。 zap 是开源的 Go 高性能日志库 主要有以下特点： 支持不同的日志级别 能够打印基本信息等但不支持日志的分割 但是可以使用 lumberjack 也是 zap 官方推荐用于日志分割 官网：https://github.com/uber-go/zap...
配置使用rsyslog+loganalyzer收集防火墙及交换机日志
weixin_33691817的博客
11-07 3281
1.目的背景 日志功能对于操作系统是相当重要的，在使用中，无论是系统还是应用等等，出了任何问题，我们首先想到的便是分析日志，查找问题原因。 自 CentOS 6 开始，我们的 CentOS 便开始使用 rsyslog 做为日志收集服务了，相对于之前的 syslog 它能够支持多线程，数据库存储，支持更多了传输协议等等优点。 而 LogAnalyzer 则...
rsyslog日志级别 配置日志输出级别
河静
12-24 4130
日志级别如下: 等级数值 等级名称 说明 7 debug 调试程序产生的的日志 6 info 基本信息说明，无伤大雅 5 notice 虽然是正常信息，但比info还需要被注意到的一些信息内容 4 warning（warn） 警示的信息，可能有问题，但是还不至于影响某个daemon的运行。基本上info、notice、warning这三个等级没啥事，就是告诉你一些基本信息 3 err（error） 一些重大的错误信息，比如配置文件写错导致daemon无法启动，通常可以根据er
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 例子
Go语言日志库zap
YIYIYI
06-01 1869
Go语言日志库zap
Go 第三方库之 uber-go/zap（记录日志到文件、支持自动分割日志、支持日志级别、打印调用文件、函数和行号）
LinAndCurry的博客
12-31 2614
目录 1.简介 2.下载安装使用 3.zap looger使用 4.将日志写入文件 5.使用lumberjack进行日志切割归档 1.简介 zap 是 uber 开源的 Go 高性能日志库，支持不同的日志级别， 能够打印基本信息等，但不支持日志的分割，这里我们可以使用 lumberjack 也是 zap 官方推荐用于日志分割，结合这两个库我们就可以实现以下功能的日志机制： 能够将事件记录到文件中，而不是应用程序控制台； 日志切割能够根据文件大小、时间或间隔等来切割日志文件； 支持不同的日
spark代码中添加logger_在Go语言项目中使用Zap日志库
weixin_34777998的博客
01-04 331
介绍在许多Go语言项目中，我们需要一个好的日志记录器能够提供下面这些功能：能够将事件记录到文件中，而不是应用程序控制台。日志切割-能够根据文件大小、时间或间隔等来切割日志文件。支持不同的日志级别。例如INFO，DEBUG，ERROR等。能够打印基本信息，如调用文件/函数名和行号，日志时间等。默认的Go Logger在介绍Uber-go的zap包之前，让我们先看看Go语言提供的基本日志功能。Go语言...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值