.NET Core 和 ASP.NET Core 中的日志记录

作者:Kirk LarkinJuergen GutschRick Anderson

.NET Core 支持适用于各种内置和第三方日志记录提供程序的日志记录 API。 本文介绍了如何将日志记录 API 与内置提供程序一起使用。

本文中所述的大多数代码示例都来自 ASP.NET Core 应用。 这些代码片段的日志记录特定部分适用于任何使用通用主机的 .NET Core 应用。 ASP.NET Core Web 应用模板使用通用主机。

查看或下载示例代码如何下载

日志记录提供程序

日志记录提供程序存储日志,但显示日志的 Console 提供程序除外。 例如,Azure Application Insights 提供程序将日志存储在 Azure Application Insights 中。 可以启用多个提供程序。

默认 ASP.NET Core Web 应用模板:

public class Program
{
    public static void Main(string[] args)
    {
        CreateHostBuilder(args).Build().Run();
    }

    public static IHostBuilder CreateHostBuilder(string[] args) =>
        Host.CreateDefaultBuilder(args)
            .ConfigureWebHostDefaults(webBuilder =>
            {
                webBuilder.UseStartup<Startup>();
            });
}

上面的代码显示了使用 ASP.NET Core Web 应用模板创建的 Program 类。 接下来的几节提供基于使用通用主机的 ASP.NET Core Web 应用模板的示例。 本文档稍后将介绍非托管控制台应用

若要替代Host.CreateDefaultBuilder 添加的默认日志记录提供程序集,请调用 ClearProviders 并添加所需的日志记录提供程序。 例如,以下代码:

public static IHostBuilder CreateHostBuilder(string[] args) =>
    Host.CreateDefaultBuilder(args)
        .ConfigureLogging(logging =>
        {
            logging.ClearProviders();
            logging.AddConsole();
        })
        .ConfigureWebHostDefaults(webBuilder =>
        {
            webBuilder.UseStartup<Startup>();
        });

有关其他提供程序,请参阅:

创建日志

若要创建日志,请使用依赖项注入 (DI) 中的 ILogger<TCategoryName>对象。

如下示例中:

  • 创建一个记录器 ILogger<AboutModel>,该记录器使用类型为 AboutModel 的完全限定名称的日志类别。 日志类别是与每个日志关联的字符串。
  • 调用 LogInformation 以在 Information 级别登录。 日志“级别”代表所记录事件的严重程度。
public class AboutModel : PageModel
{
    private readonly ILogger _logger;

    public AboutModel(ILogger<AboutModel> logger)
    {
        _logger = logger;
    }
    public string Message { get; set; }

    public void OnGet()
    {
        Message = $"About page visited at {DateTime.UtcNow.ToLongTimeString()}";
        _logger.LogInformation(Message);
    }
}

本文档稍后将更详细地介绍级别类别

有关 Blazor 的信息,请参阅本文档中的在 Blazor 和 Blazor WebAssembly 中创建日志。

在 Main 和 Startup 中创建日志介绍如何在 MainStartup 中创建日志。

配置日志记录

日志配置通常由 appsettings {Environment}.json 文件的 Logging 部分提供 。 以下 appsettings.Development.json 文件由 ASP.NET Core Web 应用模板生成:

{
  "Logging": {
    "LogLevel": {
      "Default": "Information",
      "Microsoft": "Warning",
      "Microsoft.Hosting.Lifetime": "Information"
    }
  }
}

在上述 JSON 中:

  • 指定了 "Default""Microsoft""Microsoft.Hosting.Lifetime" 类别。
  • "Microsoft" 类别适用于以 "Microsoft" 开头的所有类别。 例如,此设置适用于 "Microsoft.AspNetCore.Routing.EndpointMiddleware" 类别。
  • "Microsoft" 类别在日志级别 Warning 或更高级别记录。
  • "Microsoft.Hosting.Lifetime" 类别比 "Microsoft" 类别更具体,因此 "Microsoft.Hosting.Lifetime" 类别在日志级别“Information”和更高级别记录。
  • 未指定特定的日志提供程序,因此 LogLevel 适用于所有启用的日志记录提供程序,但 Windows EventLog 除外。

Logging 属性可以具有 LogLevel 和日志提供程序属性。 LogLevel 指定要针对所选类别进行记录的最低级别。 在前面的 JSON 中,指定了 InformationWarning 日志级别。 LogLevel 表示日志的严重性,范围为 0 到 6:

Trace = 0、Debug = 1、Information = 2、Warning = 3、Error = 4、Critical = 5 和 None = 6。

指定 LogLevel 时,将为指定级别和更高级别的消息启用日志记录。 在前面的 JSON 中,记录了 Information 及更高级别的 Default 类别。 例如,记录了 InformationWarningErrorCritical 消息。 如果未指定 LogLevel,则日志记录默认为 Information 级别。 有关详细信息,请参阅日志级别

提供程序属性可以指定 LogLevel 属性。 提供程序下的 LogLevel 指定要为该提供程序记录的级别,并替代非提供程序日志设置。 请考虑使用以下 appsettings.json 文件:

{
  "Logging": {
    "LogLevel": { // All providers, LogLevel applies to all the enabled providers.
      "Default": "Error", // Default logging, Error and higher.
      "Microsoft": "Warning" // All Microsoft* categories, Warning and higher.
    },
    "Debug": { // Debug provider.
      "LogLevel": {
        "Default": "Information", // Overrides preceding LogLevel:Default setting.
        "Microsoft.Hosting": "Trace" // Debug:Microsoft.Hosting category.
      }
    },
    "EventSource": { // EventSource provider
      "LogLevel": {
        "Default": "Warning" // All categories of EventSource provider.
      }
    }
  }
}

Logging.{providername}.LogLevel 中的设置将替代 Logging.LogLevel 中的设置。 在前面的 JSON 中,Debug 提供程序的默认日志级别设置为 Information

Logging:Debug:LogLevel:Default:Information

前面的设置为每个 Logging:Debug: 类别(Microsoft.Hosting 除外)指定 Information 日志级别。 当列出特定类别时,该特定类别将替代默认类别。 在前面的 JSON 中,Logging:Debug:LogLevel 类别 "Microsoft.Hosting""Default" 替代 Logging:LogLevel 中的设置

可以为以下任何一项指定最低日志级别:

  • 特定提供程序:例如,Logging:EventSource:LogLevel:Default:Information
  • 特定类别:例如,Logging:LogLevel:Microsoft:Warning
  • 所有提供程序和所有类别:Logging:LogLevel:Default:Warning

低于最低级别的任何日志均不会执行以下操作:

  • 传递到提供程序。
  • 记录或显示。

要阻止所有日志,请指定 LogLevel.NoneLogLevel.None 的值为 6,该值高于 LogLevel.Critical (5)。

如果提供程序支持日志作用域,则 IncludeScopes 将指示是否启用这些域。 有关详细信息,请参阅日志范围

以下 appsettings.json 文件包含默认情况下启用的所有提供程序:

{
  "Logging": {
    "LogLevel": { // No provider, LogLevel applies to all the enabled providers.
      "Default": "Error",
      "Microsoft": "Warning",
      "Microsoft.Hosting.Lifetime": "Warning"
    },
    "Debug": { // Debug provider.
      "LogLevel": {
        "Default": "Information" // Overrides preceding LogLevel:Default setting.
      }
    },
    "Console": {
      "IncludeScopes": true,
      "LogLevel": {
        "Microsoft.AspNetCore.Mvc.Razor.Internal": "Warning",
        "Microsoft.AspNetCore.Mvc.Razor.Razor": "Debug",
        "Microsoft.AspNetCore.Mvc.Razor": "Error",
        "Default": "Information"
      }
    },
    "EventSource": {
      "LogLevel": {
        "Microsoft": "Information"
      }
    },
    "EventLog": {
      "LogLevel": {
        "Microsoft": "Information"
      }
    },
    "AzureAppServicesFile": {
      "IncludeScopes": true,
      "LogLevel": {
        "Default": "Warning"
      }
    },
    "AzureAppServicesBlob": {
      "IncludeScopes": true,
      "LogLevel": {
        "Microsoft": "Information"
      }
    },
    "ApplicationInsights": {
      "LogLevel": {
        "Default": "Information"
      }
    }
  }
}

在上述示例中:

  • 类别和级别不是建议的值。 提供该示例是为了显示所有默认提供程序。
  • Logging.{providername}.LogLevel 中的设置将替代 Logging.LogLevel 中的设置。 例如,Debug.LogLevel.Default 中的级别将替代 LogLevel.Default 中的级别。
  • 将使用每个默认提供程序别名。 每个提供程序都定义了一个别名;可在配置中使用该别名来代替完全限定的类型名称。 内置提供程序别名包括:
    • 控制台
    • 调试
    • EventSource
    • EventLog
    • AzureAppServicesFile
    • AzureAppServicesBlob
    • ApplicationInsights

通过命令行、环境变量和其他配置设置日志级别

日志级别可以由任何配置提供程序设置。

所有平台上的环境变量分层键都不支持 : 分隔符。 __(双下划线):

  • 受所有平台支持。 例如,Bash 不支持 : 分隔符,但支持 __
  • 自动替换为 :

以下命令:

  • 在 Windows 上,将环境密钥 Logging:LogLevel:Microsoft 设置为值 Information
  • 使用通过 ASP.NET Core Web 应用模板创建的应用时,请测试设置。 使用 set 之后,必须在项目目录中运行 dotnet run 命令。
set Logging__LogLevel__Microsoft=Information
dotnet run

前面的环境设置:

  • 仅在进程中设置,这些进程是从设置进程的命令窗口启动的。
  • 不由使用 Visual Studio 启动的浏览器读取。

以下 setx 命令还可以在 Windows 上设置环境键和值。 与 set 不同,setx 设置是持久的。 /M 开关在系统环境中设置变量。 如果未使用 /M,则设置用户环境变量。

setx Logging__LogLevel__Microsoft=Information /M

Azure 应用服务上,选择“设置”>“配置”页面上的“新应用程序设置” 。 Azure 应用服务应用程序设置:

  • 已静态加密且通过加密的通道进行传输。
  • 已作为环境变量公开。

有关详细信息,请参阅 Azure 应用:使用 Azure 门户替代应用配置

有关使用环境变量设置 ASP.NET Core 配置值的详细信息,请参阅环境变量。 有关使用其他配置源(包括命令行、Azure Key Vault、Azure 应用配置、其他文件格式等)的信息,请参阅 ASP.NET Core 中的配置

如何应用筛选规则

创建 ILogger<TCategoryName> 对象时,ILoggerFactory 对象将根据提供程序选择一条规则,将其应用于该记录器。 将按所选规则筛选 ILogger 实例写入的所有消息。 从可用规则中为每个提供程序和类别对选择最具体的规则。

