zap接收gin框架默認(rèn)的日志并配置日志歸檔示例
更新時(shí)間：2022年04月16日 09:52:38 作者：Jeff的技術(shù)棧
本文介紹了在基于gin框架開(kāi)發(fā)的項(xiàng)目中如何配置并使用zap來(lái)接收并記錄gin框架默認(rèn)的日志和如何配置日志歸檔。有需要的朋友可以借鑒參考下，希望能夠有所幫助
使用zap接收gin框架默認(rèn)的日志并配置日志歸檔
我們?cè)诨趃in框架開(kāi)發(fā)項(xiàng)目時(shí)通常都會(huì)選擇使用專(zhuān)業(yè)的日志庫(kù)來(lái)記錄項(xiàng)目中的日志，go語(yǔ)言常用的日志庫(kù)有zap、logrus等.
但是我們?cè)撊绾卧谌罩局杏涗沢in框架本身輸出的那些日志呢？
gin默認(rèn)的中間件
首先我們來(lái)看一個(gè)最簡(jiǎn)單的gin項(xiàng)目：
func main() {
r := gin.Default()
r.GET("/hello", func(c *gin.Context) {
c.String("hello liwenzhou.com!")
})
r.Run(
}
接下來(lái)我們看一下gin.Default()的源碼：
func Default() *Engine {
debugPrintWARNINGDefault()
engine := New()
engine.Use(Logger(), Recovery())
return engine
}
也就是我們?cè)谑褂?code>gin.Default()的同時(shí)是用到了gin框架內(nèi)的兩個(gè)默認(rèn)中間件Logger()和Recovery()。
其中Logger()是把gin框架本身的日志輸出到標(biāo)準(zhǔn)輸出（我們本地開(kāi)發(fā)調(diào)試時(shí)在終端輸出的那些日志就是它的功勞），而Recovery()是在程序出現(xiàn)panic的時(shí)候恢復(fù)現(xiàn)場(chǎng)并寫(xiě)入500響應(yīng)的。
基于zap的中間件
我們可以模仿Logger()和Recovery()的實(shí)現(xiàn)，使用我們的日志庫(kù)來(lái)接收gin框架默認(rèn)輸出的日志。
這里以zap為例，我們實(shí)現(xiàn)兩個(gè)中間件如下：
// GinLogger 接收gin框架默認(rèn)的日志
func GinLogger(logger *zap.Logger) gin.HandlerFunc {
return func(c *gin.Context) {
start := time.Now()
path := c.Request.URL.Path
query := c.Request.URL.RawQuery
c.Next()
cost := time.Since(start)
logger.Info(path,
zap.Int("status", c.Writer.Status()),
zap.String("method", c.Request.Method),
zap.String("path", path),
zap.String("query", query),
zap.String("ip", c.ClientIP()),
zap.String("user-agent", c.Request.UserAgent()),
zap.String("errors", c.Errors.ByType(gin.ErrorTypePrivate).String()),
zap.Duration("cost", cost),
)
}
}
// GinRecovery recover掉項(xiàng)目可能出現(xiàn)的panic
func GinRecovery(logger *zap.Logger, stack bool) gin.HandlerFunc {
return func(c *gin.Context) {
defer func() {
if err := recover(); err != nil {
// Check for a broken connection, as it is not really a
// condition that warrants a panic stack trace.
var brokenPipe bool
if ne, ok := err.(*net.OpError); ok {
if se, ok := ne.Err.(*os.SyscallError); ok {
if strings.Contains(strings.ToLower(se.Error()), "broken pipe") || strings.Contains(strings.ToLower(se.Error()), "connection reset by peer") {
brokenPipe = true
}
}
}
httpRequest, _ := httputil.DumpRequest(c.Request, false)
if brokenPipe {
logger.Error(c.Request.URL.Path,
zap.Any("error", err),
zap.String("request", string(httpRequest)),
)
// If the connection is dead, we can't write a status to it.
c.Error(err.(error)) // nolint: errcheck
c.Abort()
return
}
if stack {
logger.Error("[Recovery from panic]",
zap.Any("error", err),
zap.String("request", string(httpRequest)),
zap.String("stack", string(debug.Stack())),
)
} else {
logger.Error("[Recovery from panic]",
zap.Any("error", err),
zap.String("request", string(httpRequest)),
)
}
c.AbortWithStatus(http.StatusInternalServerError)
}
}()
c.Next()
}
}
如果不想自己實(shí)現(xiàn)，可以使用github上有別人封裝好的https://github.com/gin-contrib/zap。
這樣我們就可以在gin框架中使用我們上面定義好的兩個(gè)中間件來(lái)代替gin框架默認(rèn)的Logger()和Recovery()了。
r := gin.New() r.Use(GinLogger(), GinRecovery())
在gin項(xiàng)目中使用zap
最后我們?cè)偌尤胛覀冺?xiàng)目中常用的日志切割，完整版的logger.go代碼如下：
package logger
import (
"gin_zap_demo/config"
"net"
"net/http"
"net/http/httputil"
"os"
"runtime/debug"
"strings"
"time"
"github.com/gin-gonic/gin"
"github.com/natefinch/lumberjack"
"go.uber.org/zap"
"go.uber.org/zap/zapcore"
)
var lg *zap.Logger
// InitLogger 初始化Logger
func InitLogger(cfg *config.LogConfig) (err error) {
writeSyncer := getLogWriter(cfg.Filename, cfg.MaxSize, cfg.MaxBackups, cfg.MaxAge)
encoder := getEncoder()
var l = new(zapcore.Level)
err = l.UnmarshalText([]byte(cfg.Level))
if err != nil {
return
}
core := zapcore.NewCore(encoder, writeSyncer, l)
lg = zap.New(core, zap.AddCaller())
zap.ReplaceGlobals(lg) // 替換zap包中全局的logger實(shí)例，后續(xù)在其他包中只需使用zap.L()調(diào)用即可
return
}
func getEncoder() zapcore.Encoder {
encoderConfig := zap.NewProductionEncoderConfig()
encoderConfig.EncodeTime = zapcore.ISO8601TimeEncoder
encoderConfig.TimeKey = "time"
encoderConfig.EncodeLevel = zapcore.CapitalLevelEncoder
encoderConfig.EncodeDuration = zapcore.SecondsDurationEncoder
encoderConfig.EncodeCaller = zapcore.ShortCallerEncoder
return zapcore.NewJSONEncoder(encoderConfig)
}
func getLogWriter(filename string, maxSize, maxBackup, maxAge int) zapcore.WriteSyncer {
lumberJackLogger := &lumberjack.Logger{
Filename: filename,
MaxSize: maxSize,
MaxBackups: maxBackup,
MaxAge: maxAge,
}
return zapcore.AddSync(lumberJackLogger)
}
// GinLogger 接收gin框架默認(rèn)的日志
func GinLogger() gin.HandlerFunc {
return func(c *gin.Context) {
start := time.Now()
path := c.Request.URL.Path
query := c.Request.URL.RawQuery
c.Next()
cost := time.Since(start)
lg.Info(path,
zap.Int("status", c.Writer.Status()),
zap.String("method", c.Request.Method),
zap.String("path", path),
zap.String("query", query),
zap.String("ip", c.ClientIP()),
zap.String("user-agent", c.Request.UserAgent()),
zap.String("errors", c.Errors.ByType(gin.ErrorTypePrivate).String()),
zap.Duration("cost", cost),
)
}
}
// GinRecovery recover掉項(xiàng)目可能出現(xiàn)的panic，并使用zap記錄相關(guān)日志
func GinRecovery(stack bool) gin.HandlerFunc {
return func(c *gin.Context) {
defer func() {
if err := recover(); err != nil {
// Check for a broken connection, as it is not really a
// condition that warrants a panic stack trace.
var brokenPipe bool
if ne, ok := err.(*net.OpError); ok {
if se, ok := ne.Err.(*os.SyscallError); ok {
if strings.Contains(strings.ToLower(se.Error()), "broken pipe") || strings.Contains(strings.ToLower(se.Error()), "connection reset by peer") {
brokenPipe = true
}
}
}
httpRequest, _ := httputil.DumpRequest(c.Request, false)
if brokenPipe {
lg.Error(c.Request.URL.Path,
zap.Any("error", err),
zap.String("request", string(httpRequest)),
)
// If the connection is dead, we can't write a status to it.
c.Error(err.(error)) // nolint: errcheck
c.Abort()
return
}
if stack {
lg.Error("[Recovery from panic]",
zap.Any("error", err),
zap.String("request", string(httpRequest)),
zap.String("stack", string(debug.Stack())),
)
} else {
lg.Error("[Recovery from panic]",
zap.Any("error", err),
zap.String("request", string(httpRequest)),
)
}
c.AbortWithStatus(http.StatusInternalServerError)
}
}()
c.Next()
}
}
然后定義日志相關(guān)配置：
type LogConfig struct {
Level string `json:"level"`
Filename string `json:"filename"`
MaxSize int `json:"maxsize"`
MaxAge int `json:"max_age"`
MaxBackups int `json:"max_backups"`
}
在項(xiàng)目中先從配置文件加載配置信息，再調(diào)用logger.InitLogger(config.Conf.LogConfig)即可完成logger實(shí)例的初識(shí)化。其中，通過(guò)r.Use(logger.GinLogger(), logger.GinRecovery(true))注冊(cè)我們的中間件來(lái)使用zap接收gin框架自身的日志，在項(xiàng)目中需要的地方通過(guò)使用zap.L().Xxx()方法來(lái)記錄自定義日志信息。
package main
import (
"fmt"
"gin_zap_demo/config"
"gin_zap_demo/logger"
"net/http"
"os"
"go.uber.org/zap"
"github.com/gin-gonic/gin"
)
func main() {
// load config from config.json
if len(os.Args) < 1 {
return
}
if err := config.Init(os.Args[1]); err != nil {
panic(err)
}
// init logger
if err := logger.InitLogger(config.Conf.LogConfig); err != nil {
fmt.Printf("init logger failed, err:%v\n", err)
return
}
gin.SetMode(config.Conf.Mode)
r := gin.Default()
// 注冊(cè)zap相關(guān)中間件
r.Use(logger.GinLogger(), logger.GinRecovery(true))
r.GET("/hello", func(c *gin.Context) {
// 假設(shè)你有一些數(shù)據(jù)需要記錄到日志中
var (
name = "q1mi"
age = 18
)
// 記錄日志并使用zap.Xxx(key, val)記錄相關(guān)字段
zap.L().Debug("this is hello func", zap.String("user", name), zap.Int("age", age))
c.String(http.StatusOK, "hello liwenzhou.com!")
})
addr := fmt.Sprintf(":%v", config.Conf.Port)
r.Run(addr)
}以上就是zap接收gin框架默認(rèn)的日志并配置日志歸檔示例的詳細(xì)內(nèi)容，更多關(guān)于zap日志gin框架默認(rèn)配置歸檔的資料請(qǐng)關(guān)注腳本之家其它相關(guān)文章！
相關(guān)文章
Go語(yǔ)言編程學(xué)習(xí)golang配置golint
這篇文章主要為大家介紹了Go語(yǔ)言編程學(xué)習(xí)golang配置golint的過(guò)程示例詳解，有需要的朋友可以借鑒參考下，希望能夠有所幫助，祝大家多多進(jìn)步，早日升職加薪2021-11-11
golang的context?主要用來(lái)在?goroutine?之間傳遞上下文信息，包括：取消信號(hào)、超時(shí)時(shí)間、截止時(shí)間、k-v?等，本文就詳細(xì)的來(lái)介紹一下golang的協(xié)程上下文的具體使用，感興趣的可以了解一下2022-04-04
Go?io/fs.FileMode文件系統(tǒng)基本操作和權(quán)限管理深入理解
這篇文章主要為大家介紹了Go?io/fs.FileMode文件系統(tǒng)基本操作和權(quán)限管理深入理解,有需要的朋友可以借鑒參考下,希望能夠有所幫助,祝大家多多進(jìn)步,早日升職加薪2024-01-01
這篇文章主要介紹了Go 內(nèi)存模型的相關(guān)資料,本文通過(guò)實(shí)例代碼給大家介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或工作具有一定的參考借鑒價(jià)值，需要的朋友可以參考下2020-12-12
在 Go 語(yǔ)言的 log 包中,使用“位運(yùn)算相或” (|) 來(lái)配置日志的 flag,可以讓我們靈活地組合多種日志信息輸出選項(xiàng),下面我們就來(lái)看看這種方法的好處和原理吧2024-11-11
或許您是從其他語(yǔ)言轉(zhuǎn)到GO語(yǔ)言這邊的,那麼在其他語(yǔ)言的影響下您可能會(huì)不太適應(yīng)GO語(yǔ)言的數(shù)組,因?yàn)镚O語(yǔ)言把數(shù)組給拆分成了array,slice和map,需要的朋友可以參考下2015-01-01
Golang錯(cuò)誤處理：異常捕捉和恢復(fù)機(jī)制
Golang中,異常處理是通過(guò) defer + panic + recover 的方式來(lái)實(shí)現(xiàn)的,使用 defer 可以將清理操作注冊(cè)到函數(shù)執(zhí)行完畢后執(zhí)行,而 panic 和 recover 可以用于處理異常,通過(guò)組合使用這些功能,可以實(shí)現(xiàn)更加健壯的程序2024-01-01
golang中接口對(duì)象的轉(zhuǎn)型兩種方式
這篇文章主要介紹了golang中接口對(duì)象的轉(zhuǎn)型方式，大家都知道接口對(duì)象的轉(zhuǎn)型有兩種方式，文中通過(guò)示例代碼給大家介紹的非常詳細(xì),需要的朋友可以參考下2021-10-10
詳解Go語(yǔ)言如何實(shí)現(xiàn)字符串切片反轉(zhuǎn)函數(shù)
Go?語(yǔ)言不像其他語(yǔ)言如?Python，有著內(nèi)置的?reverse()?函數(shù)，本文將先學(xué)習(xí)一下Python中對(duì)于列表的反轉(zhuǎn)方法，然后再學(xué)習(xí)如果在Go語(yǔ)言中實(shí)現(xiàn)相同的功能，感興趣的小伙伴快跟隨小編一起來(lái)學(xué)習(xí)一下2022-10-10
Go語(yǔ)言實(shí)現(xiàn)ssh&scp的方法詳解
這篇文章主要為大家詳細(xì)介紹了如何利用Go語(yǔ)言實(shí)現(xiàn)ssh&scp，文中的示例代碼講解詳細(xì)，具有一定的參考價(jià)值，感興趣的小伙伴可以了解一下2022-10-10