Golang自动轮转日志文件多策略实现：rollingwriter使用指南

什么是rollingwriter

rollingwriter是一个功能强大的Golang日志轮转库，它提供了多种日志轮转策略，包括按时间、按文件大小、按文件行数等，并且支持多种压缩和归档选项。

安装

go get github.com/arthurkiller/rollingwriter

基本使用

1. 简单示例

package main

import (
	"log"
	"os"
	"time"

	"github.com/arthurkiller/rollingwriter"
)

func main() {
	// 配置rollingwriter
	config := rollingwriter.Config{
		LogPath:                "./logs",      // 日志目录
		TimeTagFormat:          "20060102",    // 时间格式
		FileName:               "app.log",     // 基础文件名
		MaxRemain:              3,             // 保留的旧日志文件数量
		RollingPolicy:          rollingwriter.TimeRolling, // 按时间轮转
		RollingTimePattern:     "* * * * * *", // 每分钟轮转一次
		WriterMode:             "none",        // 不压缩
		BufferWriterThershould: 8 * 1024,      // 8KB缓冲区
	}

	// 创建writer
	writer, err := rollingwriter.NewWriterFromConfig(&config)
	if err != nil {
		log.Fatal(err)
	}

	// 设置log输出
	log.SetOutput(writer)

	// 模拟日志输出
	for i := 0; i < 100; i++ {
		log.Printf("This is a test log message %d", i)
		time.Sleep(time.Second)
	}
}

多种轮转策略

1. 按时间轮转

config := rollingwriter.Config{
	LogPath:            "./logs",
	TimeTagFormat:      "20060102",
	FileName:           "time_rotate.log",
	MaxRemain:          7,  // 保留7天的日志
	RollingPolicy:      rollingwriter.TimeRolling,
	RollingTimePattern: "0 0 0 * * *", // 每天午夜轮转
}

2. 按文件大小轮转

config := rollingwriter.Config{
	LogPath:       "./logs",
	TimeTagFormat: "20060102",
	FileName:      "size_rotate.log",
	MaxRemain:     10, // 保留10个旧日志文件
	RollingPolicy: rollingwriter.VolumeRolling,
	RollingVolumeSize: "100MB", // 每个日志文件最大100MB
}

3. 按文件行数轮转

config := rollingwriter.Config{
	LogPath:       "./logs",
	TimeTagFormat: "20060102",
	FileName:      "line_rotate.log",
	MaxRemain:     5, // 保留5个旧日志文件
	RollingPolicy: rollingwriter.LineRolling,
	RollingLine:   100000, // 每10万行轮转一次
}

高级配置

1. 压缩轮转后的日志

config := rollingwriter.Config{
	LogPath:       "./logs",
	FileName:      "compressed.log",
	RollingPolicy: rollingwriter.VolumeRolling,
	RollingVolumeSize: "50MB",
	WriterMode:    "lock", // 使用lock模式
	Compress:      true,   // 启用压缩
	CompressSuffix: ".gz", // 压缩后缀
}

2. 异步写入

config := rollingwriter.Config{
	LogPath:       "./logs",
	FileName:      "async.log",
	RollingPolicy: rollingwriter.VolumeRolling,
	RollingVolumeSize: "100MB",
	Async:         true,      // 启用异步写入
	BufferSize:    4096,      // 缓冲区大小
}

3. 自定义文件名格式

config := rollingwriter.Config{
	LogPath:       "./logs",
	FileName:      "custom",
	TimeTagFormat: "2006-01-02-15-04-05",
	RollingPolicy: rollingwriter.TimeRolling,
	RollingTimePattern: "* * * * * *", // 每分钟轮转
	MaxRemain:     60, // 保留60个文件
}

最佳实践

1. 与标准log包集成

func setupLogger() {
	config := rollingwriter.Config{
		LogPath:       "./logs",
		FileName:      "app.log",
		RollingPolicy: rollingwriter.TimeRolling,
		RollingTimePattern: "0 0 0 * * *", // 每天轮转
		MaxRemain:     7,
		Async:        true,
	}
	
	writer, err := rollingwriter.NewWriterFromConfig(&config)
	if err != nil {
		panic(err)
	}
	
	log.SetOutput(writer)
	log.SetFlags(log.LstdFlags | log.Lshortfile)
}

2. 与logrus集成

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

func setupLogrus() *logrus.Logger {
	config := rollingwriter.Config{
		LogPath:       "./logs",
		FileName:      "logrus.log",
		RollingPolicy: rollingwriter.VolumeRolling,
		RollingVolumeSize: "100MB",
		MaxRemain:     10,
	}
	
	writer, err := rollingwriter.NewWriterFromConfig(&config)
	if err != nil {
		panic(err)
	}
	
	logger := logrus.New()
	logger.SetOutput(writer)
	logger.SetFormatter(&logrus.JSONFormatter{})
	
	return logger
}

注意事项

1. 确保日志目录有写入权限
2. 合理设置MaxRemain参数，避免磁盘空间被占满
3. 生产环境中建议启用异步写入以提高性能
4. 对于高频日志，考虑使用缓冲区减少IO操作

rollingwriter提供了灵活且强大的日志轮转功能，可以根据实际需求组合不同的策略和选项，是Golang项目中管理日志文件的优秀选择。