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

为什么选择 Serilog？

Serilog 是 .NET 生态中最流行的日志框架之一，它原生支持结构化日志记录，语法简洁，扩展性强，并且与 ASP.NET Core 深度集成。此外，它支持多种输出目标（控制台、文件、数据库、云服务等）。

第一步：创建 C# 项目并安装 Serilog

打开 Visual Studio 或使用 .NET CLI 创建一个新项目：

dotnet new console -n StructuredLoggingDemocd StructuredLoggingDemo

然后安装 Serilog 及其控制台输出插件：

dotnet add package Serilogdotnet add package Serilog.Sinks.Console

第二步：配置 Serilog 并输出结构化日志

修改 Program.cs 文件如下：

using Serilog;// 配置 SerilogLog.Logger = new LoggerConfiguration()    .WriteTo.Console(        outputTemplate: "{Timestamp:yyyy-MM-dd HH:mm:ss} [{Level:u3}] {Message:lj}{NewLine}{Exception}")    .CreateLogger();try{    Log.Information("Application starting...");    // 模拟用户登录事件    string userName = "Alice";    string ipAddress = "10.0.0.5";    // 使用结构化日志：将变量作为命名参数传入    Log.Information("User {UserName} logged in from IP {IpAddress}", userName, ipAddress);    Log.Information("Application shutdown.");}catch (Exception ex){    Log.Fatal(ex, "Application terminated unexpectedly");}finally{    Log.CloseAndFlush();}

运行程序后，你将在控制台看到类似这样的输出：

2024-06-01 10:35:00 [INF] Application starting...2024-06-01 10:35:00 [INF] User Alice logged in from IP 10.0.0.52024-06-01 10:35:00 [INF] Application shutdown.

但这还不是真正的结构化输出（仍是文本）。要输出 JSON 格式，我们需要使用 CompactJsonFormatter。

第三步：启用 JSON 结构化输出

首先安装 JSON 格式化包：

dotnet add package Serilog.Formatting.Compact

然后修改配置，使用 CompactJsonFormatter：

using Serilog;using Serilog.Formatting.Compact;Log.Logger = new LoggerConfiguration()    .WriteTo.Console(new CompactJsonFormatter())    .CreateLogger();// 后续日志代码不变Log.Information("User {UserName} logged in from IP {IpAddress}", "Bob", "172.16.0.20");Log.CloseAndFlush();

现在运行程序，你会看到每条日志都是一行完整的 JSON：

{"@t":"2024-06-01T10:40:00.0000000Z","@m":"User Bob logged in from IP 172.16.0.20","@i":"a1b2c3d4","UserName":"Bob","IpAddress":"172.16.0.20"}

这种格式非常适合被日志收集系统（如 Fluentd、Logstash）解析，从而实现强大的日志分析功能。

进阶技巧：记录自定义对象

Serilog 还支持直接记录复杂对象：

var user = new { Id = 1001, Name = "Carol", Role = "Admin" };Log.Information("Processing user {@User}", user); // 注意 @ 符号！

使用 {@User}（带 @）会将整个对象序列化为 JSON；若用 {User}（不带 @），则只调用 ToString()。

总结

通过本教程，你已经掌握了在 C# 中实现日志格式化和结构化日志记录的核心方法。使用 Serilog 不仅能提升开发效率，还能为系统运维和监控打下坚实基础。

记住这几个关键点：

• 使用命名参数（如 {UserName}）代替字符串拼接
• 用 {@Object} 记录完整对象结构
• 选择 CompactJsonFormatter 输出机器可读的日志
• 善用 C# Serilog教程 中的最佳实践

现在，你可以将这些知识应用到你的实际项目中，构建更可观测、更易维护的 C# 应用程序！