萬盛學電腦網

您现在的位置: 萬盛學電腦網 >> 程式設計 >  >> 網路程式設計 >> ASP.NET 程式設計

log4net 進階配置:多 Logger 分類管理與自動日誌維護策略

為什麼需要多 Logger 分類?

大型系統中,不同功能模組(如訂單、支付、日誌、API)的日誌需求各異:

  • 輸出目標不同:檔案、資料庫、Console、Syslog、Elasticsearch
  • 日誌等級不同:核心交易記 DEBUG,一般業務記 INFO,錯誤記 ERROR
  • 保留天數不同:交易日誌保留 7 年,除錯日誌保留 7 天
  • 格式不同:審計日誌需結構化 JSON,除錯日誌可用純文字

透過程式碼動態建立多個 ILoggerRepository,各自配置 Appender,即可實現精細化日誌管理。

動態建立 Logger 的核心實作

public static ILog GetLogger(string repositoryName = "")
{
    if (string.IsNullOrEmpty(repositoryName)) 
        return LogManager.GetLogger("Default");

    ILoggerRepository repository = null;
    
    // 1. 嘗試取得現有 Repository
    try { repository = LogManager.GetRepository(repositoryName); } 
    catch { }

    // 2. 找到直接回傳 Logger
    if (repository != null)
        return LogManager.GetLogger(repositoryName, "Default");

    // 3. 不存在則建立新 Repository (雙重檢查鎖定模式防併發)
    try { repository = LogManager.CreateRepository(repositoryName); }
    catch 
    { 
        repository = LogManager.GetRepository(repositoryName); 
    }

    // 4. 配置日誌等級 (從 AppSettings 讀取)
    var appSettings = ConfigurationManager.AppSettings;
    const string logLevelKey = "LogLevel";
    if (appSettings.AllKeys.Contains(logLevelKey))
    {
        var level = appSettings[logLevelKey].ToLower();
        repository.Threshold = level switch
        {
            "all" => Level.All,
            "debug" => Level.Debug,
            "info" => Level.Info,
            "warn" => Level.Warn,
            "error" => Level.Error,
            "fatal" => Level.Fatal,
            "off" => Level.Off,
            _ => Level.All
        };
    }
    else repository.Threshold = Level.All;

    // 5. 配置 Appender (從 AppSettings 讀取,支援多個以逗號分隔)
    const string logAppenderKey = "LogAppender";
    if (appSettings.AllKeys.Contains(logAppenderKey))
    {
        var appenders = appSettings[logAppenderKey].ToLower().Split(',');
        foreach (var appender in appenders)
        {
            switch (appender.Trim())
            {
                case "rollingfile": LoadRollingFileAppender(repository); break;
                case "console": LoadConsoleAppender(repository); break;
                case "trace": LoadTraceAppender(repository); break;
            }
        }
    }
    else LoadRollingFileAppender(repository); // 預設

    return LogManager.GetLogger(repositoryName, "Default");
}

Appender 載入實作範例

private static void LoadRollingFileAppender(ILoggerRepository repository)
{
    var appender = new RollingFileAppender
    {
        Name = "RollingFile",
        File = "Logs/",                    // 目錄
        AppendToFile = true,
        LockingModel = new FileAppender.MinimalLock(),
        RollingStyle = RollingFileAppender.RollingMode.Composite,
        DatePattern = "yyyy-MM-dd HH'時.log'",
        MaxSizeRollBackups = 1000,         // 最大備份數
        MaximumFileSize = "500KB",         // 單檔大小
        StaticLogFileName = false,         // 允許檔名變動
        Layout = new PatternLayout("%n【記錄時間】%date%n【描述】%message%n")
    };
    appender.ActivateOptions();
    BasicConfigurator.Configure(repository, appender);
}

private static void LoadConsoleAppender(ILoggerRepository repository)
{
    var appender = new ConsoleAppender
    {
        Layout = new PatternLayout("%date [%thread] %-5level %logger - %message%newline")
    };
    appender.ActivateOptions();
    BasicConfigurator.Configure(repository, appender);
}

