Go logrus 日誌框架詳解
【導讀】本文介紹了 logrus 日誌庫和與 iris web 框架的結合。
logrus 特性
-
完全兼容 golang 標準庫日誌模塊：logrus 擁有六種日誌級別：debug、info、warn、error、fatal 和 panic，這是 golang 標準庫日誌模塊的 API 的超集。如果您的項目使用標準庫日誌模塊，完全可以以最低的代價遷移到 logrus 上。
-
可擴展的 Hook 機制：允許使用者通過 hook 的方式將日誌分發到任意地方，如本地文件系統、標準輸出、logstash、elasticsearch 或者 mq 等，或者通過 hook 定義日誌內容和格式等。
-
可選的日誌輸出格式：logrus 內置了兩種日誌格式，
JSONFormatter和TextFormatter，如果這兩個格式不滿足需求，可以自己動手實現接口Formatter，來定義自己的日誌格式。 -
Field 機制：logrus 鼓勵通過 Field 機制進行精細化的、結構化的日誌記錄，而不是通過冗長的消息來記錄日誌。
-
logrus 是一個可插拔的、結構化的日誌框架。
logrus 使用
簡單示例
package main
import (
log "github.com/sirupsen/logrus"
)
func main() {
log.WithFields(log.Fields{
"animal": "walrus",
}).Info("A walrus appears")
}輸出結果：
time="2018-08-11T15:42:22+08:00" level=info msg="A walrus appears" animal=walrus簡單配置
package main
import (
"os"
log "github.com/sirupsen/logrus"
)
func init() {
// 設置日誌格式爲json格式
log.SetFormatter(&log.JSONFormatter{})
// 設置將日誌輸出到標準輸出（默認的輸出爲stderr，標準錯誤）
// 日誌消息輸出可以是任意的io.writer類型
log.SetOutput(os.Stdout)
// 設置日誌級別爲warn以上
log.SetLevel(log.WarnLevel)
}
func main() {
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!")
}Logger
logger 是一種相對高級的用法, 對於一個大型項目, 往往需要一個全局的 logrus 實例，即logger對象來記錄項目所有的日誌。
package main
import (
"github.com/sirupsen/logrus"
"os"
)
// logrus提供了New()函數來創建一個logrus的實例。
// 項目中，可以創建任意數量的logrus實例。
var log = logrus.New()
func main() {
// 爲當前logrus實例設置消息的輸出，同樣地，
// 可以設置logrus實例的輸出到任意io.writer
log.Out = os.Stdout
// 爲當前logrus實例設置消息輸出格式爲json格式。
// 同樣地，也可以單獨爲某個logrus實例設置日誌級別和hook，這裏不詳細敘述。
log.Formatter = &logrus.JSONFormatter{}
log.WithFields(logrus.Fields{
"animal": "walrus",
"size": 10,
}).Info("A group of walrus emerges from the ocean")
}Fields
logrus 不推薦使用冗長的消息來記錄運行信息，它推薦使用Fields來進行精細化的、結構化的信息記錄。
log.WithFields(log.Fields{
"event": event,
"topic": topic,
"key": key,
}).Fatal("Failed to send event")前面的WithFields API 可以規範使用者按照其提倡的方式記錄日誌。但是WithFields依然是可選的，因爲某些場景下，使用者確實只需要記錄儀一條簡單的消息。
通常，在一個應用中、或者應用的一部分中，都有一些固定的Field。比如在處理用戶 http 請求時，上下文中，所有的日誌都會有request_id和user_ip。爲了避免每次記錄日誌都要使用log.WithFields(log.Fields{"request_id": request_id, "user_ip": user_ip})，我們可以創建一個logrus.Entry實例，爲這個實例設置默認Fields，在上下文中使用這個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")日誌本地文件分割
logrus 本身不帶日誌本地文件分割功能，但是我們可以通過file-rotatelogs進行日誌本地文件分割。每次當我們寫入日誌的時候，logrus 都會調用file-rotatelogs來判斷日誌是否要進行切分。
import (
"github.com/lestrrat-go/file-rotatelogs"
"github.com/rifflock/lfshook"
log "github.com/sirupsen/logrus"
"time"
)
func newLfsHook(logLevel *string, maxRemainCnt uint) log.Hook {
writer, err := rotatelogs.New(
logName+".%Y%m%d%H",
// WithLinkName爲最新的日誌建立軟連接，以方便隨着找到當前日誌文件
rotatelogs.WithLinkName(logName),
// WithRotationTime設置日誌分割的時間，這裏設置爲一小時分割一次
rotatelogs.WithRotationTime(time.Hour),
// WithMaxAge和WithRotationCount二者只能設置一個，
// WithMaxAge設置文件清理前的最長保存時間，
// WithRotationCount設置文件清理前最多保存的個數。
//rotatelogs.WithMaxAge(time.Hour*24),
rotatelogs.WithRotationCount(maxRemainCnt),
)
if err != nil {
log.Errorf("config local file system for logger error: %v", err)
}
level, ok := logLevels[*logLevel]
if ok {
log.SetLevel(level)
} else {
log.SetLevel(log.WarnLevel)
}
lfsHook := lfshook.NewHook(lfshook.WriterMap{
log.DebugLevel: writer,
log.InfoLevel: writer,
log.WarnLevel: writer,
log.ErrorLevel: writer,
log.FatalLevel: writer,
log.PanicLevel: writer,
}, &log.TextFormatter{DisableColors: true})
return lfsHook
}結合 IRIS 使用
先初始化一個 Logger 出來
config/config.go 定義一個 log 配置的結構體
type LogConfig struct {
Level string `yaml:"level"`
Path string `yaml:"path"`
Save uint `yaml:"save"`
}config/logger.go` 根據配置的日誌級別，日誌路徑，日誌保留天數初始化一個 Logger
package config
import (
"github.com/lestrrat-go/file-rotatelogs"
"github.com/rifflock/lfshook"
"github.com/sirupsen/logrus"
"os"
"path"
"time"
)
var (
Log = logrus.New()
)
func initLog(logConfig LogConfig) {
Log.Out = os.Stdout
var loglevel logrus.Level
err := loglevel.UnmarshalText([]byte(logConfig.Level))
if err != nil {
Log.Panicf("設置log級別失敗：%v", err)
}
Log.SetLevel(loglevel)
Log.Formatter = &logrus.TextFormatter{}
LocalFilesystemLogger(Log, logConfig.Path, logConfig.Save)
//Log.ReportCaller = true
}
func logWriter(logPath string, level string, save uint) *rotatelogs.RotateLogs {
logFullPath := path.Join(logPath, level)
logwriter, err := rotatelogs.New(
logFullPath+".%Y%m%d",
rotatelogs.WithLinkName(logFullPath), // 生成軟鏈，指向最新日誌文件
rotatelogs.WithRotationCount(save), // 文件最大保存份數
rotatelogs.WithRotationTime(24*time.Hour), // 日誌切割時間間隔
)
if err != nil {
panic(err)
}
return logwriter
}
func LocalFilesystemLogger(log *logrus.Logger, logPath string, save uint) {
lfHook := lfshook.NewHook(lfshook.WriterMap{
logrus.DebugLevel: logWriter(logPath, "debug", save), // 爲不同級別設置不同的輸出目的
logrus.InfoLevel: logWriter(logPath, "info", save),
logrus.WarnLevel: logWriter(logPath, "warn", save),
logrus.ErrorLevel: logWriter(logPath, "error", save),
logrus.FatalLevel: logWriter(logPath, "fatal", save),
logrus.PanicLevel: logWriter(logPath, "panic", save),
}, &logrus.JSONFormatter{})
log.AddHook(lfHook)
}再擼一箇中間件打印請求記錄middleware/logger_middleware.go
package middleware
import (
"bytes"
"github.com/dgrijalva/jwt-go"
"github.com/kataras/iris/v12"
"goms/config"
"io/ioutil"
"net/http"
"path"
"time"
)
func LoggerHandler(ctx iris.Context) {
p := ctx.Request().URL.Path
method := ctx.Request().Method
start := time.Now()
fields := make(map[string]interface{})
fields["title"] = "訪問日誌"
fields["fun_name"] = path.Join(method, p)
fields["ip"] = ctx.Request().RemoteAddr
fields["method"] = method
fields["url"] = ctx.Request().URL.String()
fields["proto"] = ctx.Request().Proto
//fields["header"] = ctx.Request().Header
fields["user_agent"] = ctx.Request().UserAgent()
fields["x_request_id"] = ctx.GetHeader("X-Request-Id")
// 如果是POST/PUT請求，並且內容類型爲JSON，則讀取內容體
if method == http.MethodPost || method == http.MethodPut || method == http.MethodPatch {
body, err := ioutil.ReadAll(ctx.Request().Body)
if err == nil {
defer ctx.Request().Body.Close()
buf := bytes.NewBuffer(body)
ctx.Request().Body = ioutil.NopCloser(buf)
fields["content_length"] = ctx.GetContentLength()
fields["body"] = string(body)
}
}
ctx.Next()
//下面是返回日誌
fields["res_status"] = ctx.ResponseWriter().StatusCode()
if ctx.Values().GetString("out_err") != "" {
fields["out_err"] = ctx.Values().GetString("out_err")
}
fields["res_length"] = ctx.ResponseWriter().Header().Get("size")
if v := ctx.Values().Get("res_body"); v != nil {
if b, ok := v.([]byte); ok {
fields["res_body"] = string(b)
}
}
token := ctx.Values().Get("jwt")
if token != nil {
fields["uid"] = token.(*jwt.Token).Claims
}
timeConsuming := time.Since(start).Nanoseconds() / 1e6
config.Log.WithFields(fields).Infof("[http] %s-%s-%s-%d(%dms)",
p, ctx.Request().Method, ctx.Request().RemoteAddr, ctx.ResponseWriter().StatusCode(), timeConsuming)
}加進路由route/route.go
package route
import (
"github.com/kataras/iris/v12"
"github.com/kataras/iris/v12/mvc"
"goms/controllers"
"goms/middleware"
)
func InitRoute(app *iris.Application) {
app.Use(middleware.LoggerHandler)
mvc.Configure(app.Party("/account"), func(m *mvc.Application) {
m.Handle(controllers.NewLoginController())
})
......
}最後感覺還是不咋好用，用 Json 格式不太好看，用 Text 格式又沒有時間，再尋找一下別的 Log 庫看看！
轉自：
wisp888.gitee.io/golang-iris-%E5%AD%A6%E4%B9%A0%E5%9B%9B-log%E6%97%A5%E5%BF%97.html
本文由 Readfog 進行 AMP 轉碼，版權歸原作者所有。
來源：https://mp.weixin.qq.com/s/UbGtIlNb6UjH389KntKkKw