go的日志库logrus

简介

logrus完全兼容Go的标准日志库log。同时它还支持文本、JSON两种日志输出格式。

源码地址：https://github.com/sirupsen/logrus

快速开始

先安装：

$ go get github.com/sirupsen/logrus
1

quick start：

func main() {
	// 手动修改日志显示的级别，即高于该级别的就会显示
	logrus.SetLevel(logrus.TraceLevel)

	logrus.Trace("trace msg")
	logrus.Debug("debug msg")
	logrus.Info("info msg")
	logrus.Warn("warn msg")
	logrus.Error("error msg")
	logrus.Fatal("fatal msg")
	logrus.Panic("panic msg") // Fatal会直接退出程序，所以panic不会触发
}
1
2
3
4
5
6
7
8
9
10
11
12

默认的日志显示级别为：Info。日志级别由高到低分别是：Panic、Fatal、Error、Warn、Info、Debug、Trace。

输出的日志包含：

• time：输出日志的时间
• level：日志级别
• msg：日志信息

手动定制

输出调用者信息

即输出调用的文件名以及调用的函数

func main() {
	logrus.SetReportCaller(true)
	logrus.Trace("trace msg")
}
1
2
3
4

此时则会打印调用者的信息。

添加字段

有时候需要在输出中添加一些字段，可以调用logrus.WithField或logrus.WithFields实现。

func main() {
	logger := logrus.WithFields(logrus.Fields{
		"user": "admin",
		"host": "localhost",
	})
	logger.Info("info msg")
}
1
2
3
4
5
6
7

WithFields的参数是map，从而实现一次性添加多个字段

等价于

func main() {
	logEntry := logrus.WithField("user", "admin")
	logEntry = logEntry.WithField("host", "localhost")
  
	logEntry.Info("info msg")
}
1
2
3
4
5
6

WithField的参数是key，value，从而实现一次性添加一个字段。

重定向输出

默认情况下，日志是输出到io.Stderr的，也就是控制台。可以通过logrus.SetOutput传入一个io.Writer从而重定向输出到不同的io。

func main() {
	io1 := &bytes.Buffer{}
	io2 := os.Stderr
	io3, err := os.OpenFile("log.txt", os.O_WRONLY|os.O_CREATE, 0755)
	if err != nil {
		log.Fatalf("create file log.txt failed: %v", err)
	}

	logrus.SetOutput(io.MultiWriter(io1, io2, io3))
	logrus.Info("info msg")
}
1
2
3
4
5
6
7
8
9
10
11

新建对象

通常情况下，考虑到易用性或者封装性，库都支持创建新的对象，这样开发者就不需要logrus.一把梭了。

func main() {
	logger := logrus.New()

	logger.Info("info msg")
}
1
2
3
4
5

从logrus的New()的源码可知：

• 默认输出到控制台
• 默认输出的日志格式是文本格式（logrus还支持JSON格式）
• 默认的日志级别是Info
• 默认不输出调用者信息

func New() *Logger {
	return &Logger{
		Out:          os.Stderr,
		Formatter:    new(TextFormatter),
		Hooks:        make(LevelHooks),
		Level:        InfoLevel,
		ExitFunc:     os.Exit,
		ReportCaller: false,
	}
}
1
2
3
4
5
6
7
8
9
10

日志格式

由上述得知，logrus默认输出的日志格式是文本格式，也就是TextFormatter，其实它还支持JSONFormatter，可以利用SetFormatter()手动指定。

func main() {
	logrus.SetFormatter(&logrus.JSONFormatter{})
	logrus.Info("info msg")
}
1
2
3
4

text格式：

time="2022-08-13T17:52:19+08:00" level=info msg="info msg"
1

JSON格式：

{"level":"info","msg":"info msg","time":"2022-08-13T17:51:35+08:00"}
1

开发者可以通过实现logrus.Formatter接口来实现自己的日志格式。

手动封装

指定Logrus的参数

type MyLogger struct {
	logger *logrus.Entry
}

func New() MyLogger {
	logger := logrus.New()
	logger.SetLevel(logrus.InfoLevel)
	logger.SetReportCaller(true)
  logger.SetFormatter(&logrus.TextFormatter{})

	return MyLogger{
		logger: logger.WithFields(logrus.Fields{"app": "test_demo"}),
	}
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14

同时再分别对各项日志级别的输出内容进行封装，这里只演示Trace()和Tracef()

func (m MyLogger) Trace(args ...interface{}) {
	m.logger.Trace(args...)
}

func (m MyLogger) Tracef(format string, args ...interface{}) {
	m.logger.Tracef(format, args...)
}
1
2
3
4
5
6
7

输出：

func main() {
	logger := New()

	logger.Info("info msg")
}
1
2
3
4
5