Github:https://github.com/sirupsen/logrus
golang标准库的日志框架非常简单,仅仅提供了print,panic和fatal三个函数,对于更精细的日志级别、日志文件分割以及日志分发等方面并没有提供支持. 所以催生了很多第三方的日志库,但是在golang的世界里,没有一个日志库像slf4j那样在Java中具有绝对统治地位.golang中,流行的日志框架包括logrus、zap、zerolog、seelog等.
logrus是目前Github上star数量最多的日志库,logrus的使用非常简单,与标准库log类似
初步使用
logrus的使用非常简单,与标准库log类似。logrus支持更多的日志级别:
- Panic:记录日志,然后panic。
- Fatal:致命错误,出现错误时程序无法正常运转。输出日志后,程序退出;
- Error:错误日志,需要查看原因;
- Warn:警告信息,提醒程序员注意;
- Info:关键操作,核心流程的日志;
- Debug:一般程序中输出的调试信息;
- Trace:很细粒度的信息,一般用不到;
package main
import (
"github.com/sirupsen/logrus"
)
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")
}
日志级别从上向下依次增加,Trace最大,Panic最小。logrus有一个日志级别,高于这个级别的日志不会输出。默认的级别为InfoLevel。所以为了能看到Trace和Debug日志,我们在main函数第一行设置日志级别为TraceLevel。
在输出日志中添加文件名和方法信息:
调用logrus.SetReportCaller(true)设置在输出日志中添加文件名和方法信息:
package main
import (
"github.com/sirupsen/logrus"
)
func main() {
logrus.SetReportCaller(true)
logrus.Info("info msg")
}
添加字段
有时候需要在输出中添加一些字段,可以通过调用logrus.WithField和logrus.WithFields实现。
logrus.WithFields接受一个logrus.Fields类型的参数,其底层实际上为map[string]interface{}:
// github.com/sirupsen/logrus/logrus.go
type Fields map[string]interface{}
package main
import (
"github.com/sirupsen/logrus"
)
func main() {
logrus.WithFields(logrus.Fields{
"name": "dj",
"age": 18,
}).Info("info msg")
}
如果在一个函数中的所有日志都需要添加某些字段,可以使用WithFields的返回值。例如在 Web 请求的处理器中,日志都要加上user_id和ip字段:
package main
import (
"github.com/sirupsen/logrus"
)
func main() {
requestLogger := logrus.WithFields(logrus.Fields{
"user_id": 10010,
"ip": "192.168.32.15",
})
requestLogger.Info("info msg")
requestLogger.Error("error msg")
}
实际上,WithFields返回一个logrus.Entry类型的值,它将logrus.Logger和设置的logrus.Fields保存下来。调用Entry相关方法输出日志时,保存下来的logrus.Fields也会随之输出。
WithFields是一个很好用的功能, 它用于记录你这条message的一些元数据信息, 比如你可以记录是有那个访问触发的(request_id)
重定向输出
默认情况下,日志输出到io.Stderr。可以调用logrus.SetOutput传入一个io.Writer参数。后续调用相关方法日志将写到io.Writer中。
下面传入一个io.MultiWriter,同时将日志写到bytes.Buffer、标准输出和文件中:
package main
import (
"bytes"
"io"
"log"
"os"
"github.com/sirupsen/logrus"
)
func main() {
writer1 := &bytes.Buffer{}
writer2 := os.Stdout
writer3, 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(writer1, writer2, writer3))
logrus.Info("info msg")
}
日志格式
文件和json
logrus支持两种日志格式,文本和 JSON,默认为文本格式。可以通过logrus.SetFormatter设置日志格式:
package main
import (
"os"
"github.com/sirupsen/logrus"
)
// 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")
log.Formatter = &logrus.TextFormatter{}
log.WithFields(logrus.Fields{
"animal": "walrus",
"size": 10,
}).Info("A group of walrus emerges from the ocean")
}
第三方格式
除了内置的TextFormatter和JSONFormatter,还有不少第三方格式支持。我们这里介绍一个nested-logrus-formatter, 它格式提供了多个字段用来定制行为:
// github.com/antonfisher/nested-logrus-formatter/formatter.go
type Formatter struct {
FieldsOrder []string
TimestampFormat string
HideKeys bool
NoColors bool
NoFieldsColors bool
ShowFullLevel bool
TrimMessages bool
}
- 默认,logrus输出日志中字段是key=value这样的形式。使用nested格式,我们可以通过设置HideKeys为true隐藏键,只输出值;
- 默认,logrus是按键的字母序输出字段,可以设置FieldsOrder定义输出字段顺序;
- 通过设置TimestampFormat设置日期格式。
package main
import (
"time"
nested "github.com/antonfisher/nested-logrus-formatter"
"github.com/sirupsen/logrus"
)
func main() {
logrus.SetFormatter(&nested.Formatter{
HideKeys: false,
TimestampFormat: time.RFC3339,
FieldsOrder: []string{"component", "category"},
ShowFullLevel: false,
})
logrus.Info("info msg")
logrus.WithFields(logrus.Fields{
"name": "dj",
"age": 18,
}).Info("info msg")
logrus.WithFields(logrus.Fields{
"component": "aaa",
"age": 18,
}).Info("info msg")
}
自定义格式
// github.com/sirupsen/logrus/formatter.go
type Formatter interface {
Format(*Entry) ([]byte, error)
}
设置钩子
还可以为logrus设置钩子,每条日志输出前都会执行钩子的特定方法。所以,我们可以添加输出字段、根据级别将日志输出到不同的目的地。
官方有很多现成的Hook, 可以实现 记录日志到文件(日志文件轮转), 记录到kafka, 记录到influxDB, 记录到MySQL…
日志本地文件分割
logrus本身不带日志本地文件分割功能,但是我们可以通过file-rotatelogs进行日志本地文件分割。 每次当我们写入日志的时候,logrus都会调用file-rotatelogs来判断日志是否要进行切分。