Golang logrus 的入门教程

1. logrus 是什么？

在Go语言开发中，日志记录是构建可观测性系统的基石。logrus作为一款功能强大且高度灵活的Go日志库，在开发者社区中享有盛誉。它不仅原生支持从Trace到Fatal的完整日志级别，还允许开发者在结构化JSON格式与易读的文本格式之间灵活切换。通过其强大的钩子（Hooks）机制，日志可以轻松输出到控制台、文件，甚至异步发送到远程日志服务、Slack或钉钉等平台，满足从开发调试到生产监控的全场景需求。

可以说，logrus在API的易用性、功能的完备性以及扩展的灵活性之间取得了卓越的平衡，是应对中大型Go项目日志管理需求的绝佳选择。

2. logrus 快速上手教程

1. 安装 logrus

使用Go模块管理依赖，通过一条简单的命令即可引入logrus：

go get github.com/sirupsen/logrus

2. 创建 Logger 对象

在Go代码中导入logrus包后，常见的做法是创建一个全局的Logger实例以便在整个应用中使用：

import "github.com/sirupsen/logrus"
var log = logrus.New()

此外，logrus还提供了一个开箱即用的全局标准logger，名为std。这个标准实例本质上是通过New()函数创建的默认配置日志器。该函数的源码清晰地展示了其核心配置项，为自定义提供了参考：

var (
	// std is the name of the standard logger in stdlib `log`
	std = New()
)
// Creates a new logger. Configuration should be set by changing `Formatter`,
// `Out` and `Hooks` directly on the default logger instance. You can also just
// instantiate your own:
//
//    var log = &logrus.Logger{
//      Out: os.Stderr,
//      Formatter: new(logrus.TextFormatter),
//      Hooks: make(logrus.LevelHooks),
//      Level: logrus.DebugLevel,
//    }
//
// It's recommended to make this a global instance called `log`.
func New() *Logger {
	return &Logger{
		Out:          os.Stderr,
		Formatter:    new(TextFormatter),
		Hooks:        make(LevelHooks),
		Level:        InfoLevel,
		ExitFunc:     os.Exit,
		ReportCaller: false,
	}
}

3. 配置 Logger 对象

创建Logger实例后，可以通过一系列便捷的方法对其进行深度定制。例如，设置日志的输出格式和记录级别：

log.SetFormatter(&logrus.TextFormatter{})
log.SetLevel(logrus.DebugLevel)

4. 打印日志

配置完成后，记录日志的API直观且符合直觉：

log.Info("This is an info log.")
log.Warn("This is a warning log.")
log.Error("This is an error log.")

logrus提供了Trace、Debug、Info、Warn、Error、Fatal和Panic等多个级别的日志方法，以适配不同重要性的信息记录。

5. 输出日志

默认情况下，日志会输出到标准错误流（os.Stderr）。通过修改Logger的Out字段，可以将其重定向到任何实现了io.Writer接口的目标，例如标准输出或一个文件：

log.Out = os.Stdout

logrus更强大的特性在于其钩子（Hooks）系统。通过调用AddHook方法，可以为日志事件添加自定义处理器，从而轻松实现日志的异步发送、邮件告警或写入特定存储等高级功能：

log.Hooks.Add(hook)

以上便是logrus最核心和基础的使用方法。掌握这些，你已经能够应对Go项目中的大部分日常日志记录需求。当然，logrus的高级功能远不止于此。

3. 使用 logrus 实现日志滚动与切割

在生产环境部署中，日志文件的无限制增长会迅速耗尽磁盘空间，并给日志查阅带来困难。因此，按时间或文件大小对日志进行自动切割、归档，并定期清理过期文件，是必不可少的运维实践，这一过程通常被称为日志滚动（Log Rotation）。

需要注意的是，logrus库本身并未内置日志滚动功能。实现这一特性的标准做法是借助成熟的第三方库。其中，lumberjack是一个经过广泛验证、稳定可靠的日志滚动库，与logrus集成非常简便。

以下代码示例清晰地展示了如何将lumberjack与logrus结合，为你的应用添加自动日志滚动能力：

package main
import (
	log "github.com/Sirupsen/logrus"
	"gopkg.in/natefinch/lumberjack.v2"
)
func main() {
	logger := &lumberjack.Logger{
    	// 日志文件的完整输出路径。
		Filename:   "/var/log/myapp/foo.log", 
    	// 单个日志文件的最大体积，单位是MB。
		MaxSize:    100,
    	// 保留的旧日志文件的最大数量。
		MaxBackups: 10,
    	// 保留旧日志文件的最大天数。
		MaxAge:     30,
    	// 是否使用gzip压缩旧的日志文件以节省空间。
		Compress:   true,
	}
	log.SetOutput(logger) // 将logrus的输出设置为lumberjack的Writer
}

