Go日志——logrus

安装

安装：

go get github.com/sirupsen/logrus

hello world

package main
import log "github.com/sirupsen/logrus"
func main() {
    log.Info("我是一条日志")
    log.WithFields(log.Fields{"key":"value"}).Info("我要打印了")
}
输出：
time="2019-05-24T08:13:47+08:00" level=info msg="我是一条日志"
time="2019-05-24T08:13:47+08:00" level=info msg="我要打印了" key=value

日志格式

将日志输出格式设置为JSON格式：

log.SetFormatter(&log.JSONFormatter{})

package main
import (
    log "github.com/sirupsen/logrus"
)
func initLog() {
    // 设置日志格式为json格式
    log.SetFormatter(&log.JSONFormatter{})
}
func main() {
    initLog()
    log.WithFields(log.Fields{
        "age": 12,
        "name":   "xiaoming",
        "sex": 1,
    }).Info("小明来了")
    log.WithFields(log.Fields{
        "age": 13,
        "name":   "xiaohong",
        "sex": 0,
    }).Error("小红来了")
    log.WithFields(log.Fields{
        "age": 14,
        "name":   "xiaofang",
        "sex": 1,
    }).Fatal("小芳来了")
}
输出：
{"age":12,"level":"info","msg":"小明来了","name":"xiaoming","sex":1,"time":"2019-05-24T08:20:19+08:00"}
{"age":13,"level":"error","msg":"小红来了","name":"xiaohong","sex":0,"time":"2019-05-24T08:20:19+08:00"}
{"age":14,"level":"fatal","msg":"小芳来了","name":"xiaofang","sex":1,"time":"2019-05-24T08:20:19+08:00"}

看到这里输出的日志格式与上面的区别，这里是json格式，上面是纯文本。

日志级别

logrus 提供 6 档日志级别，分别是：

PanicLevel
FatalLevel
ErrorLevel
WarnLevel
InfoLevel
DebugLevel

设置日志输出级别：

log.SetLevel(log.WarnLevel)

自定义输出

字段

logrus 默认的日志输出有 time、level 和 msg 3个 Field，其中 time 可以不显示，方法如下：

log.SetFormatter(&log.TextFormatter{DisableTimestamp: true})

自定义 Field 的方法如下：

log.WithFields(log.Fields{
        "age": 14,
        "name":   "xiaofang",
        "sex": 1,
    }).Fatal("小芳来了")

路径

logrus默认日志输出为stderr，你可以修改为任何的io.Writer。比如os.File文件流。

func init() {
    //设置输出样式，自带的只有两种样式logrus.JSONFormatter{}和logrus.TextFormatter{}
    logrus.SetFormatter(&logrus.JSONFormatter{})
    //设置output,默认为stderr,可以为任何io.Writer，比如文件*os.File
    file, _ := os.OpenFile("1.log", os.O_CREATE|os.O_WRONLY, 0666)
    log.SetOutput(file)
    //设置最低loglevel
    logrus.SetLevel(logrus.InfoLevel)
}

hook机制

上面说过logrus是一个支持可插拔，结构化的日志框架，可插拔的特性就在于它的hook机制。一些功能需要用户自己通过hook机制去实现定制化的开发。比如说在log4j中常见的日志按天按小时做切分的功能官方并没有提供支持，你可以通过hook机制实现它。
Hook接口定义如下：

type Hook interface {
    Levels() []Level
    Fire(*Entry) error
}

logrus的hook原理是：在每次写入日志时拦截，修改logrus.Entry 。logrus在记录Levels()返回的日志级别的消息时，会触发HOOK， 然后按照Fire方法定义的内容，修改logrus.Entry 。logrus.Entry里面就是记录的每一条日志的内容。
所以在Hook中你需要做的就是在Fire方法中定义你想如何操作这一条日志的方法，在Levels方法中定义你想展示的日志级别。
如下是一个在所有日志中打印一个特殊字符串的Hook：
TraceIdHook

package hook
import (
     "github.com/sirupsen/logrus"
)
type TraceIdHook struct {
    TraceId  string
}
func NewTraceIdHook(traceId string) logrus.Hook {
    hook := TraceIdHook{
        TraceId:  traceId,
    }
    return &hook
}
func (hook *TraceIdHook) Fire(entry *logrus.Entry) error {
    entry.Data["traceId"] = hook.TraceId
    return nil
}
func (hook *TraceIdHook) Levels() []logrus.Level {
    return logrus.AllLevels
}

主程序：

package main
import (
    uuid "github.com/satori/go.uuid"
    log "github.com/sirupsen/logrus"
    "webDemo/hook"
)
func initLog() {
    uuids, _ := uuid.NewV1()
    log.AddHook(hook.NewTraceIdHook(uuids.String() +" "))
}
func main() {
    initLog()
    log.WithFields(log.Fields{
        "age": 12,
        "name":   "xiaoming",
        "sex": 1,
    }).Info("小明来了")
    log.WithFields(log.Fields{
        "age": 13,
        "name":   "xiaohong",
        "sex": 0,
    }).Error("小红来了")
    log.WithFields(log.Fields{
        "age": 14,
        "name":   "xiaofang",
        "sex": 1,
    }).Fatal("小芳来了")
}

该hook会在日志中打印出一个uuid字符串。