0

0

C#如何进行日志记录 Serilog日志框架配置与使用教程

星降

星降

发布时间:2025-12-25 13:44:51

|

837人浏览过

|

来源于php中文网

原创

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

c#如何进行日志记录 serilog日志框架配置与使用教程

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 Serilog
Install-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 控制控制台日志格式;rollingIntervalretainedFileCountLimit 让日志按天切分并自动清理旧文件
  • 务必在 builder.Build() 之前完成 Log.Logger 初始化,否则启动异常无法记录

在代码中使用结构化日志

无需手动拼接字符串,直接传入命名参数,Serilog 会将其作为结构化字段保存(对 ELK/Seq 等非常友好):

AILOGO
AILOGO

LOGO123旗下的AI智能LOGO生成器,只需输入品牌名称就能免费在线生成公司logo设计及配套企业VI,轻松打造您的个性品牌!

下载
public class HomeController : Controller
{
private readonly ILogger _logger;

public HomeController(ILogger logger)
{
_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() 的调用位置——记牢这两点,日志就稳了。

相关专题

更多
数据分析工具有哪些
数据分析工具有哪些

数据分析工具有Excel、SQL、Python、R、Tableau、Power BI、SAS、SPSS和MATLAB等。详细介绍:1、Excel,具有强大的计算和数据处理功能;2、SQL,可以进行数据查询、过滤、排序、聚合等操作;3、Python,拥有丰富的数据分析库;4、R,拥有丰富的统计分析库和图形库;5、Tableau,提供了直观易用的用户界面等等。

673

2023.10.12

SQL中distinct的用法
SQL中distinct的用法

SQL中distinct的语法是“SELECT DISTINCT column1, column2,...,FROM table_name;”。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

319

2023.10.27

SQL中months_between使用方法
SQL中months_between使用方法

在SQL中,MONTHS_BETWEEN 是一个常见的函数,用于计算两个日期之间的月份差。想了解更多SQL的相关内容,可以阅读本专题下面的文章。

344

2024.02.23

SQL出现5120错误解决方法
SQL出现5120错误解决方法

SQL Server错误5120是由于没有足够的权限来访问或操作指定的数据库或文件引起的。想了解更多sql错误的相关内容,可以阅读本专题下面的文章。

1081

2024.03.06

sql procedure语法错误解决方法
sql procedure语法错误解决方法

sql procedure语法错误解决办法:1、仔细检查错误消息;2、检查语法规则;3、检查括号和引号;4、检查变量和参数;5、检查关键字和函数;6、逐步调试;7、参考文档和示例。想了解更多语法错误的相关内容,可以阅读本专题下面的文章。

355

2024.03.06

oracle数据库运行sql方法
oracle数据库运行sql方法

运行sql步骤包括:打开sql plus工具并连接到数据库。在提示符下输入sql语句。按enter键运行该语句。查看结果,错误消息或退出sql plus。想了解更多oracle数据库的相关内容,可以阅读本专题下面的文章。

671

2024.04.07

sql中where的含义
sql中where的含义

sql中where子句用于从表中过滤数据,它基于指定条件选择特定的行。想了解更多where的相关内容,可以阅读本专题下面的文章。

563

2024.04.29

sql中删除表的语句是什么
sql中删除表的语句是什么

sql中用于删除表的语句是drop table。语法为drop table table_name;该语句将永久删除指定表的表和数据。想了解更多sql的相关内容,可以阅读本专题下面的文章。

405

2024.04.29

苹果官网入口直接访问
苹果官网入口直接访问

苹果官网直接访问入口是https://www.apple.com/cn/,该页面具备0.8秒首屏渲染、HTTP/3与Brotli加速、WebP+AVIF双格式图片、免登录浏览全参数等特性。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

10

2025.12.24

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Java 教程
Java 教程

共578课时 | 37.3万人学习

国外Web开发全栈课程全集
国外Web开发全栈课程全集

共12课时 | 0.9万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2025 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号