go日志库logrus的安装及快速使用

作者:王者之峰 时间:2024-04-26 17:31:40 

安装简介

Logrus是Go的结构化日志记录器,与标准的日志记录器库完全API兼容。

go get安装的logrus库

go get github.com/sirupsen/logrus

快速使用

package main
import (
  log "github.com/sirupsen/logrus"
)
func main() {
  log.SetLevel(log.TraceLevel)
  log.Trace("trace")
  log.Debug("debug")
  log.Info("info")
  log.Warn("warn")
  log.Error("error")
  log.Fatal("fatal")
  log.Panic("panic")
}

输出:

TRAC[0000] trace                                        
DEBU[0000] debug                                        
INFO[0000] info                                         
WARN[0000] warn                                         
ERRO[0000] error                                        
FATA[0000] fatal                                        
exit status 1

可以看到panic没有输出,因为fatal会导致goroutine直接退出。

支持的日志级别

logrus支持多种日志级别,下面从小到大:

  • Panic:记录日志,然后panic

  • Fatal:致命错误,输出日志后,程序退出

  • Error:错误

  • Warn:警告

  • Info:关键信息

  • Debug:调试信息

  • Trace:很细粒度的信息,一般用不到。

可以看到Trace级别最大,Panic最小。默认的级别为Info,高于这个级别的日志不会输出。

日期

可以看到上面的日志没有时间,可以指定日志格式:

package main
import (
  log "github.com/sirupsen/logrus"
)
func main() {
  log.SetLevel(log.TraceLevel)
  log.SetFormatter(&log.TextFormatter{
     FullTimestamp:   true,
     TimestampFormat: "2022-07-17 00:00:00.000",
  })
  log.Trace("trace")
  log.Debug("debug")
  log.Info("info")
  log.Warn("warn")
  log.Error("error")
  log.Fatal("fatal")
  log.Panic("panic")
}

精确到毫秒。

输出:

TRAC[171717+08-77 00:00:00.628] trace                                        
DEBU[171717+08-77 00:00:00.629] debug                                        
INFO[171717+08-77 00:00:00.629] info                                         
WARN[171717+08-77 00:00:00.629] warn                                         
ERRO[171717+08-77 00:00:00.629] error                                        
FATA[171717+08-77 00:00:00.629] fatal                                        
exit status 1

打印调用位置

在进行定位的时候需要知道是那行代码调用的log.SetReportCaller(true)

package main
import (
  log "github.com/sirupsen/logrus"
)
func main() {
  log.SetLevel(log.TraceLevel)
  log.SetReportCaller(true)
  log.SetFormatter(&log.TextFormatter{
     FullTimestamp:   true,
     TimestampFormat: "2022-07-17 00:00:00.000",
  })
  log.Trace("trace")
  log.Debug("debug")
  log.Info("info")
  log.Warn("warn")
  log.Error("error")
  log.Fatal("fatal")
  log.Panic("panic")
}

输出:

TRAC[171717+08-77 00:00:00.019]/Users/wanghaifeng/GolandProjects/StudyProject/src/log/my_log.go:14 main.main() trace                                        
DEBU[171717+08-77 00:00:00.019]/Users/wanghaifeng/GolandProjects/StudyProject/src/log/my_log.go:15 main.main() debug                                        
INFO[171717+08-77 00:00:00.019]/Users/wanghaifeng/GolandProjects/StudyProject/src/log/my_log.go:16 main.main() info                                         
WARN[171717+08-77 00:00:00.019]/Users/wanghaifeng/GolandProjects/StudyProject/src/log/my_log.go:17 main.main() warn                                         
ERRO[171717+08-77 00:00:00.019]/Users/wanghaifeng/GolandProjects/StudyProject/src/log/my_log.go:18 main.main() error                                        
FATA[171717+08-77 00:00:00.019]/Users/wanghaifeng/GolandProjects/StudyProject/src/log/my_log.go:19 main.main() fatal                                        
exit status 1

添加字段

