loggerhelper

loggerhelper/V2

github.com/sirupsen/logrus的帮助程序.用于快速设置,开袋可用.

该模块定位为基础组件,如果需要用它就只用它比较好.

V2版本是对V0版本的重构,允许修改全局logger,并允许将logger输出

V2版本针对go 1.18+,使用泛型语法.低版本还是继续使用v0版本

特性

• 开袋可用,即便没有进行设置也已经设置为使用json格式打印消息.
• WithExtFields可选,可以是0到任意多个
• 可以通过log.Set(opts ...optparams.Option[log.Options])设置默认logger
• 支持hook
• 支持获取默认logger
• 支持导出Log对象针对不同业务进行区分.导出的Log对象只是默认字段不同,依然受log.Set设置的其他属性影响

基本用法

即便不初始化也可以工作

package main

import (
    log "github.com/Golang-Tools/loggerhelper"
)
func main() {
    log.Info("test")
    log.Warn("qweqwr", log.Dict{"a": 1},log.Dict{"b": 1})
}

设置log

设置log可以设置log等级,默认字段的值,输出,以及钩子:

• func Set(opts ...optparams.Option[Options]) 设置logger对象

package main

import (
    log "github.com/Golang-Tools/loggerhelper/v2"
    "io/ioutil"
    "os"
    "github.com/sirupsen/logrus"
    "github.com/sirupsen/logrus/hooks/writer"
)
func main() {
    log.Info("test1")
    log.Set(log.WithLevel("WARN"), log.WithExtFields(log.Dict{"d": 3}))
    log.Info("test2")
    log.Warn("test3")
    log.Set(log.WithLevel("Debug"), log.WithExtFields(log.Dict{"e": 3}))
    log.Debug("test4", log.Dict{"a": 1})
    log.Warn("test5", log.Dict{"a": 1})

    hook := writer.Hook{ // Send logs with level higher than warning to stderr
        Writer: os.Stderr,
        LogLevels: []logrus.Level{
            logrus.PanicLevel,
            logrus.FatalLevel,
            logrus.ErrorLevel,
            logrus.WarnLevel,
        },
    }
    log.SetLogger(WithLevel("WARN"), WithExtFields(log.Dict{"d": 3}), WithOutput(ioutil.Discard), AddHooks(hook))
    log.Info("test")
    log.Warn("qweqwr", log.Dict{"a": 1})
}

获取logger

获取logger接口GetLogger() *logrus.Logger可以获取到当前的logger,这主要用于导出给其他模块使用.比如用于设置gin的log

app.Use(ginlogrus.Logger(log.GetLogger()), gin.Recovery())

导出Log

往往我们希望不同的模块使用不同的log标识这样可以比较准确地定位错误.这时可以通过Export接口导出当前的Log对象.

log.Set(log.WithExtFields(log.Dict{"app": "l1"}))
Logger1 := log.Export()

log.Set(log.WithExtFields(log.Dict{"app": "l2"}))
Logger2 := log.Export()
Logger1.Debug("test logger1")
Logger2.Debug("test logger2")