Golang logrus 日志包及日志切割的實現(xiàn)

本文主要介紹 Golang 中最佳日志解決方案，包括常用日志包logrus 的基本使用，如何結(jié)合file-rotatelogs 包實現(xiàn)日志文件的輪轉(zhuǎn)切割兩大話題。

Golang 關(guān)于日志處理有很多包可以使用，標(biāo)準(zhǔn)庫提供的 log 包功能比較少，不支持日志級別的精確控制，自定義添加日志字段等。在眾多的日志包中，更推薦使用第三方的 logrus 包，完全兼容自帶的 log 包。logrus 是目前 Github 上 star 數(shù)量最多的日志庫，logrus 功能強大，性能高效，而且具有高度靈活性，提供了自定義插件的功能。

很多開源項目，如 docker，prometheus，dejavuzhou/ginbro 等，都是用了 logrus 來記錄其日志。

logrus 特性

• 完全兼容 golang 標(biāo)準(zhǔn)庫日志模塊：logrus 擁有六種日志級別：debug、info、warn、error、fatal 和 panic，這是 golang 標(biāo)準(zhǔn)庫日志模塊的 API 的超集。
• logrus.Debug(“Useful debugging information.”)
• logrus.Info(“Something noteworthy happened!”)
• logrus.Warn(“You should probably take a look at this.”)
• logrus.Error(“Something failed but I'm not quitting.”)
• logrus.Fatal(“Bye.”) //log之后會調(diào)用os.Exit(1)
• logrus.Panic(“I'm bailing.”) //log之后會panic()
• 可擴展的 Hook 機制：允許使用者通過 hook 的方式將日志分發(fā)到任意地方，如本地文件系統(tǒng)、標(biāo)準(zhǔn)輸出、logstash、elasticsearch 或者 mq 等，或者通過 hook 定義日志內(nèi)容和格式等。
• 可選的日志輸出格式：logrus 內(nèi)置了兩種日志格式，JSONFormatter 和 TextFormatter，如果這兩個格式不滿足需求，可以自己動手實現(xiàn)接口 Formatter 接口來定義自己的日志格式。
• Field 機制：logrus 鼓勵通過 Field 機制進行精細(xì)化的、結(jié)構(gòu)化的日志記錄,而不是通過冗長的消息來記錄日志。
• logrus 是一個可插拔的、結(jié)構(gòu)化的日志框架。
• Entry: logrus.WithFields 會自動返回一個 *Entry，Entry里面的有些變量會被自動加上
• time:entry被創(chuàng)建時的時間戳
• msg:在調(diào)用.Info()等方法時被添加
• level，當(dāng)前日志級別

logrus 基本使用

package main

import (
  "os"

  "github.com/sirupsen/logrus"
  log "github.com/sirupsen/logrus"
)

var logger *logrus.Entry

func init() {
  // 設(shè)置日志格式為json格式
  log.SetFormatter(&log.JSONFormatter{})
  log.SetOutput(os.Stdout)
  log.SetLevel(log.InfoLevel)
  logger = log.WithFields(log.Fields{"request_id": "123444", "user_ip": "127.0.0.1"})
}

func main() {
  logger.Info("hello, logrus....")
  logger.Info("hello, logrus1....")
  // log.WithFields(log.Fields{
  // "animal": "walrus",
  // "size":  10,
  // }).Info("A group of walrus emerges from the ocean")

  // log.WithFields(log.Fields{
  // "omg":  true,
  // "number": 122,
  // }).Warn("The group's number increased tremendously!")

  // log.WithFields(log.Fields{
  // "omg":  true,
  // "number": 100,
  // }).Fatal("The ice breaks!")
}

基于 logrus 和 file-rotatelogs 包實現(xiàn)日志切割

很多時候應(yīng)用會將日志輸出到文件系統(tǒng)，對于訪問量大的應(yīng)用來說日志的自動輪轉(zhuǎn)切割管理是個很重要的問題，如果應(yīng)用不能妥善處理日志管理，那么會帶來很多不必要的維護開銷：外部工具切割日志、人工清理日志等手段確保不會將磁盤打滿。

file-rotatelogs: When you integrate this to to you app, it automatically write to logs that are rotated from within the app: No more disk-full alerts because you forgot to setup logrotate!

logrus 本身不支持日志輪轉(zhuǎn)切割功能，需要配合 file-rotatelogs 包來實現(xiàn)，防止日志打滿磁盤。file-rotatelogs 實現(xiàn)了 io.Writer 接口，并且提供了文件的切割功能，其實例可以作為 logrus 的目標(biāo)輸出，兩者能無縫集成，這也是 file-rotatelogs 的設(shè)計初衷：

It's normally expected that this library is used with some other logging service, such as the built-in log library, or loggers such as github.com/lestrrat-go/apache-logformat.

示例代碼：

應(yīng)用日志文件 /Users/opensource/test/go.log，每隔 1 分鐘輪轉(zhuǎn)一個新文件，保留最近 3 分鐘的日志文件，多余的自動清理掉。

package main

import (
 "time"

 rotatelogs "github.com/lestrrat-go/file-rotatelogs"
 log "github.com/sirupsen/logrus"
)

func init() {
 path := "/Users/opensource/test/go.log"
 /* 日志輪轉(zhuǎn)相關(guān)函數(shù)
 `WithLinkName` 為最新的日志建立軟連接
 `WithRotationTime` 設(shè)置日志分割的時間，隔多久分割一次
 WithMaxAge 和 WithRotationCount二者只能設(shè)置一個
  `WithMaxAge` 設(shè)置文件清理前的最長保存時間
  `WithRotationCount` 設(shè)置文件清理前最多保存的個數(shù)
 */
 // 下面配置日志每隔 1 分鐘輪轉(zhuǎn)一個新文件，保留最近 3 分鐘的日志文件，多余的自動清理掉。
 writer, _ := rotatelogs.New(
 path+".%Y%m%d%H%M",
 rotatelogs.WithLinkName(path),
 rotatelogs.WithMaxAge(time.Duration(180)*time.Second),
 rotatelogs.WithRotationTime(time.Duration(60)*time.Second),
 )
 log.SetOutput(writer)
 //log.SetFormatter(&log.JSONFormatter{})
}

func main() {
 for {
 log.Info("hello, world!")
 time.Sleep(time.Duration(2) * time.Second)
 }
}

Golang 標(biāo)準(zhǔn)日志庫 log 使用

雖然 Golang 標(biāo)準(zhǔn)日志庫功能少，但是可以選擇性的了解下，下面為基本使用的代碼示例，比較簡單：

package main

import (
  "fmt"
  "log"
)

func init() {
  log.SetPrefix("【UserCenter】")              // 設(shè)置每行日志的前綴
  log.SetFlags(log.LstdFlags | log.Lshortfile | log.LUTC) // 設(shè)置日志的抬頭字段
}

func main() {
  log.Println("log...")
  log.Fatalln("Fatal Error...")
  fmt.Println("Not print!")
}

自定義日志輸出

package main

import (
  "io"
  "log"
  "os"
)

var (
  Info  *log.Logger
  Warning *log.Logger
  Error  *log.Logger
)

func init() {
  errFile, err := os.OpenFile("errors.log", os.O_CREATE|os.O_WRONLY|os.O_APPEND, 0666)
  if err != nil {
    log.Fatalln("打開日志文件失?。?, err)
  }

  Info = log.New(os.Stdout, "Info:", log.Ldate|log.Ltime|log.Lshortfile)
  Warning = log.New(os.Stdout, "Warning:", log.Ldate|log.Ltime|log.Lshortfile)
  Error = log.New(io.MultiWriter(os.Stderr, errFile), "Error:", log.Ldate|log.Ltime|log.Lshortfile)
}

func main() {
  Info.Println("Info log...")
  Warning.Printf("Warning log...")
  Error.Println("Error log...")
}

相關(guān)文檔

https://mojotv.cn/2018/12/27/golang-logrus-tutorial
https://github.com/lestrrat-go/file-rotatelogs
https://www.flysnow.org/2017/05/06/go-in-action-go-log.html

以上就是本文的全部內(nèi)容，希望對大家的學(xué)習(xí)有所幫助，也希望大家多多支持億速云。