Go语言系列之日志库zap

已于 2022-06-30 11:05:37 修改
阅读量739 收藏
点赞数
分类专栏： golang 文章标签： go
于 2021-09-10 16:40:43 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/baidu_37366055/article/details/120224812
版权

在许多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个字段:

PackageTimeTime % to zapObjects Allocated
⚡️ zap862 ns/op+0%5 allocs/op
⚡️ zap (sugared)1250 ns/op+45%11 allocs/op
zerolog4021 ns/op+366%76 allocs/op
go-kit4542 ns/op+427%105 allocs/op
apex/log26785 ns/op+3007%115 allocs/op
logrus29501 ns/op+3322%125 allocs/op
log1529906 ns/op+3369%122 allocs/op

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

PackageTimeTime % to zapObjects Allocated
⚡️ zap118 ns/op+0%0 allocs/op
⚡️ zap (sugared)191 ns/op+62%2 allocs/op
zerolog93 ns/op-21%0 allocs/op
go-kit280 ns/op+137%11 allocs/op
standard library499 ns/op+323%2 allocs/op
apex/log1990 ns/op+1586%10 allocs/op
logrus3129 ns/op+2552%24 allocs/op
log153887 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

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

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方法记录消息。

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

1

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

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

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

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

1

2

{"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"}

{"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

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

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()

    }

}

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

1

2

{"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"}

你应该注意到的了，到目前为止这两个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

2

file, _ := os.Create("./test.log")

writeSyncer := zapcore.AddSync(file)

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

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

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

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中。

1

2

3

4

{"level":"debug","ts":1572160754.994731,"msg":"Trying to hit GET request for www.sogo.com"}

{"level":"error","ts":1572160754.994982,"msg":"Error fetching URL www.sogo.com : Error = Get www.sogo.com: unsupported protocol scheme \"\""}

{"level":"debug","ts":1572160754.994996,"msg":"Trying to hit GET request for http://www.sogo.com"}

