深入淺析golang zap 日誌庫使用(含檔案切割、分級別儲存和全域性使用等)
阿新 • • 發佈:2020-02-20
日誌處理經常有以下幾個需求:
1、不同級別的日誌輸出到不同的日誌檔案中。
2、日誌檔案按照檔案大小或日期進行切割儲存,以避免單一日誌檔案過大。
3、日誌使用簡單方便,一次定義全域性使用。
建議使用使用Uber-go的Zap Logger,大神李文周大部落格已經說的非常明確了,請先參考李老師的部落格:
https://www.liwenzhou.com/posts/Go/zap/
問題二和問題三需要補充描述:
一、日誌按照級別分檔案切割儲存
1.1 首先實現兩個判斷日誌等級的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")
檔名可拼接入系統時間
func getWriter(filename string) io.Writer { // 生成rotatelogs的Logger 實際生成的檔名 demo.log.YYmmddHH // demo.log是指向最新日誌的連結 // 儲存7天內的日誌,每1小時(整點)分割一次日誌 hook,err := rotatelogs.New( strings.Replace(filename,".log","",-1)+"-%Y%m%d%H.log",// 沒有使用go風格反人類的format格式 //rotatelogs.WithLinkName(filename),//rotatelogs.WithMaxAge(time.Hour*24*7),//rotatelogs.WithRotationTime(time.Hour),) if err != nil { panic(err) } return hook }
1.3 最後建立具體的Logger
core := zapcore.NewTee( zapcore.NewCore(encoder,zapcore.AddSync(infoWriter),infoLevel),zapcore.NewCore(encoder,zapcore.AddSync(errorWriter),errorLevel),)
1.4 建立logger
log := zap.New(core,zap.AddCaller()) errorLogger = log.Sugar()
二、日誌定義全域性使用
定義完一個logger 之後,我們希望整個專案可以拿來即用,不需要在每個檔案裡都進行初始化,我們使用go函式中的靜態函式來實現。
2.1 定義一個logger包
2.2 定義外部可直接訪問的函式
注意函式首字母要大寫
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(){ // 設定一些基本日誌格式 具體含義還比較好理解,直接看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) },}) // 實現兩個判斷日誌等級的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() 在下方實現 infoWriter := getWriter("./logs/demo_info.log") errorWriter := getWriter("./logs/demo_error.log") // 最後建立具體的Logger core := zapcore.NewTee( zapcore.NewCore(encoder,) log := zap.New(core,zap.AddCaller()) // 需要傳入 zap.AddCaller() 才會顯示打日誌點的檔名和行數,有點小坑 errorLogger = log.Sugar() } func getWriter(filename string) io.Writer { // 生成rotatelogs的Logger 實際生成的檔名 demo.log.YYmmddHH // demo.log是指向最新日誌的連結 // 儲存7天內的日誌,每1小時(整點)分割一次日誌 hook,) if err != nil { panic(err) } return hook } func Debug(args ...interface{}) { errorLogger.Debug(args...) } func Debugf(template string,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 函式使用
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) }
總結
以上所述是小編給大家介紹的golang zap 日誌庫使用(含檔案切割、分級別儲存和全域性使用等),希望對大家有所幫助,也非常感謝大家對我們網站的支援!