0

0

C# Serilog enriquecedores方法 C#如何为日志添加额外的上下文信息

幻夢星雲

幻夢星雲

发布时间:2026-03-13 11:08:32

|

660人浏览过

|

来源于php中文网

原创

Serilog 的 Enricher 是用于全局自动为日志添加上下文字段的机制,如线程ID、请求ID、用户名等,避免手动拼接或误用 LogContext;内置 Enricher 通过 .Enrich.WithXxx() 注册,自定义需实现 ILogEventEnricher 并安全访问 HttpContext;须注意性能陷阱,禁止 IO、锁及频繁分配内存。

c# serilog enriquecedores方法 c#如何为日志添加额外的上下文信息

什么是 Serilog 的 Enricher(富化器)

Serilog 里的 Enricher 是专门用来给每条日志自动附加额外字段的机制,不是靠每次写 Log.Information("msg", prop) 手动传参,而是全局、统一、可复用地注入上下文。比如你想让所有日志都带上线程 ID、请求 ID、用户名或环境名,就该用它。

常见错误是试图在日志语句里硬拼字符串(如 "[User:xxx] " + msg),这破坏结构化日志,也漏掉异常堆栈里的上下文;另一种错误是滥用 LogContext.PushProperty,它只对当前作用域有效,且容易因忘记 Pop 或异步切换导致上下文丢失。

内置 Enricher 怎么用:从 WithThreadIdWithMachineName

Serilog 自带一批开箱即用的 Enricher,全在 Serilog.Enrichers.* 包里,需单独安装(如 Serilog.Enrichers.Thread)。注册方式统一走 .Enrich.WithXxx() 链式调用:

Log.Logger = new LoggerConfiguration()
    .Enrich.WithThreadId()           // 注入 ThreadId 字段
    .Enrich.WithMachineName()        // 注入 MachineName
    .Enrich.WithEnvironmentUserName() // 注入当前 Windows 用户名(仅 Windows)
    .WriteTo.Console()
    .CreateLogger();

注意:WithEnvironmentUserName 在 Linux/macOS 上会写空字符串;WithThreadId 在线程池线程中可能重复(因为线程复用),若需唯一性,应改用 WithCorrelationId 或自定义请求级 ID。

自定义 Enricher:如何注入 HTTP 请求 ID 和用户信息

ASP.NET Core 场景下最常需要的是请求 ID 和当前登录用户,但这些不在 Serilog 内置范围里——得自己写 IEnricher 实现。关键点是:不能直接访问 HttpContext,因为 IEnricher 是无状态的,必须配合依赖注入和作用域生命周期。

Rose.ai
Rose.ai

一个云数据平台,帮助用户发现、可视化数据

下载

推荐做法是用 ILogEventEnricher + IHttpContextAccessor,并在 Program.cs 中注册为 Scoped:

  • 安装 Microsoft.AspNetCore.Http 和确保已配置 services.AddHttpContextAccessor()
  • 实现类里通过构造函数接收 IHttpContextAccessor,在 Enrich 方法中安全读取 HttpContext?.TraceIdentifierUser.Identity.Name
  • 务必判空:HttpContext 可能为 null(如后台任务、HostedService 中)

示例字段注入逻辑:

public void Enrich(LogEvent logEvent, ILogEventPropertyFactory propertyFactory)
{
    var httpContext = _httpContextAccessor.HttpContext;
    if (httpContext != null)
    {
        logEvent.AddPropertyIfAbsent(propertyFactory.CreateProperty("RequestId", httpContext.TraceIdentifier));
        logEvent.AddPropertyIfAbsent(propertyFactory.CreateProperty("UserName", httpContext.User?.Identity?.Name ?? "-"));
    }
}

Enricher 的执行时机和性能陷阱

