快捷導航

golang框架gin的日志處理和zap lumberjack日志使用方式

更新時間：2024年01月17日 08:56:25 作者：可以吧可以吧

這篇文章主要介紹了golang框架gin的日志處理和zap lumberjack日志使用方式,具有很好的參考價值,希望對大家有所幫助,如有錯誤或未考慮完全的地方,望不吝賜教

gin自帶日志

新建logger.go

package logs
 
import (
	"fmt"
	"github.com/gin-gonic/gin"
	rotatelogs "github.com/lestrrat-go/file-rotatelogs"
	"github.com/rifflock/lfshook"
	"github.com/sirupsen/logrus"
	"os"
	"runtime"
	"time"
	"upload/config"
)
 
var ostype = runtime.GOOS
 
// 日志記錄到文件
func LoggerToFile() gin.HandlerFunc {
	logFileName := config.LOG_FILE_NAME
	fileName := config.LOG_FILE_PATH_LINUX + "/" + logFileName
 
	if ostype == "windows" {
		fileName = config.LOG_FILE_PATH_WIN + "\\" + logFileName
	} else if ostype == "linux" {
		fileName = config.LOG_FILE_PATH_LINUX + "/" + logFileName
	}
 
	 日志文件
	//fileName := path.Join(logFilePath, logFileName)
 
	// 寫入文件
	src, err := os.OpenFile(fileName, os.O_APPEND|os.O_WRONLY, os.ModeAppend)
	if err != nil {
		fmt.Println("loggerToFile err==>", err)
	}
 
	// 實例化
	logger := logrus.New()
 
	// 設(shè)置輸出
	logger.Out = src
 
	// 設(shè)置日志級別
	logger.SetLevel(logrus.DebugLevel)
 
	// 設(shè)置 rotatelogs
	logWriter, err := rotatelogs.New(
		// 分割后的文件名稱
		fileName+".%Y%m%d.log",
 
		// 生成軟鏈，指向最新日志文件
		rotatelogs.WithLinkName(fileName),
 
		// 設(shè)置最大保存時間(7天)
		rotatelogs.WithMaxAge(7*24*time.Hour),
 
		// 設(shè)置日志切割時間間隔(1天)
		rotatelogs.WithRotationTime(24*time.Hour),
	)
 
	writeMap := lfshook.WriterMap{
		logrus.InfoLevel:  logWriter,
		logrus.FatalLevel: logWriter,
		logrus.DebugLevel: logWriter,
		logrus.WarnLevel:  logWriter,
		logrus.ErrorLevel: logWriter,
		logrus.PanicLevel: logWriter,
	}
 
	lfHook := lfshook.NewHook(writeMap, &logrus.JSONFormatter{
		TimestampFormat: "2006-01-02 15:04:05",
	})
 
	// 新增鉤子
	logger.AddHook(lfHook)
 
	return func(c *gin.Context) {
		// 開始時間
		startTime := time.Now()
 
		// 處理請求
		c.Next()
 
		// 結(jié)束時間
		endTime := time.Now()
 
		// 執(zhí)行時間
		latencyTime := endTime.Sub(startTime)
 
		// 請求方式
		reqMethod := c.Request.Method
 
		// 請求路由
		reqUri := c.Request.RequestURI
 
		// 狀態(tài)碼
		statusCode := c.Writer.Status()
 
		// 請求IP
		clientIP := c.ClientIP()
 
		// 日志格式
		logger.WithFields(logrus.Fields{
			"status_code":  statusCode,
			"latency_time": latencyTime,
			"client_ip":    clientIP,
			"req_method":   reqMethod,
			"req_uri":      reqUri,
		}).Info()
	}
}
 
// 日志記錄到 MongoDB
func LoggerToMongo() gin.HandlerFunc {
	return func(c *gin.Context) {
 
	}
}
 
// 日志記錄到 ES
func LoggerToES() gin.HandlerFunc {
	return func(c *gin.Context) {
 
	}
}
 
// 日志記錄到 MQ
func LoggerToMQ() gin.HandlerFunc {
	return func(c *gin.Context) {
 
	}
}

mian.go 引用

engine.Use(middleware.LoggerToFile())

配置config/config.go

package config
const (
	//[log]
	LOG_FILE_PATH_LINUX = "/home/data/logs/upload/logs"
	LOG_FILE_PATH_WIN   = "\\home\\data\\logs\\upload\\logs\\"
	LOG_FILE_NAME       = "system.log"
)
 
var config = new(Config)
 
 
func Get() Config {
	return *config
}

zap lumberjack接管gin日志

新建logger.go

package logs
 
import (
	"github.com/gin-gonic/gin"
	"github.com/natefinch/lumberjack"
	"go.uber.org/zap"
	"go.uber.org/zap/zapcore"
	"net"
	"net/http/httputil"
	"os"
	"runtime/debug"
	"strings"
	"time"
)
 
