Go第三方日誌庫logrus

BigSun丶發表於2024-03-18
Go

目錄
  • Go第三方日誌庫logrus
  • 一、logrus介紹
  • 二、安裝
  • 三、基本示例
  • 四、進階示例
  • 五、日誌級別
  • 六、設定日誌級別
  • 七、欄位
  • 八、預設欄位
  • 九、日誌條目
  • 十、Hooks
  • 十一、格式化
  • 十二、記錄函式名

Go第三方日誌庫logrus

  • 日誌是程式中必不可少的一個環節，由於Go語言內建的日誌庫功能比較簡潔，我們在實際開發中通常會選擇使用第三方的日誌庫來進行開發。本文介紹了logrus這個日誌庫的基本使用。

一、logrus介紹

  • Logrus是Go（golang）的結構化logger，與標準庫logger完全API相容。

  • 它有以下特點：

    • 完全相容標準日誌庫，擁有七種日誌級別：Trace, Debug, Info, Warning, Error, Fataland Panic。

    • 可擴充套件的Hook機制，允許使用者透過Hook的方式將日誌分發到任意地方，如本地檔案系統，logstash，elasticsearch或者mq等，或者透過Hook定義日誌內容和格式等

    • 可選的日誌輸出格式，內建了兩種日誌格式JSONFormater和TextFormatter，還可以自定義日誌格式

    • Field機制，透過Filed機制進行結構化的日誌記錄

    • 執行緒安全

二、安裝

go get github.com/sirupsen/logrus

三、基本示例

  • 使用Logrus最簡單的方法是簡單的包級匯出日誌程式:
package main
 
import (
  log "github.com/sirupsen/logrus"
)
 
func main() {
  log.WithFields(log.Fields{
    "animal": "dog",
  }).Info("一條舔狗出現了。")
}

四、進階示例

  • 對於更高階的用法，例如在同一應用程式記錄到多個位置，你還可以建立logrus Logger的例項：
package main
 
import (
  "os"
  "github.com/sirupsen/logrus"
)
 
// 建立一個新的logger例項。可以建立任意多個。
var log = logrus.New()
 
func main() {
  // 設定日誌輸出為os.Stdout
  log.Out = os.Stdout
 
  // 可以設定像檔案等任意`io.Writer`型別作為日誌輸出
  // file, err := os.OpenFile("logrus.log", os.O_CREATE|os.O_WRONLY|os.O_APPEND, 0666)
  // if err == nil {
  //  log.Out = file
  // } else {
  //  log.Info("Failed to log to file, using default stderr")
  // }
 
  log.WithFields(logrus.Fields{
    "animal": "dog",
    "size":   10,
  }).Info("一群舔狗出現了。")
}

五、日誌級別

  • Logrus有七個日誌級別：Trace, Debug, Info, Warning, Error, Fataland 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.")
// 記完日誌後會呼叫os.Exit(1) 
log.Fatal("Bye.")
// 記完日誌後會呼叫 panic() 
log.Panic("I'm bailing.")

六、設定日誌級別

  • 你可以在Logger上設定日誌記錄級別，然後它只會記錄具有該級別或以上級別任何內容的條目：
// 會記錄info及以上級別 (warn, error, fatal, panic)
log.SetLevel(log.InfoLevel)
  • 如果你的程式支援debug或環境變數模式，設定log.Level = logrus.DebugLevel會很有幫助。

七、欄位

  • Logrus鼓勵透過日誌欄位進行謹慎的結構化日誌記錄，而不是冗長的、不可解析的錯誤訊息。

  • 例如，區別於使用log.Fatalf("Failed to send event %s to topic %s with key %d")，你應該使用如下方式記錄更容易發現的內容:

log.WithFields(log.Fields{
  "event": event,
  "topic": topic,
  "key": key,
}).Fatal("Failed to send event")
  • WithFields的呼叫是可選的。

八、預設欄位

  • 通常，將一些欄位始終附加到應用程式的全部或部分的日誌語句中會很有幫助。例如，你可能希望始終在請求的上下文中記錄request_id和user_ip。

  • 區別於在每一行日誌中寫上log.WithFields(log.Fields{"request_id": request_id, "user_ip": user_ip})，你可以向下面的示例程式碼一樣建立一個logrus.Entry去傳遞這些欄位。

