Go 淺析主流日誌庫：從設計層學習如何集成日誌輪轉與切割功能

前言

在現有的日誌庫中，包括 go 1.21.0 引入的 slog 日誌庫，它們通常都支持對日誌文件進行輪轉與切割，只不過這些功能並不直接被內置，而是需要我們主動配置來啓用。

本文將探討幾個熱門的日誌庫如 logrus、zap 和官網的 slog，我將分析這些庫的的關鍵設計元素，探討它們是如何支持日誌輪轉與切割功能的配置。

淺析 logrus、zap 和 slog 的設計

在對 logrus、zap 和 slog 這幾個日誌庫的設計進行對比分析時，一個顯著的共同點是它們都包含了 io.Writer 這個關鍵的屬性。這一屬性在日誌框架設計中起着核心作用，它決定了日誌輸出的目標位置。

logrus 日誌庫

logrus 是一個功能豐富的 Go 語言日誌庫，它提供了結構化日誌記錄、日誌級別控制等功能。

當使用 logrus 時，可以調用 logrus.New() 函數來創建 Logger 實例。通過該實例我們執行很多操作，例如自定義日誌輸出的位置和打印日誌等。我們看看下面的代碼：

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

Logger 結構體的定義如下所示：

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

關鍵屬性 Out，其類型爲 io.Writer，這一屬性用於指定日誌的輸出目標，無論是標準輸出、文件，還是其他自定義的輸出載體。

zap 日誌庫

zap 是一個性能極高的日誌庫。它提供了結構化日誌記錄、多級別日誌控制，以及靈活的配置選項。

與 logrus 類似，zap 也允許支持通過配置來決定日誌輸出的位置，但實現方式略有不同。在 zap 中，日誌輸出是通過配置 zapcore.Core 實現的。在創建 zapcore.Core 實例時，需要指定一個 zapcore.WriteSyncer 接口實現作爲參數，這個參數直接決定了日誌的輸出目標。要創建 zapcore.WriteSyncer 實例，通常使用 zapcore.AddSync() 函數，它接收一個類型爲 io.Writer 的參數。

下面是一個使用 zap 創建日誌實例的基本示例：

writer := zapcore.AddSync(os.Stdout) // 使用標準輸出作爲日誌目標
core := zapcore.NewCore(
    zapcore.NewJSONEncoder(zap.NewProductionEncoderConfig()),
    writer,
    zap.InfoLevel,
)
logger := zap.New(core)
defer logger.Sync() // 刷新任何緩衝的日誌條目

// 使用 logger 進行日誌記錄

關鍵在於 zapcore.AddSync() 函數，該函數接收一個類型爲 io.Writer 的參數，這一參數用於指定日誌的輸出目標，無論是標準輸出、文件，還是其他自定義的輸出載體。

slog 日誌庫

slog 是在 go 1.21.0 版本引入的一個官網日誌庫，它提供了結構化日誌。如果想要更詳細地瞭解 slog 日誌庫，自薦一篇文章 Go slog 包：開啓結構化日誌的奇妙之旅。

與 logrus 和 zap 類似，slog 也允許用戶通過指定 io.Writer 參數來設置日誌輸出的目標。這一設置是在創建 slog.Handler 接口的實現時進行的。

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

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

淺析總結

在對 logurs、zap 和 slog 這三個主流日誌庫的分析中，我們可以發現一個關鍵的共同點：它們在處理日誌輸出時均依賴於 io.Writer 接口。這些日誌庫通過將 io.Writer接口作爲關鍵參數的類型，以便設置日誌的輸出目標。

日誌輪轉與切割功能的實現機制與實踐

實現機制

在淺析了 logurs、zap 和 slog 日誌庫的設計後，我們發現了它們的共同點。現在，讓我們深入瞭解日誌輪轉與切割功能的實現機制。

爲了實現 日誌文件的輪轉與切割，通常我們會藉助第三方庫，如 lumberjack，當然還有其他類似的庫可供選擇，這裏就不一一列舉了。

lumberjack 是一個專門設計用於日誌輪轉和切割的庫，其作用可以類比於一個可插拔的組件。我們可以通過配置該組件，並將其集成到所選的日誌庫中，從而實現日誌文件的輪轉與切割功能。

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

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

在這個例子中，我們創建了一個 lumberjack.Logger 實例，並設置了以下參數：

Filename：指定日誌文件的存儲路徑。
MaxSize：日誌文件達到多少 MB 後進行輪轉。
MaxBackups：最多保留多少箇舊日誌文件。
MaxAge：舊文件保留的最長時間（天）。
Compress：是否壓縮舊文件（如轉換爲. gz）。

需要特別注意的是， lumberjack 的 Logger 結構體實現了 io.Writer 接口。這意味着所有關於日誌文件的輪轉與切割的核心邏輯都封裝在 Write 方法中。這一實現也方便 Logger 結構體被集成到任何支持 io.Writer 參數的日誌庫中。

明白了這些，想必你已經知道如何實現日誌輪轉與切割的功能了吧。lumberjack 的 logger 結構體實現了 io.Writer 接口，因此將它傳遞到第三方庫中，就能完成集成配置了。

實踐

logrus 日誌庫的實現

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

zap 日誌庫的實現

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

slog 日誌庫的實現

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

小結

本文對三個熱門的日誌庫 logrus、zap 和 slog 設計要素進行淺析，我們發現雖然它們在創建日誌實例的細節上有所差異，但它們共同依賴於 io.Writer 接口參數來處理日誌的輸出。掌握如何配置 io.Writer 參數，並結合 lumberjack 庫的使用，我們就可以實現日誌文件的輪轉與切割功能。

即使後面推出新的日誌庫，我們也可以通過類似的方法，快速地集成日誌文件的輪轉與切割功能。

本文由 Readfog 進行 AMP 轉碼，版權歸原作者所有。
來源：https://mp.weixin.qq.com/s/rBV1PTSvW0kLyaS5CLy4NQ

前言