在为给定的类别创建 ILogger 时,以下算法将用于每个提供程序:

  • 选择匹配提供程序或其别名的所有规则。 如果找不到任何匹配项,则选择提供程序为空的所有规则。
  • 根据上一步的结果,选择具有最长匹配类别前缀的规则。 如果找不到任何匹配项,则选择未指定类别的所有规则。
  • 如果选择了多条规则,则采用最后一条 。
  • 如果未选择任何规则,则使用 MinimumLevel

记录来自 dotnet run 和 Visual Studio 的输出

将显示使用默认日志记录提供程序创建的日志:

  • 在 Visual Studio 中
    • 在调试时,在“调试输出”窗口中。
    • 在“ASP.NET Core Web 服务器”窗口中。
  • 使用 dotnet run 运行应用时,在控制台窗口中。

以“Microsoft”类别开头的日志来自 ASP.NET Core 框架代码。 ASP.NET Core 和应用程序代码使用相同的日志记录 API 和提供程序。

日志类别

创建 ILogger 对象时,将指定类别。 该类别包含在由此 ILogger 实例创建的每条日志消息中。 类别字符串是任意的,但约定将使用类名称。 例如,在控制器中,名称可能为 "TodoApi.Controllers.TodoController"。 ASP.NET Core Web 应用使用 ILogger<T> 自动获取使用完全限定类型名称 T 作为类别的 ILogger 实例:

public class PrivacyModel : PageModel
{
    private readonly ILogger<PrivacyModel> _logger;

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

    public void OnGet()
    {
        _logger.LogInformation("GET Pages.PrivacyModel called.");
    }
}

要显式指定类别,请调用 ILoggerFactory.CreateLogger

public class ContactModel : PageModel
{
    private readonly ILogger _logger;

    public ContactModel(ILoggerFactory logger)
    {
        _logger = logger.CreateLogger("MyCategory");
    }

    public void OnGet()
    {
        _logger.LogInformation("GET Pages.ContactModel called.");
    }

ILogger<T> 相当于使用 T 的完全限定类型名称来调用 CreateLogger

日志级别

下表列出了 LogLevel 值、方便的 Log{LogLevel} 扩展方法以及建议的用法:

LogLevel “值” 方法 描述
Trace 0 LogTrace 包含最详细的消息。 这些消息可能包含敏感的应用数据。 这些消息默认情况下处于禁用状态,并且不应在生产中启用。
调试 1 LogDebug 用于调试和开发。 由于量大,请在生产中小心使用。
信息 2 LogInformation 跟踪应用的常规流。 可能具有长期值。
警告 3 LogWarning 对于异常事件或意外事件。 通常包括不会导致应用失败的错误或情况。
错误 4 LogError 表示无法处理的错误和异常。 这些消息表示当前操作或请求失败,而不是整个应用失败。
严重 5 LogCritical 需要立即关注的失败。 例如数据丢失、磁盘空间不足。
6 指定日志记录类别不应写入任何消息。

在上表中,LogLevel 按严重性由低到高的顺序列出。

Log 方法的第一个参数 LogLevel 指示日志的严重性。 大多数开发人员调用 Log{LogLevel} 扩展方法,而不调用 Log(LogLevel, ...)Log{LogLevel} 扩展方法调用 Log 方法并指定 LogLevel。 例如,以下两个日志记录调用功能相同,并生成相同的日志:

[HttpGet]
public IActionResult Test1(int id)
{
    var routeInfo = ControllerContext.ToCtxString(id);

    _logger.Log(LogLevel.Information, MyLogEvents.TestItem, routeInfo);
    _logger.LogInformation(MyLogEvents.TestItem, routeInfo);

    return ControllerContext.MyDisplayRouteInfo();
}

MyLogEvents.TestItem 是事件 ID。 MyLogEvents 是示例应用的一部分,并显示在日志事件 ID 部分中。

MyDisplayRouteInfo 和 ToCtxStringRick.Docs.Samples.RouteInfo NuGet 包提供。 这些方法会显示 Controller 路线信息。

下面的代码会创建 InformationWarning 日志:

[HttpGet("{id}")]
public async Task<ActionResult<TodoItemDTO>> GetTodoItem(long id)
{
    _logger.LogInformation(MyLogEvents.GetItem, "Getting item {Id}", id);

    var todoItem = await _context.TodoItems.FindAsync(id);

    if (todoItem == null)
    {
        _logger.LogWarning(MyLogEvents.GetItemNotFound, "Get({Id}) NOT FOUND", id);
        return NotFound();
    }

    return ItemToDTO(todoItem);
}

在前面的代码中,第一个 Log{LogLevel} 参数 MyLogEvents.GetItem日志事件 ID。 第二个参数是消息模板,其中的占位符用于填写剩余方法形参提供的实参值。 本文档后面的消息模板部分介绍了方法参数。

调用相应的 Log{LogLevel} 方法,以控制写入到特定存储介质的日志输出量。 例如:

  • 生产中:
    • TraceInformation 级别记录日志会产生大量详细的日志消息。 为了控制成本且不超过数据存储限制,请将 TraceInformation 级别消息记录到容量大、成本低的数据存储中。 考虑将 TraceInformation 限制为特定类别。
    • WarningCritical 级别的日志记录应该很少产生日志消息。
      • 成本和存储限制通常不是问题。
      • 很少有日志可以为数据存储选择提供更大的灵活性。
  • 在开发过程中:
    • 设置为 Warning
    • 在进行故障排除时,添加 TraceInformation 消息。 若要限制输出,请仅对正在调查的类别设置 TraceInformation

ASP.NET Core 为框架事件写入日志。 例如,考虑以下对象的日志输出:

  • 使用 ASP.NET Core 模板创建的 Razor Pages 应用。
  • 日志记录设置为 Logging:Console:LogLevel:Microsoft:Information
  • 导航到“隐私”页面:
info: Microsoft.AspNetCore.Hosting.Diagnostics[1]
      Request starting HTTP/2 GET https://localhost:5001/Privacy
info: Microsoft.AspNetCore.Routing.EndpointMiddleware[0]
      Executing endpoint '/Privacy'
info: Microsoft.AspNetCore.Mvc.RazorPages.Infrastructure.PageActionInvoker[3]
      Route matched with {page = "/Privacy"}. Executing page /Privacy
info: Microsoft.AspNetCore.Mvc.RazorPages.Infrastructure.PageActionInvoker[101]
      Executing handler method DefaultRP.Pages.PrivacyModel.OnGet - ModelState is Valid
info: Microsoft.AspNetCore.Mvc.RazorPages.Infrastructure.PageActionInvoker[102]
      Executed handler method OnGet, returned result .
info: Microsoft.AspNetCore.Mvc.RazorPages.Infrastructure.PageActionInvoker[103]
      Executing an implicit handler method - ModelState is Valid
info: Microsoft.AspNetCore.Mvc.RazorPages.Infrastructure.PageActionInvoker[104]
      Executed an implicit handler method, returned result Microsoft.AspNetCore.Mvc.RazorPages.PageResult.
info: Microsoft.AspNetCore.Mvc.RazorPages.Infrastructure.PageActionInvoker[4]
      Executed page /Privacy in 74.5188ms
info: Microsoft.AspNetCore.Routing.EndpointMiddleware[1]
      Executed endpoint '/Privacy'
info: Microsoft.AspNetCore.Hosting.Diagnostics[2]
      Request finished in 149.3023ms 200 text/html; charset=utf-8

以下 JSON 设置了 Logging:Console:LogLevel:Microsoft:Information

{
  "Logging": {      // Default, all providers.
    "LogLevel": {
      "Microsoft": "Warning"
    },
    "Console": { // Console provider.
      "LogLevel": {
        "Microsoft": "Information"
      }
    }
  }
}

日志事件 ID

每个日志都可指定一个事件 ID 。 示例应用使用 MyLogEvents 类来定义事件 ID:

public class MyLogEvents
{
    public const int GenerateItems = 1000;
    public const int ListItems     = 1001;
    public const int GetItem       = 1002;
    public const int InsertItem    = 1003;
    public const int UpdateItem    = 1004;
    public const int DeleteItem    = 1005;

    public const int TestItem      = 3000;

    public const int GetItemNotFound    = 4000;
    public const int UpdateItemNotFound = 4001;
}
[HttpGet("{id}")]
public async Task<ActionResult<TodoItemDTO>> GetTodoItem(long id)
{
    _logger.LogInformation(MyLogEvents.GetItem, "Getting item {Id}", id);

    var todoItem = await _context.TodoItems.FindAsync(id);

    if (todoItem == null)
    {
        _logger.LogWarning(MyLogEvents.GetItemNotFound, "Get({Id}) NOT FOUND", id);
        return NotFound();
    }

    return ItemToDTO(todoItem);
}

事件 ID 与一组事件相关联。 例如,与在页面上显示项列表相关的所有日志可能是 1001。

日志记录提供程序可将事件 ID 存储在 ID 字段中,存储在日志记录消息中,或者不进行存储。 调试提供程序不显示事件 ID。 控制台提供程序在类别后的括号中显示事件 ID:

info: TodoApi.Controllers.TodoItemsController[1002]
      Getting item 1
warn: TodoApi.Controllers.TodoItemsController[4000]
      Get(1) NOT FOUND

一些日志记录提供程序将事件 ID 存储在一个字段中,该字段允许对 ID 进行筛选。

日志消息模板

每个日志 API 都使用一个消息模板。 消息模板可包含要填写参数的占位符。 请在占位符中使用名称而不是数字。

[HttpGet("{id}")]
public async Task<ActionResult<TodoItemDTO>> GetTodoItem(long id)
{
    _logger.LogInformation(MyLogEvents.GetItem, "Getting item {Id}", id);

    var todoItem = await _context.TodoItems.FindAsync(id);

    if (todoItem == null)
    {
        _logger.LogWarning(MyLogEvents.GetItemNotFound, "Get({Id}) NOT FOUND", id);
        return NotFound();
    }

    return ItemToDTO(todoItem);
}

占位符的顺序(而非其名称)决定了为其提供值的参数。 在以下代码中,消息模板中的参数名称不按顺序排列:

string p1 = "param1";
string p2 = "param2";
_logger.LogInformation("Parameter values: {p2}, {p1}", p1, p2);

上面的代码按顺序通过参数值创建日志消息:

Parameter values: param1, param2

此方法允许日志记录提供程序实现语义或结构化日志记录。 参数本身会传递给日志记录系统,而不仅仅是格式化的消息模板。 这使日志记录提供程序可以将参数值存储为字段。 例如,考虑使用以下记录器方法:

_logger.LogInformation("Getting item {Id} at {RequestTime}", id, DateTime.Now);

例如,登录到 Azure 表存储时:

