golang logrus 记录错误堆栈_每日一库之 logrus 日志使用教程-优快云博客

本文介绍了Golang中最受欢迎的日志库Logrus，详细讲解了其特性，包括兼容标准库日志、可扩展的Hook机制、日志格式定制及Fields用法。Logrus允许开发者记录结构化日志，并可通过Hook将日志发送到邮件、Slack、Dingding等。此外，文章还展示了如何自定义Hook以实现日志分隔和线程安全。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

golang 日志库

golang标准库的日志框架非常简单,仅仅提供了print,panic和fatal三个函数对于更精细的日志级别、日志文件分割以及日志分发等方面并没有提供支持. 所以催生了很多第三方的日志库,但是在 golang 的世界里,没有一个日志库像 slf4j 那样在 Java 中具有绝对统治地位.golang 中,流行的日志框架包括 logrus、zap、zerolog、seelog 等.

logrus是目前 Github 上 star 数量最多的日志库,目前(2018.12,下同)star 数量为 8119,fork 数为 1031. logrus功能强大,性能高效,而且具有高度灵活性,提供了自定义插件的功能.很多开源项目,如docker,prometheus,dejavuzhou/ginbro[1]等,都是用了 logrus 来记录其日志.

zap 是 Uber 推出的一个快速、结构化的分级日志库.具有强大的 ad-hoc 分析功能,并且具有灵活的仪表盘.zap 目前在 GitHub 上的 star 数量约为 4.3k. seelog 提供了灵活的异步调度、格式化和过滤功能.目前在 GitHub 上也有约 1.1k.

logrus 特性

完全兼容 golang 标准库日志模块：logrus 拥有六种日志级别：debug、info、warn、error、fatal 和 panic，这是 golang 标准库日志模块的 API 的超集.如果您的项目使用标准库日志模块,完全可以以最低的代价迁移到 logrus 上。
- logrus.Debug("Useful debugging information.")
- logrus.Info("Something noteworthy happened!")
- logrus.Warn("You should probably take a look at this.")
- logrus.Error("Something failed but I'm not quitting.")
- logrus.Fatal("Bye.") // log 之后会调用 os.Exit(1)
- logrus.Panic("I'm bailing.") // log 之后会 panic()
可扩展的 Hook 机制：允许使用者通过 hook 的方式将日志分发到任意地方,如本地文件系统、标准输出、logstash、elasticsearch或者mq等,或者通过 hook 定义日志内容和格式等.
可选的日志输出格式：logrus 内置了两种日志格式,JSONFormatter和TextFormatter,如果这两个格式不满足需求,可以自己动手实现接口 Formatter,来定义自己的日志格式.
Field机制：logrus鼓励通过 Field 机制进行精细化的、结构化的日志记录,而不是通过冗长的消息来记录日志.
logrus是一个可插拔的、结构化的日志框架.
Entry: logrus.WithFields 会自动返回一个 *Entry,Entry 里面的有些变量会被自动加上
- time:entry被创建时的时间戳
- msg:在调用.Info()等方法时被添加
- level

logrus 的使用

1.基本用法

package mainimport (  log "github.com/sirupsen/logrus")func main() {  log.WithFields(log.Fields{    "animal": "walrus",  }).Info("A walrus appears")}

上面代码执行后,标准输出上输出如下：

time="2018-08-11T15:42:22+08:00" level=info msg="A walrus appears" animal=walrus

logrus与 golang 标准库日志模块完全兼容,因此您可以使用log“github.com/sirupsen/logrus”替换所有日志导入. logrus可以通过简单的配置,来定义输出、格式或者日志级别等.

