前言

在現(xiàn)有的日志庫(kù)中，包括 go 1.21.0 引入的 slog 日志庫(kù)，它們通常都支持對(duì)日志文件進(jìn)行輪轉(zhuǎn)與切割，只不過(guò)這些功能并不直接被內(nèi)置，而是需要我們主動(dòng)配置來(lái)啟用。

本文將探討幾個(gè)熱門(mén)的日志庫(kù)如 logrus、zap 和官網(wǎng)的 slog，我將分析這些庫(kù)的的關(guān)鍵設(shè)計(jì)元素，探討它們是如何支持日志輪轉(zhuǎn)與切割功能的配置。

準(zhǔn)備好了嗎？準(zhǔn)備一杯你最喜歡的咖啡或茶，隨著本文一探究竟吧。

前段時(shí)間發(fā)布了一篇 Go slog 包：開(kāi)啟結(jié)構(gòu)化日志的奇妙之旅 文章，有一位網(wǎng)友問(wèn)我該日志庫(kù)是否支持日志輪轉(zhuǎn)與切割功能，此文章也算是解答他的一個(gè)疑惑。

圖片

淺析 logrus、zap 和 slog 的設(shè)計(jì)

在對(duì) logrus、zap 和 slog 這幾個(gè)日志庫(kù)的設(shè)計(jì)進(jìn)行對(duì)比分析時(shí)，一個(gè)顯著的共同點(diǎn)是它們都包含了 io.Writer 這個(gè)關(guān)鍵的屬性。這一屬性在日志框架設(shè)計(jì)中起著核心作用，它決定了日志輸出的目標(biāo)位置。

logrus 日志庫(kù)

logrus 是一個(gè)功能豐富的Go語(yǔ)言日志庫(kù)，它提供了結(jié)構(gòu)化日志記錄、日志級(jí)別控制等功能。

當(dāng)使用 logrus 時(shí)，可以調(diào)用 logrus.New() 函數(shù)來(lái)創(chuàng)建 Logger 實(shí)例。通過(guò)該實(shí)例我們執(zhí)行很多操作，例如自定義日志輸出的位置和打印日志等。我們看看下面的代碼：

logger := logrus.New()
logger.Out = os.Stdout // 標(biāo)準(zhǔn)輸出
// 或者定向到文件
//out, err := os.OpenFile("file.log", os.O_CREATE|os.O_WRONLY, 0666)
//if err != nil {
//	panic(err)
//}
//logger.Out = out

Logger 結(jié)構(gòu)體的定義如下所示：

type Logger struct {
	Out io.Writer
	Hooks LevelHooks
	Formatter Formatter
    // 其他字段...
}

關(guān)鍵屬性 Out，其類型為 io.Writer，這一屬性用于指定日志的輸出目標(biāo)，無(wú)論是標(biāo)準(zhǔn)輸出、文件，還是其他自定義的輸出載體。

zap 日志庫(kù)

zap 是一個(gè)性能極高的日志庫(kù)。它提供了結(jié)構(gòu)化日志記錄、多級(jí)別日志控制，以及靈活的配置選項(xiàng)。

與 logrus 類似，zap 也允許支持通過(guò)配置來(lái)決定日志輸出的位置，但實(shí)現(xiàn)方式略有不同。在 zap 中，日志輸出是通過(guò)配置 zapcore.Core 實(shí)現(xiàn)的。在創(chuàng)建 zapcore.Core 實(shí)例時(shí)，需要指定一個(gè) zapcore.WriteSyncer 接口實(shí)現(xiàn)作為參數(shù)，這個(gè)參數(shù)直接決定了日志的輸出目標(biāo)。要?jiǎng)?chuàng)建 zapcore.WriteSyncer 實(shí)例，通常使用 zapcore.AddSync() 函數(shù)，它接收一個(gè)類型為 io.Writer 的參數(shù)。

下面是一個(gè)使用 zap 創(chuàng)建日志實(shí)例的基本示例：

writer := zapcore.AddSync(os.Stdout) // 使用標(biāo)準(zhǔn)輸出作為日志目標(biāo)
core := zapcore.NewCore(
    zapcore.NewJSONEncoder(zap.NewProductionEncoderConfig()),
    writer,
    zap.InfoLevel,
)
logger := zap.New(core)
defer logger.Sync() // 刷新任何緩沖的日志條目

