Uber-go Zap
# 2. Uber-go Zap
# 链接资料
- 官网
zap package - go.uber.org/zap - Go Packages (opens new window)
Zap (opens new window)是非常快的、结构化的,分日志级别的Go日志库。
# 为什么选择Uber-go zap
它同时提供了结构化日志记录和printf风格的日志记录
它非常的快
根据Uber-go Zap的文档,它的性能比类似的结构化日志包更好——也比标准库更快。 以下是Zap发布的基准测试信息
记录一条消息和10个字段:
Package | Time | Time % to zap | Objects Allocated |
---|---|---|---|
⚡️ zap | 862 ns/op | +0% | 5 allocs/op |
⚡️ zap (sugared) | 1250 ns/op | +45% | 11 allocs/op |
zerolog | 4021 ns/op | +366% | 76 allocs/op |
go-kit | 4542 ns/op | +427% | 105 allocs/op |
apex/log | 26785 ns/op | +3007% | 115 allocs/op |
logrus | 29501 ns/op | +3322% | 125 allocs/op |
log15 | 29906 ns/op | +3369% | 122 allocs/op |
记录一个静态字符串,没有任何上下文或printf风格的模板:
Package | Time | Time % to zap | Objects Allocated |
---|---|---|---|
⚡️ zap | 118 ns/op | +0% | 0 allocs/op |
⚡️ zap (sugared) | 191 ns/op | +62% | 2 allocs/op |
zerolog | 93 ns/op | -21% | 0 allocs/op |
go-kit | 280 ns/op | +137% | 11 allocs/op |
standard library | 499 ns/op | +323% | 2 allocs/op |
apex/log | 1990 ns/op | +1586% | 10 allocs/op |
logrus | 3129 ns/op | +2552% | 24 allocs/op |
log15 | 3887 ns/op | +3194% | 23 allocs/op |
# 使用go zap
# 1. 安装
运行下面的命令安装zap
go get -u go.uber.org/zap
# 2. 配置使用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 (
"go.uber.org/zap"
"net/http"
)
// 1. 初始化日志
var logger *zap.Logger
// InitLogger 2. 创建日志
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()
}
}
func main() {
// 1. 创建日志
InitLogger()
defer logger.Sync()
// 2. 测试日志
simpleHttpGet("www.google.com")
simpleHttpGet("http://www.google.com")
}
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
在上面的代码中,我们首先创建了一个Logger,然后使用Info/ Error等Logger方法记录消息。
日志记录器方法的语法是这样的:
func (log *Logger) MethodXXX(msg string, fields ...Field)
2
其中MethodXXX
是一个可变参数函数,可以是Info / Error/ Debug / Panic等。每个方法都接受一个消息字符串和任意数量的zapcore.Field
场参数。
每个zapcore.Field
其实就是一组键值对参数。
我们执行上面的代码会得到如下输出结果:
{"level":"error","ts":1677507734.0103495,"caller":"2. Uber-go zap/main.go:20","msg":"Error fetching url..","url":"www.google.com","error":"Get \"www.google.com\": unsupported protocol
scheme \"\"","stacktrace":"main.simpleHttpGet\n\tG:/GolangCode/my/golang-foundation/golangWeb/Gin/2. Zap日志库/2. Uber-go zap/main.go:20\nmain.main\n\tG:/GolangCode/my/golang-foundation/golangWeb/Gin/2. Zap日志库/2. Uber-go zap/main.go:38\nruntime.main\n\tD:/Go/src/runtime/proc.go:250"}
{"level":"error","ts":1677507755.378643,"caller":"2. Uber-go zap/main.go:20","msg":"Error fetching url..","url":"http://www.google.com","error":"Get \"http://www.google.com\": dial tc
p 104.244.43.208:80: connectex: A connection attempt failed because the connected party did not properly respond after a period of time, or established connection failed because conne
cted host has failed to respond.","stacktrace":"main.simpleHttpGet\n\tG:/GolangCode/my/golang-foundation/golangWeb/Gin/2. Zap日志库/2. Uber-go zap/main.go:20\nmain.main\n\tG:/GolangCode/my/golang-foundation/golangWeb/Gin/2. Zap日志库/2. Uber-go zap/main.go:39\nruntime.main\n\tD:/Go/src/runtime/proc.go:250"}
2
3
4
5
# 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()
}
}
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
当你执行上面的代码会得到如下输出:
{"level":"error","ts":1572159149.923002,"caller":"logic/temp2.go:27","msg":"Error fetching URL www.sogo.com : Error = Get www.sogo.com: unsupported protocol scheme \"\"","stacktrace":"main.simpleHttpGet\n\t/Users/q1mi/zap_demo/logic/temp2.go:27\nmain.main\n\t/Users/q1mi/zap_demo/logic/temp2.go:14\nruntime.main\n\t/usr/local/go/src/runtime/proc.go:203"}
{"level":"info","ts":1572159150.192585,"caller":"logic/temp2.go:29","msg":"Success! statusCode = 200 OK for URL http://www.sogo.com"}
2
3
你应该注意到的了,到目前为止这两个logger都打印输出JSON结构格式。
在本博客的后面部分,我们将更详细地讨论SugaredLogger,并了解如何进一步配置它。
# 定制logger
安装运行下面的命令安装zap
go get -u go.uber.org/zap
# 1. 将日志写入文件而不是终端
我们要做的第一个更改是把日志写入文件,而不是打印到应用程序控制台。
- 我们将使用
zap.New(…)
方法来手动传递所有配置,而不是使用像zap.NewProduction()
这样的预置方法来创建logger。
func New(core zapcore.Core, options ...Option) *Logger
zapcore.Core
需要三个配置——Encoder
,WriteSyncer
,LogLevel
。
# Encoder
编码器(如何写入日志)。我们将使用开箱即用的NewJSONEncoder()
,并使用预先设置的ProductionEncoderConfig()
。(json格式还是什么格式)
zapcore.NewJSONEncoder(zap.NewProductionEncoderConfig())
# WriterSyncer
指定日志将写到哪里去。我们使用zapcore.AddSync()
函数并且将打开的文件句柄传进去。
file, _ := os.Create("./test.log")
writeSyncer := zapcore.AddSync(file)
2
# Log Level
哪种级别的日志将被写入。
我们将修改上述部分中的Logger代码,并重写InitLogger()
方法。其余方法—main()
/SimpleHttpGet()
保持不变。
当使用这些修改过的logger配置调用上述部分的main()
函数时,以下输出将打印在文件——test.log
中。、
{"level":"error","ts":1677509690.0401602,"msg":"Error fetching url..{url 15 0 www.google.com <nil>} {error 26 0 Get \"www.google.com\": unsupported protocol scheme \"\"}"}
{"level":"error","ts":1677509711.3957076,"msg":"Error fetching url..{url 15 0 http://www.google.com <nil>} {error 26 0 Get \"http://www.google.com\": dial tcp 202.160.129.36: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.}"}
2
# 代码示例
package main
import (
"go.uber.org/zap"
"go.uber.org/zap/zapcore"
"net/http"
"os"
)
var sugarLogger *zap.SugaredLogger
func InitLogger() {
writeSyncer := getLogWriter()
encoder := getEncoder()
// encoder: 写入方式 writeSyncer: 写入位置 zapcore.DebugLevel:日志级别
core := zapcore.NewCore(encoder, writeSyncer, zapcore.InfoLevel)
logger := zap.New(core)
sugarLogger = logger.Sugar()
}
// getEncoder 写入日志的方式JSON
func getEncoder() zapcore.Encoder {
return zapcore.NewJSONEncoder(zap.NewProductionEncoderConfig())
}
// getLogWriter 写入日志的位置
func getLogWriter() zapcore.WriteSyncer {
// 追加写入日志
file, _ := os.OpenFile("./test.log", os.O_CREATE|os.O_APPEND|os.O_RDWR, 0744)
return zapcore.AddSync(file)
}
// 测试日志输出
func simpleHttpGet(url string) {
resp, err := http.Get(url)
if err != nil {
sugarLogger.Error(
"Error fetching url..",
zap.String("url", url),
zap.Error(err))
} else {
sugarLogger.Info("Success..",
zap.String("statusCode", resp.Status),
zap.String("url", url))
resp.Body.Close()
}
}
func main() {
InitLogger()
defer sugarLogger.Sync()
simpleHttpGet("www.google.com")
simpleHttpGet("http://www.google.com")
}
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
# 2. 将JSON Encoder更改为普通的Log Encoder
现在,我们希望将编码器从JSON Encoder更改为普通Encoder。为此,我们需要将NewJSONEncoder()
更改为NewConsoleEncoder()
。
return zapcore.NewConsoleEncoder(zap.NewProductionEncoderConfig())
当使用这些修改过的logger配置调用上述部分的main()
函数时,以下输出将打印在文件——test.log
中。
1.572161051846623e+09 debug Trying to hit GET request for www.sogo.com
1.572161051846828e+09 error Error fetching URL www.sogo.com : Error = Get www.sogo.com: unsupported protocol scheme ""
1.5721610518468401e+09 debug Trying to hit GET request for http://www.sogo.com
1.572161052068744e+09 info Success! statusCode = 200 OK for URL http://www.sogo.com
2
3
4
5
# 3. 更改时间编码并添加调用者详细信息
鉴于我们对配置所做的更改,有下面两个问题:
时间是以非人类可读的方式展示,例如1.572161051846623e+09
调用方函数的详细信息没有显示在日志中
我们要做的第一件事是覆盖默认的ProductionConfig()
,并进行以下更改:
修改时间编码器
在日志文件中使用大写字母记录日志级别
// getEncoder 写入日志的方式 三种方式
func getEncoder() zapcore.Encoder {
// 普通json格式
//return zapcore.NewJSONEncoder(zap.NewProductionEncoderConfig())
// 修改日志写入为控制台的输出格式
//return zapcore.NewConsoleEncoder(zap.NewProductionEncoderConfig())
// 修改日志时间方式
encoderConfig := zap.NewProductionEncoderConfig()
encoderConfig.EncodeTime = zapcore.ISO8601TimeEncoder
encoderConfig.EncodeLevel = zapcore.CapitalLevelEncoder
return zapcore.NewConsoleEncoder(encoderConfig)
}
2
3
4
5
6
7
8
9
10
11
12
13
14
# 4. zap.AddCaller 将调用函数信息记录到日志中
接下来,我们将修改zap logger代码,添加将调用函数信息记录到日志中的功能。为此,我们将在zap.New(..)
函数中添加一个Option
。
// 将调用函数信息记录到日志中的功能
logger := zap.New(core, zap.AddCaller())
2
当使用这些修改过的logger配置调用上述部分的main()
函数时,以下输出将打印在文件——test.log
中。
2019-10-27T15:33:29.855+0800 DEBUG logic/temp2.go:47 Trying to hit GET request for www.sogo.com
2019-10-27T15:33:29.855+0800 ERROR logic/temp2.go:50 Error fetching URL www.sogo.com : Error = Get www.sogo.com: unsupported protocol scheme ""
2019-10-27T15:33:29.856+0800 DEBUG logic/temp2.go:47 Trying to hit GET request for http://www.sogo.com
2019-10-27T15:33:30.125+0800 INFO logic/temp2.go:52 Success! statusCode = 200 OK for URL http://www.sogo.com
2
3
4
5
# 5. AddCallerSkip
当我们不是直接使用初始化好的logger实例记录日志,而是将其包装成一个函数等,此时日录日志的函数调用链会增加,想要获得准确的调用信息就需要通过AddCallerSkip
函数来跳过。
logger := zap.New(core, zap.AddCaller(), zap.AddCallerSkip(1))
# 将日志输出到多个位置 MultiWriter
我们可以将日志同时输出到文件和终端。
func getLogWriter() zapcore.WriteSyncer {
file, _ := os.Create("./test.log")
// 利用io.MultiWriter支持文件和终端两个输出目标
ws := io.MultiWriter(file, os.Stdout)
return zapcore.AddSync(ws)
}
2
3
4
5
6
7
# 将err日志单独输出到文件
有时候我们除了将全量日志输出到xx.log
文件中之外,还希望将ERROR
级别的日志单独输出到一个名为xx.err.log
的日志文件中。我们可以通过以下方式实现。
func InitLogger() {
encoder := getEncoder()
// test.log记录全量日志
logF, _ := os.Create("./test.log")
c1 := zapcore.NewCore(encoder, zapcore.AddSync(logF), zapcore.DebugLevel)
// test.err.log记录ERROR级别的日志
errF, _ := os.Create("./test.err.log")
c2 := zapcore.NewCore(encoder, zapcore.AddSync(errF), zap.ErrorLevel)
// 使用NewTee将c1和c2合并到core
core := zapcore.NewTee(c1, c2)
logger = zap.New(core, zap.AddCaller())
}
2
3
4
5
6
7
8
9
10
11
12
# 使用Lumberjack进行日志切割归档
这个日志程序中唯一缺少的就是日志切割归档功能。
Zap本身不支持切割归档日志文件
官方的说法是为了添加日志切割归档功能,我们将使用第三方库Lumberjack (opens new window)来实现。
目前只支持按文件大小切割,原因是按时间切割效率低且不能保证日志数据不被破坏。详情戳https://github.com/natefinch/lumberjack/issues/54 (opens new window)。
想按日期切割可以使用github.com/lestrrat-go/file-rotatelogs (opens new window)这个库,虽然目前不维护了,但也够用了。
// 使用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)
2
3
4
5
6
7
8
9
10
11
# 安装
执行下面的命令安装 Lumberjack v2 版本。
go get gopkg.in/natefinch/lumberjack.v2
# zap logger中加入Lumberjack
要在zap中加入Lumberjack支持,我们需要修改WriteSyncer
代码。我们将按照下面的代码修改getLogWriter()
函数:
func getLogWriter() zapcore.WriteSyncer {
lumberJackLogger := &lumberjack.Logger{
Filename: "./test.log",
MaxSize: 10,
MaxBackups: 5,
MaxAge: 30,
Compress: false,
}
return zapcore.AddSync(lumberJackLogger)
}
2
3
4
5
6
7
8
9
10
11
Lumberjack Logger采用以下属性作为输入:
Filename: 日志文件的位置
MaxSize:在进行切割之前,日志文件的最大大小(以MB为单位)
MaxBackups:保留旧文件的最大个数
MaxAges:保留旧文件的最大天数
Compress:是否压缩/归档旧文件
# 测试所有功能
最终,使用Zap/Lumberjack logger的完整示例代码如下:
package main
import (
"net/http"
"gopkg.in/natefinch/lumberjack.v2"
"go.uber.org/zap"
"go.uber.org/zap/zapcore"
)
var sugarLogger *zap.SugaredLogger
func main() {
InitLogger()
defer sugarLogger.Sync()
simpleHttpGet("www.sogo.com")
simpleHttpGet("http://www.sogo.com")
}
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: "./test.log",
MaxSize: 1,
MaxBackups: 5,
MaxAge: 30,
Compress: false,
}
return zapcore.AddSync(lumberJackLogger)
}
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()
}
}
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
执行上述代码,下面的内容会输出到文件——test.log中。
2019-10-27T15:50:32.944+0800 DEBUG logic/temp2.go:48 Trying to hit GET request for www.sogo.com
2019-10-27T15:50:32.944+0800 ERROR logic/temp2.go:51 Error fetching URL www.sogo.com : Error = Get www.sogo.com: unsupported protocol scheme ""
2019-10-27T15:50:32.944+0800 DEBUG logic/temp2.go:48 Trying to hit GET request for http://www.sogo.com
2019-10-27T15:50:33.165+0800 INFO logic/temp2.go:53 Success! statusCode = 200 OK for URL http://www.sogo.com
2
3
4
5
同时,可以在main
函数中循环记录日志,测试日志文件是否会自动切割和归档(日志文件每1MB会切割并且在当前目录下最多保存5个备份)。
至此,我们总结了如何将Zap日志程序集成到Go应用程序项目中。
翻译自https://dev-journal.in/2019/05/27/adding-uber-go-zap-logger-to-golang-project/ (opens new window),为了更好理解原文内容稍有更改。
# 代码示例
package main
import (
"go.uber.org/zap"
"go.uber.org/zap/zapcore"
"gopkg.in/natefinch/lumberjack.v2"
"net/http"
)
var sugarLogger *zap.SugaredLogger
func InitLogger() {
writeSyncer := getLogWriter()
encoder := getEncoder()
// encoder: 写入方式 writeSyncer: 写入位置 zapcore.DebugLevel:日志级别
core := zapcore.NewCore(encoder, writeSyncer, zapcore.InfoLevel)
logger := zap.New(core, zap.AddCaller(), zap.AddCallerSkip(1))
sugarLogger = logger.Sugar()
}
// getEncoder 写入日志的方式 三种方式
func getEncoder() zapcore.Encoder {
// 普通json格式
//return zapcore.NewJSONEncoder(zap.NewProductionEncoderConfig())
// 修改日志写入为控制台的输出格式
//return zapcore.NewConsoleEncoder(zap.NewProductionEncoderConfig())
// 修改日志时间方式
encoderConfig := zap.NewProductionEncoderConfig()
encoderConfig.EncodeTime = zapcore.ISO8601TimeEncoder
encoderConfig.EncodeLevel = zapcore.CapitalLevelEncoder
return zapcore.NewConsoleEncoder(encoderConfig)
}
// 可以直接把结构体拿过来重新定义里面的方法重写
//func getEncoder() zapcore.Encoder {
// //return zapcore.NewJSONEncoder(zap.NewProductionEncoderConfig())
// encoderConfig := zapcore.EncoderConfig{
// TimeKey: "ts",
// LevelKey: "level",
// NameKey: "logger",
// CallerKey: "caller",
// MessageKey: "msg",
// StacktraceKey: "stacktrace",
// LineEnding: zapcore.DefaultLineEnding,
// EncodeLevel: zapcore.LowercaseLevelEncoder,
// EncodeTime: zapcore.ISO8601TimeEncoder,
// EncodeDuration: zapcore.SecondsDurationEncoder,
// EncodeCaller: zapcore.ShortCallerEncoder,
// }
//
// return zapcore.NewConsoleEncoder(encoderConfig)
//}
// getLogWriter 写入日志的位置
//
// func getLogWriter() zapcore.WriteSyncer {
// // 追加写入日志
// file, _ := os.OpenFile("./test.log", os.O_CREATE|os.O_APPEND|os.O_RDWR, 0744)
// return zapcore.AddSync(file)
// }
func getLogWriter() zapcore.WriteSyncer {
lumberJackLogger := &lumberjack.Logger{
Filename: "./test.log",
MaxSize: 10,
MaxBackups: 5,
MaxAge: 30,
Compress: false,
}
return zapcore.AddSync(lumberJackLogger)
}
// 测试日志输出
func simpleHttpGet(url string) {
resp, err := http.Get(url)
if err != nil {
sugarLogger.Error(
"Error fetching url..",
zap.String("url", url),
zap.Error(err))
} else {
sugarLogger.Info("Success..",
zap.String("statusCode", resp.Status),
zap.String("url", url))
resp.Body.Close()
}
}
func main() {
InitLogger()
defer sugarLogger.Sync()
simpleHttpGet("www.google.com")
simpleHttpGet("http://www.google.com")
}
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96