（14）ASP.NET Core 中的日誌記錄

1.前言 ASP.NET Core支持適用於各種內置和第三方日誌記錄提供應用程式的日誌記錄API。本文介紹瞭如何將日誌記錄API與內置提供應用程式一起使用。 2.添加日誌提供程式日誌記錄提供應用程式顯示或存儲日誌。例如，控制台提供應用程式在控制臺上顯示日誌，Azure Application In ...

1.前言

ASP.NET Core支持適用於各種內置和第三方日誌記錄提供應用程式的日誌記錄API。本文介紹瞭如何將日誌記錄API與內置提供應用程式一起使用。

2.添加日誌提供程式

日誌記錄提供應用程式顯示或存儲日誌。例如，控制台提供應用程式在控制臺上顯示日誌，Azure Application Insights提供應用程式將這些日誌存儲在Azure Application Insights中。要添加提供應用程式，請在Program.cs中調用提供程式的Add{provider name}擴展方法：

public static void Main(string[] args)
{
    var webHost = new WebHostBuilder()
        .UseKestrel()
        .UseContentRoot(Directory.GetCurrentDirectory())
        .ConfigureAppConfiguration((hostingContext, config) =>
        {
            var env = hostingContext.HostingEnvironment;
            config.AddJsonFile("appsettings.json", optional: true, reloadOnChange: true)
                  .AddJsonFile($"appsettings.{env.EnvironmentName}.json",
                      optional: true, reloadOnChange: true);
            config.AddEnvironmentVariables();
        })
        .ConfigureLogging((hostingContext, logging) =>
        {
            //添加appsettings.json中關於日誌的Logging節點配置
            logging.AddConfiguration(hostingContext.Configuration.GetSection("Logging"));
            //日誌控制台記錄提供程式
            logging.AddConsole();
            //日誌Debug記錄提供程式
logging.AddDebug();
            //日誌EventSource記錄提供程式
logging.AddEventSourceLogger();
        })
        .UseStartup<Startup>()
        .Build();
    webHost.Run();
}

預設項目模板調用CreateDefaultBuilder，該操作將添加日誌記錄（控制台、DEBUG、EventSource）提供給應用程式：

public static void Main(string[] args)
{
    CreateWebHostBuilder(args).Build().Run();
}
public static IWebHostBuilder CreateWebHostBuilder(string[] args) =>
    WebHost.CreateDefaultBuilder(args)
        .UseStartup<Startup>();

3.創建日誌

創建日誌可以從依賴註入（DI）中獲取ILogger<TCategoryName>對象。以下Razor頁面示例會創建級別為Information且類別為AboutModel類（Models/AboutModel）的日誌：

public class AboutModel
{
    private readonly ILogger _logger;
    public AboutModel(ILogger<AboutModel> logger)
　{
  　 //ILogger是Core內置日誌組件，預設已經註入，無需再次手動註入
        _logger = logger;
    }
    public void OnGet()
    {
        var Message = $"About page visited at {DateTime.UtcNow.ToLongTimeString()}";
        _logger.LogInformation("Message displayed: {Message}", Message);
    }
}
private readonly ILogger<AboutModel> _logger;
public HomeController(ILogger<AboutModel> logger)
{
    _logger = logger;
}
public IActionResult Index()
{
    AboutModel aboutModel = new AboutModel(_logger);
    aboutModel.OnGet();
    return View();
}

通過Kestral伺服器啟動調試：

看看控制台輸出日誌記錄：

日誌“級別”代表所記錄事件的嚴重程度。日誌“類別”是與每個日誌關聯的字元串。ILogger<T>實例會創建“類別”為類型T的完全限定名稱的日誌。

3.1啟動時（Startup）創建日誌

要將日誌寫入Startup類，構造函數簽名需包含ILogger參數：

public class Startup
{
    private readonly ILogger _logger;
    public Startup(IConfiguration configuration, ILogger<Startup> logger)
    {
        Configuration = configuration;
        _logger = logger;
    }
    public IConfiguration Configuration { get; }
    public void ConfigureServices(IServiceCollection services)
    {
        _logger.LogInformation("Added TodoRepository to services");
    }
    public void Configure(IApplicationBuilder app, IHostingEnvironment env)
    {
        if (env.IsDevelopment())
        {
            _logger.LogInformation("In Development environment");
        }
    }
}

