如何在 ASP.NET Core 8 中集成 Serilog 进行高效日志记录
一. 引言
日志记录在应用程序开发中至关重要，它可以帮助开发者监控和调查应用程序中的问题或错误。Serilog 是一个流行且实用的工具，它提供了结构化日志记录，使得开发者能够快速找到错误和问题。
Serilog 是 .NET 应用程序的诊断日志库，它提供了一种简单、灵活且强大的方式来记录应用程序事件、错误和其他信息。Serilog 旨在与结构化日志记录良好配合，意味着它可以记录丰富的结构化数据，而不仅仅是纯文本消息。
二. Serilog 的关键特性
2.1 结构化日志记录
Serilog 允许您记录结构化数据，这使得查询和分析日志变得更加容易。例如，您可以记录一个包含多个属性的对象，每个属性都可以单独索引和查询。
2.2 Sink 支持
Serilog 支持各种“sink”，这使得您可以将日志写入不同的存储系统，例如文件、数据库、控制台以及云服务如 Azure Application Insights、Elasticsearch 等。
2.3 可配置性
Serilog 具有高度的可配置性。您可以配置它将日志写入多个 sink，按严重级别过滤日志，增加附加数据等。
2.4 性能
Serilog 旨在提高性能，并尽量减少对应用程序性能的影响。
2.5 集成
Serilog 与其他 .NET 库和框架（包括 ASP.NET Core、Entity Framework 等）集成良好。
三. 如何在 ASP.NET Core 中使用 Serilog
3.1 安装必要的包
首先，您需要在项目中安装以下 NuGet 包：
-
Serilog -
Serilog.AspNetCore -
Serilog.Sinks.File
3.2 配置 appsettings.json
安装必要的包后，您需要在 appsettings.json 文件中配置 Serilog。请在 appsettings.json 文件中添加以下配置：
"Serilog": {
"Using": [ "Serilog.Sinks.Console", "Serilog.Sinks.File" ],
"MinimumLevel": {
"Default": "Information",
"Override": {
"Microsoft": "Warning",
"System": "Warning"
}
},
"WriteTo": [
{ "Name": "Console" },
{
"Name": "File",
"Args": {
"path": "logs/log-.log",
"rollingInterval": "Day",
"rollOnFileSizeLimit": true
}
}
]
}
配置说明：
-
"Using"：指定 Serilog 使用的 sinks，这里包括 Console 和 File。 -
"MinimumLevel"：设置日志的最小级别。"Default"指定了默认的日志级别，"Override"用于覆盖某些特定命名空间的日志级别。 -
"WriteTo"：配置日志输出的目标，这里指定了 Console 和 File。
3.3 在 Program.cs 文件中添加 Serilog 配置
在 Program.cs 文件中，添加 Serilog 配置：
builder.Host.UseSerilog((context, configuration) =>
configuration.ReadFrom.Configuration(context.Configuration));
代码说明：
-
builder.Host.UseSerilog：配置主机使用 Serilog 进行日志记录。 -
configuration.ReadFrom.Configuration：从配置文件读取 Serilog 的配置。
3.4 在中间件中添加 Serilog
在 App.Run() 之前，添加 Serilog 中间件：
app.UseSerilogRequestLogging();
代码说明：
-
app.UseSerilogRequestLogging()：将请求日志记录到 Serilog。
3.5 在 C# 类中进行日志记录
您可以在任意 C# 类中使用日志记录。以下是 WeatherForecastController 的日志记录示例：
private readonly ILogger<WeatherForecastController> _logger;
public WeatherForecastController(ILogger<WeatherForecastController> logger)
{
_logger = logger;
}
[HttpGet(Name = "GetWeatherForecast")]
public IEnumerable<WeatherForecast> Get()
{
_logger.LogInformation("Get Weather forecast called successfully");
return Enumerable.Range(1, 5).Select(index => new WeatherForecast
{
Date = DateOnly.FromDateTime(DateTime.Now.AddDays(index)),
TemperatureC = Random.Shared.Next(-20, 55),
Summary = Summaries[Random.Shared.Next(Summaries.Length)]
})
.ToArray();
}
代码说明：
-
ILogger<WeatherForecastController>：注入的日志记录器实例。 -
_logger.LogInformation：记录信息级别的日志。
四. 结论
本文详细介绍了 Serilog 这一强大的 .NET 应用程序日志库的使用。我们讨论了 Serilog 的优点，包括结构化日志记录，并演示了如何在 ASP.NET Core 8 应用程序中实现它。通过集成 Serilog，开发者可以获得更详细和有用的日志数据，从而提高调试、监控和系统维护的效率。
Serilog 的结构化日志记录能力增强了日志分析和可视化，使其成为现代应用程序不可或缺的工具。采用 Serilog 可以显著提升应用程序的可观察性、可靠性和整体健康状况。