使用zap打造你的golang日志库

 1package main
 2
 3import "log"
 4
 5func main() {
 6    log.Print("info or debug")
 7    log.Fatal("fatal")
 8    log.Panic("panic")
 9}
10
11// 输出如下
122022/11/23 22:23:32 info or debug
132022/11/23 22:23:32 fatal
14exit status 1

 1package main
 2
 3import log "github.com/sirupsen/logrus"
 4
 5var logger = log.New()
 6
 7func main() {
 8    // 这里可以通过WithFields来附加字段
 9    logger.WithFields(log.Fields{"testfield": "test"}).Info("test info")
10    logger.Info("info")
11    logger.Error("Error")
12    logger.Fatal("Error")
13    logger.Panic("Panic")
14}
15
16// 输出如下
17INFO[0000] test info                                     testfield=test
18INFO[0000] info
19ERRO[0000] Error
20FATA[0000] Error
21exit status 1

 1package logger
 2
 3import (
 4	"os"
 5
 6	"github.com/natefinch/lumberjack"
 7	"go.uber.org/zap"
 8	"go.uber.org/zap/zapcore"
 9)
10
11var (
12	MyLogger   = InitLogger()
13	DefaultLog = MyLogger.Sugar()
14)
15
16func InitLogger(logArgs ...string) *zap.Logger {
17    ...
18}

  1func InitLogger(logArgs ...string) *zap.Logger {
  2	var logger *zap.Logger
  3	var coreArr []zapcore.Core
  4	var format, logType, priority string
  5
  6	// get the parameters
  7	switch {
  8	case len(logArgs) >= 3:
  9		format = logArgs[0]
 10		logType = logArgs[1]
 11		priority = logArgs[2]
 12	case len(logArgs) == 2:
 13		format = logArgs[0]
 14		logType = logArgs[1]
 15	case len(logArgs) == 1:
 16		format = logArgs[0]
 17	}
 18
 19	// get encoder
 20	encoderConfig := zap.NewProductionEncoderConfig()
 21	encoderConfig.EncodeTime = zapcore.ISO8601TimeEncoder        // time format
 22	encoderConfig.EncodeLevel = zapcore.CapitalColorLevelEncoder // use different color for various log levels
 23	// uncomment next line to show full path of the code
 24	// encoderConfig.EncodeCaller = zapcore.FullCallerEncoder
 25	// NewJSONEncoder() for json，NewConsoleEncoder() for normal
 26	if format == "" {
 27		format = "normal"
 28	}
 29	encoder := zapcore.NewConsoleEncoder(encoderConfig)
 30	if format == "json" {
 31		encoder = zapcore.NewJSONEncoder(encoderConfig)
 32	}
 33
 34	// log levels
 35	errorPriority := zap.LevelEnablerFunc(func(lev zapcore.Level) bool {
 36		return lev >= zap.ErrorLevel
 37	})
 38	infoPriority := zap.LevelEnablerFunc(func(lev zapcore.Level) bool {
 39		return lev < zap.ErrorLevel && lev >= zap.InfoLevel
 40	})
 41	debugPriority := zap.LevelEnablerFunc(func(lev zapcore.Level) bool {
 42		return lev < zap.InfoLevel && lev >= zap.DebugLevel
 43	})
 44	if logType == "" {
 45		logType = "console"
 46	}
 47	// writeSyncer for debug file
 48	debugFileWriteSyncer := zapcore.AddSync(&lumberjack.Logger{
 49		Filename:   "./log/debug.log", // will create if not exist
 50		MaxSize:    128,               // max size for log file, unit:MB
 51		MaxBackups: 3,                 // max backup's count
 52		MaxAge:     10,                // max reserved days for log file
 53		Compress:   false,             // whether to compress or not
 54	})
 55	debugFileCore := zapcore.NewCore(encoder, os.Stdout, debugPriority)
 56	if logType == "file" {
 57		debugFileCore = zapcore.NewCore(encoder, zapcore.NewMultiWriteSyncer(debugFileWriteSyncer, zapcore.AddSync(os.Stdout)), debugPriority)
 58	}
 59	// writeSyncer for info file
 60	infoFileWriteSyncer := zapcore.AddSync(&lumberjack.Logger{
 61		Filename:   "./log/info.log",
 62		MaxSize:    128,
 63		MaxBackups: 3,
 64		MaxAge:     10,
 65		Compress:   false,
 66	})
 67	infoFileCore := zapcore.NewCore(encoder, os.Stdout, infoPriority)
 68	if logType == "file" {
 69		infoFileCore = zapcore.NewCore(encoder, zapcore.NewMultiWriteSyncer(infoFileWriteSyncer, zapcore.AddSync(os.Stdout)), infoPriority)
 70	}
 71	// writeSyncer for error file
 72	errorFileWriteSyncer := zapcore.AddSync(&lumberjack.Logger{
 73		Filename:   "./log/error.log",
 74		MaxSize:    128,
 75		MaxBackups: 5,
 76		MaxAge:     10,
 77		Compress:   false,
 78	})
 79	errorFileCore := zapcore.NewCore(encoder, os.Stdout, errorPriority)
 80	if logType == "file" {
 81		errorFileCore = zapcore.NewCore(encoder, zapcore.NewMultiWriteSyncer(errorFileWriteSyncer, zapcore.AddSync(os.Stdout)), errorPriority)
 82	}
 83
 84	switch priority {
 85	case "":
 86		coreArr = append(coreArr, infoFileCore)
 87		coreArr = append(coreArr, errorFileCore)
 88	case "info":
 89		coreArr = append(coreArr, infoFileCore)
 90		coreArr = append(coreArr, errorFileCore)
 91	case "error":
 92		coreArr = append(coreArr, errorFileCore)
 93	case "debug":
 94		coreArr = append(coreArr, debugFileCore)
 95		coreArr = append(coreArr, infoFileCore)
 96		coreArr = append(coreArr, errorFileCore)
 97	}
 98	logger = zap.New(zapcore.NewTee(coreArr...), zap.AddCaller()) //zap.AddCaller() is to show the line number
 99	return logger
100}

 1package main
 2
 3import (
 4	"xxx/pkg/logger"
 5)
 6
 7// var log = logger.DefaultLog
 8var log = logger.InitLogger("", "", "debug").Sugar()
 9
10func main() {
11	log.Debug("debug")
12	log.Info("info")
13	log.Warn("warn")
14	log.Error("error")
15	log.Fatal("fatal")
16	log.Panic("panic")
17}