// 1 定義一下logger使用的常量
const (
	mode     = "dev"                   //開發(fā)模式
	filename = "logs/logs.log" // 日志存放路徑
	//level       = "debug"       // 日志級別
	level       = zapcore.DebugLevel // 日志級別
	max_size    = 200                //最大存儲大小
	max_age     = 30                 //最大存儲時間
	max_backups = 7                  //#備份數(shù)量
)
 
// 2 初始化Logger對象
func InitLogger() (err error) {
	// 創(chuàng)建Core三大件，進行初始化
	writeSyncer := getLogWriter(filename, max_size, max_backups, max_age)
	encoder := getEncoder()
	// 創(chuàng)建核心-->如果是dev模式，就在控制臺和文件都打印，否則就只寫到文件中
	var core zapcore.Core
	if mode == "dev" {
		// 開發(fā)模式，日志輸出到終端
		consoleEncoder := zapcore.NewConsoleEncoder(zap.NewDevelopmentEncoderConfig())
		// NewTee創(chuàng)建一個核心，將日志條目復(fù)制到兩個或多個底層核心中。
		core = zapcore.NewTee(
			zapcore.NewCore(encoder, writeSyncer, level),
			zapcore.NewCore(consoleEncoder, zapcore.Lock(os.Stdout), level),
		)
	} else {
		core = zapcore.NewCore(encoder, writeSyncer, level)
	}
 
	//core := zapcore.NewCore(encoder, writeSyncer, level)
	// 創(chuàng)建 logger 對象
	log := zap.New(core, zap.AddCaller())
	// 替換全局的 logger, 后續(xù)在其他包中只需使用zap.L()調(diào)用即可
	zap.ReplaceGlobals(log)
	return
}
 
// 獲取Encoder，給初始化logger使用的
func getEncoder() zapcore.Encoder {
	// 使用zap提供的 NewProductionEncoderConfig
	encoderConfig := zap.NewProductionEncoderConfig()
	// 設(shè)置時間格式
	encoderConfig.EncodeTime = zapcore.ISO8601TimeEncoder
	// 時間的key
	encoderConfig.TimeKey = "time"
	// 級別
	encoderConfig.EncodeLevel = zapcore.CapitalLevelEncoder
	// 顯示調(diào)用者信息
	encoderConfig.EncodeCaller = zapcore.ShortCallerEncoder
	// 返回json 格式的 日志編輯器
	return zapcore.NewJSONEncoder(encoderConfig)
}
 
// 獲取切割的問題，給初始化logger使用的
func getLogWriter(filename string, maxSize, maxBackup, maxAge int) zapcore.WriteSyncer {
	// 使用 lumberjack 歸檔切片日志
	lumberJackLogger := &lumberjack.Logger{
		Filename:   filename,
		MaxSize:    maxSize,
		MaxBackups: maxBackup,
		MaxAge:     maxAge,
	}
	return zapcore.AddSync(lumberJackLogger)
}
 
// GinLogger 用于替換gin框架的Logger中間件，不傳參數(shù)，直接這樣寫
func GinLogger(c *gin.Context) {
	logger := zap.L()
	start := time.Now()
	path := c.Request.URL.Path
	query := c.Request.URL.RawQuery
	c.Next() // 執(zhí)行視圖函數(shù)
	// 視圖函數(shù)執(zhí)行完成，統(tǒng)計時間，記錄日志
	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 用于替換gin框架的Recovery中間件，因為傳入?yún)?shù)，再包一層
func GinRecovery(stack bool) gin.HandlerFunc {
	logger := zap.L()
	return func(c *gin.Context) {
		defer func() {
			// defer 延遲調(diào)用，出了異常，處理并恢復(fù)異常，記錄日志
			if err := recover(); err != nil {
				//  這個不必須，檢查是否存在斷開的連接(broken pipe或者connection reset by peer)---------開始--------
				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
						}
					}
				}
				//httputil包預(yù)先準備好的DumpRequest方法
				httpRequest, _ := httputil.DumpRequest(c.Request, false)
				if brokenPipe {
					logger.Error(c.Request.URL.Path,
						zap.Any("error", err),
						zap.String("request", string(httpRequest)),
					)
					// 如果連接已斷開，我們無法向其寫入狀態(tài)
					c.Error(err.(error))
					c.Abort()
					return
				}
				//  這個不必須，檢查是否存在斷開的連接(broken pipe或者connection reset by peer)---------結(jié)束--------
 
				// 是否打印堆棧信息，使用的是debug.Stack()，傳入false，在日志中就沒有堆棧信息
				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.String(200, "訪問出錯了")
			}
		}()
		c.Next()
	}
}

main.go 調(diào)用

	r := gin.New()
	// 初始化logger
	middleware.InitLogger()
	// 兩個中間件加入gin中
	r.Use(middleware.GinLogger, middleware.GinRecovery(true))

就可以看到日志了

2022-10-20T14:56:04.998+0800 INFO middleware/logger.go:92 /ping {"appid": "", "status": 200, "method": "GET", "path": "/ping", "query": "aa=1", "ip": "127.0.0.1", "user-agent": "PostmanRuntime/7.29.2", "errors": "", "cost":
"0s"}