  • 每个 Azure 表实体都可以有 IDRequestTime 属性。
  • 具有属性的表简化了对记录数据的查询。 例如,查询可以找到特定 RequestTime 范围内的所有日志,而不必分析文本消息中的时间。

记录异常

记录器方法的重载采用异常参数:

[HttpGet("{id}")]
public IActionResult TestExp(int id)
{
    var routeInfo = ControllerContext.ToCtxString(id);
    _logger.LogInformation(MyLogEvents.TestItem, routeInfo);

    try
    {
        if (id == 3)
        {
            throw new Exception("Test exception");
        }
    }
    catch (Exception ex)
    {
        _logger.LogWarning(MyLogEvents.GetItemNotFound, ex, "TestExp({Id})", id);
        return NotFound();
    }

    return ControllerContext.MyDisplayRouteInfo();
}

MyDisplayRouteInfo 和 ToCtxStringRick.Docs.Samples.RouteInfo NuGet 包提供。 这些方法会显示 Controller 路线信息。

异常日志记录是特定于提供程序的。

默认日志级别

如果未设置默认日志级别,则默认的日志级别值为 Information

例如,考虑以下 Web 应用:

  • 使用 ASP.NET Web 应用模板创建的应用。
  • 已删除 appsettings.json 和 appsettings.Development.json 或对其进行重命名 。

使用上述设置,导航到隐私或主页会生成许多 TraceDebugInformation 消息,并在类别名称中包含 Microsoft

如果未在配置中设置默认日志级别,以下代码会设置默认日志级别:

public class Program
{
    public static void Main(string[] args)
    {
        CreateHostBuilder(args).Build().Run();
    }

    public static IHostBuilder CreateHostBuilder(string[] args) =>
        Host.CreateDefaultBuilder(args)
            .ConfigureLogging(logging => logging.SetMinimumLevel(LogLevel.Warning))
            .ConfigureWebHostDefaults(webBuilder =>
            {
                webBuilder.UseStartup<Startup>();
            });
}

通常,日志级别应在配置中指定,而不是在代码中指定。

筛选器函数

对配置或代码没有向其分配规则的所有提供程序和类别调用筛选器函数:

public class Program
{
    public static void Main(string[] args)
    {
        CreateHostBuilder(args).Build().Run();
    }

    public static IHostBuilder CreateHostBuilder(string[] args) =>
        Host.CreateDefaultBuilder(args)
            .ConfigureLogging(logging =>
            {
                logging.AddFilter((provider, category, logLevel) =>
                {
                    if (provider.Contains("ConsoleLoggerProvider")
                        && category.Contains("Controller")
                        && logLevel >= LogLevel.Information)
                    {
                        return true;
                    }
                    else if (provider.Contains("ConsoleLoggerProvider")
                        && category.Contains("Microsoft")
                        && logLevel >= LogLevel.Information)
                    {
                        return true;
                    }
                    else
                    {
                        return false;
                    }
                });
            })
            .ConfigureWebHostDefaults(webBuilder =>
            {
                webBuilder.UseStartup<Startup>();
            });
}

如果类别包含 ControllerMicrosoft,并且日志级别为 Information 或更高级别,以上代码会显示控制台日志。

通常,日志级别应在配置中指定,而不是在代码中指定。

ASP.NET Core 和 EF Core 类别

下表包含 ASP.NET Core 和 Entity Framework Core 使用的一些类别,并带有有关日志的注释:

类别 说明
Microsoft.AspNetCore 常规 ASP.NET Core 诊断。
Microsoft.AspNetCore.DataProtection 考虑、找到并使用了哪些密钥。
Microsoft.AspNetCore.HostFiltering 所允许的主机。
Microsoft.AspNetCore.Hosting HTTP 请求完成的时间和启动时间。 加载了哪些承载启动程序集。
Microsoft.AspNetCore.Mvc MVC 和 Razor 诊断。 模型绑定、筛选器执行、视图编译和操作选择。
Microsoft.AspNetCore.Routing 路由匹配信息。
Microsoft.AspNetCore.Server 连接启动、停止和保持活动响应。 HTTP 证书信息。
Microsoft.AspNetCore.StaticFiles 提供的文件。
Microsoft.EntityFrameworkCore 常规 Entity Framework Core 诊断。 数据库活动和配置、更改检测、迁移。

若要在控制台窗口中查看更多类别,请将 appsettings.Development.json 设置为以下各项:

{
  "Logging": {
    "LogLevel": {
      "Default": "Information",
      "Microsoft": "Trace",
      "Microsoft.Hosting.Lifetime": "Information"
    }
  }
}

日志作用域

“作用域”可对一组逻辑操作分组 。 此分组可用于将相同的数据附加到作为集合的一部分而创建的每个日志。 例如,在处理事务期间创建的每个日志都可包括事务 ID。

范围:

以下提供程序支持范围:

要使用作用域,请在 using 块中包装记录器调用:

[HttpGet("{id}")]
public async Task<ActionResult<TodoItemDTO>> GetTodoItem(long id)
{
    TodoItem todoItem;

    using (_logger.BeginScope("using block message"))
    {
        _logger.LogInformation(MyLogEvents.GetItem, "Getting item {Id}", id);

        todoItem = await _context.TodoItems.FindAsync(id);

        if (todoItem == null)
        {
            _logger.LogWarning(MyLogEvents.GetItemNotFound, 
                "Get({Id}) NOT FOUND", id);
            return NotFound();
        }
    }

    return ItemToDTO(todoItem);
}

以下 JSON 为控制台提供程序启用范围:

{
  "Logging": {
    "Debug": {
      "LogLevel": {
        "Default": "Information"
      }
    },
    "Console": {
      "IncludeScopes": true, // Required to use Scopes.
      "LogLevel": {
        "Microsoft": "Warning",
        "Default": "Information"
      }
    },
    "LogLevel": {
      "Default": "Debug"
    }
  }
}

下列代码为控制台提供程序启用作用域:

通常,日志记录应在配置中指定,而不是在代码中指定。

内置日志记录提供程序

ASP.NET Core 包含以下日志记录提供程序:

要了解 stdout 以及如何通过 ASP.NET Core 模块调试日志记录,请参阅 对 Azure 应用服务和 IIS 上的 ASP.NET Core 进行故障排除ASP.NET Core 模块

控制台

Console 提供程序将输出记录到控制台。 如需详细了解如何在开发环境中查看 Console 日志,请参阅记录来自 dotnet run 和 Visual Studio 的输出

调试

Debug 提供程序通过使用 System.Diagnostics.Debug 类来写入日志输出。 对 System.Diagnostics.Debug.WriteLine 的调用写入到 Debug 提供程序。

在 Linux 上,Debug 提供程序日志位置取决于分发,并且可以是以下位置之一:

  • /var/log/message
  • /var/log/syslog

事件来源

EventSource 提供程序写入名称为 Microsoft-Extensions-Logging 的跨平台事件源。 在 Windows 上,提供程序使用的是 ETW

dotnet 跟踪工具

dotnet-trace 工具是一种跨平台 CLI 全局工具,可用于收集正在运行的进程的 .NET Core 跟踪。 该工具会使用 LoggingEventSource 收集 Microsoft.Extensions.Logging.EventSource 提供程序数据。

有关安装说明,请参阅 dotnet-trace

使用 dotnet 跟踪工具从应用中收集跟踪:

  1. 使用 dotnet run 命令运行此应用。

  2. 确定 .NET Core 应用的进程标识符 (PID):

    找到进程的 PID,它与应用的程序集的名称相同。

  3. 执行 dotnet trace 命令。

    常规命令语法:

    dotnet trace collect -p {PID} 
        --providers Microsoft-Extensions-Logging:{Keyword}:{Event Level}
            :FilterSpecs=\"
                {Logger Category 1}:{Event Level 1};
                {Logger Category 2}:{Event Level 2};
                ...
                {Logger Category N}:{Event Level N}\"
    

