深入淺析golang zap 日志庫使用(含文件切割、分級別存儲和全局使用等)
日志處理經(jīng)常有以下幾個需求:
1、不同級別的日志輸出到不同的日志文件中。
2、日志文件按照文件大小或日期進行切割存儲,以避免單一日志文件過大。
3、日志使用簡單方便,一次定義全局使用。
建議使用使用Uber-go的Zap Logger,大神李文周大博客已經(jīng)說的非常明確了,請先參考李老師的博客:
https://www.liwenzhou.com/posts/Go/zap/
問題二和問題三需要補充描述:
一、日志按照級別分文件切割存儲
1.1 首先實現(xiàn)兩個判斷日志等級的interface
infoLevel := zap.LevelEnablerFunc(func(lvl zapcore.Level) bool {
return lvl >= zapcore.InfoLevel
})
errorLevel := zap.LevelEnablerFunc(func(lvl zapcore.Level) bool {
return lvl >= zapcore.ErrorLevel
})
1.2 獲取 info、error日志文件的io.Writer
infoWriter := getWriter("./logs/demo_info.log")
errorWriter := getWriter("./logs/demo_error.log")
文件名可拼接入系統(tǒng)時間
func getWriter(filename string) io.Writer {
// 生成rotatelogs的Logger 實際生成的文件名 demo.log.YYmmddHH
// demo.log是指向最新日志的鏈接
// 保存7天內(nèi)的日志,每1小時(整點)分割一次日志
hook, err := rotatelogs.New(
strings.Replace(filename, ".log", "", -1)+"-%Y%m%d%H.log", // 沒有使用go風(fēng)格反人類的format格式
//rotatelogs.WithLinkName(filename),
//rotatelogs.WithMaxAge(time.Hour*24*7),
//rotatelogs.WithRotationTime(time.Hour),
)
if err != nil {
panic(err)
}
return hook
}
1.3 最后創(chuàng)建具體的Logger
core := zapcore.NewTee( zapcore.NewCore(encoder, zapcore.AddSync(infoWriter), infoLevel), zapcore.NewCore(encoder, zapcore.AddSync(errorWriter), errorLevel), )
1.4 創(chuàng)建logger
log := zap.New(core, zap.AddCaller()) errorLogger = log.Sugar()
二、日志定義全局使用
定義完一個logger 之后,我們希望整個項目可以拿來即用,不需要在每個文件里都進行初始化,我們使用go函數(shù)中的靜態(tài)函數(shù)來實現(xiàn)。
2.1 定義一個logger包

2.2 定義外部可直接訪問的函數(shù)
注意函數(shù)首字母要大寫
func Debug(args ...interface{}) {
errorLogger.Debug(args...)
}
func Debugf(template string, args ...interface{}) {
errorLogger.Debugf(template, args...)
}
func Info(args ...interface{}) {
errorLogger.Info(args...)
}
func Infof(template string, args ...interface{}) {
errorLogger.Infof(template, args...)
}
func Warn(args ...interface{}) {
errorLogger.Warn(args...)
}
func Warnf(template string, args ...interface{}) {
errorLogger.Warnf(template, args...)
}
func Error(args ...interface{}) {
errorLogger.Error(args...)
}
func Errorf(template string, args ...interface{}) {
errorLogger.Errorf(template, args...)
}
func DPanic(args ...interface{}) {
errorLogger.DPanic(args...)
}
func DPanicf(template string, args ...interface{}) {
errorLogger.DPanicf(template, args...)
}
2.3 在需要使用的地方直接引入logger 包就可以直接使用
logger.Infof("create token succ , token=%v", token)
三、源碼
3.1 文件目錄

