1. Zap Logger

    是非常快的、结构化的,分日志级别的Go日志库。

    1.1.2. 为什么选择Uber-go zap

    • 它同时提供了结构化日志记录和printf风格的日志记录
    • 它非常的快

    根据Uber-go Zap的文档,它的性能比类似的结构化日志包更好——也比标准库更快。 以下是Zap发布的基准测试信息

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

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

    Zap Logger - 图1

    运行下面的命令安装zap

    1.1.4. 配置Zap Logger

    Zap提供了两种类型的日志记录器—Sugared Logger和Logger。

    在性能很好但不是很关键的上下文中,使用SugaredLogger。它比其他结构化日志记录包快4-10倍,并且支持结构化和printf风格的日志记录。

    • 通过调用zap.NewProduction()/zap.NewDevelopment()或者zap.Example()创建一个Logger。
    • 上面的每一个函数都将创建一个logger。唯一的区别在于它将记录的信息不同。例如production logger默认记录调用函数信息、日期和时间等。
    • 通过Logger调用Info/Error等。
    • 默认情况下日志都会打印到应用程序的console界面。
    1. import (
    2. "net/http"
    3. "go.uber.org/zap"
    4. )
    5. var logger *zap.Logger
    6. func main() {
    7. InitLogger()
    8. defer logger.Sync()
    9. simpleHttpGet("www.5lmh.com")
    10. simpleHttpGet("http://www.google.com")
    11. }
    12. func InitLogger() {
    13. logger, _ = zap.NewProduction()
    14. }
    15. func simpleHttpGet(url string) {
    16. resp, err := http.Get(url)
    17. if err != nil {
    18. logger.Error(
    19. "Error fetching url..",
    20. zap.String("url", url),
    21. zap.Error(err))
    22. } else {
    23. logger.Info("Success..",
    24. zap.String("statusCode", resp.Status),
    25. zap.String("url", url))
    26. resp.Body.Close()
    27. }
    28. }

    在上面的代码中,我们首先创建了一个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":1573180669.9273467,"caller":"ce2/main.go:25","msg":"Error fetching url..","url":"http://www.google.com","error":"Get http://www.google.com: dial tcp 31.13.72.54: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.","stacktrace":"main.simpleHttpGet\n\te:/goproject/src/github.com/student/log/ce2/main.go:25\nmain.main\n\te:/goproject/src/github.com/student/log/ce2/main.go:15\nruntime.main\n\tE:/go/src/runtime/proc.go:200"}

    1.1.6. Sugared Logger

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

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

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

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

    你应该注意到的了,到目前为止这两个logger都打印输出JSON结构格式。

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

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

    • 我们要做的第一个更改是把日志写入文件,而不是打印到应用程序控制台。
    1. func New(core zapcore.Core, options ...Option) *Logger

    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. package main
    2. import (
    3. "net/http"
    4. "os"
    5. "go.uber.org/zap"
    6. "go.uber.org/zap/zapcore"
    7. )
    8. func main() {
    9. InitLogger()
    10. defer sugarLogger.Sync()
    11. simpleHttpGet("http://www.google.com")
    12. }
    13. func InitLogger() {
    14. writeSyncer := getLogWriter()
    15. encoder := getEncoder()
    16. core := zapcore.NewCore(encoder, writeSyncer, zapcore.DebugLevel)
    17. logger := zap.New(core)
    18. sugarLogger = logger.Sugar()
    19. }
    20. func getEncoder() zapcore.Encoder {
    21. return zapcore.NewJSONEncoder(zap.NewProductionEncoderConfig())
    22. }
    23. func getLogWriter() zapcore.WriteSyncer {
    24. //如果想要追加写入可以查看我的博客文件操作那一章
    25. file, _ := os.Create("./test.log")
    26. return zapcore.AddSync(file)
    27. }
    28. func simpleHttpGet(url string) {
    29. sugarLogger.Debugf("Trying to hit GET request for %s", url)
    30. resp, err := http.Get(url)
    31. if err != nil {
    32. sugarLogger.Errorf("Error fetching URL %s : Error = %s", url, err)
    33. } else {
    34. sugarLogger.Infof("Success! statusCode = %s for URL %s", resp.Status, url)
    35. resp.Body.Close()
    36. }
    37. }

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

    将JSON Encoder更改为普通的Log Encoder

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

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

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

    1. 1.573181811861697e+09 debug Trying to hit GET request for www.5lmh.com
    2. 1.5731818118626883e+09 error Error fetching URL www.5lmh.com : Error = Get www.5lmh.com: unsupported protocol scheme ""
    3. 1.5731818118626883e+09 debug Trying to hit GET request for http://www.google.com
    4. 1.5731818329012108e+09 error Error fetching URL http://www.google.com : Error = Get http://www.google.com: dial tcp 216.58.200.228: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.

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

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

    • 时间是以非人类可读的方式展示,例如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. }
    1. logger := zap.New(core, zap.AddCaller())