Go每日一库之rotatelogs

介绍

Golang的rotatelogs库是一个用于日志轮转（log rotation）的库。日志轮转是一种常用的日志管理策略，它允许开发者将日志按照一定规则分割成多个文件，以便于管理和分析。通过使用rotatelogs库，开发者可以方便地实现日志文件的自动创建、分割和备份。

以下是关于rotatelogs库的一些关键点归纳：

1. 目的：实现日志文件的自动轮转，避免单个日志文件过大，提高日志管理的效率和方便性。
2. 功能：
   • 允许开发者自定义日志文件的命名规则和存储位置。
   • 支持按时间（如每天、每小时等）或文件大小来分割日志。
   • 可以设置日志文件的最大年龄（存活期），自动删除过期的日志文件。
   • 提供灵活的日志写入接口，可以与其他日志库（如logrus）配合使用。
3. 使用方式：
   • 引入rotatelogs库，并创建一个rotatelogs.Logger实例。
   • 配置日志文件的命名规则、存储位置、轮转时间等参数。
   • 将rotatelogs.Logger实例与日志记录器（如logrus）绑定，实现日志的自动轮转。
4. 优点：
   • 简单易用，通过配置即可实现复杂的日志轮转需求。
   • 高性能，基于Golang的原生特性开发，具有出色的性能和稳定性。
   • 灵活性强，可以与多种日志库配合使用，满足不同的日志管理需求。

实战

package rotationLog

import (
	"path"
	"time"

	rotatelogs "github.com/lestrrat-go/file-rotatelogs"
	"github.com/sirupsen/logrus"
)

const (
	baseLogDir    = "/var/log/app_log/"
	defaultJobLog = "job.log"
)

func InitLogger() error {
	baseLogFile := path.Join(baseLogDir, defaultJobLog)
	writer, err := rotatelogs.New(
		baseLogFile+".%Y_%m_%d_%H.log",               //指定文件存储的地址
		rotatelogs.WithLinkName(baseLogFile),         //指向的是现在使用的日志文件
		rotatelogs.WithMaxAge(30*24*time.Hour),       //指定单个日志文件的最长存活时间
		rotatelogs.WithRotationTime(24*time.Hour),    //指定日志的分割时间，这里是每天使用一个日志文件
	)
	if err != nil {
		logrus.Printf("failed to create rotatelogs: %s", err)
		return err
	}
	logrus.SetOutput(writer)
	return nil
}

• "/var/log/app_log/job.log.%Y_%m_%d_%H.log": 指定文件存储的地址

• WithLinkName： /var/log/app_log/job.log指向的是现在使用的日志文件

• WithMaxAge： 指定单个日志文件的最长存活时间

• WithRotationTime： 指定日志的分割时间，这里是每天使用一个日志文件

精进

[Go Package] 主流 Go 日志方案 logrus + rotatelogs + lfshook