Serilog 是 C# 中支持结构化日志、多输出目标、配置简洁的现代日志框架;需在 Program.cs 顶部初始化 Log.Logger 并调用 builder.Host.UseSerilog(),使用 {FieldName} 占位实现结构化记录,配合 Enrich 和过滤提升可观测性。

Serilog 是 C# 中轻量、灵活且功能强大的日志框架,它支持结构化日志(structured logging),能轻松输出到控制台、文件、Elasticsearch、Seq、SQL Server 等多种目标。配置简单,API 直观,是现代 .NET 应用推荐的日志方案。
安装 Serilog 核心与常用接收器
在项目中通过 NuGet 安装以下基础包:
- Serilog:核心库
- Serilog.Sinks.Console:输出到控制台
- Serilog.Sinks.File:写入本地文件(支持滚动)
- Serilog.AspNetCore:集成 ASP.NET Core(含中间件和请求日志)
例如在 Visual Studio 的包管理器控制台中运行:
Install-Package SerilogInstall-Package Serilog.Sinks.Console
Install-Package Serilog.Sinks.File
Install-Package Serilog.AspNetCore
在 Program.cs 中配置全局日志(.NET 6+)
推荐在 Program.cs 的最顶部完成初始化,确保日志在应用启动早期就可用:
using Serilog;var builder = WebApplication.CreateBuilder(args);
// 配置 Serilog(必须在 AddServices 之前或同时)
Log.Logger = new LoggerConfiguration()
.MinimumLevel.Debug()
.WriteTo.Console(outputTemplate: "[{Timestamp:HH:mm:ss} {Level:u3}] {Message:lj}{NewLine}{Exception}")
.WriteTo.File("logs/log-.txt", rollingInterval: RollingInterval.Day, retainedFileCountLimit: 7)
.CreateLogger();
// 将 Serilog 注入 ASP.NET Core 日志系统
builder.Host.UseSerilog(); // 注意:不是 builder.Logging
关键点:
- 调用 UseSerilog() 替代默认日志提供程序,这样
ILogger会自动使用 Serilog 实例 -
outputTemplate控制控制台日志格式;rollingInterval和retainedFileCountLimit让日志按天切分并自动清理旧文件 - 务必在
builder.Build()之前完成Log.Logger初始化,否则启动异常无法记录
在代码中使用结构化日志
无需手动拼接字符串,直接传入命名参数,Serilog 会将其作为结构化字段保存(对 ELK/Seq 等非常友好):
public class HomeController : Controller{
private readonly ILogger
public HomeController(ILogger
{
_logger = logger;
}
public IActionResult Index()
{
var userId = 123;
var userName = "Alice";
_logger.LogInformation("User {UserId} ({UserName}) accessed home page", userId, userName);
// 输出示例:User 123 (Alice) accessed home page
// 结构化字段:{ "UserId": 123, "UserName": "Alice" }
try
{
throw new InvalidOperationException("Simulated error");
}
catch (Exception ex)
{
_logger.Error(ex, "Failed to load user profile for {UserId}", userId);
}
return View();
}
}
优势:
- 消息模板中用
{FieldName}占位,参数顺序对应,语义清晰 - 异常自动附加堆栈,
Error(ex, ...)比Error("{@ex}", ex)更规范 - 支持
{@obj}(序列化整个对象)和{%obj}(仅打印类型名),避免误序列化敏感数据
进阶:添加上下文与过滤
为日志自动附加请求 ID、用户名、环境等上下文信息:
// 在 Program.cs 配置中加入 Enrich 块.Enrich.FromLogContext() // 支持 LogContext.PushProperty
.Enrich.WithEnvironmentName() // 添加 Environment=Development
.Enrich.WithMachineName() // 添加 MachineName 字段
.Enrich.WithProperty("App", "MyWebApp")
然后在控制器或中间件中动态注入上下文:
using (LogContext.PushProperty("Action", "Index")){
_logger.LogInformation("Starting action...");
}
还可按命名空间或级别过滤日志:
.MinimumLevel.Override("Microsoft", LogEventLevel.Warning).MinimumLevel.Override("MyApp.Data", LogEventLevel.Verbose)
基本上就这些。Serilog 上手快、扩展性强,搭配 Seq 或 Elasticsearch 能快速搭建可观测性体系。不复杂但容易忽略的是初始化时机和 UseSerilog() 的调用位置——记牢这两点,日志就稳了。