    使用 PowerShell 命令行界面时,将 --providers 值用单引号 (') 引起来:

    dotnet trace collect -p {PID} 
        --providers 'Microsoft-Extensions-Logging:{Keyword}:{Event Level}
            :FilterSpecs=\"
                {Logger Category 1}:{Event Level 1};
                {Logger Category 2}:{Event Level 2};
                ...
                {Logger Category N}:{Event Level N}\"'
    

    在非 Windows 平台上,添加 -f speedscope 选项,将输出跟踪文件更改为 speedscope

    关键字 说明
    1 记录有关 LoggingEventSource 的 meta 事件。 请不要从 ILogger 记录事件。
    2 在调用 ILogger.Log() 时启用 Message 事件。 以编程(未格式化)方式提供信息。
    4 在调用 ILogger.Log() 时启用 FormatMessage 事件。 提供格式化字符串版本的信息。
    8 在调用 ILogger.Log() 时启用 MessageJson 事件。 提供参数的 JSON 表示形式。
    事件级别 描述
    0 LogAlways
    1 Critical
    2 Error
    3 Warning
    4 Informational
    5 Verbose

    {Logger Category}{Event Level}FilterSpecs 条目表示其他日志筛选条件。 请用分号 (;) 分隔 FilterSpecs 条目。

    下例使用 Windows 命令界面(--providers 值不用单引号引起来) :

    dotnet trace collect -p {PID} --providers Microsoft-Extensions-Logging:4:2:FilterSpecs=\"Microsoft.AspNetCore.Hosting*:4\"
    

    上面的命令会激活:

    • 事件源记录器,它用于为错误 (2) 生成格式化字符串 (4)。
    • Informational 日志记录级别 (4) 的 Microsoft.AspNetCore.Hosting 日志记录。
  4. 通过按 Enter 键或 Ctrl+C 停止 dotnet 跟踪工具。

    跟踪使用名称 trace.nettrace 保存在执行 dotnet trace 命令的文件夹中 。

  5. 使用预览功能打开跟踪。 打开 trace.nettrace 文件并浏览跟踪事件 。

如果应用不使用 CreateDefaultBuilder 生成主机,则请向应用的日志记录配置添加事件源提供程序

有关详细信息,请参见:

Perfview

使用 PerfView 实用工具收集和查看日志。 虽然其他工具也可以查看 ETW 日志,但在处理由 ASP.NET Core 发出的 ETW 事件时,使用 PerfView 能获得最佳体验。

要将 PerfView 配置为收集此提供程序记录的事件,请向 Additional Providers 列表添加字符串 *Microsoft-Extensions-Logging 。 请勿遗漏字符串起始处的 *

Windows 事件日志

EventLog 提供程序将日志输出发送到 Windows 事件日志。 与其他提供程序不同,EventLog 提供程序不继承默认的非提供程序设置。 如果未指定 EventLog 日志设置,则它们默认为 LogLevel.Warning

若要记录低于 LogLevel.Warning 的事件,请显式设置日志级别。 以下示例将事件日志的默认日志级别设置为 LogLevel.Information

"Logging": {
  "EventLog": {
    "LogLevel": {
      "Default": "Information"
    }
  }
}

AddEventLog 重载可以传入 EventLogSettings。 如果为 null 或未指定,则使用以下默认设置:

  • LogName:“Application”
  • SourceName:“.NET Runtime”
  • MachineName:使用本地计算机名称。

以下代码将 SourceName 从默认值 ".NET Runtime" 更改为 MyLogs

public class Program
{
    public static void Main(string[] args)
    {
        CreateHostBuilder(args).Build().Run();
    }

    public static IHostBuilder CreateHostBuilder(string[] args) =>
        Host.CreateDefaultBuilder(args)
            .ConfigureLogging(logging =>
            {
                logging.AddEventLog(eventLogSettings =>
                {
                    eventLogSettings.SourceName = "MyLogs"; 
                });
            })
            .ConfigureWebHostDefaults(webBuilder =>
            {
                webBuilder.UseStartup<Startup>();
            });
}

Azure 应用服务

Microsoft.Extensions.Logging.AzureAppServices 提供程序包将日志写入 Azure App Service 应用的文件系统,以及 Azure 存储帐户中的 blob 存储

共享框架中不包括该提供程序包。 若要使用提供程序,请将提供程序包添加到项目。

要配置提供程序设置,请使用 AzureFileLoggerOptionsAzureBlobLoggerOptions,如以下示例所示:

public class Scopes
{
    public class Program
    {
        public static void Main(string[] args)
        {
            CreateHostBuilder(args).Build().Run();
        }

        public static IHostBuilder CreateHostBuilder(string[] args) =>
            Host.CreateDefaultBuilder(args)
                .ConfigureLogging(logging => logging.AddAzureWebAppDiagnostics())
                .ConfigureServices(serviceCollection => serviceCollection
                    .Configure<AzureFileLoggerOptions>(options =>
                    {
                        options.FileName = "azure-diagnostics-";
                        options.FileSizeLimit = 50 * 1024;
                        options.RetainedFileCountLimit = 5;
                    })
                    .Configure<AzureBlobLoggerOptions>(options =>
                    {
                        options.BlobName = "log.txt";
                    }))
                .ConfigureWebHostDefaults(webBuilder =>
                {
                    webBuilder.UseStartup<Startup>();
                });
    }
}

部署到 Azure 应用服务时,应用使用 Azure 门户的“应用服务”页面的应用服务日志部分中的设置。 更新以下设置后,更改立即生效,无需重启或重新部署应用。

  • 应用程序日志记录(Filesystem)
  • 应用程序日志记录(Blob)

日志文件的默认位置是 D:\home\LogFiles\Application 文件夹,默认文件名为 diagnostics-yyyymmdd.txt 。 默认文件大小上限为 10 MB,默认最大保留文件数为 2。 默认 blob 名为 {app-name}{timestamp}/yyyy/mm/dd/hh/{guid}-applicationLog.txt 。

仅当项目在 Azure 环境中运行时,此提供程序才记录日志。

Azure 日志流式处理

Azure 日志流式处理支持从以下位置实时查看日志活动:

  • 应用服务器
  • Web 服务器
  • 请求跟踪失败

要配置 Azure 日志流式处理,请执行以下操作:

  • 从应用的门户页导航到“应用服务日志”页。
  • 将“应用程序日志记录(Filesystem)”设置为“开” 。
  • 选择日志级别 。 此设置仅适用于 Azure 日志流式处理。

导航到“日志流”页面以查看日志。 记录的消息使用 ILogger 接口进行记录。

Azure Application Insights

Microsoft.Extensions.Logging.ApplicationInsights 提供程序包将日志写入 Azure Application Insights。 Application Insights 是一项服务,可监视 Web 应用并提供用于查询和分析遥测数据的工具。 如果使用此提供程序,则可以使用 Application Insights 工具来查询和分析日志。

日志记录提供程序作为 Microsoft.ApplicationInsights.AspNetCore(这是提供 ASP.NET Core 的所有可用遥测的包)的依赖项包括在内。 如果使用此包,则无需安装提供程序包。

Microsoft.ApplicationInsights.Web 包适用于 ASP.NET 4.x,而不适用于 ASP.NET Core。

有关更多信息,请参见以下资源:

第三方日志记录提供程序

适用于 ASP.NET Core 的第三方日志记录框架:

某些第三方框架可以执行语义日志记录(又称结构化日志记录)

使用第三方框架类似于使用以下内置提供程序之一:

  1. 将 NuGet 包添加到你的项目。
  2. 调用日志记录框架提供的 ILoggerFactory 扩展方法。

有关详细信息,请参阅各提供程序的相关文档。 Microsoft 不支持第三方日志记录提供程序。

非托管控制台应用

要通过示例了解如何在非 Web 控制台应用中使用一般主机,请参阅后台任务示例应用 的 Program.cs 文件 (在 ASP.NET Core 中使用托管服务实现后台任务) 。

对于没有通用主机的应用,日志记录代码在添加提供程序创建记录器的方式上有所不同。

日志记录提供程序

在非主机控制台应用中,在创建 LoggerFactory 时调用提供程序的 Add{provider name} 扩展方法:

class Program
{
    static void Main(string[] args)
    {
        using var loggerFactory = LoggerFactory.Create(builder =>
        {
            builder
                .AddFilter("Microsoft", LogLevel.Warning)
                .AddFilter("System", LogLevel.Warning)
                .AddFilter("LoggingConsoleApp.Program", LogLevel.Debug)
                .AddConsole()
                .AddEventLog();
        });
        ILogger logger = loggerFactory.CreateLogger<Program>();
        logger.LogInformation("Example log message");
    }
}

创建日志

若要创建日志,请使用 ILogger<TCategoryName> 对象。 使用 LoggerFactory 创建一个 ILogger

以下示例创建类别为 LoggingConsoleApp.Program 的记录器。

class Program
{
    static void Main(string[] args)
    {
        using var loggerFactory = LoggerFactory.Create(builder =>
        {
            builder
                .AddFilter("Microsoft", LogLevel.Warning)
                .AddFilter("System", LogLevel.Warning)
                .AddFilter("LoggingConsoleApp.Program", LogLevel.Debug)
                .AddConsole()
                .AddEventLog();
        });
        ILogger logger = loggerFactory.CreateLogger<Program>();
        logger.LogInformation("Example log message");
    }
}

在以下 ASP.NET CORE 示例中,记录器用于创建级别为 Information 的日志。 日志“级别”代表所记录事件的严重程度。

class Program
{
    static void Main(string[] args)
    {
        using var loggerFactory = LoggerFactory.Create(builder =>
        {
            builder
                .AddFilter("Microsoft", LogLevel.Warning)
                .AddFilter("System", LogLevel.Warning)
                .AddFilter("LoggingConsoleApp.Program", LogLevel.Debug)
                .AddConsole()
                .AddEventLog();
        });
        ILogger logger = loggerFactory.CreateLogger<Program>();
        logger.LogInformation("Example log message");
    }
}

本文档中详细介绍了级别类别

主机构造过程中的日志

不直接支持在主机构造期间进行日志记录。 但是,可以使用单独的记录器。 在以下示例中,Serilog 记录器用于登录 CreateHostBuilderAddSerilog 使用 Log.Logger 中指定的静态配置:

using System;
using Microsoft.AspNetCore.Hosting;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Configuration;
using Microsoft.Extensions.Hosting;
using Microsoft.Extensions.Logging;

public class Program
{
    public static void Main(string[] args)
    {
        CreateHostBuilder(args).Build().Run();
    }

    public static IHostBuilder CreateHostBuilder(string[] args)
    {
        var builtConfig = new ConfigurationBuilder()
            .AddJsonFile("appsettings.json")
            .AddCommandLine(args)
            .Build();

        Log.Logger = new LoggerConfiguration()
            .WriteTo.Console()
            .WriteTo.File(builtConfig["Logging:FilePath"])
            .CreateLogger();

        try
        {
            return Host.CreateDefaultBuilder(args)
                .ConfigureServices((context, services) =>
                {
                    services.AddRazorPages();
                })
                .ConfigureAppConfiguration((hostingContext, config) =>
                {
                    config.AddConfiguration(builtConfig);
                })
                .ConfigureLogging(logging =>
                {   
                    logging.AddSerilog();
                })
                .ConfigureWebHostDefaults(webBuilder =>
                {
                    webBuilder.UseStartup<Startup>();
                });
        }
        catch (Exception ex)
        {
            Log.Fatal(ex, "Host builder error");

            throw;
        }
        finally
        {
            Log.CloseAndFlush();
        }
    }
}

配置依赖于 ILogger 的服务

由于为 Web 主机创建了单独的 DI 容器,所以在 ASP.NET Core 的早期版本中,构造函数将记录器注入到 Startup 工作。 若要了解为何仅为通用主机创建一个容器,请参阅重大更改公告

若要配置依赖于 ILogger<T> 的服务,请使用构造函数注入或提供工厂方法。 只有在没有其他选择的情况下,才建议使用工厂方法。 例如,假设某个服务需要由 DI 提供的 ILogger<T> 实例:

public void ConfigureServices(IServiceCollection services)
{
    services.AddControllers();
    services.AddRazorPages();

    services.AddSingleton<IMyService>((container) =>
    {
        var logger = container.GetRequiredService<ILogger<MyService>>();
        return new MyService() { Logger = logger };
    });
}

前面突出显示的代码是 Func,该代码在 DI 容器第一次需要构造 MyService 实例时运行。 可以用这种方式访问任何已注册的服务。

在 Main 中创建日志

以下代码通过在构建主机之后从 DI 获取 ILogger 实例来登录 Main

public static void Main(string[] args)
{
    var host = CreateHostBuilder(args).Build();

    var logger = host.Services.GetRequiredService<ILogger<Program>>();
    logger.LogInformation("Host created.");

    host.Run();
}

public static IHostBuilder CreateHostBuilder(string[] args) =>
    Host.CreateDefaultBuilder(args)
        .ConfigureWebHostDefaults(webBuilder =>
        {
            webBuilder.UseStartup<Startup>();
        });

启动时创建日志

以下代码在 Startup.Configure 中写入日志:

public void Configure(IApplicationBuilder app, IWebHostEnvironment env,
                      ILogger<Startup> logger)
{
    if (env.IsDevelopment())
    {
        logger.LogInformation("In Development.");
        app.UseDeveloperExceptionPage();
    }
    else
    {
        logger.LogInformation("Not Development.");
        app.UseExceptionHandler("/Error");
        app.UseHsts();
    }

    app.UseHttpsRedirection();
    app.UseStaticFiles();

    app.UseRouting();

    app.UseAuthorization();

    app.UseEndpoints(endpoints =>
    {
        endpoints.MapControllers();
        endpoints.MapRazorPages();
    });
}

不支持在 Startup.ConfigureServices 方法中完成 DI 容器设置之前就写入日志:

  • 不支持将记录器注入到 Startup 构造函数中。
  • 不支持将记录器注入到 Startup.ConfigureServices 方法签名中

这一限制的原因是,日志记录依赖于 DI 和配置,而配置又依赖于 DI。 在完成 ConfigureServices 之前,不会设置 DI 容器。

有关配置依赖于 ILogger<T> 的服务或为什么在早期版本中可以使用构造函数将记录器注入 Startup 的信息,请参阅配置依赖 ILogger 的服务

没有异步记录器方法

日志记录应该会很快,不值得牺牲性能来使用异步代码。 如果日志记录数据存储很慢,请不要直接写入它。 考虑先将日志消息写入快速存储,然后再将其移至慢速存储。 例如,登录到 SQL Server 时,请勿直接使用 Log 方法登录,因为 Log 方法是同步的。 相反,你会将日志消息同步添加到内存中的队列,并让后台辅助线程从队列中拉出消息,以完成将数据推送到 SQL Server 的异步工作。 有关详细信息,请参阅 GitHub 问题。

更改正在运行的应用中的日志级别

不可使用日志记录 API 在应用运行时更改日志记录。 但是,一些配置提供程序可重新加载配置,这将对日志记录配置立即产生影响。 例如,文件配置提供程序默认情况下重载日志记录配置。 如果在应用运行时在代码中更改了配置,则该应用可调用 IConfigurationRoot.Reload 来更新应用的日志记录配置。

ILogger 和 ILoggerFactory

ILogger<TCategoryName>ILoggerFactory 接口和实现都包含在 .NET Core SDK 中。 它们还可以通过以下 NuGet 包获得:

在代码中应用日志筛选器规则

设置日志筛选器规则的首选方法是使用配置

下面的示例演示了如何在代码中注册筛选规则:

public class Program
{
    public static void Main(string[] args)
    {
        CreateHostBuilder(args).Build().Run();
    }

    public static IHostBuilder CreateHostBuilder(string[] args) =>
        Host.CreateDefaultBuilder(args)
            .ConfigureLogging(logging =>
               logging.AddFilter("System", LogLevel.Debug)
                  .AddFilter<DebugLoggerProvider>("Microsoft", LogLevel.Information)
                  .AddFilter<ConsoleLoggerProvider>("Microsoft", LogLevel.Trace))
            .ConfigureWebHostDefaults(webBuilder =>
            {
                webBuilder.UseStartup<Startup>();
            });
}

logging.AddFilter("System", LogLevel.Debug) 指定 System 类别和日志级别 Debug。 筛选器将应用于所有提供程序,因为未配置特定的提供程序。

AddFilter<DebugLoggerProvider>("Microsoft", LogLevel.Information) 指定以下项:

  • Debug 日志记录提供程序。
  • 日志级别 Information 及更高级别。
  • "Microsoft" 开头的所有类别。

创建自定义记录器

若要添加自定义记录器,请添加包含 ILoggerFactoryILoggerProvider

public void Configure(
    IApplicationBuilder app,
    IWebHostEnvironment env,
    ILoggerFactory loggerFactory)
{
    loggerFactory.AddProvider(new CustomLoggerProvider(new CustomLoggerConfiguration()));

ILoggerProvider 创建一个或多个 ILogger 实例。 框架使用 ILogger 实例记录信息。

示例自定义记录器配置

示例:

  • 设计为非常基本的示例,可通过事件 ID 和日志级别设置日志控制台的颜色。 记录器通常不会随事件 ID 改变,也不特定于日志级别。
  • 使用以下配置类型为每个日志级别和事件 ID 创建不同的颜色控制台条目:
public class ColorConsoleLoggerConfiguration
{
    public LogLevel LogLevel { get; set; } = LogLevel.Warning;
    public int EventId { get; set; } = 0;
    public ConsoleColor Color { get; set; } = ConsoleColor.Yellow;
}

前面的代码将默认级别设置为 Warning,并将颜色设置为 Yellow。 如果 EventId 设置为 0,我们将记录所有事件。

创建自定义记录器

ILogger 实现类别名称通常是日志记录源。 例如,创建记录器的类型:

public class ColorConsoleLogger : ILogger
{
    private readonly string _name;
    private readonly ColorConsoleLoggerConfiguration _config;

    public ColorConsoleLogger(string name, ColorConsoleLoggerConfiguration config)
    {
        _name = name;
        _config = config;
    }

    public IDisposable BeginScope<TState>(TState state)
    {
        return null;
    }

    public bool IsEnabled(LogLevel logLevel)
    {
        return logLevel == _config.LogLevel;
    }

    public void Log<TState>(LogLevel logLevel, EventId eventId, TState state, 
                        Exception exception, Func<TState, Exception, string> formatter)
    {
        if (!IsEnabled(logLevel))
        {
            return;
        }

        if (_config.EventId == 0 || _config.EventId == eventId.Id)
        {
            var color = Console.ForegroundColor;
            Console.ForegroundColor = _config.Color;
            Console.WriteLine($"{logLevel} - {eventId.Id} " +
                              $"- {_name} - {formatter(state, exception)}");
            Console.ForegroundColor = color;
        }
    }
}

前面的代码:

  • 为每个类别名称创建一个记录器实例。
  • IsEnabled 中检查 logLevel == _config.LogLevel,因此每个 logLevel 都有一个唯一的记录器。 通常,还应为所有更高的日志级别启用记录器:
public bool IsEnabled(LogLevel logLevel)
{
    return logLevel >= _config.LogLevel;
}

创建自定义 LoggerProvider

LoggerProvider 是创建记录器实例的类。 也许不需要为每个类别创建记录器实例,但这对于某些记录器(例如 NLog 或 log4net)是需要的。 这样,你还可以按需为每个类别选择不同的日志记录输出目标:

public class ColorConsoleLoggerProvider : ILoggerProvider
{
    private readonly ColorConsoleLoggerConfiguration _config;
    private readonly ConcurrentDictionary<string, ColorConsoleLogger> _loggers = new ConcurrentDictionary<string, ColorConsoleLogger>();

    public ColorConsoleLoggerProvider(ColorConsoleLoggerConfiguration config)
    {
        _config = config;
    }

    public ILogger CreateLogger(string categoryName)
    {
        return _loggers.GetOrAdd(categoryName, name => new ColorConsoleLogger(name, _config));
    }

    public void Dispose()
    {
        _loggers.Clear();
    }
}

在前面的代码中,CreateLogger 为每个类别名称创建 ColorConsoleLogger 的单个实例并将其存储在 ConcurrentDictionary<TKey,TValue> 中;

自定义记录器的使用和注册

Startup.Configure 中注册记录器:

public void Configure(IApplicationBuilder app, IWebHostEnvironment env, 
                      ILoggerFactory loggerFactory)
{
    // Default registration.
    loggerFactory.AddProvider(new ColorConsoleLoggerProvider(
                              new ColorConsoleLoggerConfiguration
    {
        LogLevel = LogLevel.Error,
        Color = ConsoleColor.Red
    }));

    // Custom registration with default values.
    loggerFactory.AddColorConsoleLogger();

    // Custom registration with a new configuration instance.
    loggerFactory.AddColorConsoleLogger(new ColorConsoleLoggerConfiguration
    {
        LogLevel = LogLevel.Debug,
        Color = ConsoleColor.Gray
    });

    // Custom registration with a configuration object.
    loggerFactory.AddColorConsoleLogger(c =>
    {
        c.LogLevel = LogLevel.Information;
        c.Color = ConsoleColor.Blue;
    });

    if (env.IsDevelopment())
    {
        app.UseDeveloperExceptionPage();
    }
    else
    {
        app.UseExceptionHandler("/Home/Error");
        app.UseHsts();
    }
    app.UseHttpsRedirection();
    app.UseStaticFiles();

    app.UseRouting();

    app.UseAuthorization();

    app.UseEndpoints(endpoints =>
    {
        endpoints.MapControllerRoute(
            name: "default",
            pattern: "{controller=Home}/{action=Index}/{id?}");
    });
}

对于前面的代码,为 ILoggerFactory 提供至少一个扩展方法:

public static class ColorConsoleLoggerExtensions
{
    public static ILoggerFactory AddColorConsoleLogger(
                                      this ILoggerFactory loggerFactory, 
                                      ColorConsoleLoggerConfiguration config)
    {
        loggerFactory.AddProvider(new ColorConsoleLoggerProvider(config));
        return loggerFactory;
    }
    public static ILoggerFactory AddColorConsoleLogger(
                                      this ILoggerFactory loggerFactory)
    {
        var config = new ColorConsoleLoggerConfiguration();
        return loggerFactory.AddColorConsoleLogger(config);
    }
    public static ILoggerFactory AddColorConsoleLogger(
                                    this ILoggerFactory loggerFactory, 
                                    Action<ColorConsoleLoggerConfiguration> configure)
    {
        var config = new ColorConsoleLoggerConfiguration();
        configure(config);
        return loggerFactory.AddColorConsoleLogger(config);
    }
}

其他资源

作者:Tom DykstraSteve Smith

.NET Core 支持适用于各种内置和第三方日志记录提供程序的日志记录 API。 本文介绍了如何将日志记录 API 与内置提供程序一起使用。

查看或下载示例代码如何下载

添加提供程序

日志记录提供程序会显示或存储日志。 例如,控制台提供程序在控制台上显示日志,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) =>
        {
            // Requires `using Microsoft.Extensions.Logging;`
            logging.AddConfiguration(hostingContext.Configuration.GetSection("Logging"));
            logging.AddConsole();
            logging.AddDebug();
            logging.AddEventSourceLogger();
        })
        .UseStartup<Startup>()
        .Build();

