golang中常見(jiàn)的logrus日志庫(kù)

更新時(shí)間：2023年05月25日 08:28:49 作者：博客猿馬甲哥

這篇文章主要介紹了golang中常見(jiàn)的logrus日志庫(kù)的相關(guān)資料,需要的朋友可以參考下

主謂賓定狀補(bǔ)

logrus是一個(gè)結(jié)構(gòu)化的、可插拔的、兼容golang標(biāo)準(zhǔn)log api的日志庫(kù)。

快速過(guò)一下能力

支持對(duì)output=TTY增加關(guān)鍵字顏色
內(nèi)置JSONFormatter和TextFormatter(默認(rèn))兩種Formatter
支持輸出logger所在的函數(shù)行位置 log.SetReportCaller(true)
可以兼容golang內(nèi)置的標(biāo)準(zhǔn)log庫(kù), 建議無(wú)腦替換
鼓勵(lì)輸出可解析的日志字段，而不是大段的無(wú)法結(jié)構(gòu)化的文本日志

log.WithFields(log.Fields{
 "event": event,
 "topic": topic,
 "key": key,
}).Fatal("Failed to send event")

基于現(xiàn)狀，湊了6個(gè)錢包上生產(chǎn)，下面給出一些自己的生產(chǎn)實(shí)踐。

添磚加瓦

1. logrus不支持滾動(dòng)日志

好馬配好鞍 https://github.com/lestrrat-go/file-rotatelogs 讓你下雨天不再哭泣。

它會(huì)根據(jù)配置自動(dòng)按照時(shí)間切分日志，并滾動(dòng)清理日志(不用配磁盤報(bào)警，不用擔(dān)心磁盤滿故障)。

logf, err := rotatelogs.New(
  	cfg.Log.LogDir+logName+".%Y%m%d%H%M",
  	rotatelogs.WithLinkName(cfg.Log.LogDir+logName),
  	rotatelogs.WithMaxAge(24*time.Hour),
  	rotatelogs.WithRotationTime(time.Hour),
  )
  if err != nil {
  	stdLog.Printf("failed to create rotatelogs: %s", err)
  	return
  }

2. 日志格式化

java生態(tài)默認(rèn)日志輸出格式：

11:44:44.827 WARN [93ef3E0120160803114444] [main] [ClassPathXmlApplicationContext] Exception encountered during context initialization - cancelling refresh attempt

在公司中javaer占據(jù)主流，故java的默認(rèn)格式就成了公司集中式日志的"標(biāo)準(zhǔn)"格式。

很明顯，logrus默認(rèn)的兩種Formatter都不匹配。

github.com/antonfisher/nested-logrus-formatter 讓你柳暗花明。

log.SetFormatter(&nested.Formatter{ // 嵌套日志兼容skynet日志格式
		HideKeys:        true,
		FieldsOrder:     []string{"region", "node", "topic"},
		TimestampFormat: "2006-01-02 15:04:05.000", // 顯示ms
	})

3. 自定義Hook用法：輸出默認(rèn)字段

寫本文的時(shí)候，發(fā)現(xiàn)logrus官方本身支持輸出默認(rèn)日志字段。
requestLogger := log.WithFields(log.Fields{"request_id": request_id, "user_ip": user_ip})
requestLogger.Warn("something not great happened")

Hook: 通常鉤子函數(shù)用于在觸發(fā)某種事件時(shí)附帶一些動(dòng)作。

logrus的Hook定義:logEntry滿足指定的logLevel日志時(shí)，你想要做的動(dòng)作(你甚至可以不設(shè)置output直接在hook輸出日志，這就是內(nèi)置write hook的實(shí)現(xiàn))。

type Hook interface {
	Levels() []Level
	Fire(*Entry) error
}

示例代碼為logLevel>=info的logEntry，固定了2個(gè)日志字段。

type FixedFieldHook struct {
	LogLevels  []logrus.Level
	FixedField map[string]string
}

// Fire will be called when some logging function is called with current hook
// It will format log entry to string and write it to appropriate writer
func (hook *FixedFieldHook) Fire(entry *logrus.Entry) error {
	for k, v := range hook.FixedField {
		entry.Data[k] = v
	}
	return nil
}

log.AddHook(&FixedFieldHook{ // Set fixed field
		FixedField: map[string]string{"region": cfg.LocalRegion, "node": ip},
		LogLevels: []logrus.Level{
			logrus.InfoLevel,
			logrus.ErrorLevel,
			logrus.WarnLevel,
			logrus.FatalLevel,
		},
	})

拋磚引玉，戰(zhàn)術(shù)臥倒。

到此這篇關(guān)于golang中常見(jiàn)的logrus日志庫(kù)的文章就介紹到這了,更多相關(guān)golang中l(wèi)ogrus日志庫(kù)內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: