C#日志的结构化输出配置（新手入门指南：使用Serilog实现结构化日志记录）

什么是结构化日志？

结构化日志是指将日志内容以键值对或对象的形式记录，而不是简单的字符串。例如：

{  "Timestamp": "2024-06-01T10:30:00Z",  "Level": "Information",  "Message": "用户登录成功",  "UserId": 12345,  "IpAddress": "192.168.1.100"}

这种格式便于日志系统（如ELK、Seq、Datadog）进行索引和分析。

为什么选择 Serilog？

在 C# 生态中，Serilog 是最流行的结构化日志库之一。它支持丰富的输出目标（控制台、文件、数据库、云服务等），语法简洁，并原生支持结构化日志。

Step 1：安装 Serilog 包

打开你的 .NET 项目（支持 .NET Core / .NET 5+），通过 NuGet 安装以下包：

dotnet add package Serilogdotnet add package Serilog.Sinks.Consoledotnet add package Serilog.Sinks.File

Step 2：配置 Serilog

在 Program.cs 中初始化 Serilog。以下是一个基础配置示例：

using Serilog;// 配置日志Log.Logger = new LoggerConfiguration()    .WriteTo.Console() // 输出到控制台    .WriteTo.File("logs/app-.txt", rollingInterval: RollingInterval.Day) // 每天一个日志文件    .CreateLogger();try{    Log.Information("应用程序启动中...");    // 你的应用逻辑}catch (Exception ex){    Log.Fatal(ex, "应用程序启动失败");}finally{    Log.CloseAndFlush();}

Step 3：记录结构化日志

关键来了！使用 命名占位符 来记录结构化数据：

// 普通日志Log.Information("处理订单 {OrderId}，用户ID为 {UserId}", orderId, userId);// 带属性的日志（可用于后续筛选）Log.ForContext("SourceContext", "OrderService")   .Information("订单已创建，金额为 {Amount:C}", amount);

这样，OrderId 和 UserId 会被自动提取为结构化字段，而不仅仅是拼接字符串。

Step 4：输出为 JSON 格式（可选但推荐）

为了更好地与日志分析工具集成，建议将日志输出为 JSON。只需修改配置：

.WriteTo.Console(new RenderedCompactJsonFormatter()).WriteTo.File(new RenderedCompactJsonFormatter(), "logs/app.json", rollingInterval: RollingInterval.Day)

记得添加引用：

using Serilog.Formatting.Compact;

最佳实践建议

• 始终使用命名占位符（如 {UserId}），避免字符串拼接。
• 敏感信息（如密码）不要记录到日志中。
• 合理设置日志级别（Debug/Information/Warning/Error/Fatal）。
• 定期清理日志文件，防止磁盘爆满。

总结

通过本教程，你已经掌握了在 C# 项目中使用 Serilog 实现结构化日志配置的基本方法。结构化日志不仅能提升调试效率，还能为后续的监控和告警打下坚实基础。无论你是初学者还是有经验的开发者，掌握C#日志结构化输出都是迈向日志记录最佳实践的关键一步。

如果你正在寻找一个高效、易用的日志解决方案，那么 C# Serilog教程 就是你入门的最佳起点！