使用 AgileConfig 動態配置 NLog

2022 年 5 月 17 日
筆記
.NET Core, AgileConfig

NLog 是我們在 .NET 領域使用非常廣泛的日誌組件。它默認使用 xml 來維護它的配置。最近有幾個同學問我當使用 AgileConfig 的時候如何配置 NLog 。因為 AgileConfig 不支援集成 xml 格式的配置。其實 NLog 是支援從 appsettings.json / IConfiguration 讀取配置的，那麼肯定跟我們的 AgileConfig 集合是沒有問題的。以下介紹下 NLog 如何跟 AgileConfig 進行集成，以及支援動態化的配置。

使用 AgileConfig 配置 NLog

NLog 默認的配置是通過 xml 來配置的。現在我們的 .NET 程式大多數都是通過 appsettings.json 來配置的。NLog 提供了從 appsettings.json / IConfiguration 讀取配置的的擴展。既然支援 IConfiguration 讀取那麼跟我們的 AgileConfig 起來就非常簡單了。

修改 program.cs

從 nuget 安裝：

NLog.Extensions.Hosting
NLog.Web.AspNetCore

使用 UseAgileConfig 擴展開啟 AgileConfig 支援。在 builder.Services.AddLogging 方法內手動設置 LogManager.Configuration 的值。

//use agileconfig client
builder.Host.UseAgileConfig();

//add nlog porvider
builder.Services.AddLogging(b => {
    b.ClearProviders();
     IConfiguration config = builder.Configuration;
    NLog.LogManager.Configuration = new NLogLoggingConfiguration(config.GetSection("NLog"));
    b.AddNLogWeb();
});

在 AgileConfig 維護配置

修改好程式碼後，我們需要把 json 配置文件維護到 AgileConfig 上。
AgileConfig 的基礎使用不再贅述，看以前的文章。AgileConfig 資料。

新建應用 Nlog_test
在 AgileConfig 控制台新建一個應用 Nlog_test 。

維護 Nlog 配置
把以下 json 配置維護到 Nlog_test 應用下。

{
  "NLog": {
    "rules": [
      {
        "logger": "*",
        "minLevel": "Trace",
        "writeTo": "logfile2"
      }
    ],
    "targets": {
      "async": "True",
      "logconsole": {
        "type": "Console"
      },
      "logfile1": {
        "fileName": "d:/nlogs/nlog-${shortdate}.log",
        "type": "File"
      },
      "logfile2": {
        "fileName": "d:/nlogs/nlog-${shortdate}-file2.log",
        "type": "File"
      }
    },
    "throwConfigExceptions": "True"
  }
}

複製以上 json 文件粘貼到「編輯 JSON」文本框：

發布配置
點擊發布按鈕，上線 Nlog 配置。

運行項目

運行項目後我們可以看到日誌已經寫到指定的位置，說明 Nlog 成功從 AgileConfig 讀取到了配置。

動態刷新 NLog 配置

上面的程式碼我們實現了脫離 xml 從 Agileconfig 讀取配置來 NLog ，但是我們這個配置是一次性的，當我們在 AgileConfig 控制台修改配置的時候並不會更改 Nlog 的配置。這個顯然不符合我們 AgileConfig 動態配置的氣質。既然 NLog 不會自動監聽 IConfiguration 的變化，那麼我們就通過 AgileConfig 的配置變化事件來手動 reload NLog 的配置吧。

void loadNlogConfig()
{
    IConfiguration config = builder.Configuration;
    NLog.LogManager.Configuration = new NLogLoggingConfiguration(config.GetSection("NLog"));
    NLog.LogManager.Configuration.Reload();
}

//use agileconfig client
builder.Host.UseAgileConfig((ConfigChangedArg e) => {
    loadNlogConfig();
});

//add nlog porvider
builder.Services.AddLogging(b => {
    b.ClearProviders();
    NLog.LogManager.ConfigurationChanged += (_, _) => NLog.LogManager.ReconfigExistingLoggers();
    loadNlogConfig();
    b.AddNLogWeb();
});

通過以上配置，當我們在 AgileConfig 修改 Nlog 配置規則的時候，只要點擊發布，應用的 Nlog 配置就會實時更改。

AgileConfig

AgileConfig 是一個輕量級配置中心
✨✨✨Github地址：//github.com/dotnetcore/AgileConfig 開源不易，歡迎star✨✨✨

演示地址：//agileconfig_server.xbaby.xyz/ 超級管理員帳號：admin 密碼：123456

關注我的公眾號一起玩轉技術

Tags: .NET Core AgileConfig