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

浅雪君_1526

浅雪君_1526

2026-03-13

680人浏览

原创

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 怎么用:从 WithThreadId 到 WithMachineName

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 是无状态的,必须配合依赖注入和作用域生命周期。

C#
C#

"避开 C# 常见错误——空陷阱、异步陷阱、LINQ 陷阱及资源泄漏。"

下载

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

  • 安装 Microsoft.AspNetCore.Http 和确保已配置 services.AddHttpContextAccessor()
  • 实现类里通过构造函数接收 IHttpContextAccessor,在 Enrich 方法中安全读取 HttpContext?.TraceIdentifier 或 User.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 字段里没包含你加的上下文,那是正常的——上下文只加在日志事件元数据里,异常堆栈仍是原始内容。

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

c#

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
C语言变量命名
C语言变量命名

c语言变量名规则是:1、变量名以英文字母开头;2、变量名中的字母是区分大小写的;3、变量名不能是关键字;4、变量名中不能包含空格、标点符号和类型说明符。php中文网还提供c语言变量的相关下载、相关课程等内容,供大家免费下载使用。

2023.06.20

3909

3

c语言入门自学零基础
c语言入门自学零基础

C语言是当代人学习及生活中的必备基础知识,应用十分广泛,本专题为大家c语言入门自学零基础的相关文章,以及相关课程,感兴趣的朋友千万不要错过了。

2023.07.25

2528

9

c语言运算符的优先级顺序
c语言运算符的优先级顺序

c语言运算符的优先级顺序是括号运算符 > 一元运算符 > 算术运算符 > 移位运算符 > 关系运算符 > 位运算符 > 逻辑运算符 > 赋值运算符 > 逗号运算符。本专题为大家提供c语言运算符相关的各种文章、以及下载和课程。

2023.08.02

1460

5

c语言数据结构
c语言数据结构

数据结构是指将数据按照一定的方式组织和存储的方法。它是计算机科学中的重要概念,用来描述和解决实际问题中的数据组织和处理问题。数据结构可以分为线性结构和非线性结构。线性结构包括数组、链表、堆栈和队列等,而非线性结构包括树和图等。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.09

1398

4

c语言random函数用法
c语言random函数用法

c语言random函数用法:1、random.random,随机生成(0,1)之间的浮点数;2、random.randint,随机生成在范围之内的整数,两个参数分别表示上限和下限;3、random.randrange,在指定范围内,按指定基数递增的集合中获得一个随机数;4、random.choice,从序列中随机抽选一个数;5、random.shuffle,随机排序。

2023.09.05

1456

5

c语言const用法
c语言const用法

const是关键字,可以用于声明常量、函数参数中的const修饰符、const修饰函数返回值、const修饰指针。详细介绍:1、声明常量,const关键字可用于声明常量,常量的值在程序运行期间不可修改,常量可以是基本数据类型,如整数、浮点数、字符等,也可是自定义的数据类型;2、函数参数中的const修饰符,const关键字可用于函数的参数中,表示该参数在函数内部不可修改等等。

2023.09.20

2478

7

c语言get函数的用法
c语言get函数的用法

get函数是一个用于从输入流中获取字符的函数。可以从键盘、文件或其他输入设备中读取字符,并将其存储在指定的变量中。本文介绍了get函数的用法以及一些相关的注意事项。希望这篇文章能够帮助你更好地理解和使用get函数 。

2023.09.20

4160

8

c数组初始化的方法
c数组初始化的方法

c语言数组初始化的方法有直接赋值法、不完全初始化法、省略数组长度法和二维数组初始化法。详细介绍:1、直接赋值法,这种方法可以直接将数组的值进行初始化;2、不完全初始化法,。这种方法可以在一定程度上节省内存空间;3、省略数组长度法,这种方法可以让编译器自动计算数组的长度;4、二维数组初始化法等等。

2023.09.22

20015

6

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

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

2023.09.22

569

3

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
C++ Core Guidelines
C++ Core Guidelines

共0课时 | 0人学习

C++ Reference
C++ Reference

共0课时 | 0人学习

C++ 官方标准说明
C++ 官方标准说明

共0课时 | 0人学习