logrus 是一个功能丰富的、结构化的日志库，广泛用于 Go 语言项目中。它是一个相对易用且功能强大的日志工具，支持多种输出格式和日志级别，同时支持日志的钩子（hook）和日志的自定义配置。
Life is like a journey
logrus 支持结构化日志，可以将日志以键值对的形式记录，使得日志数据更容易被机器分析、存储和查询。结构化日志对于日志聚合和分析非常有用，尤其在分布式系统中。logrus 提供了丰富的日志级别支持。常见的日志级别包括：
Panic：表示严重错误，程序应该立即退出。Fatal：表示致命错误，程序通常会退出，但比 Panic 稍微温和。Error：表示错误事件，通常程序不会退出。Warn：表示警告信息。Info：用于输出常规的、对用户有用的信息。Debug：用于调试信息，适用于开发时日志。Trace：用于最详细的调试信息，记录每个程序步骤。logrus 支持多种日志格式，包括：
logrus 可以将日志输出到多个地方，如控制台、文件、网络等。你可以使用不同的输出目标配置不同的格式、级别等。logrus 支持钩子，可以向日志系统中插入自定义的行为，例如发送日志到外部服务（如 Slack、Datadog 等）或进行日志分析。钩子是日志记录前的拦截器，可以执行一些附加操作。logrus 允许在日志记录时为日志条目添加多个字段，使得日志更具上下文信息。例如，可以记录请求 ID、用户 ID、执行的操作等字段，便于后期分析。logrus 可以支持日志文件的自动轮转。例如，使用 lumberjack 库可以实现日志文件的自动切割和归档。go get github.com/sirupsen/logrus
package main
import (
"github.com/sirupsen/logrus"
)
func main() {
// 创建一个默认的 logger
log := logrus.New()
// 设置日志级别
log.SetLevel(logrus.DebugLevel)
// 记录不同级别的日志
log.Trace("This is a trace message")
log.Debug("This is a debug message")
log.Info("This is an info message")
log.Warn("This is a warning message")
log.Error("This is an error message")
log.Fatal("This is a fatal message")
log.Panic("This is a panic message")
}
logrus 支持在日志条目中添加多个字段，帮助增加日志的上下文信息：
package main
import (
"github.com/sirupsen/logrus"
)
func main() {
log := logrus.New()
// 添加字段
log.WithFields(logrus.Fields{
"username": "john_doe",
"request_id": "abc123",
}).Info("User login event")
}
输出将是：
time="2025-01-06T10:00:00Z" level=info msg="User login event" request_id=abc123 username=john_doe
logrus 默认使用文本格式输出日志，适合开发时调试和查看。logrus.SetFormatter(&logrus.TextFormatter{
FullTimestamp: true,
})
logrus 支持 JSON 格式输出，适合生产环境中与日志分析系统配合使用。logrus.SetFormatter(&logrus.JSONFormatter{})
可以同时将日志输出到多个地方（例如控制台和文件）：
package main
import (
"github.com/sirupsen/logrus"
"os"
)
func main() {
log := logrus.New()
// 输出到控制台
log.SetOutput(os.Stdout)
// 输出到文件
file, err := os.OpenFile("logfile.log", os.O_CREATE|os.O_WRONLY|os.O_APPEND, 0666)
if err != nil {
log.Fatal(err)
}
log.SetOutput(file)
// 记录日志
log.Info("This is an info message")
}
logrus 的钩子机制可以让你在记录日志时进行额外的操作。比如发送日志到远程服务、增加额外的上下文等。
package main
import (
"github.com/sirupsen/logrus"
)
// 自定义钩子
type CustomHook struct {}
func (hook *CustomHook) Levels() []logrus.Level {
return []logrus.Level{
logrus.InfoLevel,
logrus.WarnLevel,
}
}
func (hook *CustomHook) Fire(entry *logrus.Entry) error {
// 你可以在这里做一些操作，比如记录日志到远程系统
entry.Data["custom_hook"] = "true"
return nil
}
func main() {
log := logrus.New()
// 添加钩子
log.AddHook(&CustomHook{})
log.Info("This is an info message with a custom hook")
}
logrus 与第三方库（如 lumberjack）结合使用时，可以实现日志的自动切割和归档：
go get github.com/natefinch/lumberjack
package main
import (
"github.com/natefinch/lumberjack"
"github.com/sirupsen/logrus"
)
func main() {
log := logrus.New()
// 配置日志旋转
log.SetOutput(&lumberjack.Logger{
Filename: "logfile.log",
MaxSize: 10, // 每个日志文件最大 10MB
MaxBackups: 3, // 保留 3 个备份文件
MaxAge: 30, // 保留 30 天的日志
Compress: true,
})
// 记录日志
log.Info("This is a rotated log file")
}
由于 logrus 支持结构化日志（特别是 JSON 格式），它可以与常见的日志聚合工具（如 ELK Stack、Fluentd、Graylog）无缝集成。
logrus 提供了较为灵活的 API，但相较于一些轻量级的日志库（如 zap），它的性能稍逊一筹。在高吞吐量、低延迟的场景中，如果对性能要求极高，可能需要考虑 zap 或其他更专注于性能的库。然而，对于大多数应用场景，logrus 提供了足够的功能和性能。
logrus 是一个功能丰富且易于使用的 Go 语言日志库，支持多种日志级别、结构化日志、输出格式、输出目标以及日志钩子。它适用于大多数应用，特别是在开发过程中，提供了清晰、灵活的日志记录功能。同时，logrus 也能够方便地集成到生产环境中的日志聚合和分析系统中。如果你需要一个易用且功能强大的日志库，logrus 是一个非常好的选择。