在Golang中使用日志模块

程序编写过程中，日志非常重要，养成打印日志的习惯，可以帮你在程序编写过程中，少走很多弯路。

日志通常必须包含以下三个重要的内容：

1，发生事件的时间戳

2，日志的级别，debug，error或info等

3，日志的上下文内容，协助问题的排查

日志固然很重要，但有些内容并不适合或者说不需要打印在日志内容中，否则不仅占用存储空间，而且会干扰问题的排查。下面内容就不适合打印到日志中：

- 名字

- IP地址

- 信用卡号码或者任何敏感信息

Golang标准库中自带的log包

log包提供基本的日志功能，但是没有提供日志级别（比如debug、warning、error）,

package main

import "log"

func main() {

     log.Println("Content from log package!")

}

上面的代码会打印出“Content from log package!”到标准输出中，和“fmt”不同的是，日志开头会带上时间信息，

2020/07/09 12:20:53 Content from log package!

默认情况下，日志会打印到标准错误输出中，通过配置可以打印在文件中，这是常用的方式。

输出日志到文件

如果需要输出内容到文件，创建一个新的文件或者打开一个已存在的文件并设置其为日志的输出，

package main

import (

    "log"

    "os"

)


func main() {

    // 如果文件logs.txt不存在，会自动创建

    file, err := os.OpenFile("logs.txt", os.O_APPEND|os.O_CREATE|os.O_WRONLY, 0666)

    if err != nil {

        log.Fatal(err)

    }

    log.SetOutput(file)

    log.Println("Content from log package!")

}

准确的说，只要实现接口io.Writer的类型都可以作为文件的输出。

产生自定义的loggers

log包实现一个预定义的logger，其写日志到标准错误输出，可以使用log.New()实现自定义的logger，

使用logger产生自定义的logger，需要传递下面三个参数，

- out：任何实现io.Writer接口的类型，它是日志输出的目的地

- prefix：这个字符串将附在每条日志的开头

- flag：常量集合，允许定义日志的属性

下面是一个logger的例子，实现了Info、Warning和Error：

package main

import (

    "log"

    "os"

)

var (

    WarningLogger *log.Logger

    InfoLogger    *log.Logger

    ErrorLogger   *log.Logger

)
func init() {

    file, err := os.OpenFile("logs.txt", os.O_APPEND|os.O_CREATE|os.O_WRONLY, 0666)

    if err != nil {

        log.Fatal(err)

    }
  InfoLogger = log.New(file, "INFO: ", log.Ldate|log.Ltime|log.Lshortfile)

    WarningLogger = log.New(file, "WARNING: ", log.Ldate|log.Ltime|log.Lshortfile)

    ErrorLogger = log.New(file, "ERROR: ", log.Ldate|log.Ltime|log.Lshortfile)

}

func main() {

    InfoLogger.Println("Starting the application...")

    InfoLogger.Println("Something noteworthy happened")

    WarningLogger.Println("There is something you should know about")

    ErrorLogger.Println("Something went wrong")

}

运行后，将在日志文件logs.txt中输出如下内容，

INFO: 2020/07/09 12:20:53 main.go:26: Starting the application...

INFO: 2020/07/09 12:20:53 main.go:27: Something noteworthy happened

WARNING: 2020/07/09 12:20:53 12:01:06 main.go:28: There is something you should know about

ERROR: 2020/07/09 12:20:53 main.go:29: Something went wrong

上面的例子中，我们将各个级别的日志都打印到了一个文件中，如果每个logger对应一个单独的文件，也是可以的。

Log flags

使用flags可以丰富日志文件信息，比如提供输出日志的文件名、行号、日期和时间。例如，日志的正文是“Something went wrong”，定义一个logger，它的flag参数为“log.Ldate|log.Ltime|log.Lshortfile”，日志输出的完整内容如下：

2020/07/09 12:20:53 main.go:29: Something went wrong

不过需要注意一点，flag不能控制其输出内容的顺序。

日志框架

使用日志框架可以标准化日志数据，就是说，

- 更容易地阅读和理解日志数据

- 更容易从不同的源收集日志并转储到一个中心化的平台用于分析

选择一个logging框架

两个常见的日志框架是glog和logrus。glog比较流行，但是近几年没有再持续更新。logrus维护的很好，很多流行的项目都有使用，比如大名鼎鼎的Docker，后面将着重介绍logrus。

logrus

logrus的安装比较简单，

go get "github.com/Sirupsen/logrus"

一个非常好的事情是，logrus和标准的log包是完全兼容的，可以用logrus完全替代log，

log "github.com/sirupsen/logrus"

对上面的例子进行改写，

package main

import (

  log "github.com/sirupsen/logrus"

)

func main() {

    log.Println("Content from logrus package!")

}

运行这段代码将打印如下内容，

INFO[0000] Content from logrus package!

真的，不能再简单了！

输出JSON格式的日志

JSON格式的日志虽然不太适合阅读，但却非常适合分析服务使用。使用logrus可以方便的实现JSON格式的日志输出，

package main

import (

    log "github.com/sirupsen/logrus"

)
func main() {

    log.SetFormatter(&log.JSONFormatter{})

    log.WithFields(

        log.Fields{

            "foo": "foo",

            "bar": "bar",

        },

    ).Info("Something happened")

}

代码的输出如下，

{"bar":"bar","foo":"foo","level":"info","msg":"Something happened","time":"2019-12-09T15:55:24+01:00"}

这样，非常便于存储日志在Elasticsearch中。

logrus支持日志级别，这点是标准包log所不具备的。logrus有多种日志级别：Trace、Debug、Info、Warn、Error、Fatal和Panic：

log.Trace("Something very low level.")

log.Debug("Useful debugging information.")

log.Info("Something noteworthy happened!")

log.Warn("You should probably take a look at this.")

log.Error("Something failed but I'm not quitting.")

// Calls os.Exit(1) after logging

log.Fatal("Bye.")

// Calls panic() after logging

log.Panic("I'm bailing.")

通过在logger中设置日志级别，可以根据环境输出日志项。默认logrus打印出Info及其更高项（Warn、Error、Fatal、Panic）

package main

import (

    log "github.com/sirupsen/logrus"

)

func main() {

    log.SetFormatter(&log.JSONFormatter{})

    log.Debug("Useful debugging information.")

    log.Info("Something noteworthy happened!")

    log.Warn("You should probably take a look at this.")

    log.Error("Something failed but I'm not quitting.")

}

运行上面代码将输出下面内容，

{"level":"info","msg":"Something noteworthy happened!","time":"2019-12-09T16:18:21+01:00"}

{"level":"warning","msg":"You should probably take a look at this.","time":"2019-12-09T16:18:21+01:00"}

{"level":"error","msg":"Something failed but I'm not quitting.","time":"2019-12-09T16:18:21+01:00"}

Debug级别的日志没有打印出，如果要输出，可以配置log.Level等于log.DebugLevel，

log.SetLevel(log.DebugLevel)

关于Golang的日志就介绍到这里，希望能帮到你！