Serilog 日志库的简介

Serilog 日志库的简介什么是 SerilogSerilog 是一个专为 .NET 应用程序设计的结构化日志库它改变了传统日志记录的方式。与传统的基于字符串的日志记录如 log4net、NLog不同Serilog 强调结构化数据的收集和存储。它允许开发者以键值对的形式记录日志属性而不是简单的文本消息。这使得日志不仅可以被人阅读还可以被机器高效解析和查询特别适合与 ELKElasticsearch、Logstash、Kibana或 Seq 等日志分析工具集成。Serilog 的核心优势包括-结构化日志自动将对象属性序列化为结构化数据。-丰富的 sink输出目标支持控制台、文件、数据库、Elasticsearch、Seq、Azure 等。-灵活的事件级别Verbose、Debug、Information、Warning、Error、Fatal。-易于集成与 .NET Core 和 ASP.NET Core 有原生支持。## 快速开始第一个 Serilog 示例下面是一个简单的控制台应用程序演示如何使用 Serilog 记录基本日志。请确保安装了Serilog和Serilog.Sinks.ConsoleNuGet 包。csharpusing Serilog;class Program{ static void Main(string[] args) { // 1. 配置 Serilog 日志记录器输出到控制台包含时间戳、级别和消息 Log.Logger new LoggerConfiguration() .MinimumLevel.Debug() // 设置最低日志级别为 Debug .WriteTo.Console() // 将日志输出到控制台 .CreateLogger(); // 2. 记录不同级别的日志 Log.Verbose(这是一个详细日志); // 不会输出因为级别低于 Debug Log.Debug(开始处理用户请求); Log.Information(用户登录成功用户名: {Username}, Alice); Log.Warning(数据库连接超时正在重试...); Log.Error(处理订单时发生异常: {ExceptionMessage}, 订单号无效); // 3. 使用结构化日志记录对象 var user new { Id 101, Name Bob, Role Admin }; Log.Information(用户详情: {User}, user); // 符号表示将对象序列化为结构化数据 // 4. 关闭日志器确保所有缓冲区刷新 Log.CloseAndFlush(); }}运行结果示例控制台输出[14:30:25 DBG] 开始处理用户请求[14:30:25 INF] 用户登录成功用户名: Alice[14:30:25 WRN] 数据库连接超时正在重试...[14:30:25 ERR] 处理订单时发生异常: 订单号无效[14:30:25 INF] 用户详情: {Id: 101, Name: Bob, Role: Admin}注释说明-MinimumLevel.Debug()过滤掉了Verbose级别的日志。- 使用{Username}占位符可以动态插入值同时保留结构化的属性名。-User语法告诉 Serilog 将整个对象序列化为 JSON 结构。## 高级用法多 Sink 与环境配置在实际项目中我们通常需要将日志同时输出到多个目标例如控制台用于开发文件用于生产Elasticsearch 用于集中分析。下面的示例展示了如何配置多 sink并根据环境动态调整日志级别。csharpusing Serilog;using Serilog.Events;using Serilog.Sinks.ElasticSearch; // 需要安装 Serilog.Sinks.ElasticSearchusing System;class Program{ static void Main(string[] args) { // 假设通过环境变量判断是开发环境还是生产环境 bool isDevelopment Environment.GetEnvironmentVariable(ASPNETCORE_ENVIRONMENT) Development; // 配置日志记录器 var loggerConfig new LoggerConfiguration() .MinimumLevel.Debug() // 全局最低级别 .WriteTo.Console( restrictedToMinimumLevel: LogEventLevel.Information, // 控制台只输出 Information 及以上 outputTemplate: [{Timestamp:HH:mm:ss} {Level:u3}] {Message:lj}{NewLine}{Exception} ) .WriteTo.File( path: logs/log-.txt, // 文件路径- 表示按日期滚动 rollingInterval: RollingInterval.Day, // 每天一个日志文件 restrictedToMinimumLevel: LogEventLevel.Warning, // 文件只记录 Warning 及以上 retainedFileCountLimit: 7 // 保留最近 7 天的日志 ); // 生产环境额外输出到 Elasticsearch if (!isDevelopment) { loggerConfig.WriteTo.Elasticsearch( new ElasticsearchSinkOptions(new Uri(http://localhost:9200)) { IndexFormat myapp-logs-{0:yyyy.MM.dd}, AutoRegisterTemplate true, MinimumLogEventLevel LogEventLevel.Information }); } Log.Logger loggerConfig.CreateLogger(); // 模拟业务操作 try { Log.Information(应用程序启动); ProcessOrder(12345); } catch (Exception ex) { Log.Fatal(ex, 应用程序崩溃原因: {ErrorMessage}, ex.Message); } finally { Log.CloseAndFlush(); } } static void ProcessOrder(int orderId) { Log.Debug(开始处理订单 {OrderId}, orderId); // 开发环境可见 if (orderId 0) { Log.Error(无效订单号: {OrderId}, orderId); throw new ArgumentException(订单号必须大于零); } Log.Information(订单 {OrderId} 处理成功, orderId); }}运行结果说明-控制台显示Information及更高级别的日志格式为[时间 级别] 消息。-文件在logs/目录下生成类似log-20250329.txt的文件仅包含Warning及以上的错误。-Elasticsearch生产环境所有Information及以上的日志会发送到 Elasticsearch便于后续分析。关键配置解释-restrictedToMinimumLevel为每个 sink 单独设置最低级别。-rollingInterval按时间滚动文件避免单个文件过大。-retainedFileCountLimit自动删除旧文件节省磁盘空间。-outputTemplate自定义输出格式增加时间戳、级别、异常堆栈等。## 与 ASP.NET Core 集成在 ASP.NET Core 应用程序中Serilog 可以通过UseSerilog()方法无缝集成。只需在Program.cs中配置即可csharpusing Serilog;public class Program{ public static void Main(string[] args) { Log.Logger new LoggerConfiguration() .ReadFrom.Configuration(Configuration) // 从 appsettings.json 读取配置 .Enrich.FromLogContext() // 启用上下文信息如请求路径 .WriteTo.Console() .CreateLogger(); try { Log.Information(启动 Web 应用程序); CreateHostBuilder(args).Build().Run(); } catch (Exception ex) { Log.Fatal(ex, 应用程序启动失败); } finally { Log.CloseAndFlush(); } } public static IHostBuilder CreateHostBuilder(string[] args) Host.CreateDefaultBuilder(args) .UseSerilog() // 替换默认日志系统 .ConfigureWebHostDefaults(webBuilder { webBuilder.UseStartupStartup(); });}然后在appsettings.json中定义 sink 和过滤规则json{ Serilog: { MinimumLevel: { Default: Information, Override: { Microsoft: Warning, System: Warning } }, WriteTo: [ { Name: Console }, { Name: File, Args: { path: logs/web-.log, rollingInterval: Day } } ] }}这样ASP.NET Core 的请求、错误等信息都会被 Serilog 捕获并格式化输出。## 总结Serilog 通过结构化日志的方式将日志从简单的文本记录提升为可搜索、可分析的数据资产。它提供了丰富的 sink 和多级别的过滤能力能够适应从单机开发到分布式生产环境的多样化需求。通过本文的代码示例你应该已经掌握了 Serilog 的基本配置、多 sink 用法以及与 ASP.NET Core 的集成方法。建议在实际项目中尽早引入 Serilog并利用其结构化特性与 ELK、Seq 等工具配合实现高效的日志监控和问题排查。