    webHost.Run();
}

前面的代码需要引用 Microsoft.Extensions.LoggingMicrosoft.Extensions.Configuration

默认项目模板调用 CreateDefaultBuilder,该操作将添加以下日志记录提供程序:

  • 控制台
  • 调试
  • EventSource(从 ASP.NET Core 2.2 开始)
public static void Main(string[] args)
{
    CreateWebHostBuilder(args).Build().Run();
}

public static IWebHostBuilder CreateWebHostBuilder(string[] args) =>
    WebHost.CreateDefaultBuilder(args)
        .UseStartup<Startup>();

如果使用 CreateDefaultBuilder,则可自行选择提供程序来替换默认提供程序。 调用 ClearProviders,然后添加所需的提供程序。

public static void Main(string[] args)
{
    var host = CreateWebHostBuilder(args).Build();

    var todoRepository = host.Services.GetRequiredService<ITodoRepository>();
    todoRepository.Add(new Core.Model.TodoItem() { Name = "Feed the dog" });
    todoRepository.Add(new Core.Model.TodoItem() { Name = "Walk the dog" });

    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();
        });

详细了解内置日志记录提供程序,以及本文稍后部分介绍的第三方日志记录提供程序

创建日志

若要创建日志,请使用 ILogger<TCategoryName> 对象。 在 Web 应用或托管服务中,由依赖关系注入 (DI) 获取 ILogger。 在非主机控制台应用中,使用 LoggerFactory 来创建 ILogger

下面的 ASP.NET Core 示例创建了一个以 TodoApiSample.Pages.AboutModel 为类别的记录器。 日志“类别”是与每个日志关联的字符串 。 DI 提供的 ILogger<T> 实例创建日志,该日志以类型 T 的完全限定名称为类别。

