Golang日志入门与技术选型

参考文档：https://liwenzhou.com/posts/Go/zap/

无论是软件开发的调试阶段还是软件上线之后的运行阶段，日志一直都是非常重要的一个环节，我们也应该养成在程序中记录日志的好习惯。
Go 语言内置的log包实现了简单的日志服务。本文介绍了标准库log的基本使用和第三日志库的选型和使用。

1、原生Logger

例如，我们可以像下面的代码一样直接通过log包来调用上面提到的方法，默认它们会将日志信息打印到终端界面：

package main

import (
    "log"
)

func main() {
    log.Println("这是一条很普通的日志。")
    v := "很普通的"
    log.Printf("这是一条%s日志。\n", v)
    log.Fatalln("这是一条会触发fatal的日志。")
    log.Panicln("这是一条会触发panic的日志。")
}

编译并执行上面的代码会得到如下输出：

2017/06/19 14:04:17 这是一条很普通的日志。
2017/06/19 14:04:17 这是一条很普通的日志。
2017/06/19 14:04:17 这是一条会触发fatal的日志。

logger 会打印每条日志信息的日期、时间，默认输出到系统的标准错误。Fatal 系列函数会在写入日志信息后调用 os.Exit(1)。Panic 系列函数会在写入日志信息后 panic。

1.1 配置 logger配置

默认情况下的 logger 只会提供日志的时间信息，但是很多情况下我们希望得到更多信息，比如记录该日志的文件名和行号等。log标准库中为我们提供了定制这些设置的方法。
log标准库中的Flags函数会返回标准 logger 的输出配置，而SetFlags函数用来设置标准 logger 的输出配置。

func Flags() int
func SetFlags(flag int)

1.1.1 flag 选项

log标准库提供了如下的 flag 选项，它们是一系列定义好的常量。

const (
    // 控制输出日志信息的细节，不能控制输出的顺序和格式。
    // 输出的日志在每一项后会有一个冒号分隔：例如2009/01/23 01:23:23.123123 /a/b/c/d.go:23: message
    Ldate         = 1 << iota     // 日期：2009/01/23
    Ltime                         // 时间：01:23:23
    Lmicroseconds                 // 微秒级别的时间：01:23:23.123123（用于增强Ltime位）
    Llongfile                     // 文件全路径名+行号： /a/b/c/d.go:23
    Lshortfile                    // 文件名+行号：d.go:23（会覆盖掉Llongfile）
    LUTC                          // 使用UTC时间
    LstdFlags     = Ldate | Ltime // 标准logger的初始值
)

下面我们在记录日志之前先设置一下标准 logger 的输出选项如下：

func main() {
    log.SetFlags(log.Llongfile | log.Lmicroseconds | log.Ldate)
    log.Println("这是一条很普通的日志。")
}

编译执行后得到的输出结果如下：

2017/06/19 14:05:17.494943 .../log_demo/main.go:11: 这是一条很普通的日志。

1.1.2 配置日志前缀

log标准库中还提供了关于日志信息前缀的两个方法：

func Prefix() string
func SetPrefix(prefix string)

其中Prefix函数用来查看标准 logger 的输出前缀，SetPrefix函数用来设置输出前缀。

func main() {
    log.SetFlags(log.Llongfile | log.Lmicroseconds | log.Ldate)
    log.Println("这是一条很普通的日志。")
    log.SetPrefix("[小王子]")
    log.Println("这是一条很普通的日志。")
}

上面的代码输出如下：

[小王子]2017/06/19 14:05:57.940542 .../log_demo/main.go:13: 这是一条很普通的日志。

这样我们就能够在代码中为我们的日志信息添加指定的前缀，方便之后对日志信息进行检索和处理。

1.1.3 配置日志输出位置

func SetOutput(w io.Writer)

SetOutput函数用来设置标准 logger 的输出目的地，默认是标准错误输出。

例如，下面的代码会把日志输出到同目录下的xx.log文件中。

func main() {
    logFile, err := os.OpenFile("./xx.log", os.O_CREATE|os.O_WRONLY|os.O_APPEND, 0644)
    if err != nil {
        fmt.Println("open log file failed, err:", err)
        return
    }
    log.SetOutput(logFile)
    log.SetFlags(log.Llongfile | log.Lmicroseconds | log.Ldate)
    log.Println("这是一条很普通的日志。")
    log.SetPrefix("[小王子]")
    log.Println("这是一条很普通的日志。")
}

如果你要使用标准的 logger，我们通常会把上面的配置操作写到init函数中。

func init() {
    logFile, err := os.OpenFile("./xx.log", os.O_CREATE|os.O_WRONLY|os.O_APPEND, 0644)
    if err != nil {
        fmt.Println("open log file failed, err:", err)
        return
    }
    log.SetOutput(logFile)
    log.SetFlags(log.Llongfile | log.Lmicroseconds | log.Ldate)
}

1.2 创建 logger

log标准库中还提供了一个创建新 logger 对象的构造函数–New，支持我们创建自己的 logger 示例。New函数的签名如下：

func New(out io.Writer, prefix string, flag int) *Logger

New 创建一个 Logger 对象。其中，参数 out 设置日志信息写入的目的地。参数 prefix 会添加到生成的每一条日志前面。参数 flag 定义日志的属性（时间、文件等等）。

举个例子：

func main() {
    logger := log.New(os.Stdout, "<New>", log.Lshortfile|log.Ldate|log.Ltime)
    logger.Println("这是自定义的logger记录的日志。")
}

将上面的代码编译执行之后，得到结果如下：

<New>2017/06/19 14:06:51 main.go:34: 这是自定义的logger记录的日志。

1.3 总结

Go 内置的 log 库功能有限，例如无法满足记录不同级别日志的情况，我们在实际的项目中根据自己的需要选择使用第三方的日志库，如 logrus、zap 等。

2、第三方日志库

2.1 日志选型需求整理

日志写入性能
日志级别分离，并且可分离成多个日志文件
可读性与结构化，Json格式或有分隔符，方便后续的日志采集、监控等
能够打印基本信息，如调用文件 / 函数名和行号，日志时间等
日志书写友好，支持通过context自动log trace等
文件切割，可按小时、天进行日志拆分，或者按文件大小
文件定时删除
开源性，与其他开源框架支持较好
多输出－同时支持标准输出，文件等

2.2 日志比对

2.2.1 功能比对

参考文档：

https://www.jianshu.com/p/38a67ab593ee

https://zhuanlan.zhihu.com/p/141321801

zerolog：https://zhuanlan.zhihu.com/p/136296821

搜看的许多日志框架，最后剩下两款目前明显性能比较好的Uber开源的Zap和ZeroLog，参考github中开源项目日志引用情况和日志周边框架支持最终选用Zap。

需求点	go.uber.org/zap(国内一些开源项目见得比较多、性能也不错、推荐)	github.com/rs/zerolog
日志写入性能	较高	高
日志级别分离	支持	支持
可读性 (Json格式或有分隔符，方便后续的日志采集、监控等)	json格式	json格式
易用性：接入方便，书写方便（格式化），可Hook注入trace_id等	自动接入时间、代码信息、日志级别，支持Hook	可支持接入时间、代码信息、日志级别等，支持Hook
文件切割 (可按时间、文件大小日志拆分)	不支持，可通过lumberjack实现	支持
定时删除	支持	支持
多输出－同时支持标准输出，文件等	支持	支持

2.2.3 性能数据比对

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

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

image.png

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