{"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

2

3

4

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

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

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

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

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

  • 修改时间编码器
  • 在日志文件中使用大写字母记录日志级别

1

2

3

4

5

6

func getEncoder() zapcore.Encoder {

    encoderConfig := zap.NewProductionEncoderConfig()

    encoderConfig.EncodeTime = zapcore.ISO8601TimeEncoder

    encoderConfig.EncodeLevel = zapcore.CapitalLevelEncoder

    return zapcore.NewConsoleEncoder(encoderConfig)

}

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

1

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

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

1

2

3

4

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

使用Lumberjack进行日志切割归档

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

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

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

安装

执行下面的命令安装Lumberjack

1

go get -u github.com/natefinch/lumberjack

zap logger中加入Lumberjack

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

1

2

3

4

5

6

7

8

9

10

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：保留旧文件的最大个数
  • MaxAges：保留旧文件的最大天数
  • Compress：是否压缩/归档旧文件

测试所有功能

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

1

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

package main

import (

    "net/http"

    "github.com/natefinch/lumberjack"

    "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中。

1

2

3

4

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

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

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

谱写
关注
  • 0
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
Go日志库——logrus
成长之路
07-17 4210
go日志库学习-logrus
GO语言使用Zap日志库（小白文）
weixin_59801183的博客
05-06 1978
本文介绍了GO语言如何快速使用zap日志库进行日志打印
Go语言快速上手Zap日志库
最新发布
qq_63644576的博客
05-26 529
Zap是由Uber开源的Go语言日志库，以其高性能和易用性在Go社区中广受欢迎。它提供了丰富的日志记录功能，包括不同级别的日志记录、结构化日志输出、日志轮转等。对于Go语言开发者来说，Zap是一个非常好的选择，特别是在需要处理大量日志数据的应用场景中。Zap是一个强大而灵活的Go语言日志库，它提供了丰富的功能和良好的性能。通过简单的配置和使用，你就可以在Go项目中快速上手Zap，记录高质量的日志。无论是对于新手还是有经验的开发者，Zap都是一个值得推荐的日志库。的便捷版本，它提供了更多的方法，如。
golang 日志库zap和日志切割实践
qq_32421489的博客
07-19 1521
golang 日志库zap和日志切割实践
Golang zap 快速上手
Dablelv 的博客专栏。
02-17 923
它支持多种日志级别、日志格式和输出方式，包括文本格式和 JSON 格式的输出，以及在控制台输出、文件输出、发送到远程服务、发送到。需要注意的是，Zap 的性能非常高，并且使用简单，因此它是 Golang 中最受欢迎的日志库之一。在上面的示例中，我们创建了一个 JSONEncoder 和一个 Core，将日志输出到标准输出，并将 lumberjackLogger 作为 Core 的 WriteSyncer。在上面的示例中，我们创建了一个生产级别的 Logger，它将日志记录到控制台或文件中。
Golang高性能日志库zap + lumberjack 日志切割组件详解
脑袋装水的博客
09-01 7491
Golang 高性能日志库 zap 的详细使用！！！ Gin集成zap！！！ lumberjack 日志切割组件的详细使用！！！
golang gin 日志中间件
qq_39272466的博客
06-19 637
【代码】golang gin 日志中间件。
Go-Golang异步日志库支持异步批量写入按天或者小时自动切割错误等级多文件等
08-14
本文将深入探讨一个专为Go语言设计的异步日志库，该库支持异步批量写入、按天或小时自动切割、错误等级分类以及多文件管理等功能。我们将讨论这些特性的实现原理以及它们在实际开发中的应用。 首先，异步日志写入是...
Go-zap是Go中一个快速结构化分级日志库
08-14
本文将深入探讨“Go-zap”，这是一个专为Go设计的高性能、结构化、分级的日志库，其目标是提供比标准库`log`更强大的功能和更好的性能。 **Go-zap的核心特性** 1. **高性能**: Zap的设计考虑了速度，它能够快速地...
Go-logger-Go简约的日志库
08-14
在Go语言中，日志处理是非常重要的一部分，它帮助开发者记录程序运行时的状态，以便于调试和问题排查。"Go-logger-Go简约的日志库" 提供了一种简洁高效的方式来处理日志，使得开发者可以更专注于核心业务逻辑。下面...
基于go-kit的微服务架构脚手架,集成zap日志库
05-24
基于go-kit的微服务架构脚手架,集成zap日志库、mysql、redis、grpc、etcd等常用组件，可作为项目脚手架开箱即用；项目部署采用k8s和docker swarmGo语言（也称为Golang）是由Google开发的一种静态强类型、编译型的...
logbench:Golang日志记录库基准测试
05-22
在Golang编程语言中，日志记录库是开发者在构建应用程序时不可或缺的工具。日志可以帮助我们追踪程序运行状态，定位错误，以及进行性能分析。本文将深入探讨标题中的"Logbench"，这是一个用于比较Golang日志库性能的...
3. 在Go语言项目中使用Zap日志库
YouMing_Li的博客
03-06 1722
在许多Go能够将事件记录到文件中，而不是应用程序控制台。日志切割：能够根据文件大小、时间或间隔等来切割日志文件。支持不同的日志级别。例如等。能够打印基本信息，如调用文件/函数名和行号，日志时间等。
Go 语言中的 logger 和 zap 日志库
weixin_41335923的博客
04-22 1414
目录Go 语言中的 logger 和 zap 日志库Go LoggerZap LoggerLoggerSugared Logger定制 Logger 记录到文件中参考 Go 语言中的 logger 和 zap 日志库 在软件开发过程中，需要进行关键日志记录，便于后期的审计和排错。 一个好的日志记录器应该具备以下功能： 日志写入到文件而不是控制台输出 日志切割-按文件大小、时间或间隔等切割日志文件 支持不同的日志级别，如：INFO，DEBUG，ERROR 等 能打印基本信息，如调用文件/函数名和行号，日志时
go语言的日志实现(打印日志、日志写入文件、日志切割)
ydl1128的博客
08-04 5317
Go语言内置的log包实现了简单的日志服务。log包定义了Logger类型，该类型提供了一些格式化输出的方法。本包也提供了一个预定义的“标准”logger，可以通过调用函数Print系列(Print|Printf|Println）、Fatal系列（Fatal|Fatalf|Fatalln）、和Panic系列（Panic|Panicf|Panicln）来使用，比自行创建一个logger对象更容易使用。...
golang logrus (1) 简单使用
weixin_33694620的博客
06-13 728
目录 1、简介 2、简单使用 3、基本使用 4、API 概览 5、参考文章 1、简介 logrus 是结构化的，与 golang 标准库完全兼容的 golang 日志打印框架。支持 Filed 和 HOOK 机制，自带 text 和 json 两种日志输出格式。 2、简单使用 最简单的方法就是直接使用包级暴露的打印方法。直接上代码： package main import "github.co...
go的日志库logrus
weixin_45747080的博客
08-17 785
logrus完全兼容Go的标准日志库log。同时它还支持文本、JSON两种日志输出格式。
go语言中log库的使用,并且加强添加日志级别控制
shura1014的博客
11-05 1194
每门语言日志都是很重要的一部分，它能帮助我们快速定位到问题。下面我们来了解go是怎样使用日志的
Go 记录日志——log包
云淡风轻
05-15 3437
Golang’s log模块主要提供了3类接口。分别是 “Print 、Panic 、Fatal ”，对每一类接口其提供了3中调用方式，分别是 “Xxxx 、 Xxxxln 、Xxxxf”，基本和fmt中的相关函数类似，下面是一个Print的示例： package main import ( "log" ) func main(){ arr := []int {2,3} ...
ZAP高性能日志库简要介绍
03-08
ZAP是一款高性能的日志库，它采用了零内存分配的设计，能够在高并发场景下保持稳定的性能表现。它支持多种日志级别，可以方便地进行日志输出和管理。此外，ZAP还提供了多种输出格式和输出目标，可以满足不同场景下的...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值