Zap文档的使用 | 青训营笔记

这是我参与「第五届青训营 」伴学笔记创作活动的第 4 天

默认的Go Logger

在介绍Uber-go的zap包之前，让我们先看看Go语言提供的基本日志功能。Go语言提供的默认日志包是golang.org/pkg/log/。

实现Go Logger

实现一个Go语言中的日志记录器非常简单——创建一个新的日志文件，然后设置它为日志的输出位置。

设置Logger

我们可以像下面的代码一样设置日志记录器

func SetupLogger() {
	logFileLocation, _ := os.OpenFile("/Users/q1mi/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文件被创建，下面的内容会被添加到这个日志文件中。

2019/05/24 01:14:13 Error fetching url www.google.com : Get www.google.com: unsupported protocol scheme ""
2019/05/24 01:14:14 Status Code for http://www.google.com : 200 OK

Go Logger的优势和劣势

优势

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

劣势

• 仅限基本的日志级别

  • 只有一个Print选项。不支持INFO/DEBUG等多个级别。

• 对于错误日志，它有Fatal和Panic

  • Fatal日志通过调用os.Exit(1)来结束程序
  • Panic日志在写入日志消息之后抛出一个panic
  • 但是它缺少一个ERROR日志级别，这个级别可以在不抛出panic或退出程序的情况下记录错误

• 缺乏日志格式化的能力——例如记录调用者的函数名和行号，格式化日期和时间格式。等等。

• 不提供日志切割的能力。

Zap文档的使用

1.安装

go get -u go.uber.org/zap
go get -u github.com/natefinch/lumberjack
​

在Zap中搭配着lumberjack使用，可以实现日志切割的效果

2.gin框架下的配置使用

var logger *zap.Logger
var sugarLogger *zap.SugaredLogger
​
func main() {
    InitLogger()
    r := gin.New()
    r.Use(GinLogger(logger), GinRecovery(logger, true))
    r.GET("/hello", hello)
    r.Run()
}
func hello(context *gin.Context) {
    context.String(http.StatusOK, "hello golond")
}
func InitLogger() {
    writerSyncer := getLogWriter()
    encoder := gerEncoder()
    core := zapcore.NewCore(encoder, writerSyncer, zapcore.DebugLevel)
​
    //TODO zap.AddCaller() 是在日志里添加函数调用的信息
    logger := zap.New(core, zap.AddCaller())
    sugarLogger = logger.Sugar()
}
func gerEncoder() zapcore.Encoder {
    //TODO:修改时间形式 改为年月日格式
    encoderConfig := zap.NewProductionEncoderConfig()
    encoderConfig.EncodeTime = zapcore.ISO8601TimeEncoder   //修改时间
    encoderConfig.EncodeLevel = zapcore.CapitalLevelEncoder //大写字母记录级别
    //TODO:修改日志形式 控制台打印格式
    return zapcore.NewConsoleEncoder(encoderConfig)
​
}
func getLogWriter() zapcore.WriteSyncer {
    //TODO 在zap中加入lumberjack支持，帮助我们进行日志的切割
    lumberJackLogger := &lumberjack.Logger{
        Filename:   "./test.log",
        MaxSize:    100,   //单位是 M
        MaxAge:     5,     //备份数量
        MaxBackups: 30,    //备份天数
        Compress:   false, //是否压缩
​
    }
    return zapcore.AddSync(lumberJackLogger)
}
​
// GinLogger 接收gin框架默认的日志
func GinLogger(logger *zap.Logger) gin.HandlerFunc {
    return func(c *gin.Context) {
        start := time.Now()
        path := c.Request.URL.Path
        query := c.Request.URL.RawQuery
        c.Next()
​
        cost := time.Since(start)
        logger.Info(path,
            zap.Int("status", c.Writer.Status()),
            zap.String("method", c.Request.Method),
            zap.String("path", path),
            zap.String("query", query),
            zap.String("ip", c.ClientIP()),
            zap.String("user-agent", c.Request.UserAgent()),
            zap.String("errors", c.Errors.ByType(gin.ErrorTypePrivate).String()),
            zap.Duration("cost", cost),
        )
    }
}
​
// GinRecovery recover掉项目可能出现的panic
func GinRecovery(logger *zap.Logger, stack bool) gin.HandlerFunc {
    return func(c *gin.Context) {
        defer func() {
            if err := recover(); err != nil {
                // Check for a broken connection, as it is not really a
                // condition that warrants a panic stack trace.
                var brokenPipe bool
                if ne, ok := err.(*net.OpError); ok {
                    if se, ok := ne.Err.(*os.SyscallError); ok {
                        if strings.Contains(strings.ToLower(se.Error()), "broken pipe") || strings.Contains(strings.ToLower(se.Error()), "connection reset by peer") {
                            brokenPipe = true
                        }
                    }
                }
​
                httpRequest, _ := httputil.DumpRequest(c.Request, false)
                if brokenPipe {
                    logger.Error(c.Request.URL.Path,
                        zap.Any("error", err),
                        zap.String("request", string(httpRequest)),
                    )
                    // If the connection is dead, we can't write a status to it.
                    c.Error(err.(error)) // nolint: errcheck
                    c.Abort()
                    return
                }
​
                if stack {
                    logger.Error("[Recovery from panic]",
                        zap.Any("error", err),
                        zap.String("request", string(httpRequest)),
                        zap.String("stack", string(debug.Stack())),
                    )
                } else {
                    logger.Error("[Recovery from panic]",
                        zap.Any("error", err),
                        zap.String("request", string(httpRequest)),
                    )
                }
                c.AbortWithStatus(http.StatusInternalServerError)
            }
        }()
        c.Next()
    }
}