requestLogger := log.WithFields(log.Fields{"request_id": request_id, "user_ip": user_ip})
requestLogger.Info("something happened on that request") # will log request_id and user_ip
requestLogger.Warn("something not great happened")

九、日誌條目

  • 除了使用WithField或WithFields新增的欄位外，一些欄位會自動新增到所有日誌記錄事中:

    • time：記錄日誌時的時間戳

    • msg：記錄的日誌資訊

    • level：記錄的日誌級別

十、Hooks

  • 你可以新增日誌級別的鉤子（Hook）。例如，向異常跟蹤服務傳送Error、Fatal和Panic、資訊到StatsD或同時將日誌傳送到多個位置，例如syslog。

  • Logrus配有內建鉤子。在init中新增這些內建鉤子或你自定義的鉤子：

import (
  log "github.com/sirupsen/logrus"
  "gopkg.in/gemnasium/logrus-airbrake-hook.v2" // the package is named "airbrake"
  logrus_syslog "github.com/sirupsen/logrus/hooks/syslog"
  "log/syslog"
)
 
func init() {
 
  // Use the Airbrake hook to report errors that have Error severity or above to
  // an exception tracker. You can create custom hooks, see the Hooks section.
  log.AddHook(airbrake.NewHook(123, "xyz", "production"))
 
  hook, err := logrus_syslog.NewSyslogHook("udp", "localhost:514", syslog.LOG_INFO, "")
  if err != nil {
    log.Error("Unable to connect to local syslog daemon")
  } else {
    log.AddHook(hook)
  }
}
  • 注意：Syslog鉤子還支援連線到本地syslog（例如. “/dev/log” or “/var/run/syslog” or “/var/run/log”)。有關詳細資訊，請檢視syslog hook README。

十一、格式化

  • logrus內建以下兩種日誌格式化程式：
logrus.TextFormatter 和 logrus.JSONFormatter
  • 還支援一些第三方的格式化程式，詳見專案首頁。

十二、記錄函式名

  • 如果你希望將呼叫的函式名新增為欄位，請透過以下方式設定：
log.SetReportCaller(true)
  • 這會將呼叫者新增為”method”，如下所示：
{"animal":"penguin","level":"fatal","method":"github.com/sirupsen/arcticcreatures.migrate","msg":"a penguin swims by",
"time":"2014-03-10 19:57:38.562543129 -0400 EDT"}

注意：，開啟這個模式會增加效能開銷。
 
// 執行緒安全

- 預設的logger在併發寫的時候是被mutex保護的，比如當同時呼叫hook和寫log時mutex就會被請求，有另外一種情況，檔案是以appending mode開啟的，
此時的併發操作就是安全的，可以用
logger.SetNoLock()
來關閉它。
 
// gin框架使用logrus
 

// a gin with logrus demo
 
var log = logrus.New()
 
func init() {
	// Log as JSON instead of the default ASCII formatter.
	log.Formatter = &logrus.JSONFormatter{}
	// Output to stdout instead of the default stderr
	// Can be any io.Writer, see below for File example
	f, _ := os.Create("./gin.log")
	log.Out = f
	gin.SetMode(gin.ReleaseMode)
	gin.DefaultWriter = log.Out
	// Only log the warning severity or above.
	log.Level = logrus.InfoLevel
}
 
func main() {
	// 建立一個預設的路由引擎
	r := gin.Default()
	// GET：請求方式；/hello：請求的路徑
	// 當客戶端以GET方法請求/hello路徑時，會執行後面的匿名函式
	r.GET("/hello", func(c *gin.Context) {
		log.WithFields(logrus.Fields{
			"animal": "walrus",
			"size":   10,
		}).Warn("A group of walrus emerges from the ocean")
		// c.JSON：返回JSON格式的資料
		c.JSON(200, gin.H{
			"message": "Hello world!",
		})
	})
	// 啟動HTTP服務，預設在0.0.0.0:8080啟動服務
	r.Run()
}

logger.SetNoLock()

相關文章