在C#中记录日志,Serilog 是目前最推荐的轻量、高性能、结构化日志框架之一。它支持多种输出目标(控制台、文件、Elasticsearch、Seq 等),配置简单,且天然支持结构化日志(比如自动序列化对象、命名属性),比原生
Console.WriteLine或
TextWriter更专业、可维护性更强。
安装 Serilog 核心包和常用接收器
在项目中通过 NuGet 安装以下基础包:
Serilog:核心库 Serilog.Sinks.Console:输出到控制台(开发调试用) Serilog.Sinks.File:输出到本地文件(生产环境常用) Serilog.AspNetCore(如用 ASP.NET Core):集成中间件和请求日志命令行示例(Package Manager Console):
Install-Package SerilogInstall-Package Serilog.Sinks.Console
Install-Package Serilog.Sinks.File
Install-Package Serilog.AspNetCore
基础配置(.NET 6/7/8 主机构建方式)
在
Program.cs中配置全局日志提供器: using Serilog;
var builder = WebApplication.CreateBuilder(args);
// 配置 Serilog(必须在 builder.Build() 之前)
Log.Logger = new LoggerConfiguration()
.MinimumLevel.Debug() // 最低日志等级
.WriteTo.Console() // 输出到控制台
.WriteTo.File("logs/myapp-.log", rollingInterval: RollingInterval.Day) // 按天滚动文件
.CreateLogger();
// 注入到 DI 容器(可选,但推荐)
builder.Services.AddLogging(loggingBuilder =>
loggingBuilder.AddSerilog(Log.Logger, dispose: true));
注意:
Log.Logger必须尽早初始化,否则启动过程中的异常可能无法记录。
在代码中使用日志(注入 ILogger)
推荐在类中通过构造函数注入
ILogger<yourclass></yourclass>,而不是直接调用静态
Log.Information()(后者不利于单元测试和上下文隔离): public class UserService
{
private readonly ILogger
public UserService(ILogger
{
_logger = logger;
}
public void CreateUser(string name, int age)
{
_logger.LogInformation("创建用户:{Name},年龄:{Age}", name, age);
_logger.LogWarning("用户 {Name} 年龄 {Age} 接近上限", name, age);
_logger.Error(new Exception("DB timeout"), "创建用户失败");
}
}
结构化日志的关键是用
{Name} 占位符——Serilog 会把值作为结构化字段记录(例如 JSON 日志里会是 "Name": "Alice", "Age": 28),不是简单字符串拼接。
进阶建议:环境区分、异步写入、过滤与上下文
按环境启用不同接收器:开发用 Console,生产关掉 Console、只保留 File + Seq 加.WriteTo.Async(...)提升高并发下的日志性能(避免阻塞主线程) 用
.Filter.ByExcluding(...)屏蔽健康检查等高频无意义日志 用
.Enrich.FromLogContext()+
LogContext.PushProperty()添加请求 ID、用户 ID 等全局上下文
例如添加请求 ID(配合 ASP.NET Core 中间件):
app.UseSerilogRequestLogging(); // 自动记录 HTTP 请求摘要,并注入 RequestId基本上就这些。Serilog 配置不复杂但容易忽略初始化时机和结构化写法,坚持用
ILogger<t></t>注入 + 命名占位符,日志就能真正发挥诊断价值。
