Golang 日志记录插件库 logrus 和 io.Writer 使用指南

logrus 是 Go 语言中一个非常流行的结构化日志记录库，它提供了丰富的日志功能和灵活的扩展性。下面我将详细介绍如何使用 logrus 以及如何结合 io.Writer 实现自定义日志输出。

1. logrus 基础使用

安装 logrus

go get github.com/sirupsen/logrus

基本示例

package main

import (
	"github.com/sirupsen/logrus"
)

func main() {
	// 设置日志格式为JSON格式
	logrus.SetFormatter(&logrus.JSONFormatter{})
	
	// 设置日志级别
	logrus.SetLevel(logrus.InfoLevel)
	
	// 记录日志
	logrus.Trace("这是一条Trace日志") // 不会输出，因为级别是Info
	logrus.Debug("这是一条Debug日志") // 不会输出
	logrus.Info("这是一条Info日志")
	logrus.Warn("这是一条Warn日志")
	logrus.Error("这是一条Error日志")
	
	// 带字段的日志
	logrus.WithFields(logrus.Fields{
		"event": "user_login",
		"user_id": 12345,
	}).Info("用户登录")
}

2. 自定义日志输出 (io.Writer)

logrus 允许我们自定义日志的输出位置，通过设置 logrus.SetOutput() 方法可以指定任何实现了 io.Writer 接口的对象。

示例：输出到文件

package main

import (
	"os"
	"github.com/sirupsen/logrus"
)

func main() {
	// 创建或打开日志文件
	file, err := os.OpenFile("app.log", os.O_CREATE|os.O_WRONLY|os.O_APPEND, 0666)
	if err != nil {
		logrus.Fatal("无法打开日志文件:", err)
	}
	defer file.Close()
	
	// 设置日志输出到文件
	logrus.SetOutput(file)
	
	// 同时输出到控制台和文件
	// logrus.SetOutput(io.MultiWriter(os.Stdout, file))
	
	logrus.Info("这条日志会被写入文件")
}

示例：自定义 io.Writer 实现

package main

import (
	"bytes"
	"net/http"
	"github.com/sirupsen/logrus"
)

// 自定义的HTTP Writer，将日志发送到HTTP服务
type HTTPWriter struct {
	URL string
}

func (w *HTTPWriter) Write(p []byte) (n int, err error) {
	resp, err := http.Post(w.URL, "application/json", bytes.NewBuffer(p))
	if err != nil {
		return 0, err
	}
	defer resp.Body.Close()
	return len(p), nil
}

func main() {
	// 使用自定义的HTTP Writer
	httpWriter := &HTTPWriter{URL: "http://example.com/log"}
	logrus.SetOutput(httpWriter)
	
	logrus.Info("这条日志将通过HTTP发送")
}

3. logrus 钩子 (Hooks)

logrus 的钩子机制允许我们在日志记录时执行自定义操作。

示例：邮件通知钩子

package main

import (
	"github.com/sirupsen/logrus"
	"gopkg.in/gomail.v2"
)

// EmailHook 实现 logrus.Hook 接口
type EmailHook struct {
	From     string
	To       string
	Subject  string
	SMTPHost string
	SMTPPort int
	Username string
	Password string
}

func (h *EmailHook) Fire(entry *logrus.Entry) error {
	if entry.Level <= logrus.ErrorLevel {
		m := gomail.NewMessage()
		m.SetHeader("From", h.From)
		m.SetHeader("To", h.To)
		m.SetHeader("Subject", h.Subject+" - "+entry.Level.String())
		m.SetBody("text/plain", entry.Message)
		
		d := gomail.NewDialer(h.SMTPHost, h.SMTPPort, h.Username, h.Password)
		return d.DialAndSend(m)
	}
	return nil
}

func (h *EmailHook) Levels() []logrus.Level {
	return []logrus.Level{
		logrus.PanicLevel,
		logrus.FatalLevel,
		logrus.ErrorLevel,
	}
}

func main() {
	hook := &EmailHook{
		From:     "logger@example.com",
		To:       "admin@example.com",
		Subject:  "应用错误日志",
		SMTPHost: "smtp.example.com",
		SMTPPort: 587,
		Username: "user",
		Password: "password",
	}
	
	logrus.AddHook(hook)
	
	// 这条错误日志会触发邮件发送
	logrus.Error("发生了一个严重错误")
}

4. 最佳实践建议

1. 日志级别：合理设置日志级别，生产环境通常使用 Info 或 Warn 级别
2. 结构化日志：尽量使用 WithFields 记录结构化数据
3. 性能考虑：避免在高频调用的代码路径中记录 Debug 或 Trace 级别日志
4. 错误处理：记录错误时使用 WithError 方法
5. 上下文信息：在 Web 请求中，记录请求ID等上下文信息

// 记录错误的最佳实践
err := someFunction()
if err != nil {
	logrus.WithError(err).Error("执行someFunction失败")
}

// Web请求中的上下文日志
func handler(w http.ResponseWriter, r *http.Request) {
	requestLogger := logrus.WithFields(logrus.Fields{
		"request_id": r.Header.Get("X-Request-ID"),
		"path":      r.URL.Path,
	})
	
	requestLogger.Info("请求开始处理")
	// ...处理逻辑
	requestLogger.Info("请求处理完成")
}

logrus 提供了强大的日志功能，结合 io.Writer 和钩子机制，可以灵活地实现各种日志需求，从简单的控制台输出到复杂的分布式日志收集系统。