亲宝软件园·资讯

展开

Go语言Zap日志库使用教程

寻找09之夏 人气:0

一、日志库选型需要和比较

1.日志库选型需求

2.日志库比较

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

PackageTimeTime % to zapObjects Allocated
⚡ zap2900 ns/op+0%5 allocs/op
⚡ zap (sugared)3475 ns/op+20%10 allocs/op
zerolog10639 ns/op+267%32 allocs/op
go-kit14434 ns/op+398%59 allocs/op
logrus17104 ns/op+490%81 allocs/op
apex/log32424 ns/op+1018%66 allocs/op
log1533579 ns/op+1058%76 allocs/op

使用已经有 10 个上下文字段的记录器记录消息：

PackageTimeTime % to zapObjects Allocated
⚡ zap373 ns/op+0%0 allocs/op
⚡ zap (sugared)452 ns/op+21%1 allocs/op
zerolog288 ns/op-23%0 allocs/op
go-kit11785 ns/op+3060%58 allocs/op
logrus19629 ns/op+5162%70 allocs/op
log1521866 ns/op+5762%72 allocs/op
apex/log30890 ns/op+8182%55 allocs/op

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

PackageTimeTime % to zapObjects Allocated
⚡ zap381 ns/op+0%0 allocs/op
⚡ zap (sugared)410 ns/op+8%1 allocs/op
zerolog369 ns/op-3%0 allocs/op
standard library385 ns/op+1%2 allocs/op
go-kit606 ns/op+59%11 allocs/op
logrus1730 ns/op+354%25 allocs/op
apex/log1998 ns/op+424%7 allocs/op
log154546 ns/op+1093%22 allocs/op

通过上面benchmark测试可以Zap性能是非常出众的。主要是大多数日志库提供的方式是基于反射的序列化和字符串格式化，这种方式代价太高，而 Zap 采取不同的方法。

二、Zap（Uber-go）

1.安装

go get -u go.uber.org/zap

2.配置Zap Logger

Zap提供了两种类型的日志记录器：Sugared Logger、Logger。在每一微秒和每一次内存分配都很重要的上下文中，使用Logger，内存分配次数也更少，但它只支持强类型的结构化日志记录。对性能不是要求极致，建议使用SugaredLogger，支持结构化和 printf 风格的日志记录。

2.1.Logger

package main
import (
	"errors"
	"go.uber.org/zap"
)
var logger *zap.Logger
func main() {
	InitLogger()
	logger.Debug("这是一条日志", zap.String("name", "zhangSang"), zap.Int("age", 18)) // zap.NewProduction() 默认不输出该级别日志
	logger.Info("这是一条日志", zap.String("name", "zhangSang"), zap.Int("age", 18))
	logger.Error("这是一条日志", zap.String("name", "zhangSang"), zap.Error(errors.New("错误信息")))
}
func InitLogger() {
	logger, _ = zap.NewProduction()
	defer logger.Sync()
}

上面代码执行结果：

