在许多Go语言项目中，我们需要一个好的日志记录器能够提供下面这些功能：

  • 能够将事件记录到文件中，而不是应用程序控制台。
  • 日志切割-能够根据文件大小、时间或间隔等来切割日志文件。
  • 支持不同的日志级别。例如INFO，DEBUG，ERROR等。
  • 能够打印基本信息，如调用文件/函数名和行号，日志时间等。

Go自带log库的优势和劣势

  • 优势

它最大的优点是使用非常简单。我们可以设置任何io.Writer作为日志记录输出并向其发送要写入的日志。

  • 劣势

    • 仅限基本的日志级别

      • 只有一个Print选项。不支持INFO/DEBUG等多个级别。
    • 对于错误日志，它有Fatal和Panic
      • Fatal日志通过调用os.Exit(1)来结束程序
      • Panic日志在写入日志消息之后抛出一个panic
      • 但是它缺少一个ERROR日志级别，这个级别可以在不抛出panic或退出程序的情况下记录错误
    • 缺乏日志格式化的能力——例如记录调用者的函数名和行号，格式化日期和时间格式。等等。
    • 不提供日志切割的能力。

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

  1. go get -u 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界面。
  1. var logger *zap.Logger
  2.  
  3. func main() {
  4. 	InitLogger()
  5.   defer logger.Sync()
  6. 	simpleHttpGet("www.google.com")
  7. 	simpleHttpGet("http://www.google.com")
  8. }
  9.  
  10. func InitLogger() {
  11. 	logger, _ = zap.NewProduction()
  12. }
  13.  
  14. func simpleHttpGet(url string) {
  15. 	resp, err := http.Get(url)
  16. 	if err != nil {
  17. 		logger.Error(
  18. 			"Error fetching url..",
  19. 			zap.String("url", url),
  20. 			zap.Error(err))
  21. 	} else {
  22. 		logger.Info("Success..",
  23. 			zap.String("statusCode", resp.Status),
  24. 			zap.String("url", url))
  25. 		resp.Body.Close()
  26. 	}
  27. }

在上面的代码中，我们首先创建了一个Logger，然后使用Info/ Error等Logger方法记录消息。

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

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

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

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

我们执行上面的代码会得到如下输出结果：

  1. {"level":"error","ts":1590662574.8328245,"caller":"go_Logger/main.go:31","msg":"Error fetching url..","url":"www.google.com","error":"Get www.google.com: unsupported protocol scheme \"\"","stacktrace":"main.simpleHttpGet\n\tE:/go/project/src/go_Logger/main.go:31\nmain.main\n\tE:/go/project/src/go_Logger/main.go:20\nruntime.main\n\tD:/Go/src/runtime/proc.go:203"}
  2. {"level":"error","ts":1590662575.9375718,"caller":"go_Logger/main.go:31","msg":"Error fetching url..","url":"http://www.google.com","error":"Get http://www.google.com: dial tcp 127.0.0.1:80: connectex: No connection could be made because the target machine actively refused it.","stacktrace":"main.simpleHttpGet\n\tE:/go/project/src/go_Logger/main.go:31\nmain.main\n\tE:/go/project/src/go_Logger/main.go:21\nruntime.main\n\tD:/Go/src/runtime/proc.go:203"}

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

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

下面是修改过后使用SugaredLogger代替Logger的代码：

  1. var sugarLogger *zap.SugaredLogger
  2.  
  3. func main() {
  4. 	InitLogger()
  5. 	defer sugarLogger.Sync()
  6. 	simpleHttpGet("www.google.com")
  7. 	simpleHttpGet("http://www.google.com")
  8. }
  9.  
  10. func InitLogger() {
  11.   logger, _ := zap.NewProduction()
  12. 	sugarLogger = logger.Sugar()
  13. }
  14.  
  15. func simpleHttpGet(url string) {
  16. 	sugarLogger.Debugf("Trying to hit GET request for %s", url)
  17. 	resp, err := http.Get(url)
  18. 	if err != nil {
  19. 		sugarLogger.Errorf("Error fetching URL %s : Error = %s", url, err)
  20. 	} else {
  21. 		sugarLogger.Infof("Success! statusCode = %s for URL %s", resp.Status, url)
  22. 		resp.Body.Close()
  23. 	}
  24. }

当你执行上面的代码会得到如下输出：

  1. {"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"}
  2. {"level":"info","ts":1572159150.192585,"caller":"logic/temp2.go:29","msg":"Success! statusCode = 200 OK for URL http://www.sogo.com"}
  1. 你应该注意到的了，到目前为止这两个logger都打印输出JSON结构格式。

在本博客的后面部分，我们将更详细地讨论SugaredLogger，并了解如何进一步配置它。

