从消息和异常中删除新行

Question

我在Asp点网核心应用程序中使用Serilog。我希望我的日志文件是人类可读的，但也能够轻松解析。

我遇到的问题是异常记录在换行符中。某些Microsoft事件包含包含新行的消息。

我希望能够解析日志文件，每行一个事件。

我可以编写自己的 ITextFormatter 实现，用 \r 替换新行，但我们的意思是我需要复制 MessageTemplateTextFormatter 和其他类中的许多逻辑。

Answer 1

在深入研究了一段时间后，我能够想出一个答案。安迪·韦斯特的回答为我指明了正确的方向。

这里有两个单独的问题：消息中的 CRLF 和异常中的 CRLF。

我能够通过在输出模板中将"{Message}"更改为"{Message：j}"来解决消息问题。

更改异常有点棘手。我不得不添加一个丰富器：

class ExceptionEnricher : ILogEventEnricher
{
    public void Enrich(LogEvent logEvent, ILogEventPropertyFactory propertyFactory)
    {
        if (logEvent.Exception == null)
            return;
        var logEventProperty = propertyFactory.CreateProperty("EscapedException", logEvent.Exception.ToString().Replace("rn", "\r\n"));
        logEvent.AddPropertyIfAbsent(logEventProperty);
    }        
}

这将添加一个名为 EscapedException 的新属性。这必须添加到带有 的配置中。Enrich.With((。

然后我在输出模板中将"{Exception}"替换为"{EscapedException}"。

Answer 2

此技术将删除所有 CRLF。首先是一个新的IText格式化程序。

    public class RemoveCrLf : ITextFormatter
    {
        private const int DefaultWriteBuffer = 256;
        private readonly ITextFormatter _textFormatter;
        /// <summary>
        /// 
        /// </summary>
        /// <param name="textFormatter"></param>
        public RemoveCrLf(ITextFormatter textFormatter)
        {
            _textFormatter = textFormatter;
        }
        /// <summary>
        /// 
        /// </summary>
        /// <param name="logEvent"></param>
        /// <param name="output"></param>
        public void Format(LogEvent logEvent, TextWriter output)
        {
            var buffer = new StringWriter(new StringBuilder(DefaultWriteBuffer));
            _textFormatter.Format(logEvent, buffer);
            var logText = buffer.ToString();
            output.WriteLine(logText.Trim().Replace("n","\n").Replace("r","\r"));
            output.Flush();
        }
    }

像这样使用它

configuration.WriteTo.Console(new RemoveCrLf(new MessageTemplateTextFormatter("[{Timestamp:HH:mm:ss} {Level:u3}] {Message:lj} {Exception}")));

当然，根据需要自定义输出模板。

Answer 3

参考 @Andrew Radford 的解决方案，该解决方案仅适用于 Windows，但不适用于预期的 Linux docker 环境。因此我增强了消息和异常的解决方案。

我已经使用Environment.NewLine在正则表达式中进行案例匹配，它将根据托管环境选择案例。

为消息添加以下类。

public class MessageEnricher : ILogEventEnricher
{
    public void Enrich(LogEvent logEvent, ILogEventPropertyFactory propertyFactory)
    {
        if (logEvent.MessageTemplate == null)
            return;
        var logEventProperty = propertyFactory.CreateProperty("EscapedMessage", Regex.Replace(logEvent.MessageTemplate.ToString(), Environment.NewLine, "[Newline]"));
        logEvent.AddPropertyIfAbsent(logEventProperty);
    }
}

对异常使用以下类。

    public void Enrich(LogEvent logEvent, ILogEventPropertyFactory propertyFactory)
    {
        if (logEvent.Exception == null)
            return;
        var logEventProperty = propertyFactory.CreateProperty("EscapedException", Regex.Replace(logEvent.Exception.ToString(), Environment.NewLine, "[Newline]"));
        logEvent.AddPropertyIfAbsent(logEventProperty);
    }

然后将这两个帮助程序类添加到程序中.cs

           Log.Logger = new LoggerConfiguration()
          .ReadFrom.Configuration(Configuration)
          .Enrich.With(new ExceptionEnricher())
          .Enrich.With(new MessageEnricher())
          .Enrich.FromLogContext()
          .CreateLogger();

更新应用设置输出模板

 "outputTemplate": "{Timestamp:yyyy-MM-dd HH:mm:ss.fff} {Level:u4} {SourceContext:l} : {EscapedMessage}{NewLine}{EscapedException}{NewLine}"

Answer 4

您没有指定如何记录异常，但假设您使用了类似以下内容：

Log.Error("An error occurred: {Exception}", exception);

然后异常将使用 ToString(( 呈现。在这种情况下，您不能简单地这样做吗：

Log.Error("An error occurred: {Exception}", exception.ToString().Replace(System.Environment.NewLine, "\r\n"));

当然，如果您需要在

多个地方执行此操作，则可以将其重构为方法(可能是扩展方法(。