ASP.NET Core 入門教程 10、ASP.NET Core 日誌記錄(NLog)入門

一、前言

1、本教程主要內容

• ASP.NET Core + 內置日誌組件記錄控制台日誌
• ASP.NET Core + NLog 按天記錄本地日誌
• ASP.NET Core + NLog 將日誌按自定義LoggerName分類記錄到不同目錄
• ASP.NET Core + NLog 按文件大小歸檔記錄本地日誌
• NLog配置文件常用配置項說明

2、本教程環境信息

本篇代碼以下代碼進行調整：https://github.com/ken-io/asp.net-core-tutorial/tree/master/chapter-02

二、ASP.NET Core 內置日誌組件使用

ASP.NET Core內置日誌組件，可以將日誌輸出在控制台

1、應用程式啟動時配置日誌

修改Program.cs，在WebHostBuilder構建時配置日誌

//需要引入的命名空間
using Microsoft.Extensions.Logging;

public static IWebHostBuilder CreateWebHostBuilder(string[] args) =>
        WebHost.CreateDefaultBuilder(args)
            .UseStartup<Startup>()
            .ConfigureLogging(logging =>
                {
                    logging.ClearProviders();
                    logging.SetMinimumLevel(LogLevel.Info);
                    logging.AddConsole();
                });

這裡設置項，主要是SetMinimumLevel(LogLevel.Information)，我們把日誌級別設置為Information，可以減少很多控制台日誌輸出

2、在控制中記錄日誌

修改HomeController.cs，通過構造函數註入ILogger

//需要引入的命名空間
using Microsoft.Extensions.Logging;

private readonly ILogger<HomeController> _logger;

public HomeController(ILogger<HomeController> logger)
{
    this._logger = logger;
}

public IActionResult Index()
{
    _logger.LogInformation("------\r\nindex：hello world\r\n------");
    return Content("Hello World ！ -ken.io");
}

public IActionResult CheckPhone(string phone)
{
    _logger.LogInformation($"------\r\ncheck phone：{phone}\r\n------");
    var result = true;
    var message = "pass";
    if (string.IsNullOrWhiteSpace(phone))
    {
        result = false;
        message = "phone number is empty";
        _logger.LogError($"------\r\ncheck phone：{message}\r\n------");
    }
    else if (phone.Length != 11)
    {
        result = false;
        message = "wrong phone number length";
        _logger.LogWarning($"------\r\ncheck phone：{message}\r\n------");
    }
    return Json(new { Result = result, Phone = phone, Message = message });
}

這裡日誌內容中包含的\r\n轉義符在控制台輸出時/寫入文件時表示換行，這裡加入\r\n和---主要是為了日誌輸出時，方便快速找到我們主動記錄的日誌。

3、驗證

啟動應用，訪問 localhost:5001，會看到控制台輸出了Hello World

訪問 localhost:5001/home/checkphone，將會看到Error日誌

訪問 localhost:5001/home/checkphone?phone=000,將會看到警告日誌

訪問 localhost:5001/home/checkphone?phone=16666666666，就只會看到Info級別日誌了

三、ASP.NET Core + NLog 記錄本地日誌

1、安裝NLog Package

在控制台使用命令安裝NLog包：

//進入項目目錄
cd Ken.Tutorial.Web
//使用命令安裝nlog
dotnet add package NLog.Web.AspNetCore --version 4.8.1

這裡我安裝的指定版本：4.8.1，如果不指定版本號，預設安裝最新版本。

2、引入NLog

修改Program.cs，在WebHostBuilder構建時配置日誌

//需要引入的命名空間
using NLog.Web;

public static IWebHostBuilder CreateWebHostBuilder(string[] args) =>
        WebHost.CreateDefaultBuilder(args)
            .UseStartup<Startup>()
            .ConfigureLogging(logging =>
                {
                    logging.ClearProviders();
                    logging.SetMinimumLevel(LogLevel.Info);
                    logging.AddConsole();
                }).UseNLog();//UseNLog

3、配置NLog

在項目根目錄Ken.Tutorial.Web新建NLog配置文件nlog.config

<?xml version="1.0" encoding="utf-8" ?>
<nlog xmlns="http://www.nlog-project.org/schemas/NLog.xsd" 
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" autoReload="true">

    <targets>
        <target name="defaultlog" xsi:type="File" keepFileOpen="false" encoding="utf-8"
            fileName="${basedir}/logs/${level}/${shortdate}.log" 
            layout="${longdate}|${level:uppercase=true}|${logger}|${message}" />
    </targets>

    <rules>
        <logger name="*" minlevel="trace" writeTo="defaultlog" />
    </rules>

</nlog>

NLog配置文件一般主要包含兩個部分，節點配置日誌寫入目標，節點配置匹配路由到的規則。