定位问题需要知道具体是那个数据调用的,可以借助于log.WithFieldlog.WithFieldslog.WithField内部调用的也是log.WithFields,参数底层使用map[string]interface{}数据结构保存:

package main
import (
  log "github.com/sirupsen/logrus"
  "os"
)
func main() {
  log.SetLevel(log.TraceLevel)
  log.SetReportCaller(true)
  log.SetFormatter(&log.TextFormatter{
     FullTimestamp:   true,
     TimestampFormat: "2022-07-17 00:00:00.000",
  })
  id := os.Args[1]
  mylog := log.WithField("id", id)
  mylog.Trace("trace")
  mylog.Debug("debug")
  mylog.Info("info")
  mylog.Warn("warn")
  mylog.Error("error")
  mylog.Fatal("fatal")
  mylog.Panic("panic")
}

输出:

➜  StudyProject go run  src/log/my_log.go 123
TRAC[171717+08-77 00:00:00.665]/Users/wanghaifeng/GolandProjects/StudyProject/src/log/my_log.go:22 main.main() trace                                         id=123
DEBU[171717+08-77 00:00:00.665]/Users/wanghaifeng/GolandProjects/StudyProject/src/log/my_log.go:23 main.main() debug                                         id=123
INFO[171717+08-77 00:00:00.665]/Users/wanghaifeng/GolandProjects/StudyProject/src/log/my_log.go:24 main.main() info                                          id=123
WARN[171717+08-77 00:00:00.665]/Users/wanghaifeng/GolandProjects/StudyProject/src/log/my_log.go:25 main.main() warn                                          id=123
ERRO[171717+08-77 00:00:00.665]/Users/wanghaifeng/GolandProjects/StudyProject/src/log/my_log.go:26 main.main() error                                         id=123
FATA[171717+08-77 00:00:00.665]/Users/wanghaifeng/GolandProjects/StudyProject/src/log/my_log.go:27 main.main() fatal                                         id=123
exit status 1

给字段值加引号

配置ForceQuotetrue

package main
import (
  log "github.com/sirupsen/logrus"
  "os"
)
func main() {
  log.SetLevel(log.TraceLevel)
  log.SetReportCaller(true)
  log.SetFormatter(&log.TextFormatter{
     FullTimestamp:   true,
     TimestampFormat: "2022-07-17 00:00:00.000",
     ForceQuote:      true,
  })
  id := os.Args[1]
  mylog := log.WithField("id", id)
  mylog.Trace("trace")
  mylog.Debug("debug")
  mylog.Info("info")
  mylog.Warn("warn")
  mylog.Error("error")
  mylog.Fatal("fatal")
  mylog.Panic("panic")
}

输出:

➜  StudyProject go run  src/log/my_log.go 123
TRAC[171717+08-77 00:00:00.427]/Users/wanghaifeng/GolandProjects/StudyProject/src/log/my_log.go:22 main.main() trace                                         id="123"
DEBU[171717+08-77 00:00:00.427]/Users/wanghaifeng/GolandProjects/StudyProject/src/log/my_log.go:23 main.main() debug                                         id="123"
INFO[171717+08-77 00:00:00.427]/Users/wanghaifeng/GolandProjects/StudyProject/src/log/my_log.go:24 main.main() info                                          id="123"
WARN[171717+08-77 00:00:00.427]/Users/wanghaifeng/GolandProjects/StudyProject/src/log/my_log.go:25 main.main() warn                                          id="123"
ERRO[171717+08-77 00:00:00.427]/Users/wanghaifeng/GolandProjects/StudyProject/src/log/my_log.go:26 main.main() error                                         id="123"
FATA[171717+08-77 00:00:00.427]/Users/wanghaifeng/GolandProjects/StudyProject/src/log/my_log.go:27 main.main() fatal                                         id="123"
exit status 1

设置钩子

每条日志在输出前都会执行钩子的特定方法,相当于全局拦截,可以方便做一些扩展,比如添加字段channel表明日志是那个应用输出的、增加tranceid方便对问题的跟踪、输出日志文件等。

设置channel

