Go开源日志库Logrus的使用

一、Logrus简介

Logrus 是一个流行的 Go 语言日志库，以其功能强大、性能高效和高度机动性而闻名。有关更多介绍可检察 Logrus。
重要特点

• 丰富的日志级别：Logrus 支持多种日志级别，包罗 Debug、Info、Warn、Error、Fatal 和 Panic，以及更细粒度的 Trace 级别。这些级别可以帮助开发者根据日志的严峻程度举行筛选和处置惩罚。
  
• 多种输出格式：Logrus 支持文本（TextFormatter）和 JSON（JSONFormatter）两种内置的日志格式，并且允许用户通过实现 Formatter 接口来自定义日志格式。
  
• 结构化日志记载：Logrus 的 Field 机制允许用户为日志添加自定义字段，这些字段将作为日志消息的一部门被记载，使得日志信息更加结构化和易于查询。
  
• 可扩展的钩子机制：Logrus 提供了钩子（hook）机制，允许用户通过编写自定义的 hook 来扩展日志的功能，例如将日志发送到远程服务器、写入文件等。
  
• 预设日志字段：Logrus 的 Default Fields 机制可以给一部门或全部日志统一添加共同的日志字段，如请求ID、用户IP等。
  

二、Logrus基本用法

1、安装logrus包

1. go get github.com/sirupsen/logrus

复制代码

2、引入logrus包

1. import "github.com/sirupsen/logrus"

复制代码

3、设置日志级别

1. logrus.SetLevel(log.DebugLevel)

复制代码

4、设置日志格式化器

1. logrus.SetFormatter(&logrus.TextFormatter{
2.         FullTimestamp:   true,                  // 完整时间
3.         TimestampFormat: "2006-01-02 15:04:05", // 时间格式
4.         ForceColors:     true,                  //显示颜色
5. })

复制代码

5、设置日志输出范例

1. // 创建日志文件
2. file, _ := os.OpenFile("logs/application.log", os.O_CREATE|os.O_WRONLY|os.O_APPEND, 0666)
4. // 设置日志输出到文件
5. // logrus.SetOutput(file)
7. // 日志输出到文件和控制台
8. logrus.SetOutput(io.MultiWriter(file, os.Stdout))
10. // 输出到控制台
11. // logrus.SetOutput(os.Stdout)

复制代码

6、记载日志

1. logrus.WithField("appName", "测试logrus").Debug("这是一条Debug日志")
2. logrus.WithField("appName", "测试logrus").Info("这是一条Info日志")
3. logrus.WithFields(logrus.Fields{
4.         "appName": "测试logrus",
5.         "appId":   101,
6. }).Info("这是一条Info日志")

复制代码

结果示例：

三、Logrus进阶用法 

1、显示行号

1. // 显示行号
2. logrus.SetReportCaller(true)

复制代码

结果演示： 

 2、hook机制

在 logrus 中，钩子（Hooks）是一种在日志条目（log entry）被处置惩罚之前或之后执行自定义逻辑的机制。你可以使用钩子来执行诸如将日志发送到外部服务（如 Sentry、Splunk 等）、修改日志消息、添加额外的日志上下文等任务。
使用方法：

• 定义hook
  

实现logrus.Hook接口，其接口定义为：

1. type Hook interface {
2.         Levels() []Level
3.         Fire(*Entry) error
4. }

复制代码

• 注册hook
  

1. logrus.AddHook()

复制代码

 完整代码：

1. package main
3. import (
4.         "os"
6.         "github.com/sirupsen/logrus"
7. )
9. // 自定义hook
10. type simpleHook struct {
11. }
13. // 实现logrus.Hook接口
14. func (h *simpleHook) Levels() []logrus.Level {
15.         // 只有日志级别为 ErrorLevel 的日志执行 Fire 中定义的操作
16.         return []logrus.Level{logrus.ErrorLevel}
17. }
19. func (h *simpleHook) Fire(entry *logrus.Entry) error {
20.         // 在日志条目被处理时执行的逻辑
21.         entry.Data["appName"] = "test"
22.         // 将错误级别的日志添加单独的错误文件中
23.         file, _ := os.OpenFile("logs/error.log", os.O_CREATE|os.O_WRONLY|os.O_APPEND, 0666)
24.         defer file.Close()
26.         line, _ := entry.String()
27.         file.Write([]byte(line))
29.         return nil
30. }
32. func main() {
33.         // 注册hook
34.         logrus.AddHook(&simpleHook{})
36.         logrus.Info("测试钩子")
37.         // 只有 error 级别的日志才显示 appName = test
38.         logrus.Error("测试钩子---错误信息")
39. }

复制代码

结果演示： 

 错误信息被单独写入logs/error.log文件中，如下：

3、按时间分割日志

Logrus自己不支持日志轮转切割功能，需要共同 file-rotatelogs 包来实现。

• 下载 file-rotatelogs 包
  

1. go get github.com/lestrrat-go/file-rotatelogs

复制代码

• 新建 RotateLogs（实现了 io.Writer 的 Write 方法）
  

1. // 创建一个 writer
2. logWriter, err := rotatelogs.New(
3.         filepath.Join("logs", "syslog_%Y%m%d%H%M%S.log"), //日志路径
4.         rotatelogs.WithLinkName(filepath.Join("logs", "syslog.log")),
5.         rotatelogs.WithMaxAge(7*24*time.Hour),       // 最大保留天数：7天
6.         rotatelogs.WithRotationTime(10*time.Second), // 日志分割时间：1分钟
7. )
8. if err != nil {
9.         panic(err)
10. }

