快捷導(dǎo)航

ASP.NET?Core記錄日志

更新時(shí)間：2022年04月07日 11:47:25 作者：暗斷腸

這篇文章介紹了ASP.NET?Core記錄日志的方法，文中通過示例代碼介紹的非常詳細(xì)。對(duì)大家的學(xué)習(xí)或工作具有一定的參考借鑒價(jià)值，需要的朋友可以參考下

1.前言

ASP.NET Core支持適用于各種內(nèi)置和第三方日志記錄提供應(yīng)用程序的日志記錄API。本文介紹了如何將日志記錄API與內(nèi)置提供應(yīng)用程序一起使用。

2.添加日志提供程序

日志記錄提供應(yīng)用程序顯示或存儲(chǔ)日志。例如，控制臺(tái)提供應(yīng)用程序在控制臺(tái)上顯示日志，Azure Application Insights提供應(yīng)用程序?qū)⑦@些日志存儲(chǔ)在Azure Application Insights中。要添加提供應(yīng)用程序，請(qǐng)?jiān)赑rogram.cs中調(diào)用提供程序的Add{provider name}擴(kuò)展方法：

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中關(guān)于日志的Logging節(jié)點(diǎn)配置
            logging.AddConfiguration(hostingContext.Configuration.GetSection("Logging"));
            //日志控制臺(tái)記錄提供程序
            logging.AddConsole();
            //日志Debug記錄提供程序
logging.AddDebug();
            //日志EventSource記錄提供程序
logging.AddEventSourceLogger();
        })
        .UseStartup<Startup>()
        .Build();
    webHost.Run();
}

默認(rèn)項(xiàng)目模板調(diào)用CreateDefaultBuilder，該操作將添加日志記錄（控制臺(tái)、DEBUG、EventSource）提供給應(yīng)用程序：

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

3.創(chuàng)建日志

創(chuàng)建日志可以從依賴注入（DI）中獲取ILogger<TCategoryName>對(duì)象。以下Razor頁面示例會(huì)創(chuàng)建級(jí)別為Information且類別為AboutModel類（Models/AboutModel）的日志：

public class AboutModel
{
    private readonly ILogger _logger;
    public AboutModel(ILogger<AboutModel> logger)
　{
  　 //ILogger是Core內(nèi)置日志組件，默認(rèn)已經(jīng)注入，無需再次手動(dòng)注入
        _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服務(wù)器啟動(dòng)調(diào)試：

看看控制臺(tái)輸出日志記錄：

日志“級(jí)別”代表所記錄事件的嚴(yán)重程度。日志“類別”是與每個(gè)日志關(guān)聯(lián)的字符串。ILogger<T>實(shí)例會(huì)創(chuàng)建“類別”為類型T的完全限定名稱的日志。

3.1啟動(dòng)時(shí)（Startup）創(chuàng)建日志

要將日志寫入Startup類，構(gòu)造函數(shù)簽名需包含ILogger參數(shù)：

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服務(wù)器啟動(dòng)調(diào)試看看控制臺(tái)輸出日志記錄：

3.2在程序中（Program）創(chuàng)建日志

如果使用CreateDefaultBuilder，則可自行選擇提供應(yīng)用程序來替換默認(rèn)應(yīng)用程序。調(diào)用 ClearProviders，然后添加所需的應(yīng)用程序。

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服務(wù)器啟動(dòng)調(diào)試看看控制臺(tái)輸出日志記錄：

4.Configuration

日志記錄提供程序配置由一個(gè)或多個(gè)配置提供程序提供：

文件格式（INI、JSON 和 XML）。
命令行參數(shù)。
環(huán)境變量。
內(nèi)存中的.NET對(duì)象。
未加密的機(jī)密管理器存儲(chǔ)。
加密的用戶存儲(chǔ)，如 Azure Key Vault。
（已安裝或已創(chuàng)建的）自定義提供程序。

例如，日志記錄配置通常由應(yīng)用設(shè)置文件的Logging部分提供。以下示例顯示了典型 appsettings.Development.json 文件的內(nèi)容：

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

Logging屬性可具有LogLevel和日志提供程序?qū)傩裕@示控制臺(tái)）。Logging下的LogLevel屬性指定了用于記錄所選類別的最低級(jí)別。在本例中，System和Microsoft類別在Information級(jí)別記錄，其他均在Debug級(jí)別記錄。如果提供程序支持日志作用域，則IncludeScopes將指示是否啟用這些域。

5.日志級(jí)別

每個(gè)日志都指定了一個(gè)LogLevel值。日志級(jí)別指示嚴(yán)重性或重要程度。如果LogLevel是Warning級(jí)別，那么跟蹤Trace，Debug，Information級(jí)別將不會(huì)記錄。ASP.NET Core 定義了以下日志級(jí)別（按嚴(yán)重性從低到高排列）：　

跟蹤Trace = 0
調(diào)試Debug = 1
信息 Information = 2
警告 Warning = 3
錯(cuò)誤 Error = 4
嚴(yán)重 Critical = 5

6.內(nèi)置日志記錄提供程序

控制臺(tái)：logging.AddConsole(); dotnet run 查看控制臺(tái)日志記錄輸出。
調(diào)試：logging.AddDebug(); 在 Linux 中，此提供程序?qū)⑷罩緦懭?/var/log/message。
EventSource：logging.AddEventSourceLogger()；在Windows中，它使用PerfView實(shí)用工具收集和查看日志，但尚無支持Linux或macOS的事件集合和顯示工具。
EventLog：logging.AddEventLog()；向Windows事件日志發(fā)送日志輸出。
TraceSource：logging.AddTraceSource(sourceSwitchName);應(yīng)用必須在.NET Framework（而非.NET Core）上運(yùn)行。