Golang日志入门与技术选型

loglog

1、原生Logger

Print系列Fatal系列Panic系列

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配置

loglogFlagsSetFlags

func Flags() int
func SetFlags(flag int)

1.1.1 flag 选项

log

下面我们在记录日志之前先设置一下标准 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)

PrefixSetPrefix

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

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("这是一条很普通的日志。")
}

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

logNewNew

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 日志选型需求整理

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

2.2 日志比对

2.2.1 功能比对

参考文档：

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

2.2.3 性能数据比对

根据Uber-go Zap的文档，它的性能比类似的结构化日志包更好——也比标准库更快。 以下是Zap发布的基准测试信息 记录一条消息和10个字段:

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

下一篇我们会来讲讲高性能日志框架Zap的使用，以及如何满足我们对于日志框架丰富的使用需求，我们下期见，Peace

我是简凡，一个励志用最简单的语言，描述最复杂问题的新时代农民工。求点赞，求关注，如果你对此篇文章有什么疑惑，欢迎在我的微信公众号中留言，我还可以为你提供以下帮助：
- 帮助建立自己的知识体系
- 互联网真实高并发场景实战讲解
- 不定期分享Golang、Java相关业内的经典场景实践
我的博客：https://besthpt.github.io/
我的微信：bestbear666
微信公众号： "简凡丶"