// 使用 logger 進(jìn)行日志記錄

關(guān)鍵在于 zapcore.AddSync() 函數(shù)，該函數(shù)接收一個(gè)類型為 io.Writer 的參數(shù)，這一參數(shù)用于指定日志的輸出目標(biāo)，無(wú)論是標(biāo)準(zhǔn)輸出、文件，還是其他自定義的輸出載體。

slog 日志庫(kù)

slog 是在 go 1.21.0 版本引入的一個(gè)官網(wǎng)日志庫(kù)，它提供了結(jié)構(gòu)化日志。如果想要更詳細(xì)地了解 slog 日志庫(kù)，自薦一篇文章 Go slog 包：開(kāi)啟結(jié)構(gòu)化日志的奇妙之旅。

與 logrus 和 zap 類似，slog 也允許用戶通過(guò)指定 io.Writer 參數(shù)來(lái)設(shè)置日志輸出的目標(biāo)。這一設(shè)置是在創(chuàng)建 slog.Handler 接口的實(shí)現(xiàn)時(shí)進(jìn)行的。

textLogger := slog.New(slog.NewTextHandler(os.Stdout, nil))
jsonLogger := slog.New(slog.NewJSONHandler(os.Stdout, nil))

在這兩個(gè)函數(shù)中，slog.NewTextHandler 和 slog.NewJSONHandler 第一個(gè)參數(shù)的類型都是 io.Writer。

淺析總結(jié)

在對(duì) logurs、zap 和 slog 這三個(gè)主流日志庫(kù)的分析中，我們可以發(fā)現(xiàn)一個(gè)關(guān)鍵的共同點(diǎn)：它們?cè)谔幚砣罩据敵鰰r(shí)均依賴于 io.Writer 接口。這些日志庫(kù)通過(guò)將 io.Writer接口作為關(guān)鍵參數(shù)的類型，以便設(shè)置日志的輸出目標(biāo)。

圖片

日志輪轉(zhuǎn)與切割功能的實(shí)現(xiàn)機(jī)制與實(shí)踐

實(shí)現(xiàn)機(jī)制

在淺析了 logurs、zap 和 slog 日志庫(kù)的設(shè)計(jì)后，我們發(fā)現(xiàn)了它們的共同點(diǎn)。現(xiàn)在，讓我們深入了解日志輪轉(zhuǎn)與切割功能的實(shí)現(xiàn)機(jī)制。

為了實(shí)現(xiàn) 日志文件的輪轉(zhuǎn)與切割，通常我們會(huì)借助第三方庫(kù)，如 lumberjack，當(dāng)然還有其他類似的庫(kù)可供選擇，這里就不一一列舉了。

lumberjack 是一個(gè)專門(mén)設(shè)計(jì)用于日志輪轉(zhuǎn)和切割的庫(kù)，其作用可以類比于一個(gè)可插拔的組件。我們可以通過(guò)配置該組件，并將其 集成 到所選的日志庫(kù)中，從而實(shí)現(xiàn)日志文件的輪轉(zhuǎn)與切割功能。

初始化 lumberjack 組件的代碼如下所示：

log := &lumberjack.Logger{
    Filename:   "/path/file.log", // 日志文件的位置
    MaxSize:    10, // 文件最大尺寸（以MB為單位）
    MaxBackups: 3, // 保留的最大舊文件數(shù)量
    MaxAge:     28, // 保留舊文件的最大天數(shù)
    Compress:   true, // 是否壓縮/歸檔舊文件
    LocalTime:  true, // 使用本地時(shí)間創(chuàng)建時(shí)間戳
}

在這個(gè)例子中，我們創(chuàng)建了一個(gè) lumberjack.Logger 實(shí)例，并設(shè)置了以下參數(shù)：

• Filename：指定日志文件的存儲(chǔ)路徑。
• MaxSize：日志文件達(dá)到多少 MB 后進(jìn)行輪轉(zhuǎn)。
• MaxBackups：最多保留多少個(gè)舊日志文件。
• MaxAge：舊文件保留的最長(zhǎng)時(shí)間（天）。
• Compress：是否壓縮舊文件（如轉(zhuǎn)換為.gz）。