public class AboutModel : PageModel
{
    private readonly ILogger _logger;

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

在下面的 ASP.NET Core 和控制台应用示例中,记录器用于创建以 Information 为级别的日志。 日志“级别”代表所记录事件的严重程度 。

public void OnGet()
{
    Message = $"About page visited at {DateTime.UtcNow.ToLongTimeString()}";
    _logger.LogInformation("Message displayed: {Message}", Message);
}

本文稍后部分将更详细地介绍级别类别

启动时创建日志

要将日志写入 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)
    {
        services.AddMvc()
            .SetCompatibilityVersion(CompatibilityVersion.Version_2_2);

        // Add our repository type
        services.AddSingleton<ITodoRepository, TodoRepository>();
        _logger.LogInformation("Added TodoRepository to services");
    }

    public void Configure(IApplicationBuilder app, IHostingEnvironment env)
    {
        if (env.IsDevelopment())
        {
            _logger.LogInformation("In Development environment");
            app.UseDeveloperExceptionPage();
        }
        else
        {
            app.UseExceptionHandler("/Error");
            app.UseHsts();
        }

        app.UseHttpsRedirection();
        app.UseStaticFiles();
        app.UseCookiePolicy();

        app.UseMvc();
    }
}

在 Program 类中创建日志

要将日志写入 Program 类,请从 DI 获取 ILogger 实例:

public static void Main(string[] args)
{
    var host = CreateWebHostBuilder(args).Build();

    var todoRepository = host.Services.GetRequiredService<ITodoRepository>();
    todoRepository.Add(new Core.Model.TodoItem() { Name = "Feed the dog" });
    todoRepository.Add(new Core.Model.TodoItem() { Name = "Walk the dog" });

    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();
        });

不直接支持在主机构造期间进行日志记录。 但是,可以使用单独的记录器。 在以下示例中,Serilog 记录器用于登录 CreateWebHostBuilderAddSerilog 使用 Log.Logger 中指定的静态配置:

using System;
using Microsoft.AspNetCore;
using Microsoft.AspNetCore.Hosting;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Configuration;
using Microsoft.Extensions.Logging;

public class Program
{
    public static void Main(string[] args)
    {
        CreateWebHostBuilder(args).Build().Run();
    }

    public static IWebHostBuilder CreateWebHostBuilder(string[] args)
    {
        var builtConfig = new ConfigurationBuilder()
            .AddJsonFile("appsettings.json")
            .AddCommandLine(args)
            .Build();

        Log.Logger = new LoggerConfiguration()
            .WriteTo.Console()
            .WriteTo.File(builtConfig["Logging:FilePath"])
            .CreateLogger();

        try
        {
            return WebHost.CreateDefaultBuilder(args)
                .ConfigureServices((context, services) =>
                {
                    services.AddMvc();
                })
                .ConfigureAppConfiguration((hostingContext, config) =>
                {
                    config.AddConfiguration(builtConfig);
                })
                .ConfigureLogging(logging =>
                {
                    logging.AddSerilog();
                })
                .UseStartup<Startup>();
        }
        catch (Exception ex)
        {
            Log.Fatal(ex, "Host builder error");

            throw;
        }
        finally
        {
            Log.CloseAndFlush();
        }
    }
}

没有异步记录器方法

日志记录应该会很快,不值得牺牲性能来使用异步代码。 如果你的日志数据存储很慢,请不要直接写入它。 首先考虑将日志消息写入快速存储,稍后再将其变为慢速存储。 例如,如果你要记录到 SQL Server,你可能不想直接在 Log 方法中记录,因为 Log 方法是同步的。 相反,你会将日志消息同步添加到内存中的队列,并让后台辅助线程从队列中拉出消息,以完成将数据推送到 SQL Server 的异步工作。 有关详细信息,请参阅 GitHub 问题。

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 属性指定了用于记录所选类别的最低级别。 在本例中,SystemMicrosoft 类别在 Information 级别记录,其他均在 Debug 级别记录。

Logging 下的其他属性均指定了日志记录提供程序。 本示例针对控制台提供程序。 如果提供程序支持日志作用域,则 IncludeScopes 将指示是否启用这些域。 提供程序属性(例如本例的 Console)也可指定 LogLevel 属性。 提供程序下的 LogLevel 指定了该提供程序记录的级别。

如果在 Logging.{providername}.LogLevel 中指定了级别,则这些级别将重写 Logging.LogLevel 中设置的所有内容。 例如,考虑以下 JSON:

{
  "Logging": {      // Default, all providers.
    "LogLevel": {
      "Microsoft": "Warning"
    },
    "Console": { // Console provider.
      "LogLevel": {
        "Microsoft": "Information"
      }
    }
  }
}

在前面的 JSON 中,Console 提供程序设置将替代前面的(默认)日志级别。

不可使用日志记录 API 在应用运行时更改日志记录。 但是,一些配置提供程序可重新加载配置,这将对日志记录配置立即产生影响。 例如,文件配置提供程序会默认重新加载日志记录配置,该程序由 CreateDefaultBuilder 添加用来读取设置文件。 如果在应用运行时在代码中更改了配置,则该应用可调用 IConfigurationRoot.Reload 来更新应用的日志记录配置。

若要了解如何实现配置提供程序,请参阅 ASP.NET Core 中的配置

日志记录输出示例

使用上一部分中显示的示例代码从命令行运行应用时,将在控制台中看到日志。 以下是控制台输出示例:

info: Microsoft.AspNetCore.Hosting.Internal.WebHost[1]
      Request starting HTTP/1.1 GET http://localhost:5000/api/todo/0
info: Microsoft.AspNetCore.Mvc.Internal.ControllerActionInvoker[1]
      Executing action method TodoApi.Controllers.TodoController.GetById (TodoApi) with arguments (0) - ModelState is Valid
info: TodoApi.Controllers.TodoController[1002]
      Getting item 0
warn: TodoApi.Controllers.TodoController[4000]
      GetById(0) NOT FOUND
info: Microsoft.AspNetCore.Mvc.StatusCodeResult[1]
      Executing HttpStatusCodeResult, setting HTTP status code 404
info: Microsoft.AspNetCore.Mvc.Internal.ControllerActionInvoker[2]
      Executed action TodoApi.Controllers.TodoController.GetById (TodoApi) in 42.9286ms
info: Microsoft.AspNetCore.Hosting.Internal.WebHost[2]
      Request finished in 148.889ms 404

通过向 http://localhost:5000/api/todo/0 处的示例应用发出 HTTP Get 请求来生成前述日志。

在 Visual Studio 中运行示例应用时,“调试”窗口中将显示如下日志:

Microsoft.AspNetCore.Hosting.Internal.WebHost:Information: Request starting HTTP/1.1 GET http://localhost:53104/api/todo/0  
Microsoft.AspNetCore.Mvc.Internal.ControllerActionInvoker:Information: Executing action method TodoApi.Controllers.TodoController.GetById (TodoApi) with arguments (0) - ModelState is Valid
TodoApi.Controllers.TodoController:Information: Getting item 0
TodoApi.Controllers.TodoController:Warning: GetById(0) NOT FOUND
Microsoft.AspNetCore.Mvc.StatusCodeResult:Information: Executing HttpStatusCodeResult, setting HTTP status code 404
Microsoft.AspNetCore.Mvc.Internal.ControllerActionInvoker:Information: Executed action TodoApi.Controllers.TodoController.GetById (TodoApi) in 152.5657ms
Microsoft.AspNetCore.Hosting.Internal.WebHost:Information: Request finished in 316.3195ms 404

由上一部分所示的 ILogger 调用创建的日志以“TodoApi”开头。 以“Microsoft”类别开头的日志来自 ASP.NET Core 框架代码。 ASP.NET Core 和应用程序代码使用相同的日志记录 API 和提供程序。

本文余下部分将介绍有关日志记录的某些详细信息及选项。

NuGet 包

ILoggerILoggerFactory 接口位于 Microsoft.Extensions.Logging.Abstractions 中,其默认实现位于 Microsoft.Extensions.Logging 中。

日志类别

创建 ILogger 对象后,将为其指定“类别” 。 该类别包含在由此 ILogger 实例创建的每条日志消息中。 类别可以是任何字符串,但约定需使用类名,例如“TodoApi.Controllers.TodoController”。

使用 ILogger<T> 获取一个 ILogger 实例,该实例使用 T 的完全限定类型名称作为类别:

public class TodoController : Controller
{
    private readonly ITodoRepository _todoRepository;
    private readonly ILogger _logger;

    public TodoController(ITodoRepository todoRepository,
        ILogger<TodoController> logger)
    {
        _todoRepository = todoRepository;
        _logger = logger;
    }

要显式指定类别,请调用 ILoggerFactory.CreateLogger

public class TodoController : Controller
{
    private readonly ITodoRepository _todoRepository;
    private readonly ILogger _logger;

    public TodoController(ITodoRepository todoRepository,
        ILoggerFactory logger)
    {
        _todoRepository = todoRepository;
        _logger = logger.CreateLogger("TodoApiSample.Controllers.TodoController");
    }

ILogger<T> 相当于使用 T 的完全限定类型名称来调用 CreateLogger

日志级别

每个日志都指定了一个 LogLevel 值。 日志级别指示严重性或重要程度。 例如,可在方法正常结束时写入 Information 日志,在方法返回“404 找不到”状态代码时写入 Warning 日志 。

下面的代码会创建 InformationWarning 日志:

public IActionResult GetById(string id)
{
    _logger.LogInformation(LoggingEvents.GetItem, "Getting item {Id}", id);
    var item = _todoRepository.Find(id);
    if (item == null)
    {
        _logger.LogWarning(LoggingEvents.GetItemNotFound, "GetById({Id}) NOT FOUND", id);
        return NotFound();
    }
    return new ObjectResult(item);
}

在前面的代码中,MyLogEvents.GetItemMyLogEvents.GetItemNotFound 参数是日志事件 ID。 第二个参数是消息模板,其中的占位符用于填写剩余方法形参提供的实参值。 本文的日志消息模板部分将介绍方法参数。

在方法名称中包含级别的日志方法(例如 LogInformationLogWarning)是 ILogger 的扩展方法。 这些方法会调用可接受 LogLevel 参数的 Log 方法。 可直接调用 Log 方法而不调用其中某个扩展方法,但语法相对复杂。 有关详细信息,请参阅 ILogger记录器扩展源代码

ASP.NET Core 定义了以下日志级别(按严重性从低到高排列)。

  • 跟踪 = 0

    有关通常仅用于调试的信息。 这些消息可能包含敏感应用程序数据,因此不得在生产环境中启用它们。 默认情况下禁用。

  • 调试 = 1

    有关在开发和调试中可能有用的信息。 示例:Entering method Configure with flag set to true. 由于日志数量过多,因此仅当执行故障排除时,才在生产中启用 Debug 级别日志。

