phphook毛病日记技巧_每日一库之 logrus 日志运用教程

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.

packagemainimport(log"github.com/sirupsen/logrus")funcmain(){log.WithFields(log.Fields{"animal":"walrus",}).Info("Awalrusappears")}

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

time="2018-08-11T15:42:22+08:00"level=infomsg="Awalrusappears"animal=walrus

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

packagemainimport("os"log"github.com/sirupsen/logrus")funcinit(){//设置日志格式为json格式log.SetFormatter(&log.JSONFormatter{})//设置将日志输出到标准输出（默认的输出为stderr,标准缺点）//日志输出可以是任意的io.writer类型log.SetOutput(os.Stdout)//设置日志级别为warn以上log.SetLevel(log.WarnLevel)}funcmain(){log.WithFields(log.Fields{"animal":"walrus","size":10,}).Info("Agroupofwalrusemergesfromtheocean")log.WithFields(log.Fields{"omg":true,"number":122,}).Warn("Thegroup'snumberincreasedtremendously!")log.WithFields(log.Fields{"omg":true,"number":100,}).Fatal("Theicebreaks!")}2.自定义 Logger

如果想在一个运用里面向多个地方log,可以创建 Logger 实例. logger是一种相对高等的用法, 对付一个大型项目, 每每须要一个全局的logrus实例,即logger工具来记录项目所有的日志.如：

packagemainimport("github.com/sirupsen/logrus""os")//logrus供应了New()函数来创建一个logrus的实例.//项目中,可以创建任意数量的logrus实例.varlog=logrus.New()funcmain(){//为当前logrus实例设置的输出,同样地,//可以设置logrus实例的输出到任意io.writerlog.Out=os.Stdout//为当前logrus实例设置输出格式为json格式.//同样地,也可以单独为某个logrus实例设置日志级别和hook,这里不详细阐述.log.Formatter=&logrus.JSONFormatter{}log.WithFields(logrus.Fields{"animal":"walrus","size":10,}).Info("Agroupofwalrusemergesfromtheocean")}3.Fields 用法

前一章提到过,logrus不推举利用冗长的来记录运行信息,它推举利用Fields来进行风雅化的、构造化的信息记录. 例如下面的记录日志的办法：

log.Fatalf("Failedtosendevent%stotopic%swithkey%d",event,topic,key)

在logrus中不太提倡,logrus鼓励利用以下办法替代之：

log.WithFields(log.Fields{"event":event,"topic":topic,"key":key,}).Fatal("Failedtosendevent")

前面的 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("somethinghappenedonthatrequest")#willlogrequest_idanduser_iprequestLogger.Warn("somethingnotgreathappened")4.Hook 接口用法

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

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

//logrus在记录Levels()返回的日志级别的时会触发HOOK,//按照Fire方法定义的内容修正logrus.Entry.typeHookinterface{Levels()[]LevelFire(Entry)error}

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

typeDefaultFieldHookstruct{}func(hookDefaultFieldHook)Fire(entrylog.Entry)error{entry.Data["appName"]="MyAppName"returnnil}func(hookDefaultFieldHook)Levels()[]log.Level{returnlog.AllLevels}

hook的利用也很大略,在初始化前调用log.AddHook(hook)添加相应的hook即可.

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

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

funcEmail(){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")iferr==nil{logger.Hooks.Add(hook)}//天生Entryvarfilename="123.txt"contextLogger:=logger.WithFields(logrus.Fields{"file":filename,"content":"GG",})//设置韶光戳和messagecontextLogger.Time=time.Now()contextLogger.Message="这是一个hook发来的邮件"//只能发送Error,Fatal,Panic级别的logcontextLogger.Level=logrus.FatalLevel//利用Fire发送,包含韶光戳,messagehook.Fire(contextLogger)}4.2 Logrus-Hook-Slack

安装 slackrus github.com/johntdyer/slackrus

packagemainimport(logrus"github.com/sirupsen/logrus""github.com/johntdyer/slackrus""os")funcmain(){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")funcnewLfsHook(logLevelstring,maxRemainCntuint)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.Hour24),rotatelogs.WithRotationCount(maxRemainCnt),)iferr!=nil{log.Errorf("configlocalfilesystemforloggererror:%v",err)}level,ok:=logLevels[logLevel]ifok{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})returnlfsHook}

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

img

可以忽略的方法(异步发送 http json body 到钉钉 api 加快相应速率)

packageutilsimport("bytes""encoding/json""fmt""log""net/http""github.com/sirupsen/logrus")varallLvls=[]logrus.Level{logrus.DebugLevel,logrus.InfoLevel,logrus.WarnLevel,logrus.ErrorLevel,logrus.FatalLevel,logrus.PanicLevel,}funcNewDingHook(url,appstring,thresholdLevellogrus.Level)dingHook{temp:=[]logrus.Level{}for_,v:=rangeallLvls{ifv<=thresholdLevel{temp=append(temp,v)}}hook:=&dingHook{apiUrl:url,levels:temp,appName:app}hook.jsonBodies=make(chan[]byte)hook.closeChan=make(chanbool)//开启chan行列步队实行postdingdinghookapigohook.startDingHookQueueJob()returnhook}func(dhdingHook)startDingHookQueueJob(){for{select{case<-dh.closeChan:returncasebs:=<-dh.jsonBodies:res,err:=http.Post(dh.apiUrl,"application/json",bytes.NewBuffer(bs))iferr!=nil{log.Println(err)}ifres!=nil&&res.StatusCode!=200{log.Println("dingHookgochanhttpposterror",res.StatusCode)}}}}typedingHookstruct{apiUrlstringlevels[]logrus.LevelappNamestringjsonBodieschan[]bytecloseChanchanbool}//Levelssetswhichlevelstosenttoslackfunc(dhdingHook)Levels()[]logrus.Level{returndh.levels}//Fire2这个异步有可能导致末了一条丢失,maingoroutine提前结束到导致子线程httppost没有发送func(dhdingHook)Fire2(elogrus.Entry)error{msg,err:=e.String()iferr!=nil{returnerr}dm:=dingMsg{Msgtype:"text"}dm.Text.Content=fmt.Sprintf("%s\n%s",dh.appName,msg)bs,err:=json.Marshal(dm)iferr!=nil{returnerr}dh.jsonBodies<-bsreturnnil}func(dhdingHook)Fire(elogrus.Entry)error{msg,err:=e.String()iferr!=nil{returnerr}dm:=dingMsg{Msgtype:"text"}dm.Text.Content=fmt.Sprintf("%s\n%s",dh.appName,msg)bs,err:=json.Marshal(dm)iferr!=nil{returnerr}res,err:=http.Post(dh.apiUrl,"application/json",bytes.NewBuffer(bs))iferr!=nil{returnerr}ifres!=nil&&res.StatusCode!=200{returnfmt.Errorf("dingHookgochanhttpposterror%d",res.StatusCode)}returnnil}typedingMsgstruct{Msgtypestring`json:"msgtype"`Textstruct{Contentstring`json:"content"`}`json:"text"`}利用钉钉 hook `cmd/root.go`[4]

funcinitSlackLogrus(){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()来关闭它

[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