需要特別注意的是， lumberjack 的 Logger 結(jié)構(gòu)體實(shí)現(xiàn)了 io.Writer 接口。這意味著所有關(guān)于日志文件的輪轉(zhuǎn)與切割的核心邏輯都封裝在 Write 方法中。這一實(shí)現(xiàn)也方便 Logger 結(jié)構(gòu)體被集成到任何支持 io.Writer 參數(shù)的日志庫(kù)中。

明白了這些，想必你已經(jīng)知道如何實(shí)現(xiàn)日志輪轉(zhuǎn)與切割的功能了吧。lumberjack 的 logger  結(jié)構(gòu)體實(shí)現(xiàn)了 io.Writer 接口，因此將它傳遞到第三方庫(kù)中，就能完成集成配置了。

實(shí)踐

logrus 日志庫(kù)的實(shí)現(xiàn)

log := &lumberjack.Logger{
    Filename:   "/path/file.log", // 日志文件的位置
    MaxSize:    10,               // 文件最大尺寸（以MB為單位）
    MaxBackups: 3,                // 保留的最大舊文件數(shù)量
    MaxAge:     28,               // 保留舊文件的最大天數(shù)
    Compress:   true,             // 是否壓縮/歸檔舊文件
    LocalTime:  true,             // 使用本地時(shí)間創(chuàng)建時(shí)間戳
}
logger := logrus.New()
logger.Out = log

zap 日志庫(kù)的實(shí)現(xiàn)

log := &lumberjack.Logger{
    Filename:   "/path/file.log", // 日志文件的位置
    MaxSize:    10,               // 文件最大尺寸（以MB為單位）
    MaxBackups: 3,                // 保留的最大舊文件數(shù)量
    MaxAge:     28,               // 保留舊文件的最大天數(shù)
    Compress:   true,             // 是否壓縮/歸檔舊文件
    LocalTime:  true,             // 使用本地時(shí)間創(chuàng)建時(shí)間戳
}
writer := zapcore.AddSync(log)
core := zapcore.NewCore(
    zapcore.NewJSONEncoder(zap.NewProductionEncoderConfig()),
    writer,
    zap.InfoLevel,
)
logger := zap.New(core)
defer logger.Sync() // 刷新任何緩沖的日志條目

slog 日志庫(kù)的實(shí)現(xiàn)

log := &lumberjack.Logger{
    Filename:   "/path/file.log", // 日志文件的位置
    MaxSize:    10,               // 文件最大尺寸（以MB為單位）
    MaxBackups: 3,                // 保留的最大舊文件數(shù)量
    MaxAge:     28,               // 保留舊文件的最大天數(shù)
    Compress:   true,             // 是否壓縮/歸檔舊文件
    LocalTime:  true,             // 使用本地時(shí)間創(chuàng)建時(shí)間戳
}
textLogger := slog.New(slog.NewTextHandler(log, nil))
jsonLogger := slog.New(slog.NewJSONHandler(log, nil))

小結(jié)

本文對(duì)三個(gè)熱門(mén)的日志庫(kù) logrus、zap 和 slog 設(shè)計(jì)要素進(jìn)行淺析，我們發(fā)現(xiàn)雖然它們?cè)趧?chuàng)建日志實(shí)例的細(xì)節(jié)上有所差異，但它們共同依賴于 io.Writer 接口參數(shù)來(lái)處理日志的輸出。掌握如何配置 io.Writer 參數(shù)，并結(jié)合 lumberjack 庫(kù)的使用，我們就可以實(shí)現(xiàn)日志文件的輪轉(zhuǎn)與切割功能。

即使后面推出新的日志庫(kù)，我們也可以通過(guò)類似的方法，快速地集成日志文件的輪轉(zhuǎn)與切割功能。

本文轉(zhuǎn)載自微信公眾號(hào)「Go技術(shù)干貨」，可以通過(guò)以下二維碼關(guān)注。轉(zhuǎn)載本文請(qǐng)聯(lián)系Go技術(shù)干貨公眾號(hào)。