代码中的注释解释了每个配置参数的作用。关键在于，lumberjack.Logger结构体完美实现了io.Writer接口，因此可以直接传递给logrus.SetOutput()方法，实现无缝集成。

4. 一个完整的生产级配置示例

为了将理论应用于实践，这里提供一个更贴近生产环境的完整配置示例。我们将配置logrus的全局标准logger，集成日志滚动功能，并实现同时向文件和控制台多路输出日志。

import (
	"fmt"
	"io"
	"os"
	"github.com/sirupsen/logrus"
	lumberjack "gopkg.in/natefinch/lumberjack.v2"
)
// LogConf 日志配置结构体，建议从配置文件（如YAML）中读取。
var LogConf = struct {
	Dir     string `yaml:"dir"`
	Name    string `yaml:"name"`
	Level   string `yaml:"level"`
	MaxSize int    `yaml:"max_size"`
}{
	Dir:     "./logs",
	Name:    "yourlogname.log",
	Level:   "trace",
	MaxSize: 100,
}
// InitLogger 初始化logrus日志器。
func InitLogger() error {
	// 设置日志格式为带时间戳的文本格式。
	logrus.SetFormatter(&logrus.TextFormatter{
		TimestampFormat: "2006-01-02 15:04:05.000",
	})
	// 根据配置动态设置日志级别。
	switch LogConf.Level {
	case "trace":
		logrus.SetLevel(logrus.TraceLevel)
	case "debug":
		logrus.SetLevel(logrus.DebugLevel)
	case "info":
		logrus.SetLevel(logrus.InfoLevel)
	case "warn":
		logrus.SetLevel(logrus.WarnLevel)
	case "error":
		logrus.SetLevel(logrus.ErrorLevel)
	case "fatal":
		logrus.SetLevel(logrus.FatalLevel)
	case "panic":
		logrus.SetLevel(logrus.PanicLevel)
	}
	logrus.SetReportCaller(true) // 开启后，日志将包含调用者的文件名、行号和函数名，便于调试。
	// 配置lumberjack实现日志滚动。
	// 参考：https://www.cnblogs.com/jssyjam/p/11845475.html。
	rollingLogger := &lumberjack.Logger{
		Filename:   fmt.Sprintf("%v/%v", LogConf.Dir, LogConf.Name), // 日志文件路径。
		MaxSize:    LogConf.MaxSize,                                 // 单个文件最大体积(MB)。
		MaxBackups: 10,                                              // 保留的旧日志文件个数。
		MaxAge:     30,                                              // 保留旧日志的最大天数。
		LocalTime:  true,                                            // 使用本地时间命名备份文件。
	}
	// 使用io.MultiWriter实现日志同时输出到滚动文件和标准输出（控制台）。
	logrus.SetOutput(io.MultiWriter(rollingLogger, os.Stdout))
	return nil
}

5. 总结与对比

通过本文的介绍，我们已经系统性地掌握了logrus从快速入门到满足生产环境需求的核心知识与实践。logrus凭借其丰富的钩子系统和可定制的格式化器，能够支持更复杂的日志处理流水线和输出目标。

最后，在Go语言的生态系统中，logrus虽然是热门选择，但了解其他优秀的日志库有助于做出更全面的技术选型：

• 标准库 log

Go语言内置的log包，提供了Print、Fatal、Panic等基础函数。它无需额外依赖，足以胜任简单应用或脚本的日志需求，是轻量级场景下的首选。

• zap

由Uber开源的高性能结构化日志库。其设计核心是“零内存分配”，在极高并发场景下性能表现极其出色。支持丰富的输出格式和方式，是许多对性能有极致要求的大型互联网公司的首选方案。

• zerolog

另一款专注于高性能和零分配的日志库。它提供了非常简洁流畅的链式API，代码库轻量，在保证高性能的同时也兼顾了开发者的使用体验。

总而言之，每个日志库都有其独特的定位和优势。logrus在功能丰富性、API友好度和社区活跃度上表现均衡；而zap和zerolog则在绝对性能指标上领先。开发者应根据项目的具体规模、性能瓶颈、团队习惯和维护成本来综合考量，选择最适合自己项目的Go日志解决方案。