  • 信息 = 2

    用于跟踪应用的常规流。 这些日志通常有长期价值。 示例:Request received for path /api/todo

  • 警告 = 3

    表示应用流中的异常或意外事件。 可能包括不会中断应用运行但仍需调查的错误或其他条件。 Warning 日志级别常用于已处理的异常。 示例:FileNotFoundException for file quotes.txt.

  • 错误 = 4

    表示无法处理的错误和异常。 这些消息指示的是当前活动或操作(例如当前 HTTP 请求)中的失败,而不是整个应用中的失败。 日志消息示例:Cannot insert record due to duplicate key violation.

  • 严重 = 5

    需要立即关注的失败。 例如数据丢失、磁盘空间不足。

使用日志级别控制写入到特定存储介质或显示窗口的日志输出量。 例如:

  • 生产中:
    • 如果通过 Information 级别在 Trace 处记录,则会生成大量详细的日志消息。 为控制成本且不超过数据存储限制,请通过 Information 级别消息将 Trace 记录到容量大、成本低的数据存储中。
    • 如果通过 Critical 级别在 Warning 处记录,通常生成的日志消息更少且更小。 因此,成本和存储限制通常不是问题,而这使得在选择数据信息时更为灵活。
  • 在开发过程中:
    • 通过 Critical 消息将 Warning 记录到控制台。
    • 在疑难解答时通过 Information 消息添加 Trace

本文稍后的日志筛选部分介绍如何控制提供程序处理的日志级别。

ASP.NET Core 为框架事件写入日志。 本文前面部分提供的日志示例排除了低于 Information 级别的日志,因此未创建 DebugTrace 级别日志。 以下示例介绍了通过运行配置为显示 Debug 日志的示例应用而生成的控制台日志:

info: Microsoft.AspNetCore.Hosting.Internal.WebHost[1]
      Request starting HTTP/1.1 GET http://localhost:62555/api/todo/0
dbug: Microsoft.AspNetCore.Routing.Tree.TreeRouter[1]
      Request successfully matched the route with name 'GetTodo' and template 'api/Todo/{id}'.
dbug: Microsoft.AspNetCore.Mvc.Internal.ActionSelector[2]
      Action 'TodoApi.Controllers.TodoController.Update (TodoApi)' with id '089d59b6-92ec-472d-b552-cc613dfd625d' did not match the constraint 'Microsoft.AspNetCore.Mvc.Internal.HttpMethodActionConstraint'
dbug: Microsoft.AspNetCore.Mvc.Internal.ActionSelector[2]
      Action 'TodoApi.Controllers.TodoController.Delete (TodoApi)' with id 'f3476abe-4bd9-4ad3-9261-3ead09607366' did not match the constraint 'Microsoft.AspNetCore.Mvc.Internal.HttpMethodActionConstraint'
dbug: Microsoft.AspNetCore.Mvc.Internal.ControllerActionInvoker[1]
      Executing action TodoApi.Controllers.TodoController.GetById (TodoApi)
info: Microsoft.AspNetCore.Mvc.Internal.ControllerActionInvoker[1]
      Executing action method TodoApi.Controllers.TodoController.GetById (TodoApi) with arguments (0) - ModelState is Valid
info: TodoApi.Controllers.TodoController[1002]
      Getting item 0
warn: TodoApi.Controllers.TodoController[4000]
      GetById(0) NOT FOUND
dbug: Microsoft.AspNetCore.Mvc.Internal.ControllerActionInvoker[2]
      Executed action method TodoApi.Controllers.TodoController.GetById (TodoApi), returned result Microsoft.AspNetCore.Mvc.NotFoundResult.
info: Microsoft.AspNetCore.Mvc.StatusCodeResult[1]
      Executing HttpStatusCodeResult, setting HTTP status code 404
info: Microsoft.AspNetCore.Mvc.Internal.ControllerActionInvoker[2]
      Executed action TodoApi.Controllers.TodoController.GetById (TodoApi) in 0.8788ms
dbug: Microsoft.AspNetCore.Server.Kestrel[9]
      Connection id "0HL6L7NEFF2QD" completed keep alive response.
info: Microsoft.AspNetCore.Hosting.Internal.WebHost[2]
      Request finished in 2.7286ms 404

日志事件 ID

每个日志都可指定一个事件 ID 。 该示例应用通过使用本地定义的 LoggingEvents 类来执行此操作:

public IActionResult GetById(string id)
{
    _logger.LogInformation(LoggingEvents.GetItem, "Getting item {Id}", id);
    var item = _todoRepository.Find(id);
    if (item == null)
    {
        _logger.LogWarning(LoggingEvents.GetItemNotFound, "GetById({Id}) NOT FOUND", id);
        return NotFound();
    }
    return new ObjectResult(item);
}
public class LoggingEvents
{
    public const int GenerateItems = 1000;
    public const int ListItems = 1001;
    public const int GetItem = 1002;
    public const int InsertItem = 1003;
    public const int UpdateItem = 1004;
    public const int DeleteItem = 1005;

    public const int GetItemNotFound = 4000;
    public const int UpdateItemNotFound = 4001;
}

事件 ID 与一组事件相关联。 例如,与在页面上显示项列表相关的所有日志可能是 1001。

日志记录提供程序可将事件 ID 存储在 ID 字段中,存储在日志记录消息中,或者不进行存储。 调试提供程序不显示事件 ID。 控制台提供程序在类别后的括号中显示事件 ID:

info: TodoApi.Controllers.TodoController[1002]
      Getting item invalidid
warn: TodoApi.Controllers.TodoController[4000]
      GetById(invalidid) NOT FOUND

日志消息模板

每个日志都会指定一个消息模板。 消息模板可包含要填写参数的占位符。 请在占位符中使用名称而不是数字。

public IActionResult GetById(string id)
{
    _logger.LogInformation(LoggingEvents.GetItem, "Getting item {Id}", id);
    var item = _todoRepository.Find(id);
    if (item == null)
    {
        _logger.LogWarning(LoggingEvents.GetItemNotFound, "GetById({Id}) NOT FOUND", id);
        return NotFound();
    }
    return new ObjectResult(item);
}

占位符的顺序(而非其名称)决定了为其提供值的参数。 在以下代码中,请注意消息模板中的参数名称未按顺序排列:

string p1 = "parm1";
string p2 = "parm2";
_logger.LogInformation("Parameter values: {p2}, {p1}", p1, p2);

此代码创建了一个参数值按顺序排列的日志消息:

Parameter values: parm1, parm2

日志记录框架按此方式工作,这样日志记录提供程序即可实现语义日志记录,也称为结构化日志记录。 参数本身会传递给日志记录系统,而不仅仅是格式化的消息模板。 通过此信息,日志记录提供程序能够将参数值存储为字段。 例如,假设记录器方法调用如下所示:

_logger.LogInformation("Getting item {Id} at {RequestTime}", id, DateTime.Now);

如果要将日志发送到 Azure 表存储,则每个 Azure 表实体都可具有 IDRequestTime 属性,这简化了对日志数据的查询。 无需分析文本消息的超时,查询即可找到特定 RequestTime 范围内的全部日志。

日志记录异常

记录器方法有可传入异常的重载,如下方示例所示:

catch (Exception ex)
{
    _logger.LogWarning(LoggingEvents.GetItemNotFound, ex, "GetById({Id}) NOT FOUND", id);
    return NotFound();
}
return new ObjectResult(item);

不同的提供程序处理异常信息的方式不同。 以下是上示代码的调试提供程序输出示例。

TodoApiSample.Controllers.TodoController: Warning: GetById(55) NOT FOUND

System.Exception: Item not found exception.
   at TodoApiSample.Controllers.TodoController.GetById(String id) in C:\TodoApiSample\Controllers\TodoController.cs:line 226

日志筛选

可为特定或所有提供程序和类别指定最低日志级别。 最低级别以下的日志不会传递给该提供程序,因此不会显示或存储它们。

要禁止显示所有日志,可将 LogLevel.None 指定为最低日志级别。 LogLevel.None 的整数值为 6,它大于 LogLevel.Critical (5)。

在配置中创建筛选规则

项目模板代码调用 CreateDefaultBuilder 来为 Console、Debug 和 EventSource(ASP.NET Core 2.2 或更高版本)提供程序设置日志记录。 正如本文前面部分所述,CreateDefaultBuilder 方法设置日志记录以在 Logging 部分查找配置。

配置数据按提供程序和类别指定最低日志级别,如下方示例所示:

{
  "Logging": {
    "Debug": {
      "LogLevel": {
        "Default": "Information"
      }
    },
    "Console": {
      "IncludeScopes": false,
      "LogLevel": {
        "Microsoft.AspNetCore.Mvc.Razor.Internal": "Warning",
        "Microsoft.AspNetCore.Mvc.Razor.Razor": "Debug",
        "Microsoft.AspNetCore.Mvc.Razor": "Error",
        "Default": "Information"
      }
    },
    "LogLevel": {
      "Default": "Debug"
    }
  }
}

此 JSON 将创建 6 条筛选规则:1 条用于调试提供程序, 4 条用于控制台提供程序, 1 条用于所有提供程序。 创建 ILogger 对象时,为每个提供程序选择一个规则。

代码中的筛选规则

下面的示例演示了如何在代码中注册筛选规则:

WebHost.CreateDefaultBuilder(args)
    .UseStartup<Startup>()
    .ConfigureLogging(logging =>
        logging.AddFilter("System", LogLevel.Debug)
               .AddFilter<DebugLoggerProvider>("Microsoft", LogLevel.Trace));

第二个 AddFilter 使用类型名称来指定调试提供程序。 第一个 AddFilter 应用于全部提供程序,因为它未指定提供程序类型。

如何应用筛选规则

先前示例中显示的配置数据和 AddFilter 代码会创建下表所示的规则。 前六条由配置示例创建,后两条由代码示例创建。

数字 提供程序 类别的开头为... 最低日志级别
1 调试 全部类别 信息
2 控制台 Microsoft.AspNetCore.Mvc.Razor.Internal 警告
3 控制台 Microsoft.AspNetCore.Mvc.Razor.Razor 调试
4 控制台 Microsoft.AspNetCore.Mvc.Razor 错误
5 控制台 全部类别 信息
6 全部提供程序 全部类别 调试
7 全部提供程序 System 调试
8 调试 Microsoft 跟踪

创建 ILogger 对象时,ILoggerFactory 对象将根据提供程序选择一条规则,将其应用于该记录器。 将按所选规则筛选 ILogger 实例写入的所有消息。 从可用规则中为每个提供程序和类别对选择最具体的规则。

在为给定的类别创建 ILogger 时,以下算法将用于每个提供程序:

