1.  
  2. 主页
  3.  / 
  4. Go 每日一库
  5.  / 
  6. Go 每日一库之 logrus 使用详解

Go 每日一库之 logrus 使用详解

简介

log库只提供了三组接口,功能过于简单了。

今天,我们来介绍一个日志库中的“明星库”——logrus

logrus完全兼容标准的log库,还支持文本、JSON 两种日志输出格式。很多知名的开源项目都使用了这个库,如大名鼎鼎的 docker。

快速使用

第三方库需要先安装:

后使用:

logrus的使用非常简单,与标准库log类似。logrus支持更多的日志级别:

  • Panic:记录日志,然后panic
  • Fatal:致命错误,出现错误时程序无法正常运转。输出日志后,程序退出;
  • Error:错误日志,需要查看原因;
  • Warn:警告信息,提醒程序员注意;
  • Info:关键操作,核心流程的日志;
  • Debug:一般程序中输出的调试信息;
  • Trace:很细粒度的信息,一般用不到;

日志级别从上向下依次增加,Trace最大,Panic最小。logrus有一个日志级别,高于这个级别的日志不会输出。

默认的级别为InfoLevel。所以为了能看到TraceDebug日志,我们在main函数第一行设置日志级别为TraceLevel

运行程序,输出:

由于logrus.Fatal会导致程序退出,下面的logrus.Panic不会执行到。

另外,我们观察到输出中有三个关键信息,timelevelmsg

  • time:输出日志的时间;
  • level:日志级别;
  • msg:日志信息。

定制

输出文件名

调用logrus.SetReportCaller(true)设置在输出日志中添加文件名和方法信息:

输出多了两个字段file为调用logrus相关方法的文件名,method为方法名:

添加字段

有时候需要在输出中添加一些字段,可以通过调用logrus.WithFieldlogrus.WithFields实现。
logrus.WithFields接受一个logrus.Fields类型的参数,其底层实际上为map[string]interface{}

下面程序在输出中添加两个字段nameage

如果在一个函数中的所有日志都需要添加某些字段,可以使用WithFields的返回值。

例如在 Web 请求的处理器中,日志都要加上user_idip字段:

实际上,WithFields返回一个logrus.Entry类型的值,它将logrus.Logger和设置的logrus.Fields保存下来。

调用Entry相关方法输出日志时,保存下来的logrus.Fields也会随之输出。

重定向输出

默认情况下,日志输出到io.Stderr。可以调用logrus.SetOutput传入一个io.Writer参数。后续调用相关方法日志将写到io.Writer中。

现在,我们就能像上篇文章介绍log时一样,可以搞点事情了。传入一个io.MultiWriter,同时将日志写到bytes.Buffer、标准输出和文件中:

自定义

实际上,考虑到易用性,库一般会使用默认值创建一个对象,包最外层的方法一般都是操作这个默认对象。

我们之前好几篇文章都提到过这点:

这个技巧应用在很多库的开发中,logrus也是如此:

首先,使用默认配置定义一个Logger对象stdSetOutput/SetFormatter/SetReportCaller/SetLevel这些方法都是调用std对象的对应方法!

我们当然也可以创建自己的Logger对象,使用方式与直接调用logrus的方法类似:

日志格式

logrus支持两种日志格式,文本和 JSON,默认为文本格式。

可以通过logrus.SetFormatter设置日志格式:

程序输出 JSON 格式的日志:

第三方格式

除了内置的TextFormatterJSONFormatter,还有不少第三方格式支持。

我们这里介绍一个nested-logrus-formatter

先安装:

后使用:

程序输出:

nested格式提供了多个字段用来定制行为:

  • 默认,logrus输出日志中字段是key=value这样的形式。使用nested格式,我们可以通过设置HideKeystrue隐藏键,只输出值;
  • 默认,logrus是按键的字母序输出字段,可以设置FieldsOrder定义输出字段顺序;
  • 通过设置TimestampFormat设置日期格式。

如果不隐藏键,程序输出:

隐藏键,程序输出:

注意到,我们将时间格式设置成time.RFC3339,即2006-01-02T15:04:05Z07:00这种形式。

通过实现接口logrus.Formatter可以实现自己的格式。

设置钩子

还可以为logrus设置钩子,每条日志输出前都会执行钩子的特定方法。所以,我们可以添加输出字段、根据级别将日志输出到不同的目的地。

logrus也内置了一个syslog的钩子,将日志输出到syslog中。这里我们实现一个钩子,在输出的日志中增加一个app=awesome-web字段。

钩子需要实现logrus.Hook接口:

Levels()方法返回感兴趣的日志级别,输出其他日志时不会触发钩子。Fire是日志输出前调用的钩子方法。

只需要在Fire方法实现中,为entry.Data添加字段就会输出到日志中。

程序输出:

logrus的第三方 Hook 很多,我们可以使用一些 Hook 将日志发送到 redis/mongodb 等存储中:

这里我们演示一个 redis,感兴趣自行验证其他的。先安装logrus-redis-hook

然后编写程序:

为了程序能正常工作,我们还需要安装redis

windows 上直接使用choco安装 redis:

直接输入redis-server,启动服务器:

Go 每日一库之 logrus 使用详解

运行程序后,我们使用redis-cli查看:

Go 每日一库之 logrus 使用详解

我们看到mykey是一个list,每过来一条日志,就在list后新增一项。

总结

本文介绍了logrus的基本用法。logrus的可扩展性非常棒,可以引入第三方格式和 Hook 增强功能。在社区也比较受欢迎。

参考

  1. logrus GitHub 仓库
  2. Hooks
这篇文章对您有用吗?

我们要如何帮助您?

发表评论

您的电子邮箱地址不会被公开。 必填项已用*标注