通過Kestral伺服器啟動調試看看控制台輸出日誌記錄：

3.2在程式中（Program）創建日誌

如果使用CreateDefaultBuilder，則可自行選擇提供應用程式來替換預設應用程式。調用 ClearProviders，然後添加所需的應用程式。

public class Program
{
    public static void Main(string[] args)
    {
        var host = CreateWebHostBuilder(args).Build();
        var logger = host.Services.GetRequiredService<ILogger<Program>>();
        logger.LogInformation("Seeded the database.");
        host.Run();
    }
    public static IWebHostBuilder CreateWebHostBuilder(string[] args) =>
    WebHost.CreateDefaultBuilder(args)
    .UseStartup<Startup>()
    .ConfigureLogging(logging =>
    {
        logging.ClearProviders();
        logging.AddConsole();
    });
}

通過Kestral伺服器啟動調試看看控制台輸出日誌記錄：

4.Configuration

日誌記錄提供程式配置由一個或多個配置提供程式提供：
●文件格式（INI、JSON 和 XML）。
●命令行參數。
●環境變數。
●記憶體中的.NET對象。
●未加密的機密管理器存儲。
●加密的用戶存儲，如 Azure Key Vault。
●（已安裝或已創建的）自定義提供程式。
例如，日誌記錄配置通常由應用設置文件的Logging部分提供。以下示例顯示了典型 appsettings.Development.json 文件的內容：

{
  "Logging": {
    "LogLevel": {
      "Default": "Debug",
      "System": "Information",
      "Microsoft": "Information"
    },
    "Console":
    {
      "IncludeScopes": true
    }
  }
}

Logging屬性可具有LogLevel和日誌提供程式屬性（顯示控制台）。Logging下的LogLevel屬性指定了用於記錄所選類別的最低級別。在本例中，System和Microsoft類別在Information級別記錄，其他均在Debug級別記錄。如果提供程式支持日誌作用域，則IncludeScopes將指示是否啟用這些域。

5.日誌級別

每個日誌都指定了一個LogLevel值。日誌級別指示嚴重性或重要程度。如果LogLevel是Warning級別，那麼跟蹤Trace，Debug，Information級別將不會記錄。ASP.NET Core 定義了以下日誌級別（按嚴重性從低到高排列）：　
●跟蹤Trace = 0
●調試Debug = 1
●信息 Information = 2
●警告 Warning = 3
●錯誤 Error = 4
●嚴重 Critical = 5

6.內置日誌記錄提供程式

●控制台：logging.AddConsole(); dotnet run 查看控制台日誌記錄輸出。
●調試：logging.AddDebug(); 在 Linux 中，此提供程式將日誌寫入 /var/log/message。
●EventSource：logging.AddEventSourceLogger()；在Windows中，它使用PerfView實用工具收集和查看日誌，但尚無支持Linux或macOS的事件集合和顯示工具。
●EventLog：logging.AddEventLog()；向Windows事件日誌發送日誌輸出。
●TraceSource：logging.AddTraceSource(sourceSwitchName);應用必須在.NET Framework（而非.NET Core）上運行。

7.第三方日誌記錄提供程式

適用於ASP.NET Core的第三方日誌記錄框架，鏈接地址官方文檔中有：
●elmah.io（GitHub 存儲庫）
●Gelf（GitHub 存儲庫）
●JSNLog（GitHub 存儲庫）
●KissLog.net（GitHub 存儲庫）
●Loggr（GitHub 存儲庫）
●NLog（GitHub 存儲庫）
●Sentry（GitHub 存儲庫）
●Serilog（GitHub 存儲庫）
●Stackdriver（Github 存儲庫）
例如使用NLog：NLog是一個靈活的免費日誌記錄平臺，適用於各種.NET平臺，包括.NET標準。NLog可以輕鬆寫入多個目標。（資料庫，文件，控制台）並即時更改日誌記錄配置。

8.總結

這篇主要講了asp.net core內置的日誌提供程式，內置的日誌自帶功能還是有限，比如不能寫入到.txt文件或資料庫中。在項目使用中還是要考慮使用第三方日誌提供程式。本篇對於內置的日誌提供程式還有：日誌消息模板、日誌作用域、Azure中的日誌記錄、日誌事件ID等未介紹，具體再參考官方文檔。

參考文獻：
ASP.NET Core 中的日誌記錄