一.概述

　　ASP.NET Core 支持适用于各种内置和第三方日志记录, 供程序的日志记录 API，本文介绍了如何将日志记录 API 与内置提供程序一起使用。对于第三方日志记录提供程序使用，文章最后有链接。

 

　　1.1 添加内置日志提供程序

　　　　日志记录提供程序能够用于显示日志信息或存储日志，比如控制台提供程序在控制台上显示日志，Azure Application Insights 提供程序会将这些日志存储在 Azure Application Insights 中。 可通过添加多个提供程序将日志发送到多个目标。

　　　　要添加提供程序，请在 Program.cs 中调用提供程序的 Add{provider name} 扩展方法：

        public static IWebHostBuilder CreateWebHostBuilder(string[] args) =>
            WebHost.CreateDefaultBuilder(args)
                .ConfigureAppConfiguration((hostingContext, config) =>
                {
                    config.SetBasePath(Directory.GetCurrentDirectory());
                    config.AddJsonFile("starship.json", false, true);
                })
               .ConfigureLogging((hostingContext, logging) =>
              {
                  //日志的 默认记录提供程序
                  //添加appsettings.json中关于日志的Logging节点配置
                  logging.AddConfiguration(hostingContext.Configuration.GetSection("Logging"));
                  //日志控制台记录提供程序
                  logging.AddConsole();
                  //日志Debug记录提供程序
                  logging.AddDebug();
                  //日志EventSource 记录提供程序
                  logging.AddEventSourceLogger();
              })
                .UseStartup<Startup>();

　　　　默认项目模板调用 CreateDefaultBuilder 扩展方法，该操作将添加以上日志记录提供程序(控制台，Debug,EventSource)：

    WebHost.CreateDefaultBuilder(args)

　　　　如果要自行选择提供程序来替换默认提供程序。 可以调用 ClearProviders，然后再添加所需的提供程序。

        public static IWebHost BuildWebHost(string[] args) =>
         WebHost.CreateDefaultBuilder(args)
        .UseStartup<Startup>()
        .ConfigureLogging(logging =>
        {
            logging.ClearProviders();
            //只有日志控制台记录提供程序
            logging.AddConsole();
        })
        .Build();

　　　　

　　1.2  创建日志

　　　　从 DI 中获取 ILogger<TCategoryName> 对象。以下 Razor 页面示例会创建日志“级别”为 Warning，“T类别”为 Page2Model，的日志：

    public class Page2Model : PageModel
    {
        private readonly ILogger _logger;

        public Page2Model(ILogger<Page2Model> logger)
        {
            _logger = logger;
        }

        public void OnGet()
        {
            _logger.LogWarning("Load the Page2");
        }
    }

　　　　如下所示(vs- -调试--窗口)：

 

 　　1.3 启动Startup时创建日志

　　　　要将日志写入 Startup 类，构造函数签名需包含 ILogger 参数：

        public class Startup
　　　　{
   　　　　 private readonly ILogger _logger;

   　　　　 public Startup(IConfiguration configuration, ILogger<Startup> logger)
   　　　　 {
       　　　　 Configuration = configuration;
       　　　　 _logger = logger;
   　　　　 }
　　　　}

　　　　

　　1.4  在Program中创建日志

    public static void Main(string[] args)
    {
   　　 var host = BuildWebHost(args);
    　　var logger = host.Services.GetRequiredService<ILogger<Program>>();
    　　logger.LogInformation("Seeded the database.");

   　　 host.Run();
    }

 

　　1.5   日志配置Configuration

　　　　　日志记录提供程序配置由一个或多个配置提供程序提供，它们可以是：

     　　　　  (1)文件格式（INI、JSON 和 XML）。

    　　　　   (2)命令行参数。

     　　　　  (3)环境变量。

      　　　　 (4)内存中的 .NET 对象。

       　　　　(5)未加密的机密管理器存储。

     　　　　  (6)加密的用户存储，如 Azure Key Vault。

       　　　　(7)（已安装或已创建的）自定义提供程序。

　　　　例如，日志记录配置通常由应用设置文件的 Logging 节点部分提供。 以下示例应用了典型 appsettings.Development.json 文件的内容：

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