golang框架gin的日志處理和zap lumberjack日志使用方式
gin框架好用,輪子也多,我也來(lái)豐富下內(nèi)容,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)
// 寫(xiě)入文件
src, err := os.OpenFile(fileName, os.O_APPEND|os.O_WRONLY, os.ModeAppend)
if err != nil {
fmt.Println("loggerToFile err==>", err)
}
// 實(shí)例化
logger := logrus.New()
// 設(shè)置輸出
logger.Out = src
// 設(shè)置日志級(jí)別
logger.SetLevel(logrus.DebugLevel)
// 設(shè)置 rotatelogs
logWriter, err := rotatelogs.New(
// 分割后的文件名稱(chēng)
fileName+".%Y%m%d.log",
// 生成軟鏈,指向最新日志文件
rotatelogs.WithLinkName(fileName),
// 設(shè)置最大保存時(shí)間(7天)
rotatelogs.WithMaxAge(7*24*time.Hour),
// 設(shè)置日志切割時(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) {
// 開(kāi)始時(shí)間
startTime := time.Now()
// 處理請(qǐng)求
c.Next()
// 結(jié)束時(shí)間
endTime := time.Now()
// 執(zhí)行時(shí)間
latencyTime := endTime.Sub(startTime)
// 請(qǐng)求方式
reqMethod := c.Request.Method
// 請(qǐng)求路由
reqUri := c.Request.RequestURI
// 狀態(tài)碼
statusCode := c.Writer.Status()
// 請(qǐng)求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" //開(kāi)發(fā)模式
filename = "logs/logs.log" // 日志存放路徑
//level = "debug" // 日志級(jí)別
level = zapcore.DebugLevel // 日志級(jí)別
max_size = 200 //最大存儲(chǔ)大小
max_age = 30 //最大存儲(chǔ)時(shí)間
max_backups = 7 //#備份數(shù)量
)
// 2 初始化Logger對(duì)象
func InitLogger() (err error) {
// 創(chuàng)建Core三大件,進(jìn)行初始化
writeSyncer := getLogWriter(filename, max_size, max_backups, max_age)
encoder := getEncoder()
// 創(chuàng)建核心-->如果是dev模式,就在控制臺(tái)和文件都打印,否則就只寫(xiě)到文件中
var core zapcore.Core
if mode == "dev" {
// 開(kāi)發(fā)模式,日志輸出到終端
consoleEncoder := zapcore.NewConsoleEncoder(zap.NewDevelopmentEncoderConfig())
// NewTee創(chuàng)建一個(gè)核心,將日志條目復(fù)制到兩個(gè)或多個(gè)底層核心中。
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 對(duì)象
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è)置時(shí)間格式
encoderConfig.EncodeTime = zapcore.ISO8601TimeEncoder
// 時(shí)間的key
encoderConfig.TimeKey = "time"
// 級(jí)別
encoderConfig.EncodeLevel = zapcore.CapitalLevelEncoder
// 顯示調(diào)用者信息
encoderConfig.EncodeCaller = zapcore.ShortCallerEncoder
// 返回json 格式的 日志編輯器
return zapcore.NewJSONEncoder(encoderConfig)
}
// 獲取切割的問(wèn)題,給初始化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ù),直接這樣寫(xiě)
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)計(jì)時(shí)間,記錄日志
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)閭魅雲(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 {
// 這個(gè)不必須,檢查是否存在斷開(kāi)的連接(broken pipe或者connection reset by peer)---------開(kāi)始--------
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ù)先準(zhǔn)備好的DumpRequest方法
httpRequest, _ := httputil.DumpRequest(c.Request, false)
if brokenPipe {
logger.Error(c.Request.URL.Path,
zap.Any("error", err),
zap.String("request", string(httpRequest)),
)
// 如果連接已斷開(kāi),我們無(wú)法向其寫(xiě)入狀態(tài)
c.Error(err.(error))
c.Abort()
return
}
// 這個(gè)不必須,檢查是否存在斷開(kāi)的連接(broken pipe或者connection reset by peer)---------結(jié)束--------
// 是否打印堆棧信息,使用的是debug.Stack(),傳入false,在日志中就沒(méi)有堆棧信息
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)),
)
}
// 有錯(cuò)誤,直接返回給前端錯(cuò)誤,前端直接報(bào)錯(cuò)
//c.AbortWithStatus(http.StatusInternalServerError)
// 該方式前端不報(bào)錯(cuò)
c.String(200, "訪問(wèn)出錯(cuò)了")
}
}()
c.Next()
}
}main.go 調(diào)用
r := gin.New() // 初始化logger middleware.InitLogger() // 兩個(gè)中間件加入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"}
總結(jié)
以上為個(gè)人經(jīng)驗(yàn),希望能給大家一個(gè)參考,也希望大家多多支持腳本之家。
- golang?日志庫(kù)ZAP[uber-go?zap]示例詳解
- golang整合日志zap的實(shí)現(xiàn)示例
- Golang日志操作庫(kù)zap的使用詳解
- GoLang基于zap日志庫(kù)的封裝過(guò)程詳解
- Golang定制化zap日志庫(kù)使用過(guò)程分析
- golang?xorm?自定義日志記錄器之使用zap實(shí)現(xiàn)日志輸出、切割日志(最新)
- golang默認(rèn)Logger日志庫(kù)在項(xiàng)目中使用Zap日志庫(kù)
- golang有用的庫(kù)及工具 之 zap.Logger包的使用指南
- 深入淺析golang zap 日志庫(kù)使用(含文件切割、分級(jí)別存儲(chǔ)和全局使用等)
- golang zap日志庫(kù)的具體使用
相關(guān)文章
golang中ants協(xié)程池使用和實(shí)現(xiàn)邏輯
本文主要介紹了golang中ants協(xié)程池使用和實(shí)現(xiàn)邏輯,實(shí)現(xiàn)了對(duì)大規(guī)模?goroutine?的調(diào)度管理、goroutine?復(fù)用,下面就來(lái)具體介紹一下,感興趣的可以了解一下2025-07-07
Go語(yǔ)言標(biāo)準(zhǔn)錯(cuò)誤error全面解析
Go語(yǔ)言中的錯(cuò)誤處理是通過(guò)內(nèi)置的error接口來(lái)實(shí)現(xiàn)的,其中errorString和wrapError是兩種常見(jiàn)的錯(cuò)誤類(lèi)型實(shí)現(xiàn)方式,errorString通過(guò)errors.New()方法實(shí)現(xiàn),而wrapError則通過(guò)fmt.Errorf()方法實(shí)現(xiàn),支持錯(cuò)誤的嵌套和解析2024-10-10
Golang仿ps實(shí)現(xiàn)獲取Linux進(jìn)程信息
這篇文章主要為大家學(xué)習(xí)介紹了Golang如何仿ps實(shí)現(xiàn)獲取Linux進(jìn)程信息,文中的示例代碼講解詳細(xì),感興趣的小伙伴可以跟隨小編一起了解一下2023-07-07
使用Golang創(chuàng)建單獨(dú)的WebSocket會(huì)話
WebSocket是一種在Web開(kāi)發(fā)中非常常見(jiàn)的通信協(xié)議,它提供了雙向、持久的連接,適用于實(shí)時(shí)數(shù)據(jù)傳輸和實(shí)時(shí)通信場(chǎng)景,本文將介紹如何使用 Golang 創(chuàng)建單獨(dú)的 WebSocket 會(huì)話,包括建立連接、消息傳遞和關(guān)閉連接等操作,需要的朋友可以參考下2023-12-12
淺談go語(yǔ)言閉包的立即執(zhí)行和不立即執(zhí)行
B站新一代 golang規(guī)則引擎gengine基礎(chǔ)語(yǔ)法