复制代码

• 新建 NewHook()
  

1. // 新建Hook，将 otatelogs作为 writer
2. hook := lfshook.NewHook(logWriter,
3.         &logrus.TextFormatter{
4.                 TimestampFormat: "2006-01-02 15:04:05",
5.                 FullTimestamp:   true,
6.         },
7. )

复制代码

• 注册 Hook
  

1. // 注册 hook
2. logger.AddHook(hook)

复制代码

完整代码：

1. package main
3. import (
4.         "io"
5.         "path/filepath"
6.         "time"
8.         rotatelogs "github.com/lestrrat-go/file-rotatelogs"
9.         "github.com/rifflock/lfshook"
10.         "github.com/sirupsen/logrus"
11. )
13. func main() {
14.         // 创建一个 writer
15.         logWriter, err := rotatelogs.New(
16.                 filepath.Join("logs", "syslog_%Y%m%d%H%M%S.log"), //日志路径
17.                 rotatelogs.WithLinkName(filepath.Join("logs", "syslog.log")),
18.                 rotatelogs.WithMaxAge(7*24*time.Hour),       // 最大保留天数：7天
19.                 rotatelogs.WithRotationTime(10*time.Second), // 日志分割时间：10秒
20.         )
21.         if err != nil {
22.                 panic(err)
23.         }
25.         // 新建Hook，将 otatelogs作为 writer
26.         hook := lfshook.NewHook(logWriter,
27.                 &logrus.TextFormatter{
28.                         TimestampFormat: "2006-01-02 15:04:05",
29.                         FullTimestamp:   true,
30.                 },
31.         )
33.         // 创建一个 logger
34.         logger := logrus.New()
35.         logger.SetReportCaller(true)
36.         logger.SetOutput(io.Discard)
38.         // 注册 hook
39.         logger.AddHook(hook)
41.         // 记录日志
42.         for i := 0; i < 10; i++ {
43.                 logger.Info("Hello world!!")
44.                 time.Sleep(3 * time.Second)
45.         }
46. }

复制代码

 结果示例：

4、按日志级别分割日志

按日志级别分割日志，可以将错误信息单独写入一个文件。
方法为：新建hook时，将差别日志级别匹配到差别的writer，如下：

1. // 新建Hook，按日志级别匹配 writer
2. hook := lfshook.NewHook(
3.         lfshook.WriterMap{
4.                 logrus.DebugLevel: logWriter,
5.                 logrus.InfoLevel:  logWriter,
6.                 logrus.WarnLevel:  logWriter,
7.                 logrus.ErrorLevel: errorWriter,
8.         },
9.         &logrus.TextFormatter{
10.                 TimestampFormat: "2006-01-02 15:04:05",
11.         },
12. )

复制代码

完整代码：

1. package main
3. import (
4.         "io"
5.         "path/filepath"
6.         "time"
8.         rotatelogs "github.com/lestrrat-go/file-rotatelogs"
9.         "github.com/rifflock/lfshook"
10.         "github.com/sirupsen/logrus"
11. )
13. func main() {
14.         // 创建一个 writer
15.         logWriter, err := rotatelogs.New(
16.                 filepath.Join("logs", "syslog_%Y%m%d%H%M%S.log"), //日志路径
17.                 rotatelogs.WithLinkName(filepath.Join("logs", "syslog.log")),
18.                 rotatelogs.WithMaxAge(7*24*time.Hour),       // 最大保留天数：7天
19.                 rotatelogs.WithRotationTime(10*time.Second), // 日志分割时间：10s
20.         )
21.         if err != nil {
22.                 panic(err)
23.         }
25.         // 创建一个 Error 级别的 writer
26.         errorWriter, err := rotatelogs.New(
27.                 filepath.Join("logs", "sysError_%Y%m%d%H%M%S.log"), //日志路径
28.                 rotatelogs.WithLinkName(filepath.Join("logs", "sysError.log")),
29.                 rotatelogs.WithMaxAge(7*24*time.Hour),       // 最大保留天数：7天
30.                 rotatelogs.WithRotationTime(10*time.Second), // 日志分割时间：1分钟
31.         )
32.         if err != nil {
33.                 panic(err)
34.         }
36.         // 新建Hook，按日志级别匹配 writer
37.         hook := lfshook.NewHook(
38.                 lfshook.WriterMap{
39.                         logrus.DebugLevel: logWriter,
40.                         logrus.InfoLevel:  logWriter,
41.                         logrus.WarnLevel:  logWriter,
42.                         logrus.ErrorLevel: errorWriter,
43.                 },
44.                 &logrus.TextFormatter{
45.                         TimestampFormat: "2006-01-02 15:04:05",
46.                 },
47.         )
49.         // 创建一个 logger
50.         logger := logrus.New()
51.         logger.SetReportCaller(true)
52.         logger.SetOutput(io.Discard)
54.         // 注册 hook
55.         logger.AddHook(hook)
57.         // 记录日志
58.         for i := 0; i < 10; i++ {
59.                 logger.Info("Hello world!!")
60.                 logger.Error("这是报错信息")
61.                 time.Sleep(3 * time.Second)
62.         }
63. }

复制代码

 结果示例：

 


免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！更多信息从访问主页：qidao123.com:ToB企服之家，中国第一个企服评测及商务社交产业平台。