zap+日志分级分文件+按时间切割日志整合demo

实现功能

    info debug 级别的日志输出到 /path/log/demo.log
    warn error .... 级别的日志输出到 /path/log/demo_error.log
    日志自动按小时分割 最多保留7天的日志

依赖的第三方包github地址

    https://github.com/uber-go/zap

    https://github.com/lestrrat-go/file-rotatelogs

​    zap提供日志分级,打点key-value参数等功能,而file-foratelogs则提供日志自动按时间分割的功能,github上star数比较多的 https://github.com/natefinch/lumberjack 也提供类似功能,但是是根据文件大小分片,感觉除非借助其他工具,否则找某个时间点的日志时,体验可能不是那么友好。

    最近看了源码, file-foratelogs实现机制是每次写日志时判断文件创建日期, 感觉有点低效, 通过time.Ticker来触发也能达到同样功能, 自己尝试实现了一下, 不难实现, 不想增加额外依赖可以直接自己在项目里手撸一个, 可参考:https://github.com/Me1onRind/logrotate

demo代码

package demo

import (
    rotatelogs "github.com/lestrrat-go/file-rotatelogs"
    "go.uber.org/zap"
    "go.uber.org/zap/zapcore"
)

var Logger *zap.Logger

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 (其实 zapcore.*Level 自身就是 interface)
    infoLevel := zap.LevelEnablerFunc(func(lvl zapcore.Level) bool {
        return lvl < zapcore.WarnLevel
    })
    
    warnLevel := zap.LevelEnablerFunc(func(lvl zapcore.Level) bool {
        return lvl >= zapcore.WarnLevel
    })
    
    // 获取 info、warn日志文件的io.Writer 抽象 getWriter() 在下方实现
    infoWriter := getWriter("/path/log/demo.log")
    warnWriter := getWriter("/path/log/demo_error.log")
    
    // 最后创建具体的Logger
    core := zapcore.NewTee(
    	zapcore.NewCore(encoder, zapcore.AddSync(infoWriter), infoLevel),
        zapcore.NewCore(encoder, zapcore.AddSync(warnWriter), warnLevel),
    )
    
    Logger = zap.New(core, zap.AddCaller())  // 需要传入 zap.AddCaller() 才会显示打日志点的文件名和行数
}

func getWriter(filename string) io.Writer {
    // 生成rotatelogs的Logger 实际生成的文件名 demo.log.YYmmddHH
    // demo.log是指向最新日志的链接
    // 保存7天内的日志,每1小时(整点)分割一次日志
    hook, err := rotatelogs.New(
        filename+".%Y%m%d%H", // 没有使用go风格反人类的format格式
        rotatelogs.WithLinkName(filename),
        rotatelogs.WithMaxAge(time.Hour*24*7),
        rotatelogs.WithRotationTime(time.Hour),
    )   

    if err != nil {
        panic(err)
    }   
    return hook
}

​    zap.NewCore接收的参数是io.Writer而不是自己包的struct,开发者可以按需传入自己需要的io.Writer 挺好。

posted @ 2019-05-24 16:29  Me1onRind  阅读(7915)  评论(0编辑  收藏  举报