Enricher 在每条日志被写入前执行,所以任何耗时操作(如读数据库、调远程 API、序列化大对象)都会拖慢整个日志链路。Serilog 不做并发保护,也不缓存结果,因此:

  • 避免在 Enrich 方法里做 IO 或锁操作
  • 不要在 Enricher 里 new 大对象或分配大量内存(尤其高频日志场景)
  • 如果要注入配置值(如 AppSettings["Env"]),应在构造函数里一次性读取并缓存,而不是每次调用都去查 IConfiguration
  • 异步 Enricher 不存在——Serilog 日志管道是同步的,async Enricher 会被忽略或引发异常

最易被忽略的是:Enricher 对 Log.Error(ex, msg) 同样生效,但异常对象本身不会被 Enricher 修改;如果你发现 Exception 字段里没包含你加的上下文,那是正常的——上下文只加在日志事件元数据里,异常堆栈仍是原始内容。

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

WorkBuddy
WorkBuddy

腾讯云推出的AI原生桌面智能体工作台

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

更多
c语言中null和NULL的区别
c语言中null和NULL的区别

c语言中null和NULL的区别是:null是C语言中的一个宏定义,通常用来表示一个空指针,可以用于初始化指针变量,或者在条件语句中判断指针是否为空;NULL是C语言中的一个预定义常量,通常用来表示一个空值,用于表示一个空的指针、空的指针数组或者空的结构体指针。

254

2023.09.22

java中null的用法
java中null的用法

在Java中,null表示一个引用类型的变量不指向任何对象。可以将null赋值给任何引用类型的变量,包括类、接口、数组、字符串等。想了解更多null的相关内容,可以阅读本专题下面的文章。

1089

2024.03.01

scripterror怎么解决
scripterror怎么解决

scripterror的解决办法有检查语法、文件路径、检查网络连接、浏览器兼容性、使用try-catch语句、使用开发者工具进行调试、更新浏览器和JavaScript库或寻求专业帮助等。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

492

2023.10.18

500error怎么解决
500error怎么解决

500error的解决办法有检查服务器日志、检查代码、检查服务器配置、更新软件版本、重新启动服务、调试代码和寻求帮助等。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

382

2023.10.25

js 字符串转数组
js 字符串转数组

js字符串转数组的方法:1、使用“split()”方法;2、使用“Array.from()”方法;3、使用for循环遍历;4、使用“Array.split()”方法。本专题为大家提供js字符串转数组的相关的文章、下载、课程内容,供大家免费下载体验。

760

2023.08.03

js截取字符串的方法
js截取字符串的方法

js截取字符串的方法有substring()方法、substr()方法、slice()方法、split()方法和slice()方法。本专题为大家提供字符串相关的文章、下载、课程内容,供大家免费下载体验。

221

2023.09.04

java基础知识汇总
java基础知识汇总

java基础知识有Java的历史和特点、Java的开发环境、Java的基本数据类型、变量和常量、运算符和表达式、控制语句、数组和字符串等等知识点。想要知道更多关于java基础知识的朋友,请阅读本专题下面的的有关文章,欢迎大家来php中文网学习。

1567

2023.10.24

字符串介绍
字符串介绍

字符串是一种数据类型,它可以是任何文本,包括字母、数字、符号等。字符串可以由不同的字符组成,例如空格、标点符号、数字等。在编程中,字符串通常用引号括起来,如单引号、双引号或反引号。想了解更多字符串的相关内容,可以阅读本专题下面的文章。

651

2023.11.24

TypeScript类型系统进阶与大型前端项目实践
TypeScript类型系统进阶与大型前端项目实践

本专题围绕 TypeScript 在大型前端项目中的应用展开,深入讲解类型系统设计与工程化开发方法。内容包括泛型与高级类型、类型推断机制、声明文件编写、模块化结构设计以及代码规范管理。通过真实项目案例分析,帮助开发者构建类型安全、结构清晰、易维护的前端工程体系,提高团队协作效率与代码质量。

26

2026.03.13

热门下载

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

精品课程

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

共94课时 | 11.2万人学习

C 教程
C 教程

共75课时 | 5.4万人学习

C++教程
C++教程

共115课时 | 21.7万人学习

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

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