如何在Serilog控制台接收器中转义渲染日志消息的换行符？

问题背景 #

为适配Azure日志处理规则（避免每行被识别为独立日志丢失上下文），同时保留换行符以便后续Splunk还原，需要在Serilog控制台接收器中转义日志消息与异常的\r、\n为\\r、\\n。异常处理的enricher运行正常，但消息enricher中调用RenderMessage()生成格式化消息时，字符串占位符会被自动添加引号，例如执行：

_logger.LogDebug($"Something happened to '{0}' or '{1}'.", "this", "that");

会得到带多余引号的结果：

Something happened to '"this"' or '"that"'.

尝试过j修饰符，但仅对嵌入对象的换行符生效，无法解决普通字符串占位符的问题。

原因分析 #

Serilog的RenderMessage()默认会对字符串类型的占位符值添加引号，这是内置的格式化行为。如果日志模板未指定字符串修饰符，就会触发该默认逻辑。

解决方案 #

以下三种方案可根据场景选择：

1. 自定义消息渲染逻辑（无需修改现有日志模板）

修改MessageEnricher，手动遍历日志模板的Token和参数，对字符串类型参数直接输出原始值（不加引号），再转义换行符：

public class MessageEnricher : ILogEventEnricher
{
    public void Enrich(LogEvent logEvent, ILogEventPropertyFactory propertyFactory)
    {
        if (logEvent.MessageTemplate == null)
            return;

        var sb = new StringBuilder();
        int paramIndex = 0;
        foreach (var token in logEvent.MessageTemplate.Tokens)
        {
            if (token is TextToken textToken)
            {
                sb.Append(textToken.Text);
            }
            else if (token is PropertyToken propToken && paramIndex < logEvent.Properties.Count)
            {
                var propValue = logEvent.Properties.ElementAt(paramIndex).Value;
                // 字符串类型直接输出原始值，其他类型按默认格式输出
                if (propValue is ScalarValue scalar && scalar.Value is string strValue)
                {
                    sb.Append(strValue);
                }
                else
                {
                    sb.Append(propValue.ToString());
                }
                paramIndex++;
            }
        }

        var escapedMessage = sb.ToString()
            .Replace("\r", "\\r")
            .Replace("\n", "\\n");

        logEvent.AddPropertyIfAbsent(
            propertyFactory.CreateProperty("EscapedMessage", escapedMessage));
    }
}

2. 给日志模板的占位符添加l修饰符（侵入日志代码）

在所有日志调用的模板中，给字符串占位符添加l（小写L）修饰符，强制Serilog输出无引号的字符串：

// 修改前
// _logger.LogDebug($"Something happened to '{0}' or '{1}'.", "this", "that");

// 修改后
_logger.LogDebug("Something happened to '{0:l}' or '{1:l}'.", "this", "that");

这种方式简单直接，但需要统一修改所有相关日志代码。

3. 在控制台接收器配置中直接转义（无需enricher）

如果不需要单独存储EscapedMessage属性，仅需输出时转义换行符，可直接在控制台接收器的输出模板中处理：

Log.Logger = new LoggerConfiguration()
    .WriteTo.Console(outputTemplate: 
        "{Timestamp:yyyy-MM-dd HH:mm:ss} [{Level:u3}] {Message.Replace(\"\\r\", \"\\\\r\").Replace(\"\\n\", \"\\\\n\")}{NewLine}{Exception.Replace(\"\\r\", \"\\\\r\").Replace(\"\\n\", \"\\\\n\")}")
    .CreateLogger();

该方案无需编写额外代码，配置层面即可解决问题，侵入性最低。

关于j修饰符的补充说明 #

j修饰符的作用是将对象序列化为JSON格式，仅会处理嵌入对象内部的换行符，对普通字符串占位符无效，因此之前测试未生效是符合预期的。

内容的提问来源于stack exchange，提问作者Alek Davis