為了能讓程式運行時能夠讀取到配置文件，需要修改Ken.Tutorial.Web.csproj文件，在生成運行文件到bin文件夾時，也把nlog.config複製過去。在工具欄切換到資源管理器視圖，雙擊文件即可修改：

<ItemGroup>
    <Content Update="nlog.config" CopyToOutputDirectory="PreserveNewest" />
</ItemGroup>

4、NLog測試

啟動應用，分別訪問以下鏈接：

• localhost:5001/home/checkphone
• localhost:5001/home/checkphone?phone=000
• localhost:5001/home/checkphone?phone=16666666666

然後在資源管理器視圖下，查看bin/Debug目錄，會看到日誌已經按照配置文件的格式生成了對應的日誌目錄及文件。

同時也會發現，nlog.config按照之前的配置也被覆制到了程式運行目錄。

• Info級別日誌

• Warn級別日誌

• Error級別日誌

這裡Info日誌是比較多的，我們可以通過配置rules，只輸出程式本身主動記錄的日誌。

<logger name="Ken.Tutorial.*" minlevel="trace" writeTo="defaultlog" />

四、NLog使用進階

1、通過自定義LoggerName歸納日誌

增加NLog配置，根據LoggerName創建目錄

<!--按照LoggerName分類-->
<target name="customlog" xsi:type="File" keepFileOpen="false" encoding="utf-8"
        fileName="${basedir}/logs/${logger}/${shortdate}-${level}.log" 
        layout="${longdate}|${level:uppercase=true}|${logger}|${message}" />

<!--記錄LoggerName以log結尾的日誌-->
<logger name="*log" minlevel="trace" writeTo="customlog" />

在HomeController中添加測試歸納日誌的Action

public IActionResult TestLog()
{
    var logger = NLog.LogManager.GetLogger("testlog");
    logger.Trace("這是Trace日誌");
    logger.Debug("這是Debug日誌");
    logger.Info("這是Info日誌");
    logger.Warn("這是警告日誌");
    logger.Error("這是錯誤日誌");
    return Content("ok");
}

這裡直接通過NLog.LogManager.GetLogger創建Logger，並沒有使用內置日誌Microsoft.Extensions.Logging.ILogger的實例，所以可以自定義LoggerName，另外，我們在應用啟動時配置的最低日誌級別等也不會對這種方式生效，是可以輸出Trace、Debug級別的日誌的。

啟動應用，訪問：localhost:5001/home/testlog，然後就可以在資源管理器界面看到在logs文件夾下按照LoggerName生成的日誌目錄，並按照日誌級別生成了不同的日誌文件：

2、按照日誌文件大小歸檔日誌

增加NLog配置，按照日誌文件大小歸檔

<!--按照日誌文件大小歸檔-->
<target name="archivelog" xsi:type="File" keepFileOpen="false" encoding="utf-8"
    fileName="${basedir}/logs/${logger}/${shortdate}-current.log" 
    archiveFileName="${basedir}/logs/${logger}/${shortdate}.{####}.log"
    archiveAboveSize="1024000"
    archiveNumbering="Sequence"
    maxArchiveFiles="100"
    layout="${longdate}|${level:uppercase=true}|${logger}|${message}" />

這裡配置當日誌文件大小在超過約1mb的時候歸檔(這裡偷懶用1000b代替1kb)，最多歸檔100個日誌文件，當歸檔日誌文件超過100個時會把最早歸檔的日誌刪除。

定義專屬規則：

<logger name="logmany" minlevel="trace" writeTo="archivelog" />

在HomeController中添加測試歸檔日誌的Action

public IActionResult TestLogMany()
{
    var logger = NLog.LogManager.GetLogger("logmany");
    for (int i = 0; i <= 30000; i++)
    {
        logger.Info("ASP.NET Core入門教程，這裡是日誌內容，測試NLog的日誌歸檔功能，ken的雜談(https://ken.io)");
    }
    return Content("ok");
}

這裡為了方便測試，直接用for迴圈，連續寫入日誌30000次

啟動應用，訪問：localhost:5001/home/testlogmany，然後就可以在資源管理器界面看到在logs/logmany文件夾下按照文件大小歸檔的日誌

五、備註

1、NLog常用配置項說明

2、附錄

• 本文代碼示例

https://github.com/ken-io/asp.net-core-tutorial/tree/master/chapter-10

• 本文參考

https://docs.microsoft.com/zh-cn/aspnet/core/fundamentals/logging/?view=aspnetcore-2.1

https://github.com/NLog/NLog.Web/wiki/Getting-started-with-ASP.NET-Core-2

https://github.com/nlog/NLog/wiki

b恩文首發於我的獨立博客：https://ken.io/note/asp.net-core-tutorial-log-nlog