0

0

C# Serilog日志上下文方法 C#如何通过LogContext添加动态属性

畫卷琴夢

畫卷琴夢

发布时间:2026-02-02 02:01:18

|

709人浏览过

|

来源于php中文网

原创

LogContext.PushProperty未生效是因为缺少Enrich.FromLogContext()配置;该enricher需全局启用才能使PushProperty的属性出现在日志中,否则上下文属性不会被注入输出。

c# serilog日志上下文方法 c#如何通过logcontext添加动态属性

LogContext.PushProperty 为什么没出现在日志里

直接调用 LogContext.PushProperty("UserId", 123) 后日志没带这个字段,大概率是因为你没在日志配置中启用上下文支持。Serilog 默认不自动注入 LogContext 的属性,必须显式启用——比如用 Enrich.FromLogContext()

常见错误是只写了 PushProperty,却漏掉 enricher 配置:

Log.Logger = new LoggerConfiguration()
    .Enrich.FromLogContext() // ⚠️ 必须加这一行
    .WriteTo.Console()
    .CreateLogger();
  • 没有 Enrich.FromLogContext()PushProperty 像往水里扔石头,涟漪根本传不到日志输出
  • 该 enricher 是全局生效的,不需要每次写日志都重复配置
  • 它只捕获「当前异步执行流」中的上下文(基于 AsyncLocal),跨线程或新 Task 会丢失

如何安全地在异步方法中使用 LogContext

LogContext 的生命周期绑定到当前 ExecutionContext,但不是所有异步场景都自动流动。尤其在 ASP.NET Core 中,Controller 方法里 push 的属性,在 await 后的 lambda 或后台任务里可能已失效。

推荐做法是:在入口处(如中间件、Controller Action)push,且尽量避免在 Task.Run 或手动切换同步上下文的地方依赖它:

  • ✅ ASP.NET Core 中,在 UseSerilogRequestLogging 中间件前注册 Enrich.FromLogContext(),再配合 LogContext.PushProperty("TraceId", HttpContext.TraceIdentifier)
  • ❌ 不要在 Task.Run(() => { LogContext.PushProperty(...); DoWork(); }) 里 push —— 子线程没有父上下文
  • ⚠️ 若必须跨任务传递,改用显式参数传入,或用 Log.ForContext("UserId", userId) 创建子 logger

PushProperty 和 ForContext 的关键区别

二者都能加属性,但作用域和机制完全不同:

Img.Upscaler
Img.Upscaler

免费的AI图片放大工具

下载
  • LogContext.PushProperty("Key", value):把属性压入当前逻辑调用,所有后续 Log.Information(...) 都自动携带(只要没被 pop);适合请求级、事务级统一字段
  • Log.ForContext("Key", value).Information(...):仅本次日志事件携带,不污染后续日志;适合单条日志的临时补充,比如记录某个计算结果
  • PushProperty 支持多次同名覆盖(后 push 的生效),而 ForContext 是链式构造新 logger,不影响原 logger
  • 性能上,ForContext 每次新建 logger 对象有开销;PushProperty 是栈操作,更轻量,但需注意别漏 pop 导致内存泄漏(不过 Serilog 内部用 AsyncLocal 管理,通常无需手动 pop)

动态属性值怎么实时求值(比如当前时间戳或随机 ID)

PushProperty 默认存的是调用时的值快照。如果想每次日志输出时重新计算(例如生成唯一 ID、取当前毫秒数),得用它的重载版本传入 Func

LogContext.PushProperty("LogTime", () => DateTime.Now.ToString("HH:mm:ss.fff"));
LogContext.PushProperty("RequestId", () => Guid.NewGuid().ToString("N"));

这样每次日志序列化时都会执行函数,拿到最新值。但要注意:

  • 函数体不能抛异常,否则整条日志会静默失败(Serilog 会吞掉异常)
  • 避免在函数里做 IO 或锁操作,否则拖慢日志性能
  • 不要返回 null,否则该字段不会出现在日志中(可返回 "null" 字符串兜底)

真正难处理的从来不是怎么加属性,而是上下文在异步分叉、线程切换、DI 生命周期边界处的“消失”——这些地方得靠显式传参或重构日志结构来兜底。

热门AI工具

更多
DeepSeek
DeepSeek

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

豆包大模型
豆包大模型

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

通义千问
通义千问

阿里巴巴推出的全能AI助手

腾讯元宝
腾讯元宝

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

文心一言
文心一言

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

讯飞写作
讯飞写作

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

即梦AI
即梦AI

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

ChatGPT
ChatGPT

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

相关专题

更多
什么是中间件
什么是中间件

中间件是一种软件组件,充当不兼容组件之间的桥梁,提供额外服务,例如集成异构系统、提供常用服务、提高应用程序性能,以及简化应用程序开发。想了解更多中间件的相关内容,可以阅读本专题下面的文章。

178

2024.05.11

Golang 中间件开发与微服务架构
Golang 中间件开发与微服务架构

本专题系统讲解 Golang 在微服务架构中的中间件开发,包括日志处理、限流与熔断、认证与授权、服务监控、API 网关设计等常见中间件功能的实现。通过实战项目,帮助开发者理解如何使用 Go 编写高效、可扩展的中间件组件,并在微服务环境中进行灵活部署与管理。

217

2025.12.18

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

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

237

2023.09.22

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

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

499

2024.03.01

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

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

361

2023.08.03

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

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

212

2023.09.04

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

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

1503

2023.10.24

字符串介绍
字符串介绍

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

625

2023.11.24

go语言 注释编码
go语言 注释编码

本专题整合了go语言注释、注释规范等等内容,阅读专题下面的文章了解更多详细内容。

30

2026.01.31

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
国外Web开发全栈课程全集
国外Web开发全栈课程全集

共12课时 | 1.0万人学习

进程与SOCKET
进程与SOCKET

共6课时 | 0.4万人学习

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

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