NLog项目中自定义NLogViewer目标的消息格式

背景介绍

NLog是一个流行的.NET日志记录框架，提供了多种日志输出目标(target)。其中NLogViewer目标专门用于将日志发送到兼容Log4J-XML格式的日志查看器，如Sentinel等。

问题描述

开发者在使用NLogViewer目标时发现，无法像Network目标那样自定义完整的日志消息格式。具体表现为：

1. Network目标可以自由定义包含线程ID、线程名称、调用位置等信息的完整消息格式
2. NLogViewer目标只能输出原始消息内容，无法包含其他上下文信息

技术分析

NLogViewer目标的默认行为是发送符合Log4J-XML标准的日志事件文档。该目标内部使用Log4JXmlEventLayout布局，默认只输出LogEventInfo.FormattedMessage(即${message})作为消息内容。

这种设计源于历史原因，NLogViewer最初是为配合NLogViewer项目开发的，采用了非标准的Log4J-XML格式实现。

解决方案

NLog 5.3.1版本中增加了对NLogViewer目标消息格式的自定义支持。现在可以通过以下方式自定义消息格式：

1. 在配置中使用FormattedMessage属性覆盖默认消息格式
2. 创建自定义布局类继承Log4JXmlEventLayout并重写相关方法

配置示例

<target name="sentinel" xsi:type="NLogViewer" address="udp4://localhost:9998">
  <layout xsi:type="Log4JXmlEventLayout" 
          formattedMessage="${threadid}|${threadname}|${message}|${exception:format=tostring}|${callsite}"/>
</target>

自定义布局实现

对于更复杂的需求，可以创建自定义布局类：

[Layout("CustomLog4JXmlLayout")]
public class CustomLog4JXmlLayout : Log4JXmlEventLayout
{
    protected override void RenderFormattedMessage(LogEventInfo logEvent, StringBuilder target)
    {
        // 自定义消息格式处理逻辑
        var customMessage = $"自定义前缀 {logEvent.Message}";
        target.Append(customMessage);
    }
}

注意事项

1. 修改日志事件对象(LogEventInfo)时要小心，因为同一个事件会被发送到所有目标
2. 自定义实现时应注意保持XML格式的有效性
3. 对于标准Log4J-XML格式需求，可以考虑使用ChainSaw目标

总结

NLog 5.3.1版本增强了对NLogViewer目标消息格式的自定义能力，开发者现在可以更灵活地控制发送到日志查看器的消息内容。根据实际需求，可以选择简单的配置方式或创建自定义布局类来实现复杂的格式化需求。