gin框架結合zap記錄專案報錯的錯誤詳情
阿新 • • 發佈：2021-02-19
日誌的記錄
1、官方的方式
func main() {
// log
gin.DisableConsoleColor()
f, _ := os.Create("logs/gin.log")
gin.DefaultWriter = io.MultiWriter(f,os.Stdout)
r := gin.Default()
r.GET("/hello",sayHi)
r.GET("/bye",sayBye)
err :=r.Run()
if err !=nil{
log.Fatal("gin run wrong" 2、使用zap接收gin框架預設的日誌並配置日誌歸檔
// 安裝 lumberjack，zap
go get -u github.com/natefinch/lumberjack
go get -u go.uber.org/zap
註冊中介軟體的操作在router.SetupRouter()中：
package router
import (
"fmt"
"gin_demo/logger"
"github.com/gin-gonic/gin"
"time"
)
func SetupRouter() * zap庫的設定操作在logger.go
package logger
import (
"gin_demo/config" // 配置檔案
"github.com/gin-gonic/gin"
"github.com/natefinch/lumberjack"
"go.uber.org/zap"
"go.uber.org/zap/zapcore"
"net"
"net/http"
"net/http/httputil"
"os"
"runtime/debug"
"strings"
"time"
)
var Logger *zap.Logger
// InitLogger 初始化Logger
func InitLogger(cfg *config.LogConfig) (err error) {
writeSyncer := getLogWriter(cfg.Filename, cfg.MaxSize, cfg.MaxBackups, cfg.MaxAge)
encoder := getEncoder()
// for human operators.
var l = new(zapcore.Level)
err = l.UnmarshalText([]byte(cfg.Level))
if err != nil {
return
}
// 列印到控制檯和日誌檔案
core := zapcore.NewCore(encoder,
zapcore.NewMultiWriteSyncer(zapcore.AddSync(os.Stderr), writeSyncer),
l)
Logger = zap.New(core, zap.AddCaller())
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框架預設的日誌
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掉專案可能出現的panic，並使用zap記錄相關日誌
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()
}
}
配置檔案config.go
package config
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"`
}
專案啟動檔案main.go
package main
import (
"fmt"
"gin_demo/config"
"gin_demo/logger"
"gin_demo/router"
"github.com/gin-gonic/gin"
"log"
"net/http"
)
type user struct {
Name string `json:"name"`
Age int
}
func sayHi(c *gin.Context) {
c.JSON(http.StatusOK, gin.H{
"message": "hello gin",
})
}
func sayBye(c *gin.Context) {
c.JSON(http.StatusOK, user{"bob", 22})
}
func main() {
// log
// 這隻日誌的配置內容
logConf := config.LogConfig{Level: "info", Filename: "logs/zap_gin.log", MaxSize: 1, MaxAge: 30, MaxBackups: 5}
// 初始化
if err := logger.InitLogger(&logConf); err != nil {
fmt.Printf("init logger failed, err:%v\n", err)
return
}
r := gin.New()
r = router.SetupRouter()
err := r.Run(":8888")
if err != nil {
log.Fatal("gin run wrong")
}
}
日誌輸出格式
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)
}
zapcore.NewJSONEncoder(encoderConfig)
{"level":"INFO","time":"2020-07-20T16:15:48.238+0800","caller":"logger/logger.go:69","msg":"/bye","status":200,"method":"GET","path":"/bye","query":"","ip":"::1","user-agent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_4) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/83.0.4103.116 Safari/537.36","errors":"","cost":0.000192231}
zapcore.NewConsoleEncoder(encoderConfig)
{"level":"INFO","time":"2021-02-18T21:46:33.557+0800","status":500,"method":"POST","path":"/emotion_classifier/classify","query":"","ip":"::1","user-agent":"PostmanRuntime/7.26.8","errors":"","cost":33.259355392}
3、 報錯err的詳情記錄 “ c.Error(err)”
單單上面的設定還不能記錄錯誤的詳細資訊，在zap.String("errors", c.Errors.ByType(gin.ErrorTypePrivate).String())中的c.Errors還是為nil，若要記錄，需要在程式碼中丟擲的err位置，使用c.Error(err),才能被最終捕獲錯誤，例如在router.go中增加一個路由
r.GET("/sentPic", func(c *gin.Context) {
res, err := sendEmotionPic(pb.NewEmotionServerClient(conn), data, imgFile.Filename) // sendEmotionPic為gprc呼叫服務
if err != nil {
//此時的err需要被context捕獲才能被zap記錄
c.Error(err) // 重點
c.JSON(http.StatusInternalServerError, gin.H{
"status": 501,
"message": err.Error(),
"msg": "圖片未識別出表情",
"data": res,
})
return
}
c.JSON(http.StatusOK, gin.H{
"status": 200,
// "message": fmt.Sprintf("'%s' recognized!", imgFile.Filename),
"msg": "successful",
"data": res,
})
}