5分钟上手Serilog：从混乱到清晰，打造.NET结构化日志系统
项目地址: https://gitcode.com/gh_mirrors/se/serilog 你还在为.NET应用日志杂乱无章而头疼吗？还在为排查生产环境问题时找不到关键日志而抓狂吗？本文将带你5分钟内从零搭建专业的结构化日志系统，让日志成为你的得力助手而非负担。读完本文，你将掌握Serilog的基本配置、结构化日志记录方法以及日志输出到控制台和文件的技巧，轻松应对日常开发和运维中的日志需求。
Serilog简介：超越传统日志的结构化革命
Serilog是一个为.NET应用程序设计的诊断日志库，它与其他日志库的最大区别在于从底层开始就支持记录结构化事件数据。传统日志通常是无结构的文本，难以高效查询和分析，而Serilog使用消息模板（Message Templates）捕获事件数据，使日志更易于搜索、过滤和分析。
Serilog的核心优势包括：
- 结构化日志记录，支持丰富的数据类型
- 简洁易用的API，配置灵活
- 低开销，在禁用日志级别时性能优异
- 广泛的输出目标（Sinks）支持，包括控制台、文件、数据库等
- 与ASP.NET Core等.NET技术栈深度集成
快速开始：5分钟安装与配置
步骤1：安装Serilog包
通过NuGet安装Serilog核心包以及常用的输出目标：
dotnet add package Serilog
dotnet add package Serilog.Sinks.Console
dotnet add package Serilog.Sinks.File
步骤2：基本配置
在应用程序入口（通常是Program.cs）配置Serilog：
using Serilog;
Log.Logger = new LoggerConfiguration()
.WriteTo.Console() // 输出到控制台
.WriteTo.File("log.txt", // 输出到文件
rollingInterval: RollingInterval.Day, // 按天滚动
rollOnFileSizeLimit: true) // 文件大小限制
.CreateLogger();
// 应用程序代码...
await Log.CloseAndFlushAsync(); // 确保应用退出前刷新日志
上述代码通过LoggerConfiguration.cs类配置日志输出目标，包括控制台和文件。CreateLogger()方法创建日志记录器实例，CloseAndFlushAsync()确保应用程序退出前所有日志都被写入。
结构化日志：不止于文本的日志艺术
基本日志记录
使用Serilog记录基本日志非常简单：
Log.Information("Hello, Serilog!");
结构化日志示例
Serilog的强大之处在于支持结构化日志。以下是一个记录位置信息和处理时间的例子：
var position = new { Latitude = 25, Longitude = 134 };
var elapsedMs = 34;
log.Information("Processed {@Position} in {Elapsed} ms", position, elapsedMs);
在这个例子中，{@Position}语法告诉Serilog序列化对象，而{Elapsed}记录简单值。这种结构化日志在JSON格式下会呈现为：
{
"Position": { "Latitude": 25, "Longitude": 134 },
"Elapsed": 34
}
日志级别
Serilog支持多种日志级别，从低到高分别是：Verbose、Debug、Information、Warning、Error、Fatal。可以通过配置设置最小日志级别：
Log.Logger = new LoggerConfiguration()
.MinimumLevel.Debug() // 设置最小日志级别为Debug
.WriteTo.Console()
.CreateLogger();
高级配置：定制你的日志系统
日志过滤
可以通过过滤器控制哪些日志被输出：
Log.Logger = new LoggerConfiguration()
.MinimumLevel.Information()
.MinimumLevel.Override("Microsoft", LogEventLevel.Warning) // 覆盖特定命名空间的日志级别
.WriteTo.Console()
.CreateLogger();
日志丰富（Enrichment）
通过Enricher可以向日志添加额外的上下文信息，如环境变量、机器名等：
Log.Logger = new LoggerConfiguration()
.Enrich.WithMachineName() // 添加机器名
.Enrich.WithEnvironmentUserName() // 添加用户名
.WriteTo.Console()
.CreateLogger();
实际应用：Serilog在项目中的最佳实践
异常处理
记录异常时，将异常对象作为最后一个参数传递：
try
{
// 可能抛出异常的代码
}
catch (Exception ex)
{
Log.Error(ex, "操作失败"); // 记录异常信息
}
ASP.NET Core集成
在ASP.NET Core应用中，可以通过以下方式集成Serilog：
var builder = WebApplication.CreateBuilder(args);
// 配置Serilog
builder.Host.UseSerilog((context, configuration) =>
configuration.WriteTo.Console()
.WriteTo.File("logs/aspnetcore.txt", rollingInterval: RollingInterval.Day));
var app = builder.Build();
// 应用程序中间件...
app.Run();
总结与展望
Serilog为.NET应用程序提供了强大而灵活的日志解决方案，通过结构化日志记录，使日志分析变得前所未有的高效。本文介绍了Serilog的基本安装、配置和使用方法，希望能帮助你快速上手这个优秀的日志库。
更多高级功能和最佳实践，请参考Serilog官方文档和GitHub仓库。
扩展资源
- Serilog官方文档
- LoggerConfiguration.cs - Serilog配置核心类
- Serilog.Sinks.Console - 控制台输出扩展
- Serilog.Sinks.File - 文件输出扩展
希望本文对你有所帮助，欢迎点赞、收藏并关注，获取更多.NET开发技巧和最佳实践！
创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考
