百度360必应搜狗淘宝本站头条
docker systemdzabbix微信报警脚本loadjsqt5.5pagination.js
当前位置：网站首页 > 技术教程 > 正文

每日一库之 logrus 日志使用教程_日志logger

suiw9 2025-02-20 17:52 36 浏览 0 评论

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?main

import?(
??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?main

import?(
????"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?main

import?(
????"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_ip
requestLogger.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?main

import?(
?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?utils

import?(
?"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?<-dh.closeChan:
???return
??case?bs?:=?<-dh.jsonBodies:
???res,?err?:=?http.Post(dh.apiUrl,?"application/json",?bytes.NewBuffer(bs))
???if?err?!=?nil?{
????log.Println(err)
???}
???if?res?!=?nil?&&?res.StatusCode?!=?200?{
????log.Println("dingHook?go?chan?http?post?error",?res.StatusCode)
???}
??}
?}

}

type?dingHook?struct?{
?apiUrl?????string
?levels?????[]logrus.Level
?appName????string
?jsonBodies?chan?[]byte
?closeChan??chan?bool
}


//?Levels?sets?which?levels?to?sent?to?slack
func?(dh?*dingHook)?Levels()?[]logrus.Level?{
?return?dh.levels
}

//Fire2?这个异步有可能导致?最后一条消息丢失,main?goroutine?提前结束到导致?子线程http?post?没有发送
func?(dh?*dingHook)?Fire2(e?*logrus.Entry)?error?{
?msg,?err?:=?e.String()
?if?err?!=?nil?{
??return?err
?}
?dm?:=?dingMsg{Msgtype:?"text"}
?dm.Text.Content?=?fmt.Sprintf("%s?\n?%s",?dh.appName,?msg)
?bs,?err?:=?json.Marshal(dm)
?if?err?!=?nil?{
??return?err
?}
?dh.jsonBodies?<-?bs
?return?nil
}
func?(dh?*dingHook)?Fire(e?*logrus.Entry)?error?{
?msg,?err?:=?e.String()
?if?err?!=?nil?{
??return?err
?}
?dm?:=?dingMsg{Msgtype:?"text"}
?dm.Text.Content?=?fmt.Sprintf("%s?\n?%s",?dh.appName,?msg)
?bs,?err?:=?json.Marshal(dm)
?if?err?!=?nil?{
??return?err
?}
?res,?err?:=?http.Post(dh.apiUrl,?"application/json",?bytes.NewBuffer(bs))
?if?err?!=?nil?{
??return?err
?}
?if?res?!=?nil?&&?res.StatusCode?!=?200?{
??return?fmt.Errorf("dingHook?go?chan?http?post?error?%d",?res.StatusCode)
?}
?return?nil
}

type?dingMsg?struct?{
?Msgtype?string?`json:"msgtype"`
?Text????struct?{
??Content?string?`json:"content"`
?}?`json:"text"`
}

使用钉钉 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)
}

logrus 线程安全

默认的 logger 在并发写的时候是被 mutex 保护的,比如当同时调用 hook 和写 log 时 mutex 就会被请求,有另外一种情况,文件是以 appending mode 打开的, 此时的并发操作就是安全的,可以用 logger.SetNoLock()来关闭它

致谢

  • logrus[5]
  • logrus-hook-email[6]
  • logrus-hook-slack[7]
  • logrus-hook-钉钉[8]

原文作者：Eric Zhou 原文链接：https://mojotv.cn/2018/12/27/golang-logrus-tutorial参考资料

[1]

dejavuzhou/ginbro: https://github.com/libragen/ginbro/blob/master/readme_zh.md

[2]

钉钉开发文档自定义机器人:
https://open-doc.dingtalk.com/microapp/serverapi2/qf2nxq

[3]

utils/logrus_hook_dingding.go: https://github.com/libragen/felix/blob/master/utils/logrus_hook_dingding.go

[4]

cmd/root.go: https://github.com/libragen/felix/blob/master/cmd/root.go

