Serilog.AspNetCore 使用教程

1. 项目介绍

Serilog.AspNetCore 是一个用于 ASP.NET Core 的 Serilog 集成库。它允许你将 ASP.NET Core 的日志消息通过 Serilog 进行路由，从而使你可以将 ASP.NET Core 的内部操作信息与应用程序事件一起写入相同的 Serilog 接收器（sinks）。通过这种方式，你可以更方便地管理和分析应用程序的日志信息。

2. 项目快速启动

安装 Serilog.AspNetCore

首先，你需要在你的 ASP.NET Core 项目中安装 Serilog.AspNetCore NuGet 包。你可以使用以下命令进行安装：

dotnet add package Serilog.AspNetCore

配置 Serilog

在你的应用程序的 Program.cs 文件中，配置 Serilog 并将其集成到 ASP.NET Core 的日志系统中。以下是一个简单的配置示例：

using Serilog;

try
{
    Log.Logger = new LoggerConfiguration()
        .WriteTo.Console()
        .CreateLogger();

    Log.Information("Starting web application");

    var builder = WebApplication.CreateBuilder(args);

    // 添加 Serilog 到服务配置
    builder.Services.AddSerilog();

    var app = builder.Build();

    app.MapGet("/", () => "Hello World!");

    app.Run();
}
catch (Exception ex)
{
    Log.Fatal(ex, "Application terminated unexpectedly");
}
finally
{
    Log.CloseAndFlush();
}

清理默认日志配置

为了确保所有日志消息都通过 Serilog 进行处理，你需要清理默认的日志配置。移除 appsettings.json 文件中的 "Logging" 部分，或者将其替换为 Serilog 的配置。

3. 应用案例和最佳实践

请求日志记录

Serilog.AspNetCore 提供了智能的 HTTP 请求日志记录功能。默认情况下，ASP.NET Core 的请求日志记录会产生多个事件，而 Serilog 的中间件可以将这些事件浓缩为一个包含请求方法、路径、状态码和时间信息的事件。

要启用此功能，请在 Program.cs 中添加以下代码：

var app = builder.Build();

app.UseSerilogRequestLogging();

// 其他应用配置

自定义日志模板

你可以通过配置 UseSerilogRequestLogging 的选项来修改请求完成事件的消息模板、添加额外属性或更改事件级别。例如：

app.UseSerilogRequestLogging(options =>
{
    options.MessageTemplate = "Handled {RequestPath}";
    options.GetLevel = (httpContext, elapsed, ex) => LogEventLevel.Debug;
    options.EnrichDiagnosticContext = (diagnosticContext, httpContext) =>
    {
        diagnosticContext.Set("RequestHost", httpContext.Request.Host.Value);
        diagnosticContext.Set("RequestScheme", httpContext.Request.Scheme);
    };
});

4. 典型生态项目

Serilog

Serilog 是一个简单且功能强大的 .NET 日志库，支持结构化日志记录。它提供了多种接收器（sinks），可以将日志消息输出到控制台、文件、数据库等多种目标。

Serilog.Sinks.Console

Serilog.Sinks.Console 是一个 Serilog 的接收器，用于将日志消息输出到控制台。它支持丰富的格式化选项，适合开发和调试阶段使用。

Serilog.Sinks.File

Serilog.Sinks.File 是一个 Serilog 的接收器，用于将日志消息写入文件。它支持日志文件的滚动和压缩，适合生产环境使用。

通过这些生态项目，你可以构建一个完整的日志记录系统，满足不同环境下的需求。