package mainimport (    "os"    log "github.com/sirupsen/logrus")func init() {    // 设置日志格式为json格式    log.SetFormatter(&log.JSONFormatter{})    // 设置将日志输出到标准输出(默认的输出为stderr,标准错误)    // 日志消息输出可以是任意的io.writer类型    log.SetOutput(os.Stdout)    // 设置日志级别为warn以上    log.SetLevel(log.WarnLevel)}func main() {    log.WithFields(log.Fields{        "animal": "walrus",        "size":   10,    }).Info("A group of walrus emerges from the ocean")    log.WithFields(log.Fields{        "omg":    true,        "number": 122,    }).Warn("The group's number increased tremendously!")    log.WithFields(log.Fields{        "omg":    true,        "number": 100,    }).Fatal("The ice breaks!")}

2.自定义 Logger

如果想在一个应用里面向多个地方log,可以创建 Logger 实例. logger是一种相对高级的用法, 对于一个大型项目, 往往需要一个全局的logrus实例,即logger对象来记录项目所有的日志.如：

package mainimport (    "github.com/sirupsen/logrus"    "os")// logrus提供了New()函数来创建一个logrus的实例.// 项目中,可以创建任意数量的logrus实例.var log = logrus.New()func main() {    // 为当前logrus实例设置消息的输出,同样地,    // 可以设置logrus实例的输出到任意io.writer    log.Out = os.Stdout    // 为当前logrus实例设置消息输出格式为json格式.    // 同样地,也可以单独为某个logrus实例设置日志级别和hook,这里不详细叙述.    log.Formatter = &logrus.JSONFormatter{}    log.WithFields(logrus.Fields{        "animal": "walrus",        "size":   10,    }).Info("A group of walrus emerges from the ocean")}

3.Fields 用法

前一章提到过,logrus不推荐使用冗长的消息来记录运行信息,它推荐使用Fields来进行精细化的、结构化的信息记录. 例如下面的记录日志的方式：

log.Fatalf("Failed to send event %s to topic %s with key %d", event, topic, key)

在logrus中不太提倡,logrus鼓励使用以下方式替代之：

log.WithFields(log.Fields{  "event": event,  "topic": topic,  "key": key,}).Fatal("Failed to send event")

前面的 WithFields API 可以规范使用者按照其提倡的方式记录日志.但是 WithFields 依然是可选的,因为某些场景下,使用者确实只需要记录仪一条简单的消息.

通常,在一个应用中、或者应用的一部分中,都有一些固定的 Field.比如在处理用户 http 请求时,上下文中,所有的日志都会有request_id和user_ip.为了避免每次记录日志都要使用 log.WithFields(log.Fields{“request_id”: request_id, “user_ip”: user_ip}),我们可以创建一个 logrus.Entry 实例,为这个实例设置默认 Fields,在上下文中使用这个 logrus.Entry 实例记录日志即可.

requestLogger := log.WithFields(log.Fields{"request_id": request_id, "user_ip": user_ip})requestLogger.Info("something happened on that request") # will log request_id and user_iprequestLogger.Warn("something not great happened")

4.Hook 接口用法

logrus 最令人心动的功能就是其可扩展的 HOOK 机制了,通过在初始化时为 logrus 添加 hook,logrus 可以实现各种扩展功能.

logrus 的 hook 接口定义如下,其原理是每此写入日志时拦截,修改 logrus.Entry.

// logrus在记录Levels()返回的日志级别的消息时会触发HOOK,// 按照Fire方法定义的内容修改logrus.Entry.type Hook interface {    Levels() []Level    Fire(*Entry) error}

一个简单自定义 hook 如下,DefaultFieldHook 定义会在所有级别的日志消息中加入默认字段 appName=”myAppName”.

type DefaultFieldHook struct {}func (hook *DefaultFieldHook) Fire(entry *log.Entry) error {    entry.Data["appName"] = "MyAppName"    return nil}func (hook *DefaultFieldHook) Levels() []log.Level {    return log.AllLevels}

hook的使用也很简单,在初始化前调用log.AddHook(hook)添加相应的hook即可.

logrus官方仅仅内置了syslog的hook. 此外,但 Github 也有很多第三方的hook可供使用,文末将提供一些第三方HOOK的连接.

4.1 Logrus-Hook-Email

email这里只需用NewMailAuthHook方法得到hook,再添加即可

func Email(){    logger:= logrus.New()    //parameter"APPLICATION_NAME", "HOST", PORT, "FROM", "TO"    //首先开启smtp服务,最后两个参数是smtp的用户名和密码    hook, err := logrus_mail.NewMailAuthHook("testapp", "smtp.163.com",25,"username@163.com","username@163.com","smtp_name","smtp_password")    if err == nil {        logger.Hooks.Add(hook)    }    //生成*Entry    var filename="123.txt"    contextLogger :=logger.WithFields(logrus.Fields{        "file":filename,        "content":  "GG",    })    //设置时间戳和message    contextLogger.Time=time.Now()    contextLogger.Message="这是一个hook发来的邮件"    //只能发送Error,Fatal,Panic级别的log    contextLogger.Level=logrus.FatalLevel    //使用Fire发送,包含时间戳,message    hook.Fire(contextLogger)}

4.2 Logrus-Hook-Slack

安装 slackrus github.com/johntdyer/slackrus

package mainimport ( logrus "github.com/sirupsen/logrus" "github.com/johntdyer/slackrus" "os")func main() { logrus.SetFormatter(&logrus.JSONFormatter{}) logrus.SetOutput(os.Stderr) logrus.SetLevel(logrus.DebugLevel) logrus.AddHook(&slackrus.SlackrusHook{  HookURL:        "https://hooks.slack.com/services/abc123/defghijklmnopqrstuvwxyz",  AcceptedLevels: slackrus.LevelThreshold(logrus.DebugLevel),  Channel:        "#slack-testing",  IconEmoji:      ":ghost:",  Username:       "foobot", }) logrus.Warn("warn") logrus.Info("info") logrus.Debug("debug")}

HookURL: 填写 slack web-hook 地址
AcceptedLevels: 设置日志输出级别
Channel: 设置日志频道
Username: 设置需要@的用户名

4.3 Logrus-Hook 日志分隔

logrus 本身不带日志本地文件分割功能,但是我们可以通过 file-rotatelogs 进行日志本地文件分割. 每次当我们写入日志的时候,logrus 都会调用 file-rotatelogs 来判断日志是否要进行切分.关于本地日志文件分割的例子网上很多,这里不再详细介绍,奉上代码：

import (    "github.com/lestrrat-go/file-rotatelogs"    "github.com/rifflock/lfshook"    log "github.com/sirupsen/logrus"    "time")func newLfsHook(logLevel *string, maxRemainCnt uint) log.Hook {    writer, err := rotatelogs.New(        logName+".%Y%m%d%H",        // WithLinkName为最新的日志建立软连接,以方便随着找到当前日志文件        rotatelogs.WithLinkName(logName),        // WithRotationTime设置日志分割的时间,这里设置为一小时分割一次        rotatelogs.WithRotationTime(time.Hour),        // WithMaxAge和WithRotationCount二者只能设置一个,        // WithMaxAge设置文件清理前的最长保存时间,        // WithRotationCount设置文件清理前最多保存的个数.        //rotatelogs.WithMaxAge(time.Hour*24),        rotatelogs.WithRotationCount(maxRemainCnt),    )    if err != nil {        log.Errorf("config local file system for logger error: %v", err)    }    level, ok := logLevels[*logLevel]    if ok {        log.SetLevel(level)    } else {        log.SetLevel(log.WarnLevel)    }    lfsHook := lfshook.NewHook(lfshook.WriterMap{        log.DebugLevel: writer,        log.InfoLevel:  writer,        log.WarnLevel:  writer,        log.ErrorLevel: writer,        log.FatalLevel: writer,        log.PanicLevel: writer,    }, &log.TextFormatter{DisableColors: true})    return lfsHook}

使用上述本地日志文件切割的效果如下：

img

4.4 Logrus-Dingding-Hook 阿里钉钉群机器人

钉钉开发文档自定义机器人[2]

自定义 hook 代码 `utils/logrus_hook_dingding.go`[3]

可以无视的方法(异步发送 http json body 到钉钉 api 加快响应速度)

hook.jsonBodies
hook.closeChan
func (dh *dingHook) startDingHookQueueJob()
func (dh *dingHook) Fire2(e *logrus.Entry) error

package utilsimport ( "bytes" "encoding/json" "fmt" "log" "net/http" "github.com/sirupsen/logrus")var allLvls = []logrus.Level{ logrus.DebugLevel, logrus.InfoLevel, logrus.WarnLevel, logrus.ErrorLevel, logrus.FatalLevel, logrus.PanicLevel,}func NewDingHook(url, app string, thresholdLevel logrus.Level) *dingHook { temp := []logrus.Level{} for _, v := range allLvls {  if v <= thresholdLevel {   temp = append(temp, v)  } } hook := &dingHook{apiUrl: url, levels: temp, appName: app} hook.jsonBodies = make(chan []byte) hook.closeChan = make(chan bool) //开启chan 队列 执行post dingding hook api go hook.startDingHookQueueJob() return hook}func (dh *dingHook) startDingHookQueueJob() { for {  select {  case

使用钉钉 hook `cmd/root.go`[4]

func initSlackLogrus() { lvl := logrus.InfoLevel //钉钉群机器人API地址 apiUrl := viper.GetString("logrus.dingHookUrl") dingHook := utils.NewDingHook(apiUrl, "Felix", lvl) logrus.SetLevel(lvl) logrus.SetFormatter(&logrus.JSONFormatter{TimestampFormat: "06-01-02T15:04:05"}) logrus.SetReportCaller(true) logrus.AddHook(dingHook)}