定制logger

将日志写入文件而不是终端

我们要做的第一个更改是把日志写入文件，而不是打印到应用程序控制台。

  • 我们将使用zap.New(…)方法来手动传递所有配置，而不是使用像zap.NewProduction()这样的预置方法来创建logger。
  1. func New(core zapcore.Core, options ...Option) *Logger

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

1.Encoder:编码器(如何写入日志)。我们将使用开箱即用的NewJSONEncoder()，并使用预先设置的ProductionEncoderConfig()。

  1.    zapcore.NewJSONEncoder(zap.NewProductionEncoderConfig())

2.WriterSyncer ：指定日志将写到哪里去。我们使用zapcore.AddSync()函数并且将打开的文件句柄传进去。

  1.    file, _ := os.Create("./test.log")
  2.    writeSyncer := zapcore.AddSync(file)

3.Log Level：哪种级别的日志将被写入。

我们将修改上述部分中的Logger代码，并重写InitLogger()方法。其余方法—main()/SimpleHttpGet()保持不变。

  1. func InitLogger() {
  2. 	writeSyncer := getLogWriter()
  3. 	encoder := getEncoder()
  4. 	core := zapcore.NewCore(encoder, writeSyncer, zapcore.DebugLevel)
  5.  
  6. 	logger := zap.New(core)
  7. 	sugarLogger = logger.Sugar()
  8. }
  9.  
  10. func getEncoder() zapcore.Encoder {
  11. 	return zapcore.NewJSONEncoder(zap.NewProductionEncoderConfig())
  12. }
  13.  
  14. func getLogWriter() zapcore.WriteSyncer {
  15. 	file, _ := os.Create("./test.log")
  16. 	return zapcore.AddSync(file)
  17. }

当使用这些修改过的logger配置调用上述部分的main()函数时，以下输出将打印在文件——test.log中。

  1. {"level":"debug","ts":1572160754.994731,"msg":"Trying to hit GET request for www.sogo.com"}
  2. {"level":"error","ts":1572160754.994982,"msg":"Error fetching URL www.sogo.com : Error = Get www.sogo.com: unsupported protocol scheme \"\""}
  3. {"level":"debug","ts":1572160754.994996,"msg":"Trying to hit GET request for http://www.sogo.com"}
  4. {"level":"info","ts":1572160757.3755069,"msg":"Success! statusCode = 200 OK for URL http://www.sogo.com"}

将JSON Encoder更改为普通的Log Encoder

现在，我们希望将编码器从JSON Encoder更改为普通Encoder。为此，我们需要将NewJSONEncoder()更改为NewConsoleEncoder()。

  1. return zapcore.NewConsoleEncoder(zap.NewProductionEncoderConfig())

当使用这些修改过的logger配置调用上述部分的main()函数时，以下输出将打印在文件——test.log中。

  1. 1.572161051846623e+09	debug	Trying to hit GET request for www.sogo.com
  2. 1.572161051846828e+09	error	Error fetching URL www.sogo.com : Error = Get www.sogo.com: unsupported protocol scheme ""
  3. 1.5721610518468401e+09	debug	Trying to hit GET request for http://www.sogo.com
  4. 1.572161052068744e+09	info	Success! statusCode = 200 OK for URL http://www.sogo.com

更改时间编码并添加调用者详细信息

鉴于我们对配置所做的更改，有下面两个问题：

  • 时间是以非人类可读的方式展示，例如1.572161051846623e+09
  • 调用方函数的详细信息没有显示在日志中

我们要做的第一件事是覆盖默认的ProductionConfig()，并进行以下更改:

  • 修改时间编码器
  • 在日志文件中使用大写字母记录日志级别
  1. func getEncoder() zapcore.Encoder {
  2. 	encoderConfig := zap.NewProductionEncoderConfig()
  3. 	encoderConfig.EncodeTime = zapcore.ISO8601TimeEncoder
  4. 	encoderConfig.EncodeLevel = zapcore.CapitalLevelEncoder
  5. 	return zapcore.NewConsoleEncoder(encoderConfig)
  6. }

接下来，我们将修改zap logger代码，添加将调用函数信息记录到日志中的功能。为此，我们将在zap.New(..)函数中添加一个Option。

  1. logger := zap.New(core, zap.AddCaller())

当使用这些修改过的logger配置调用上述部分的main()函数时，以下输出将打印在文件——test.log中。

  1. 2019-10-27T15:33:29.855+0800	DEBUG	logic/temp2.go:47	Trying to hit GET request for www.sogo.com
  2. 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 ""
  3. 2019-10-27T15:33:29.856+0800	DEBUG	logic/temp2.go:47	Trying to hit GET request for http://www.sogo.com
  4. 2019-10-27T15:33:30.125+0800	INFO	logic/temp2.go:52	Success! statusCode = 200 OK for URL http://www.sogo.com