Web.config / App.config 統一配置範例

<appSettings>
    <!-- 統一設定所有 Repository 的日誌等級 -->
    <add key="LogLevel" value="DEBUG" />
    <!-- 統一設定所有 Repository 的輸出目標 -->
    <add key="LogAppender" value="rollingfile,console" />
</appSettings>

自動日誌維護策略:RollingFileAppender 進階配置

問題:檔案無限增長導致磁碟爆滿

預設配置下,日誌檔案會隨時間無限增長。需結合 時間 與 大小 兩維度滾動:

<appender name="SmartRollingAppender" type="log4net.Appender.RollingFileAppender">
    <file value="Logs/應用程式.log" />
    <appendToFile value="true" />
    <lockingModel type="log4net.Appender.FileAppender+MinimalLock" />
    
    <!-- 核心:複合滾動模式 (時間 + 大小) -->
    <rollingStyle value="Composite" />
    
    <!-- 時間模式:每小時一個檔案 -->
    <datePattern value="yyyy-MM-dd HH'時.log'" />
    
    <!-- 大小限制:單檔 500KB -->
    <maximumFileSize value="500KB" />
    
    <!-- 最大備份數:保留最近 1000 個檔案 -->
    <maxSizeRollBackups value="1000" />
    
    <!-- 關鍵:靜態檔名設為 false,允許日期模式生效 -->
    <staticLogFileName value="false" />
    
    <layout type="log4net.Layout.PatternLayout">
        <conversionPattern value="%date [%thread] %-5level %logger - %message%newline" />
    </layout>
</appender>

運作機制

  • 檔名基礎:應用程式.log
  • 每小時產生新檔:應用程式2024-01-15 14時.log
  • 單檔超過 500KB 會再分割:應用程式2024-01-15 14時.log.1, .2...
  • 總檔案數超過 1000 時,自動刪除最舊檔案

定期清理舊日誌的補充策略

log4net 本身不支援「保留 N 天」自動刪除,建議搭配排程任務:

// 可在 Application_Start 啟動背景工作,或使用 Windows 排程器/Quartz.NET
public static void CleanOldLogs(string logDirectory, int keepDays = 30)
{
    var dir = new DirectoryInfo(logDirectory);
    var cutoff = DateTime.Now.AddDays(-keepDays);
    
    foreach (var file in dir.GetFiles("*.log*"))
    {
        if (file.LastWriteTime < cutoff)
        {
            try { file.Delete(); } catch { /* 記錄錯誤 */ }
        }
    }
}

使用範例:不同模組使用獨立 Logger

// 訂單模組
private static readonly ILog OrderLog = LogHelper.GetLogger("OrderModule");
// 支付模組  
private static readonly ILog PaymentLog = LogHelper.GetLogger("PaymentModule");
// API 存取日誌
private static readonly ILog ApiLog = LogHelper.GetLogger("ApiAccess");

// 使用
OrderLog.Info("訂單建立成功", new { OrderId = 123, Amount = 999 });
PaymentLog.Error("付款失敗", ex);
ApiLog.Debug("API 請求", new { Url = "/api/order", Ip = "192.168.1.1" });

總結

透過程式碼動態管理 ILoggerRepository,配合 AppSettings 統一配置等級與 Appender,實現了:

  1. 模組隔離:各功能擁有獨立 Logger,互不干擾
  2. 集中配置:一次設定,全域生效,維護簡單
  3. 自動維護:Composite 滾動模式 + 定期清理,防止磁碟爆滿
  4. 彈性擴充:新增模組只需呼叫 GetLogger("NewModule"),無需修改設定檔

這套架構在中大型專案中經過實戰驗證,能有效解決日誌管理混亂、磁碟空間失控、除錯困難等常見問題。

copyright © 萬盛學電腦網 all rights reserved