Azure Function中如何将Service Bus消息CorrelationId富集到Serilog日志属性
问题根因
之前的实现路线存在两个核心偏差:
- 全局注册的
MyEnricher是和Serilog根Logger同生命周期的单例,根本无法感知单次函数执行作用域内的ServiceBus消息实例,自然读取不到当前消息的CorrelationId值 - 试图给全局Enricher注入
FunctionExecutingContext的思路本身和组件设计逻辑冲突:一方面Enrich.With<T>()的泛型约束要求Enricher提供无参公开构造,另一方面全局Enricher本身就不该绑定单次请求的短生命周期上下文,架构上就不匹配 - 你当前启动配置里已经开启了
.Enrich.FromLogContext(),这个机制本身就是为短生命周期作用域动态注入日志属性设计的,完全不需要硬修改全局Enricher的构造逻辑
正确实现方案
1. 调整启动配置
删掉和需求无关的全局Enricher注册,保留FromLogContext的核心配置:
public void Configure(IWebJobsBuilder builder) { Log.Logger = new LoggerConfiguration() .Enrich.FromLogContext() // 保留该配置,是动态注入日志属性的核心 .WriteTo.Debug() .CreateLogger(); }
原本的MyEnricher类如果没有通用的全局日志富集逻辑,可以直接删除。
2. 在Function执行入口注入CorrelationId
拿到当前消息的CorrelationId后,通过LogContext.PushProperty把值推入当前执行作用域的日志上下文。一定要使用using包裹PushProperty的返回值,出作用域后会自动清理上下文属性,避免多个并发函数实例之间出现日志属性串台(Azure Function默认并发处理多个请求,没有自动清理的话会导致A请求的CorrelationId混到B请求的日志里)。
调整后的Function代码:
public static class Function2 { [FunctionName("Function2")] public static void Run([ServiceBusTrigger("test-pm")]Message myQueueItem, ILogger log) { // 将CorrelationId推入当前执行作用域的日志上下文,作用域内所有日志会自动携带该属性 using (LogContext.PushProperty("CorrelationId", myQueueItem.CorrelationId)) { log.LogInformation($"C# Queue trigger function processed: {myQueueItem}"); // 该代码块内所有新增的日志记录,都会自动带上设置好的CorrelationId属性 } } }
注意事项
- 如果Function内存在异步逻辑,要保证
LogContext.PushProperty的作用域覆盖所有需要携带CorrelationId的日志写入操作,不要在异步流程执行完之前就dispose上下文实例 - 如果有跨方法调用需要复用日志属性,只需要把作用域范围扩到Function入口的最外层即可,不需要额外改Enricher逻辑
方案优势
- 完全绕开了
Enrich.With<T>()的无参构造约束,不需要和依赖注入容器掰扯短生命周期作用域的解析问题 - 日志属性严格绑定单次函数执行的作用域,从机制上避免了并发场景下的日志串台问题
- 没有引入额外的自定义组件复杂度,逻辑直白易维护
- 完全复用已经配置好的Serilog基础能力,不需要修改现有日志输出的其他配置
内容的提问来源于stack exchange,提问作者Peter Morris
相关产品推荐
相关产品推荐