使用Lumberjack进行日志切割归档

这个日志程序中唯一缺少的就是日志切割归档功能。

Zap本身不支持切割归档日志文件

为了添加日志切割归档功能，我们将使用第三方库Lumberjack来实现。

安装

执行下面的命令安装Lumberjack

  1. go get -u github.com/natefinch/lumberjack

zap logger中加入Lumberjack

要在zap中加入Lumberjack支持，我们需要修改WriteSyncer代码。我们将按照下面的代码修改getLogWriter()函数：

  1. func getLogWriter() zapcore.WriteSyncer {
  2. 	lumberJackLogger := &lumberjack.Logger{
  3. 		Filename:   "./test.log",
  4. 		MaxSize:    10,
  5. 		MaxBackups: 5,
  6. 		MaxAge:     30,
  7. 		Compress:   false,
  8. 	}
  9. 	return zapcore.AddSync(lumberJackLogger)
  10. }

Lumberjack Logger采用以下属性作为输入:

  • Filename: 日志文件的位置
  • MaxSize：在进行切割之前，日志文件的最大大小（以MB为单位）
  • MaxBackups：保留旧文件的最大个数
  • MaxAges：保留旧文件的最大天数
  • Compress：是否压缩/归档旧文件

测试所有功能

最终，使用Zap/Lumberjack logger的完整示例代码如下：

  1. package main
  2.  
  3. import (
  4. 	"net/http"
  5.  
  6. 	"github.com/natefinch/lumberjack"
  7. 	"go.uber.org/zap"
  8. 	"go.uber.org/zap/zapcore"
  9. )
  10.  
  11. var sugarLogger *zap.SugaredLogger
  12.  
  13. func main() {
  14. 	InitLogger()
  15. 	defer sugarLogger.Sync()
  16. 	simpleHttpGet("www.sogo.com")
  17. 	simpleHttpGet("http://www.sogo.com")
  18. }
  19.  
  20. func InitLogger() {
  21. 	writeSyncer := getLogWriter()
  22. 	encoder := getEncoder()
  23. 	core := zapcore.NewCore(encoder, writeSyncer, zapcore.DebugLevel)
  24.  
  25. 	logger := zap.New(core, zap.AddCaller())
  26. 	sugarLogger = logger.Sugar()
  27. }
  28.  
  29. func getEncoder() zapcore.Encoder {
  30. 	encoderConfig := zap.NewProductionEncoderConfig()
  31. 	encoderConfig.EncodeTime = zapcore.ISO8601TimeEncoder
  32. 	encoderConfig.EncodeLevel = zapcore.CapitalLevelEncoder
  33. 	return zapcore.NewConsoleEncoder(encoderConfig)
  34. }
  35.  
  36. func getLogWriter() zapcore.WriteSyncer {
  37. 	lumberJackLogger := &lumberjack.Logger{
  38. 		Filename:   "./test.log",
  39. 		MaxSize:    1,
  40. 		MaxBackups: 5,
  41. 		MaxAge:     30,
  42. 		Compress:   false,
  43. 	}
  44. 	return zapcore.AddSync(lumberJackLogger)
  45. }
  46.  
  47. func simpleHttpGet(url string) {
  48. 	sugarLogger.Debugf("Trying to hit GET request for %s", url)
  49. 	resp, err := http.Get(url)
  50. 	if err != nil {
  51. 		sugarLogger.Errorf("Error fetching URL %s : Error = %s", url, err)
  52. 	} else {
  53. 		sugarLogger.Infof("Success! statusCode = %s for URL %s", resp.Status, url)
  54. 		resp.Body.Close()
  55. 	}
  56. }

执行上述代码，下面的内容会输出到文件——test.log中。

  1. 2019-10-27T15:50:32.944+0800	DEBUG	logic/temp2.go:48	Trying to hit GET request for www.sogo.com
  2. 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 ""
  3. 2019-10-27T15:50:32.944+0800	DEBUG	logic/temp2.go:48	Trying to hit GET request for http://www.sogo.com
  4. 2019-10-27T15:50:33.165+0800	INFO	logic/temp2.go:53	Success! statusCode = 200 OK for URL http://www.sogo.com

同时，可以在main函数中循环记录日志，测试日志文件是否会自动切割和归档（日志文件每1MB会切割并且在当前目录下最多保存5个备份）。

至此，我们总结了如何将Zap日志程序集成到Go应用程序项目中。

　

