Serilog模板格式化中的异常消息优化实践

背景介绍

Serilog作为.NET生态中广泛使用的结构化日志记录库，其强大的模板格式化功能一直是开发者喜爱的特性之一。在日常开发中，我们经常需要处理异常日志，而默认情况下，Serilog会将异常的完整信息（包括消息和堆栈跟踪）输出到日志中。

问题发现

在控制台日志输出场景下，特别是通过docker容器查看远程日志时，完整的异常堆栈信息往往会带来以下问题：

1. 增加了日志的视觉噪声，降低了关键信息的可读性
2. 在多行输出时，日志格式变得混乱
3. 彩色输出支持有限，进一步降低了可读性

解决方案探索

内置格式化方案

Serilog的标准模板属性支持自定义格式化，例如时间戳可以格式化为{Timestamp:HH:mm:ss}，日志级别可以缩写为{Level:u3}。然而，异常属性{Exception}却没有提供类似的格式化选项。

替代方案比较

1. 使用Serilog.Expressions：这是官方推荐的现代化解决方案，可以通过{Inspect(@x).Message}表达式仅输出异常消息
2. 自定义属性增强：通过添加Enricher来附加一个只包含异常消息的新属性ExceptionMessage
3. 性能考量：通过基准测试发现，表达式方案相比内置格式化仅有约12%的性能差异（136ns vs 122ns），在实际应用中几乎可以忽略不计

实现细节

使用Serilog.Expressions的实现

var logger = new LoggerConfiguration()
    .WriteTo.Console(new ExpressionTemplate("[{@t:HH:mm:ss} {@l:u3}] {@m}\n{Inspect(@x).Message}"))
    .CreateLogger();

使用Enricher的实现

public class ExceptionMessageEnricher : ILogEventEnricher
{
    public void Enrich(LogEvent logEvent, ILogEventPropertyFactory propertyFactory)
    {
        if (logEvent.Exception != null)
        {
            var property = propertyFactory.CreateProperty("ExceptionMessage", logEvent.Exception.Message);
            logEvent.AddPropertyIfAbsent(property);
        }
    }
}

// 注册使用
var logger = new LoggerConfiguration()
    .Enrich.With<ExceptionMessageEnricher>()
    .WriteTo.Console(outputTemplate: "[{Timestamp:HH:mm:ss} {Level:u3}] {Message:lj}\n{ExceptionMessage}")
    .CreateLogger();

性能考量

通过基准测试验证，两种主要方案在性能上的差异可以忽略不计：

1. 内置格式化方案：约121.8纳秒/事件
2. 表达式方案：约136.2纳秒/事件

在实际应用中，这种微小的性能差异会被网络I/O、磁盘I/O等操作完全掩盖，不会成为系统瓶颈。

最佳实践建议

1. 对于新项目，推荐直接使用Serilog.Expressions方案，它提供了更灵活和强大的格式化能力
2. 对于已有项目，如果不想引入新依赖，可以使用Enricher方案
3. 在需要更复杂格式化逻辑时，可以考虑实现自定义函数来扩展表达式功能

总结

通过本文的分析，我们了解了在Serilog中优化异常日志输出的多种方法。虽然核心库目前不直接支持异常消息的格式化选项，但通过现有技术方案完全可以实现简洁、高效的异常日志输出。开发者可以根据项目实际情况选择最适合的方案，在日志可读性和完整性之间取得平衡。