dotnet/extensions项目中ExtendedLogger的OriginalFormat属性处理问题解析

问题背景

在.NET生态系统的日志记录机制中，ExtendedLogger是Microsoft.Extensions.Telemetry库提供的一个增强型日志记录器实现。它负责处理日志消息的格式化、丰富化和导出等操作。近期发现该组件在处理{OriginalFormat}属性时存在与OpenTelemetry规范不兼容的问题，这会影响日志记录在遥测系统中的正确导出。

技术细节分析

{OriginalFormat}是一个特殊的日志属性，它存储了日志消息的原始模板字符串（即未进行参数替换前的格式）。例如，对于日志语句logger.LogInformation("Processing {ID}", 123)，{OriginalFormat}的值将是"Processing {ID}"。

OpenTelemetry规范要求：

1. 当IncludeFormattedMessage为true时，LogRecord.Body应包含已格式化的消息（如"Processing 123"）
2. 当IncludeFormattedMessage为false时，LogRecord.Body应包含原始消息模板（即{OriginalFormat}的值）

当前ExtendedLogger的实现存在两个主要问题：

1. 对于源代码生成的日志，无论IncludeFormattedMessage设置如何，总是导出格式化后的消息
2. {OriginalFormat}属性在属性集合中的位置不正确，导致OpenTelemetry处理器无法正确识别它

问题影响

这种不一致性会导致：

• 日志分析系统无法正确识别日志消息模板
• 日志聚合和统计功能失效（因为相同逻辑的日志会被视为不同消息）
• 日志查询效率降低（无法基于消息模板进行高效过滤）

解决方案

修复方案需要确保：

1. {OriginalFormat}属性始终位于日志属性集合的末尾
2. 源代码生成日志和常规日志都遵循相同的处理逻辑
3. 在启用丰富化、静态丰富化和脱敏功能时仍能保持正确的属性顺序

最佳实践建议

开发人员在使用ExtendedLogger时应注意：

1. 明确设置IncludeFormattedMessage以控制日志输出格式
2. 避免在日志模板中使用{OriginalFormat}作为参数名
3. 测试验证日志在不同配置下的输出是否符合预期

总结

正确处理{OriginalFormat}属性对于构建可靠的日志系统至关重要。通过修复这个问题，ExtendedLogger将能够更好地与OpenTelemetry生态系统集成，为.NET应用程序提供更准确、一致的日志记录能力。开发团队应关注此问题的修复版本，并在升级后验证日志输出是否符合预期。