{"level":"info","ts":1655165315.1104648,"caller":"test/main.go:13","msg":"这是一条日志","name":"zhangSang","age":18}
{"level":"error","ts":1655165315.1105008,"caller":"test/main.go:14","msg":"这是 一条日志","name":"zhangSang","error":"错误信息","stacktrace":"main.main\n\tD:/Go/Work/src/test/main.go:14\nruntime.main\n\tD:/Go/src/runtime/proc.go:255"

2.2.Sugared Logger

package main
import (
	"errors"
	"go.uber.org/zap"
)
var logger *zap.Logger
var sugar *zap.SugaredLogger
func main() {
	InitLogger()
	sugar.Debug("这是一条日志", zap.String("name", "zhangSang"), zap.Int("age", 18)) // zap.NewProduction() 默认不输出该级别日志
	sugar.Info("这是一条日志", zap.String("name", "zhangSang"), zap.Int("age", 18))
	sugar.Error("这是一条日志", zap.String("name", "zhangSang"), zap.Error(errors.New("错误信息")))
}
func InitLogger() {
	logger, _ = zap.NewProduction()
	defer logger.Sync()
	sugar = logger.Sugar()
}

上面代码执行结果：

{"level":"info","ts":1655165815.3873067,"caller":"test/main.go:14","msg":"这是一条日志{name 15 0 zhangSang <nil>} {age 11 18  <nil>}"}
{"level":"error","ts":1655165815.3880382,"caller":"test/main.go:15","msg":"这是一条日志{name 15 0 zhangSang <nil>} {error 26 0  错误信息}","stacktrace":"main.main\n\tD:/GoWork/src/test/main.go:15\nruntime.main\n\tD:/Go/src/runtime/proc.go:255"}

2.3. 配置Logger

zap.New()方法来手动传递所有配置，而不是使用像zap.NewProduction()这样的预置方法来创建 logger；zapcore.Core需要三个配置——Encoder，WriteSyncer，LogLevel。

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

1.Encoder: 编码器 (配置日志格式)。此处使用NewJSONEncoder() (如果不喜欢JSON格式日志，NewConsoleEncoder()指定普通 Encoder)，并使用预先设置的ProductionEncoderConfig()，ProductionEncoderConfig()返回一个自定义的EncoderConfig。

func getEncoder() zapcore.Encoder {
	encoderConfig := zap.NewProductionEncoderConfig()
	return zapcore.NewJSONEncoder(encoderConfig)
}

2.WriterSyncer ：指定日志写到何处。使用zapcore.AddSync()函数并且将打开的文件句柄传入。

func getLogWriter() zapcore.WriteSyncer {
	file, _ := os.OpenFile("./test.log", os.O_CREATE|os.O_APPEND|os.O_RDWR, 0666) // 打开文件（不存在创建）
	return zapcore.AddSync(file)
}

3.Log Level-指定日志级别

func InitLogger() {
	writeSyncer := getLogWriter()
	encoder := getEncoder()
	core := zapcore.NewCore(encoder, writeSyncer, zapcore.DebugLevel) // DebugLevel
	logger = zap.New(core)
	defer logger.Sync()
	sugarLogger = logger.Sugar()
}

大家将上面的方法新增测试代码中，运行结果：

4.时间格式化处理

func getEncoder() zapcore.Encoder {
	encoderConfig := zap.NewProductionEncoderConfig()
	encoderConfig.EncodeTime = customTimeEncoder
	return zapcore.NewJSONEncoder(encoderConfig)
}
func customTimeEncoder(t time.Time, enc zapcore.PrimitiveArrayEncoder) {
	enc.AppendString(t.Format("2006-01-02 15:04:05.000"))
}

运行结果：

5.输出文件名和行号

zap.New()中加上zap.AddCaller()。

func InitLogger() {
	writeSyncer := getLogWriter()
	encoder := getEncoder()
	core := zapcore.NewCore(encoder, writeSyncer, zapcore.DebugLevel) // DebugLevel
	logger = zap.New(core, zap.AddCaller())
	defer logger.Sync()
	sugarLogger = logger.Sugar()
}

运行结果：

三.使用 Lumberjack 进行日志切割归档

1. 安装

go get -u github.com/natefinch/lumberjack

2.Zap logger中使用Lumberjack

func getLogWriter() zapcore.WriteSyncer {
	lumberJackLogger := &lumberjack.Logger{
		Filename:   "./test.log", // 日志文件位置
		MaxSize:    1,            // 进行切割之前，日志文件最大值(单位：MB)，默认100MB
		MaxBackups: 10,           // 保留旧文件的最大个数
		MaxAge:     1,            // 保留旧文件的最大天数
		Compress:   false,        // 是否压缩/归档旧文件
	}
	return zapcore.AddSync(lumberJackLogger)
}

3.完整代码

package main
import (
	"github.com/natefinch/lumberjack"
	"go.uber.org/zap"
	"go.uber.org/zap/zapcore"
	"time"
)
var logger *zap.Logger
var sugar *zap.SugaredLogger
func main() {
	InitLogger()
	for i := 0; i < 99999; i++ {
		sugar.Debugf("查询用户信息开始 id:%d", 1)
		sugar.Infof("查询用户信息成功 name:%s age:%d", "zhangSan", 20)
		sugar.Errorf("查询用户信息失败 error:%v", "未该查询到该用户信息")
	}
}
func InitLogger() {
	writeSyncer := getLogWriter()
	encoder := getEncoder()
	core := zapcore.NewCore(encoder, writeSyncer, zapcore.DebugLevel)
	logger = zap.New(core, zap.AddCaller())
	defer logger.Sync()
	sugar = logger.Sugar()
}
func getEncoder() zapcore.Encoder {
	encoderConfig := zap.NewProductionEncoderConfig()
	encoderConfig.EncodeTime = customTimeEncoder
	return zapcore.NewJSONEncoder(encoderConfig)
}
func getLogWriter() zapcore.WriteSyncer {
	lumberJackLogger := &lumberjack.Logger{
		Filename:   "./test.log", // 日志文件位置
		MaxSize:    1,            // 进行切割之前，日志文件最大值(单位：MB)，默认100MB
		MaxBackups: 5,            // 保留旧文件的最大个数
		MaxAge:     1,            // 保留旧文件的最大天数
		Compress:   false,        // 是否压缩/归档旧文件
	}
	return zapcore.AddSync(lumberJackLogger)
}
func customTimeEncoder(t time.Time, enc zapcore.PrimitiveArrayEncoder) {
	enc.AppendString(t.Format("2006-01-02 15:04:05.000"))
}

在main()函数中循环9999次输出日志，运行结果：

总结

zap日志库很强大，性能优势以及绝尘，里面的设计和工程实践很指的学习，有兴趣的盆友可以看看。

加载全部内容
相关教程
猜你喜欢
用户评论