推荐Go语言Logrus日志库:功能强大，配置灵活（Ocean Go）

日志记录是软件开发中不可或缺的一部分，它可以帮助开发者了解软件的运行状态、排查问题以及分析用户行为。在 Go 语言中，虽然标准库提供了基础的日志功能，但在实际应用中，我们往往需要更强加、更灵活的日志库。本文将详细介绍Logrus日志库，包括其优势、功能、代码示例以及高级应用，最后与其他日志库进行对比。

为什么选择 Logrus 而不是 Go 标准库的 log

Go标准库的log包提供了一些基础的日志功能,如设置日志前缀、日志输出到文件等。然后，在实际应用中，我们通常需要更高级的日志功能，例如：

日志级别控制：Go 标准库的 log 包没有提供日志级别的概念，而 Logrus 支持多种日志级别（Trace，Debug，Info，Warning，Error，Fatal，Panic），方便开发者根据需求设置不同日志级别。
结构化日志：Logrus 允许在日志中增加字段，使得日志更加结构化，便于查询和分析。
自定义日志格式：Logrus 支持自定义日志的输出格式，内置了文本和 JSON 格式的 Formatter，而 Go 标准库的log包只支持文本格式。
Hooks机制：Logrus 支持 Hooks，允许在日志记录前后执行自定义的函数，比如将日志发送到远程系统或进行额外的处理。
灵活性和扩展性：Logrus 是一个高度灵活和可扩展的日志库，它提供了许多高级功能，如日志切割、自定义日志内容输出等。

Logrus 的功能

日志级别：Logrus 支持 Trace，Debug，Info，Warning，Error，Fatal，Panic。你可以根据需要设置不同的日志级别。

// 设置日志级别为 InfoLevel logrus.SetLevel(logrus.InfoLevel) // 只有当日志级别为 InfoLevel 或更高时，才会输出以下日志 logrus.Info("This is an info message") logrus.Debug("This debug message will not be printed")

结构化日志：Logrus 允许在日志中增加字段，使得日志更加机构化。

// 在日志中添加字段 logrus.WithFields(logrus.Fields{ "animal": "walrus", "size": 10, }).Info("A group of walrus emerges from the ocean")

Hooks：Logrus 支持 Hooks，允许在日志记录前后执行自定义函数。

package main import ( "github.com/sirupsen/logrus" ) // 自定义 Hook type MyHook struct{} func (hook MyHook) Levels() []logrus.Level { return logrus.AllLevels } func (hook MyHook) Fire(entry *logrus.Entry) error { // 在这里执行自定义逻辑，例如发送日志到远程系统 // ... return nil } func main() { // 添加自定义 Hook logrus.AddHook(MyHook{}) // 记录一条日志 logrus.Info("This log will trigger the custom hook") }

Formatter：Logrus 支持自定义日志的输出格式，内置了 TextFormatter 和 JSONFormatter。

// 使用 JSON 格式化器 logrus.SetFormatter(&logrus.JSONFormatter{}) // 记录一条 JSON 格式的日志 logrus.Info("This log will be formatted as JSON")

Entry：Lgorus 提供了 Entry 类型，可以让你在一个特定的上下文记录不同的格式日志。

entry := logrus.WithFields(logrus.Fields{ "animal": "walrus", "size": 10, }) // 使用 Entry 实例记录日志 entry.Info("A group of walrus emerges from the ocean")Logrus 的使用示例

我们可以创建一个 logger 来记录日志

package main import ( "os" "github.com/sirupsen/logrus" ) func main() { // 创建一个 Logrus 实例 log := logrus.New() // 设置日志输出为 os.Stdout log.Out = os.Stdout // 设置日志级别为 InfoLevel log.Level = logrus.InfoLevel // 记录一条 Info 级别的日志 log.WithFields(logrus.Fields{ "animal": "walrus", "size": 10, }).Info("A group of walrus emerges from the ocean") }

在这个例子中，我们创建了一个 Logrus 实例，设置了日志输出到标准输出，并且设置了日志的级别为 Info。然后，我们使用 WithFields 方法增加了一个 Fields，并记录了一条 Info 级别的日志。

当然我们也可以用 logrus 包内的函数直接设置 logrus 和记录日志,这样更加便捷。

package main import ( "os" "github.com/sirupsen/logrus" ) func main() { // 设置日志输出为 os.Stdout logrus.SetOutput(os.Stdout) // 设置日志级别为 InfoLevel logrus.SetLevel(logrus.InfoLevel) // 记录一条 Info 级别的日志 logrus.WithFields(logrus.Fields{ "animal": "walrus", "size": 10, }).Info("A group of walrus emerges from the ocean") }高级设置

日志切割：Logrus 本身不支持日志切割，但是可以通过 lumberjack 库辅助完成

package main import ( "github.com/natefinch/lumberjack" "github.com/sirupsen/logrus" ) func main() { // 设置 lumberjack 日志切割 lumberjackLogger := &lumberjack.Logger{ Filename: "/var/log/myapp.log", MaxSize: 5, MaxBackups: 3, MaxAge: 28, Compress: true, } // 创建一个 Logrus 实例 log := logrus.New() // 设置输出到 lumberjack log.Out = lumberjackLogger // 记录一条日志 log.WithFields(logrus.Fields{ "event": "startup", "type": "webserver", }).Info("webserver started") }

lumberjack 库地址:

代码行号：设置输出日志的代码行号,这个在开发阶段还是非常实用的

// 设置日志输出代码行号 log.SetReportCaller(true)

这样就可以设置输出文件的代码行号了，但默认是输出完整的代码文件路径，如果觉得太长了可以自定义 Formatter 的来实现。

自定义Formatter

logrus.SetReportCaller(true) logrus.SetFormatter(&logrus.TextFormatter{ ForceColors: true, // 设置开启终端输出彩色 FullTimestamp: true, // 设置开启完整时间戳 TimestampFormat: "2006-01-02 15:04:05.000", // 自定义事件格式 CallerPrettyfier: func(f *runtime.Frame) (string, string) { // ReportCaller 功能处理函数,这里我们只截取了源文件的文件名,没有输出完整路径 Filename := path.Base(f.File) b := bytes.Buffer{} b.WriteString(filename) b.WriteString(":") b.WriteString(strconv.Itoa(f.Line)) return "", b.String() }, })总结

Logrus 相较于其他Go语言日志库，具有以下优势：