ASP.NET Core記錄紀錄檔

2022-04-07 13:00:14

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）上執行。