[5]

logrus: https://github.com/sirupsen/logrus

[6]

logrus-hook-email: https://github.com/zbindenren/logrus_mail

[7]

logrus-hook-slack: https://github.com/johntdyer/slackrus

[8]

logrus-hook-钉钉:
https://github.com/dandans-dan/dingrus

相关推荐

10款超实用JavaScript音频库（js播放音频代码）

HTML5提供了一种新的音频标签实现和规范用一个简单的HTML对象而无需音频插件来控制音频。这只是一个简单的整合这些新的HTML5音频特征及使用JavaScript来创建各种播放控制。下面将介绍10款...

Howler.js，一款神奇的 JavaScript 开源网络音频工具库

o...

PROFINET转Modbus网关——工业协议融合的智能枢纽

三格电子SG-PNh750-MOD-221，无缝连接Profinet与Modbus，赋能工业物联产品概述...

简单实用的Modbus类库，支持从站和DTU

一、简介...

[西门子PLC] S7-200 SMART PROFINET :通过GSD组态PLC设备

从S7-200SMARTV2.5版本开始，S7-200SMART开始支持做PROFINETIO通信的智能设备。从而，两个S7-200SMART之间可以进行PROFINETI...

Modbus(RTU / TCP)有什么异同（modbus tcp和tcp）

Modbus是一种广泛使用的工业自动化通信协议，它支持设备之间的数据交换。Modbus协议有两个主要的变体：ModbusRTU（二进制模式）和ModbusTCP（基于TCP/IP网络的模式）。尽管...

Modbus通信调试步骤详解（modbus调试工具怎么用）

Modbus通信调试步骤详解　　Modbus通信分为串口和以太网，无论是串口还是以太网，只要是标准Modbus，就可以用Modbus模拟器进行调试。按以下几步进行调试。...

理解Intel手册汇编指令（intel 汇编指令手册）

指令格式...

「西门子PLC」S7-200 SMART的Modbus RTU通讯

S7-200SMART集成的RS485端口(端口0)以及SBCM01RS485/232信号板(端口1)两个通信端口可以同时做MODBUSRTU主站，或者一个做MODBUSRTU主站一个做MO...

InfiniBand网络运维全指南:从驱动安装到故障排查

一、InfiniBand网络概述InfiniBand（直译为“无限带宽”技术，缩写为IB）是一种用于高性能计算的计算机网络通信标准，具有极高的吞吐量和极低的延迟，用于计算机与计算机之间的数据互连。它...

一加回归 OPPO，背后的秘密不可告人

有这样一个手机品牌，它诞生于互联网品牌。在大众群体看来，它的身世似乎模糊不清，许多人以为它是国外品牌。它的产品定位是极客群体，深受国内发烧友，甚至国外极客玩家喜爱。...

[西门子PLC] S7-200SMART快速高效的完成Modbus通信程序的设计

一、导读Modbus通信是一种被广泛应用的通信协议，在变频器、智能仪表还有其他一些智能设备上都能见到它的身影。本文呢，就把S7-200SMART系列PLC当作Modbus主站，把...

狂肝10个月手搓GPU，他们在我的世界中玩起我的世界，梦想成真

梦晨衡宇萧箫发自凹非寺量子位|公众号QbitAI自从有人在《我的世界》里用红石电路造出CPU，就流传着一个梗：...

[西门子PLC] 博途TIA portal SCL编程基础入门:1-点动与自锁

一、S7-SCL编程语言简介...

工作原理系列之:Modbus（modbus工作过程）

MODBUS是一种在自动化工业中广泛应用的高速串行通信协议。该协议是由Modion公司(现在由施耐德电气公司获得)于1979年为自己的可编程逻辑控制器开发的。该协议充当了PLCS和智能自动化设备之间的...

取消回复欢迎 你 发表评论:

一周热门
最近发表
标签列表
Copyright Your WebSite.Some Rights Reserved.