在GO语言中项目中使用zap日志库
本文先介绍了GO语言中原生的日志库中使用,然后想继续介绍了非常流行的Uber开源的zap日志库,同时介绍了如何搭配Lumberjack实现日志的切割和归档。
在GO语言项目中使用zap日志库
介绍
在许多go语言项目中,我们需要一个好的日志记录器能够提供下面这些功能:
- 能够将事件记录到文件中,而不是应用程序控制台。
- 日志切割-能够根据文件大小,时间或间隔等来切割日志文件。
- 支持不同的日志级别,例如INFO、DEBUG、ERROR等。
- 能够打印基本信息,如调用文件/函数名和行号,日志时间等。
默认的GO Logger
在介绍Uber-go的zap包之前,让我们先看看go语言提供的基本日志功能,GO语言提供的默认日志包是
实现一个GO语言中的日志记录器非常简单----创建一个新的日志文件,然后设置它为日志的输出位置。
设置Logger
我们可以像下面的代码一样设置日志记录器,
func SetupLogger() {
logFileLocation, _ := os.OpenFile("./test.log", os.O_CREATE|os.O_APPEND|os.O_RDWR, 0744)
log.SetOutput(logFileLocation)
}
使用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()
}
}
Logger的运行
现在让我们执行上买你的代码并查看日志记录器的运行记录
func main() {
SetupLogger()
simpleHttpGet("www.google.com")
simpleHttpGet("http://www.google.com")
}
当我们执行上面的代码,我们能看一个test.log
文件被创建,下面的日志内容会别添加到这个日志文件中。
2023/07/24 22:44:10 Error fetching url www.baidu.com : Get "www.baidu.com": unsupported protocol scheme ""
2023/07/24 22:44:10 Status Code for https://www.baidu.com : 200 OK
Go Logger的优势和劣势
优势
它最大的优点是使用非常简单。我们可以设置任何io.Writer
作为日志记录输出并向其发送要写入的日志。
劣势
- 仅限基本的日志级别
- 只有一个
Print
选项。不支持INFO
/DEBUG
等多个级别。
- 只有一个
- 对于错误日志,它有
Fatal
和Panic
- Fatal日志通过调用
os.Exit(1)
来结束程序 - Panic日志在写入日志消息之后抛出一个panic
- 但是它缺少一个ERROR日志级别,这个级别可以在不抛出panic或退出程序的情况下记录错误
- Fatal日志通过调用
- 缺乏日志格式化的能力——例如记录调用者的函数名和行号,格式化日期和时间格式。等等。
- 不提供日志切割的能力。
Uber-go-Zap
Zap是非常的,结构化的,分日志的级别的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 |
安装
运行下面的命令安装zap
go get -u go.uber.org/zap
配置 zap Logger
Zap 提供了两种类型的日志记录器----Sugared Logger
和Logger
。
在性能很好但不是很关键的上下文中,使用SugaredLogger
。它比其他结构化日志记录包快4-10倍,并且支持结构化和printf风格的日志记录。
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":1572159218.912792,"caller":"zap_demo/temp.go:25","msg":"Error fetching url..","url":"www.sogo.com","error":"Get www.sogo.com: unsupported protocol scheme \"\"","stacktrace":"main.simpleHttpGet\n\t/Users/q1mi/zap_demo/temp.go:25\nmain.main\n\t/Users/q1mi/zap_demo/temp.go:14\nruntime.main\n\t/usr/local/go/src/runtime/proc.go:203"}
{"level":"info","ts":1572159219.1227388,"caller":"zap_demo/temp.go:30","msg":"Success..","statusCode":"200 OK","url":"http://www.sogo.com"}
Sugared Logger
现在让我们使用Sugared Logger
来实现相同的功能。
- 大部分的实现基本都相同。
- 唯一的区别是,我们通过调用主
logger
的,Sugar()
方法来获取一个SugaredLogger
. - 然后使用
SugaredLogger
以printf
格式记录语句
下面是修改过后使用SugaredLogger
代替Logger
的代码:
package main
import (
"go.uber.org/zap"
"net/http"
)
var sugarLogger *zap.SugaredLogger
func main() {
InitLogger()
defer sugarLogger.Sync()
simpleHttpGet("www.baidu.com")
simpleHttpGet("https://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("Syccess! statusCode = %s for URL %s", resp.Status, url)
resp.Body.Close()
}
}
当执行上面的代码会得到如下输出:
{"level":"error","ts":1690351341.364513,"caller":"test/main.go:26","msg":"Error fetching URL www.baidu.com: Error = Get \"www.baidu.com\": unsupported protocol scheme \"\"","stacktrace":"main.simpleHttpGet\n\t/Users/daihao/Desktop/goweekclass/learn/test/main.go:26\nmain.main\n\t/Users/daihao/Desktop/goweekclass/learn/test/main.go:13\nruntime.main\n\t/usr/local/go/src/runtime/proc.go:250"}
{"level":"info","ts":1690351341.447681,"caller":"test/main.go:28","msg":"Syccess! statusCode = 200 OK for URL https://www.baidu.com"}
应该注意到了,到目前为止这两个Logger都打印输出JSON格式。
在文中的后部分,我们将更加详细的讨论SugaredLogger
,并了解如何进一步配置它。
定制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":1690352465.018154,"msg":"Trying to hit GET request for www.baidu.com"}
{"level":"error","ts":1690352465.018272,"msg":"Error fetching URL www.baidu.com: Error = Get \"www.baidu.com\": unsupported protocol scheme \"\""}
{"level":"debug","ts":1690352465.0182772,"msg":"Trying to hit GET request for https://www.baidu.com"}
{"level":"info","ts":1690352465.114388,"msg":"Syccess! statusCode = 200 OK for URL https://www.baidu.com"}
将JSON Encoder更改为普通的Log Encoder
现在,我们希望将编码器从JSON Encoder更改为普通Encoder。为此,我们需要将NewJSONEncoder()
更改为NewConsoleEncoder()
。
return zapcore.NewConsoleEncoder(zap.NewProductionEncoderConfig())
当使用这些修改过的Logger配置调用上述部分的main()
函数时,以下输出将打印在文件----test.log
中。
1.6903527132707222e+09 debug Trying to hit GET request for www.baidu.com
1.690352713270837e+09 error Error fetching URL www.baidu.com: Error = Get "www.baidu.com": unsupported protocol scheme ""
1.690352713270842e+09 debug Trying to hit GET request for https://www.baidu.com
1.690352713348465e+09 info Syccess! statusCode = 200 OK for URL https://www.baidu.com
更改时间编码并添加调用者详细信息
鉴于我们对配置所做的更改,有下面两个问题:
- 时间是一非人类可读的展示方式,例如: 1.6903527132707222e+09
- 调用方函数的详细信息没有显示在日志中
我们要做的第一件事是覆盖默认的ProductionConfig()
,并进行一下更改:
- 修改时间编码器
- 在日志文件中使用大写字母记录日志等级
func getEncoder() zapcore.Encoder {
encoderConfig := zap.NewProductionEncoderConfig()
encoderConfig.EncodeTime = zapcore.ISO8601TimeEncoder
encoderConfig.EncodeLevel = zapcore.CapitalLevelEncoder
return zapcore.NewConsoleEncoder(zap.NewProductionEncoderConfig())
}
接下来,我们将修改的zap Logger代码,添加调用函数信息记录到日志的终端功能。为此,我们将在zap.New(...)
函数中添加一个Option
.
logger := zap.New(core, zap.AddCaller())
package main
import (
"go.uber.org/zap"
"go.uber.org/zap/zapcore"
"net/http"
"os"
)
var logger *zap.Logger
func main() {
InitLogger()
defer logger.Sync()
simpleHttpGet("www.baidu.com")
simpleHttpGet("https://www.baidu.com")
}
func InitLogger() {
writeSyncer := getLogWriter()
encoder := getEncoder()
core := zapcore.NewCore(encoder, writeSyncer, zapcore.DebugLevel)
logger = zap.New(core, zap.AddCaller()) // 添加 zap.AddCaller() 选项
}
func getEncoder() zapcore.Encoder {
encoderConfig := zap.NewProductionEncoderConfig()
encoderConfig.EncodeTime = zapcore.ISO8601TimeEncoder
encoderConfig.EncodeLevel = zapcore.CapitalLevelEncoder // 使用大写字母记录日志等级
return zapcore.NewConsoleEncoder(encoderConfig)
}
func getLogWriter() zapcore.WriteSyncer {
file, _ := os.Create("./test.log")
return zapcore.AddSync(file)
}
func simpleHttpGet(url string) {
logger.Debug("Trying to hit GET request for", zap.String("url", url))
resp, err := http.Get(url)
if err != nil {
logger.Error("Error fetching URL", zap.String("url", url), zap.Error(err))
} else {
logger.Info("Success! statusCode =", zap.String("status", resp.Status), zap.String("url", url))
resp.Body.Close()
}
}
当使用 这些修改过的Logger配置调用上述部分的main()
函数时,以下输出将打印在文件----test.log
中。
2023-07-26T14:53:41.248+0800 DEBUG test/main.go:40 Trying to hit GET request for {"url": "www.baidu.com"}
2023-07-26T14:53:41.248+0800 ERROR test/main.go:43 Error fetching URL {"url": "www.baidu.com", "error": "Get \"www.baidu.com\": unsupported protocol scheme \"\""}
2023-07-26T14:53:41.248+0800 DEBUG test/main.go:40 Trying to hit GET request for {"url": "https://www.baidu.com"}
AddCallerSkip
当我们不是直接使用初始化好的logger实例记录日志,而是将其包装成一个函数,此时目录的函数调用链会增加,想要获得准确的信息就需要通过AddCallerSkip
函数来跳过。
logger := zap.New(core, zap.AddCaller(), zap.AddCallerSkip(1))
将日志输出到多个位置
我们可以将日志同时输出到文件和终端
func getLogWriter() zapcore.WriteSyncer {
// 利用io.MutiWtiter支持文件和终端两个输出目标
file, _ := os.Create("./test.log")
ws := io.MultiWriter(file, os.Stderr)
return zapcore.AddSync(ws)
}
将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())
}
使用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)
安装
执行下面的命令安装 Lumberjack v2 版本
go get gopkg.in/natefinch/lumberjack.v2
zap logger中加入Lumberjack
要zai中加入 Lumberjack 支持,我们需要修改WiteSyncer
代码,我们将按照下面的代码修改getLoggerWriter()
函数
func getLogWriter() zapcore.WriteSyncer {
lumberJackLogger := &lumberjack.Logger{
Filename: "./test.log",
MaxSize: 10,
MaxBackups: 5,
MaxAge: 30,
Compress: false,
}
return zapcore.AddSync(lumberJackLogger)
}
Lumberjack Logger采用以下属性作为输入:
- Filename: 日志文件的位置
- MaxSize: 在进行切割之前,日志文件的最大大小,(以MB为单位)
- MaxBackups: 保留就文件的最大天数
- 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()
}
}
执行上述代码,下面的内容会输出到文件----test.log
2023-07-26T22:22:04.653+0800 DEBUG test/main.go:48 Trying to hit GET request for www.sogo.com
2023-07-26T22:22:04.654+0800 ERROR test/main.go:51 Error fetching URL www.sogo.com : Error = Get "www.sogo.com": unsupported protocol scheme ""
2023-07-26T22:22:04.654+0800 DEBUG test/main.go:48 Trying to hit GET request for http://www.sogo.com
2023-07-26T22:22:06.694+0800 INFO test/main.go:53 Success! statusCode = 501 Not Implemented for URL http://www.sogo.com
同时,可以在main
函数中循环记录日志,测试文件是否会自动切割和归档(日志文件每1MB会自动切割并且在当前目录下最多保存5个备份)。
至此,我们总结了如何将zap日志程序集成到GO应用程序项目中。
标签:www,zapcore,go,GO,日志,com,zap From: https://www.cnblogs.com/xiaohaoge/p/17583708.html