Go语言系列之日志库zap的更多相关文章

  1. Go语言系列之标准库log

    Go语言内置的log包实现了简单的日志服务.本文介绍了标准库log的基本使用. 使用Logger log包定义了Logger类型,该类型提供了一些格式化输出的方法.本包也提供了一个预定义的" ...

  2. Python语言系列-10-数据库

    MySQL 基础环境准备 readme.txt 作者:Alnk(李成果) 版本:v1.0 安装mysql数据库 略 创建student库 # mysql> create database stu ...

  3. Go语言系列之标准库fmt

    fmt包实现了类似C语言printf和scanf的格式化I/O.主要分为向外输出内容和获取输入内容两大部分. 向外输出 标准库fmt提供了以下几种输出相关函数. Print Print系列函数会将内容 ...

  4. Golang语言系列-15-数据库

    数据库 MySQL 连接数据库 package main import ( "database/sql" "fmt" _ "github.com/go ...

  5. Go语言系列之标准库strconv

    Go语言中strconv包实现了基本数据类型和其字符串表示的相互转换. strconv包 strconv包实现了基本数据类型与其字符串表示的转换,主要有以下常用函数: Atoi().Itia().pa ...

  6. Go语言系列之标准库flag

    Go语言内置的flag包实现了命令行参数的解析,flag包使得开发命令行工具更为简单. os.Args 如果你只是简单的想要获取命令行参数,可以像下面的代码示例一样使用os.Args来获取命令行参数. ...

  7. Go语言系列之标准库os

    os包提供了操作系统的系列函数,这些接口不依赖平台.设计为Unix风格的,错误处理是go风格的:调用失败会返回错误值而非错误码.通常错误值里包含更多信息. os包的接口在所有操作系统中都是一致的.非公 ...

  8. Go语言系列之标准库ioutil

    ioutil标准库中提供了一些常用.方便的IO操作函数 一.相关方法 func ReadAll(r io.Reader) ([]byte, error) func ReadDir(dirname st ...

  9. Go语言系列之标准库path/filepath

    一.Path包 import "path" path实现了对斜杠分隔的路径进行操作的函数. func IsAbs(path string) bool // 判断是否是一个绝对路径 ...

随机推荐

  1. Set数据结构基本介绍

    构造 const set = new Set([1, 2, 3, 4, 4]); 可接受的参数为所有具有iterable 接口的数据 特性: 类似数组,无重复值. const set = new Se ...

  2. Charles ios设备抓包

    在Mac下做开发,用Fiddler抓包由于离不开Windows比较痛苦,还好有Charles,到官网http://www.charlesproxy.com/可下载到最新版本(若不支持rMBP可拖到Re ...

  3. 禁用copy on write实现全局EAT HOOK

    以前写过一个,但是一不小心删除了,哎,就当再次复习复习吧. 首先抛出一个有意思的问题: 已知所有Windows可执行文件exe都会链接子系统ntdll.dll,那么真实内存中有几份ntdll.dll? ...

  4. Java应用日志如何与Jaeger的trace关联

    欢迎访问我的GitHub https://github.com/zq2599/blog_demos 内容:所有原创文章分类汇总及配套源码,涉及Java.Docker.Kubernetes.DevOPS ...

  5. Sentinel-Go 源码系列（三）滑动时间窗口算法的工程实现

    要说现在工程师最重要的能力,我觉得工程能力要排第一. 就算现在大厂面试经常要手撕算法,也是更偏向考查代码工程实现的能力,之前在群里看到这样的图片,就觉得很离谱. 算法与工程实现 在 Sentinel- ...

  6. java 编程基础 Class对象 反射 ：参数反射

    方法参数反射 Java8在java.lang.reflect包下新增了Executable抽象基类,该对象代表可执行的类成员,该类派生了Constructor和Method两个子类.Executabl ...

  7. java 多线程： Thread 锁ReentrantLock 常用方法

    注意 reentrantLock 和 同步代码块儿一样,同一个时刻只能一个线程获取锁,也就是共用锁的代码块部分,线程是顺序执行的 ReentrantLock 常用方法 getHoldCount获取当前 ...

  8. HTML界面监控键盘回车Enter按下并绑定动作

    本示例绑定键盘回车键(Enter),触发发送WebSocket消息动作 <script type="text/javascript"> //监控键盘Enter 回车键按 ...

  9. nim_duilib(20)之即刻(1)

    note 一个基于nim_duilib仿wechat的IM. 主界面 样式 美工差了. 布局 整体为水平布局,左边的深灰色区域(frame_left),右侧的light white区域(frame_r ...

  10. C++ 获取函数耗时

    C++ 记录耗时 #include <sys/timeb.h> #include <stdio.h> long long getSystemTime() { struct ti ...