3.2 lgo.go 源碼
package logger
import (
rotatelogs "github.com/lestrrat-go/file-rotatelogs"
"go.uber.org/zap"
"go.uber.org/zap/zapcore"
"io"
"strings"
"time"
)
var errorLogger *zap.SugaredLogger
func init(){
// 設(shè)置一些基本日志格式 具體含義還比較好理解,直接看zap源碼也不難懂
encoder := zapcore.NewConsoleEncoder(zapcore.EncoderConfig{
MessageKey: "msg",
LevelKey: "level",
EncodeLevel: zapcore.CapitalLevelEncoder,
TimeKey: "ts",
EncodeTime: func(t time.Time, enc zapcore.PrimitiveArrayEncoder) {
enc.AppendString(t.Format("2006-01-02 15:04:05"))
},
CallerKey: "file",
EncodeCaller: zapcore.ShortCallerEncoder,
EncodeDuration: func(d time.Duration, enc zapcore.PrimitiveArrayEncoder) {
enc.AppendInt64(int64(d) / 1000000)
},
})
// 實現(xiàn)兩個判斷日志等級的interface
infoLevel := zap.LevelEnablerFunc(func(lvl zapcore.Level) bool {
return lvl >= zapcore.InfoLevel
})
errorLevel := zap.LevelEnablerFunc(func(lvl zapcore.Level) bool {
return lvl >= zapcore.ErrorLevel
})
// 獲取 info、error日志文件的io.Writer 抽象 getWriter() 在下方實現(xiàn)
infoWriter := getWriter("./logs/demo_info.log")
errorWriter := getWriter("./logs/demo_error.log")
// 最后創(chuàng)建具體的Logger
core := zapcore.NewTee(
zapcore.NewCore(encoder, zapcore.AddSync(infoWriter), infoLevel),
zapcore.NewCore(encoder, zapcore.AddSync(errorWriter), errorLevel),
)
log := zap.New(core, zap.AddCaller()) // 需要傳入 zap.AddCaller() 才會顯示打日志點的文件名和行數(shù), 有點小坑
errorLogger = log.Sugar()
}
func getWriter(filename string) io.Writer {
// 生成rotatelogs的Logger 實際生成的文件名 demo.log.YYmmddHH
// demo.log是指向最新日志的鏈接
// 保存7天內(nèi)的日志,每1小時(整點)分割一次日志
hook, err := rotatelogs.New(
strings.Replace(filename, ".log", "", -1)+"-%Y%m%d%H.log", // 沒有使用go風(fēng)格反人類的format格式
//rotatelogs.WithLinkName(filename),
//rotatelogs.WithMaxAge(time.Hour*24*7),
//rotatelogs.WithRotationTime(time.Hour),
)
if err != nil {
panic(err)
}
return hook
}
func Debug(args ...interface{}) {
errorLogger.Debug(args...)
}
func Debugf(template string, args ...interface{}) {
errorLogger.Debugf(template, args...)
}
func Info(args ...interface{}) {
errorLogger.Info(args...)
}
func Infof(template string, args ...interface{}) {
errorLogger.Infof(template, args...)
}
func Warn(args ...interface{}) {
errorLogger.Warn(args...)
}
func Warnf(template string, args ...interface{}) {
errorLogger.Warnf(template, args...)
}
func Error(args ...interface{}) {
errorLogger.Error(args...)
}
func Errorf(template string, args ...interface{}) {
errorLogger.Errorf(template, args...)
}
func DPanic(args ...interface{}) {
errorLogger.DPanic(args...)
}
func DPanicf(template string, args ...interface{}) {
errorLogger.DPanicf(template, args...)
}
func Panic(args ...interface{}) {
errorLogger.Panic(args...)
}
func Panicf(template string, args ...interface{}) {
errorLogger.Panicf(template, args...)
}
func Fatal(args ...interface{}) {
errorLogger.Fatal(args...)
}
func Fatalf(template string, args ...interface{}) {
errorLogger.Fatalf(template, args...)
}
3.3 main 函數(shù)使用
import (
"flag"
"goAuth/logger"
"goAuth/util"
"os"
)
func main() {
createAndCheckToken()
logger.Infof("in main args:%v", os.Args)
logger.Errorf("eerror %v", "error")
flag.Parse()
logger.Infof("env is %v", *env)
config := util.InitConfig( "./config/" + *env + ".conf")
ip := config["ip"]
port := config["port"]
envConfig := config["env"]
logger.Infof("ip=%v, port=%v, env=%v", ip, port, envConfig)
}
總結(jié)
以上所述是小編給大家介紹的golang zap 日志庫使用(含文件切割、分級別存儲和全局使用等),希望對大家有所幫助,也非常感謝大家對腳本之家網(wǎng)站的支持!
相關(guān)文章
Vue中使用Echarts響應(yīng)式布局flexible.js+rem適配方案詳解
這篇文章主要介紹了Vue中使用Echarts響應(yīng)式布局flexible.js+rem適配方案詳解,本文給大家介紹的非常詳細(xì),對大家的學(xué)習(xí)或工作具有一定的參考借鑒價值,需要的朋友可以參考下2023-01-01
vue使用websocket實現(xiàn)實時數(shù)據(jù)推送功能
這篇文章主要為大家詳細(xì)介紹了vue如何使用websocket實現(xiàn)實時數(shù)據(jù)推送,發(fā)布訂閱重連單點登錄功能,感興趣的小伙伴可以跟隨小編一起學(xué)習(xí)一下2023-12-12
VUE中Echarts的resize事件報錯和移除windows的事件問題
這篇文章主要介紹了VUE中Echarts的resize事件報錯和移除windows的事件問題,具有很好的參考價值,希望對大家有所幫助。如有錯誤或未考慮完全的地方,望不吝賜教2023-07-07