package hooks
import log "github.com/sirupsen/logrus"
type ChannelHook struct {
  ChannelName string
}
func (h ChannelHook) Levels() []log.Level {
  return log.AllLevels
}
func (h ChannelHook) Fire(entry *log.Entry) error {
  entry.Data["channel"] = h.ChannelName
  return nil
}
package main
import (
  logs "StudyProject/src/log/hooks"
  log "github.com/sirupsen/logrus"
)
func main() {
  log.AddHook(logs.ChannelHook{
     ChannelName: "web",
  })
  log.Info("info")
}

输出:

INFO[0000] info                                          channel=web

输出日志

可以利用logrus的hook自己写入文件,但是指定单个文件收集的时间范围、保存的时间logrus并不支持,笔者目前的项目使用的是file-rotatelogs,但是作者已经不更新和维护,所以这里就不使用它来展示,有在考虑使用goframe的glog替换。

笔者这里就写个简单例子演示如何利用logrus的hook去写文件并且把控制台的打印干掉:

package hooks
import (
  log "github.com/sirupsen/logrus"
  "io/ioutil"
)
//
//FileHook
//  @Description: 文件hook
//
type FileHook struct {
  //
  //  FileName
  //  @Description:  文件名
  //
  FileName string
}
func (h FileHook) Levels() []log.Level {
  return log.AllLevels
}
func (h FileHook) Fire(entry *log.Entry) error {
  fomat := &log.TextFormatter{
     FullTimestamp:   true,
     TimestampFormat: "2022-07-17 00:00:00.000",
  }
  //  从entry从获得日志内容
  msg, err := fomat.Format(entry)
  if err != nil {
     return err
  }
  err = ioutil.WriteFile(h.FileName, msg, 0644)
  if err != nil {
     return err
  }
  return nil
}
package main
import (
  logs "StudyProject/src/log/hooks"
  log "github.com/sirupsen/logrus"
  "io/ioutil"
)
func main() {
  log.AddHook(logs.FileHook{"log"})
  //  关闭控制台打印
  log.SetOutput(ioutil.Discard)
  log.Info("test log write file")
}

很显然这只是个例子,不可直接应用于生产。

来源:https://juejin.cn/post/7126102527459721246

标签:go,日志库,logrus,安装
0
投稿

猜你喜欢

  • python 读取目录下csv文件并绘制曲线v111的方法

    2022-08-21 16:05:34
  • Spring+MyBatis实现数据库读写分离方案

    2024-01-23 03:05:36
  • 基于Django OneToOneField和ForeignKey的区别详解

    2021-10-17 11:01:21
  • python3 读取Excel表格中的数据

    2021-01-14 23:03:42
  • 解决python ogr shp字段写入中文乱码的问题

    2023-07-05 00:40:17
  • 详解opencv去除背景算法的方法比较

    2022-10-08 08:48:08
  • python爬取微博评论的实例讲解

    2022-01-10 19:53:14
  • Python实现PS滤镜的万花筒效果示例

    2023-11-15 10:17:25
  • selenium+python实现自动登录脚本

    2021-09-30 01:36:19
  • Python 2与Python 3版本和编码的对比

    2023-10-11 01:02:18
  • Pyqt5 实现窗口缩放,控件在窗口内自动伸缩的操作

    2022-10-16 06:32:09
  • python 读取DICOM头文件的实例

    2021-12-03 19:30:48
  • Python用requests模块实现动态网页爬虫

    2022-10-15 16:27:06
  • python模型集成知识点总结

    2023-08-03 00:16:16
  • python mysql中in参数化说明

    2024-01-13 08:38:02
  • Centos7安装和配置Mysql5.7

    2024-01-21 12:02:22
  • scrapy爬虫:scrapy.FormRequest中formdata参数详解

    2022-10-02 10:28:38
  • 简单实现jQuery轮播效果

    2024-06-07 15:26:25
  • python根据路径导入模块的方法

    2021-10-23 14:27:38
  • OpenCV-Python实现图像平滑处理操作

    2021-06-19 10:28:21
  • asp之家 网络编程 m.aspxhome.com