  • 选择匹配提供程序或其别名的所有规则。 如果找不到任何匹配项,则选择提供程序为空的所有规则。
  • 根据上一步的结果,选择具有最长匹配类别前缀的规则。 如果找不到任何匹配项,则选择未指定类别的所有规则。
  • 如果选择了多条规则,则采用最后一条 。
  • 如果未选择任何规则,则使用 MinimumLevel

使用前面的规则列表,假设你为类别“Microsoft.AspNetCore.Mvc.Razor.RazorViewEngine”创建 ILogger 对象:

  • 对于调试提供程序,规则 1、6 和 8 适用。 规则 8 最为具体,因此选择了它。
  • 对于控制台提供程序,符合的有规则 3、规则 4、规则 5 和规则 6。 规则 3 最为具体。

生成的 ILogger 实例将 Trace 级别及更高级别的日志发送到调试提供程序。 Debug 级别及更高级别的日志会发送到控制台提供程序。

提供程序别名

每个提供程序都定义了一个别名;可在配置中使用该别名来代替完全限定的类型名称 。 对于内置提供程序,请使用以下别名:

  • 控制台
  • 调试
  • EventSource
  • EventLog
  • TraceSource
  • AzureAppServicesFile
  • AzureAppServicesBlob
  • ApplicationInsights

默认最低级别

仅当配置或代码中的规则对给定提供程序和类别都不适用时,最低级别设置才会生效。 下面的示例演示如何设置最低级别:

WebHost.CreateDefaultBuilder(args)
    .UseStartup<Startup>()
    .ConfigureLogging(logging => logging.SetMinimumLevel(LogLevel.Warning));

如果没有明确设置最低级别,则默认值为 Information,它表示 TraceDebug 日志将被忽略。

筛选器函数

对配置或代码没有向其分配规则的所有提供程序和类别调用筛选器函数。 函数中的代码可访问提供程序类型、类别和日志级别。 例如:

WebHost.CreateDefaultBuilder(args)
    .UseStartup<Startup>()
    .ConfigureLogging(logBuilder =>
    {
        logBuilder.AddFilter((provider, category, logLevel) =>
        {
            if (provider == "Microsoft.Extensions.Logging.Console.ConsoleLoggerProvider" &&
                category == "TodoApiSample.Controllers.TodoController")
            {
                return false;
            }
            return true;
        });
    });

系统类别和级别

下面是 ASP.NET Core 和 Entity Framework Core 使用的一些类别,备注中说明了可从这些类别获取的具体日志:

类别 说明
Microsoft.AspNetCore 常规 ASP.NET Core 诊断。
Microsoft.AspNetCore.DataProtection 考虑、找到并使用了哪些密钥。
Microsoft.AspNetCore.HostFiltering 所允许的主机。
Microsoft.AspNetCore.Hosting HTTP 请求完成的时间和启动时间。 加载了哪些承载启动程序集。
Microsoft.AspNetCore.Mvc MVC 和 Razor 诊断。 模型绑定、筛选器执行、视图编译和操作选择。
Microsoft.AspNetCore.Routing 路由匹配信息。
Microsoft.AspNetCore.Server 连接启动、停止和保持活动响应。 HTTP 证书信息。
Microsoft.AspNetCore.StaticFiles 提供的文件。
Microsoft.EntityFrameworkCore 常规 Entity Framework Core 诊断。 数据库活动和配置、更改检测、迁移。

日志作用域

“作用域”可对一组逻辑操作分组 。 此分组可用于将相同的数据附加到作为集合的一部分而创建的每个日志。 例如,在处理事务期间创建的每个日志都可包括事务 ID。

范围是由 BeginScope 方法返回的 IDisposable 类型,持续至释放为止。 要使用作用域,请在 using 块中包装记录器调用:

public IActionResult GetById(string id)
{
    TodoItem item;
    using (_logger.BeginScope("Message attached to logs created in the using block"))
    {
        _logger.LogInformation(LoggingEvents.GetItem, "Getting item {Id}", id);
        item = _todoRepository.Find(id);
        if (item == null)
        {
            _logger.LogWarning(LoggingEvents.GetItemNotFound, "GetById({Id}) NOT FOUND", id);
            return NotFound();
        }
    }
    return new ObjectResult(item);
}

下列代码为控制台提供程序启用作用域:

Program.cs :

.ConfigureLogging((hostingContext, logging) =>
{
    logging.AddConfiguration(hostingContext.Configuration.GetSection("Logging"));
    logging.AddConsole(options => options.IncludeScopes = true);
    logging.AddDebug();
})

备注

要启用基于作用域的日志记录,必须先配置 IncludeScopes 控制台记录器选项。

若要了解关配置,请参阅配置部分。

每条日志消息都包含作用域内的信息:

info: TodoApiSample.Controllers.TodoController[1002]
      => RequestId:0HKV9C49II9CK RequestPath:/api/todo/0 => TodoApiSample.Controllers.TodoController.GetById (TodoApi) => Message attached to logs created in the using block
      Getting item 0
warn: TodoApiSample.Controllers.TodoController[4000]
      => RequestId:0HKV9C49II9CK RequestPath:/api/todo/0 => TodoApiSample.Controllers.TodoController.GetById (TodoApi) => Message attached to logs created in the using block
      GetById(0) NOT FOUND

内置日志记录提供程序

ASP.NET Core 提供以下提供程序:

要通过 ASP.NET Core 模块了解 stdout 和调试日志记录,请参阅 对 Azure 应用服务和 IIS 上的 ASP.NET Core 进行故障排除ASP.NET Core 模块

控制台提供程序

Microsoft.Extensions.Logging.Console 提供程序包向控制台发送日志输出。

logging.AddConsole();

要查看控制台日志记录输出,请在项目文件夹中打开命令提示符并运行以下命令:

dotnet run

调试提供程序

Microsoft.Extensions.Logging.Debug 提供程序包使用 System.Diagnostics.Debug 类(Debug.WriteLine 方法调用)来写入日志输出。

在 Linux 中,此提供程序将日志写入 /var/log/message 。

logging.AddDebug();

事件源提供程序

Microsoft.Extensions.Logging.EventSource 提供程序包会使用名称 Microsoft-Extensions-Logging 跨平台写入事件源。 在 Windows 上,提供程序使用的是 ETW

logging.AddEventSourceLogger();

在调用 CreateDefaultBuilder 来生成主机时,会自动添加事件源提供程序。

使用 PerfView 实用工具收集和查看日志。 虽然其他工具也可以查看 ETW 日志,但在处理由 ASP.NET Core 发出的 ETW 事件时,使用 PerfView 能获得最佳体验。

要将 PerfView 配置为收集此提供程序记录的事件,请向 Additional Providers 列表添加字符串 *Microsoft-Extensions-Logging 。 (请勿遗漏字符串起始处的星号。)

其他 Perfview 提供程序

Windows EventLog 提供程序

Microsoft.Extensions.Logging.EventLog 提供程序包向 Windows 事件日志发送日志输出。

logging.AddEventLog();

AddEventLog 重载允许传入 EventLogSettings。 如果为 null 或未指定,则使用以下默认设置:

  • LogName:“Application”
  • SourceName:“.NET Runtime”
  • MachineName:使用本地计算机名称。

警告等级和更高等级记录事件。 以下示例将事件日志的默认日志级别设置为 LogLevel.Information

"Logging": {
  "EventLog": {
    "LogLevel": {
      "Default": "Information"
    }
  }
}

TraceSource 提供程序

Microsoft.Extensions.Logging.TraceSource 提供程序包使用 TraceSource 库和提供程序。

logging.AddTraceSource(sourceSwitchName);

AddTraceSource 重载 允许传入资源开关和跟踪侦听器。

要使用此提供程序,应用必须在 .NET Framework(而非 .NET Core)上运行。 提供程序可将消息路由到多个侦听器,例如示例应用中使用的 TextWriterTraceListener

Azure 应用服务提供程序

Microsoft.Extensions.Logging.AzureAppServices 提供程序包将日志写入 Azure App Service 应用的文件系统,以及 Azure 存储帐户中的 blob 存储

logging.AddAzureWebAppDiagnostics();

Microsoft.AspNetCore.App 元包中不包括此提供程序包。 如果面向 .NET Framework 或引用 Microsoft.AspNetCore.App 元包,请向项目添加提供程序包。

AddAzureWebAppDiagnostics 重载允许传入 AzureAppServicesDiagnosticsSettings。 设置对象可以覆盖默认设置,例如日志记录输出模板、blob 名称和文件大小限制。 (“输出模板”是一个消息模板,除了通过 ILogger 方法调用提供的内容之外,还可将其应用于所有日志。 )

在部署应用服务应用时,应用程序将采用 Azure 门户中“应用服务”页面下的应用服务日志部分的设置 。 更新以下设置后,更改立即生效,无需重启或重新部署应用。

  • 应用程序日志记录(Filesystem)
  • 应用程序日志记录(Blob)

日志文件的默认位置是 D:\home\LogFiles\Application 文件夹,默认文件名为 diagnostics-yyyymmdd.txt 。 默认文件大小上限为 10 MB,默认最大保留文件数为 2。 默认 blob 名为 {app-name}{timestamp}/yyyy/mm/dd/hh/{guid}-applicationLog.txt 。

该提供程序仅当项目在 Azure 环境中运行时有效。 项目在本地运行时,该提供程序无效 — 它不会写入本地文件或 blob 的本地开发存储。

Azure 日志流式处理

通过 Azure 日志流式处理,可从以下位置实时查看日志活动:

  • 应用服务器
  • Web 服务器
  • 请求跟踪失败

要配置 Azure 日志流式处理,请执行以下操作:

  • 从应用的门户页导航到“应用服务日志”页 。
  • 将“应用程序日志记录(Filesystem)”设置为“开” 。
  • 选择日志级别 。 此设置仅适用于 Azure 日志流,不适用于应用中的其他日志记录提供程序。

导航到“日志流”页面来查看应用消息 。 它们由应用通过 ILogger 接口记录。

Azure Application Insights 跟踪日志记录

Microsoft.Extensions.Logging.ApplicationInsights 提供程序包将日志写入 Azure Application Insights。 Application Insights 是一项服务,可监视 Web 应用并提供用于查询和分析遥测数据的工具。 如果使用此提供程序,则可以使用 Application Insights 工具来查询和分析日志。

日志记录提供程序作为 Microsoft.ApplicationInsights.AspNetCore(这是提供 ASP.NET Core 的所有可用遥测的包)的依赖项包括在内。 如果使用此包,则无需安装提供程序包。

请勿使用用于 ASP.NET 4.x 的 Microsoft.ApplicationInsights.Web 包—。

有关更多信息,请参见以下资源:

第三方日志记录提供程序

适用于 ASP.NET Core 的第三方日志记录框架:

某些第三方框架可以执行语义日志记录(又称结构化日志记录)

使用第三方框架类似于使用以下内置提供程序之一:

  1. 将 NuGet 包添加到你的项目。
  2. 调用日志记录框架提供的 ILoggerFactory 扩展方法。

有关详细信息,请参阅各提供程序的相关文档。 Microsoft 不支持第三方日志记录提供程序。

其他资源