自定义NLog布局渲染器在某些项目中不产生输出



.NET Framework 4.8,NLog 4.7.6

我实现了两个简单的LayoutRenderer子类,它们只写一个Guid(从Web上下文或静态Stack<T>获取(。它们在两个Web项目中运行良好,但在第三个Web应用程序或几个控制台应用程序/服务中都不起作用。应用程序之间的配置是一致的,但有些有效,有些无效。

示例:

[LayoutRenderer("request-guid")]
public class RequestGuidLayoutRenderer:
LayoutRenderer
{
protected override void Append(StringBuilder builder, LogEventInfo logEvent)
{
var guid = RequestIdentityService.Current.RequestGuid?.ToString() ?? Constants.NullSession;
builder.Append(guid);
}
}

除了得到SessionGuid而不是RequestGuid之外,还有一个几乎相同的session-guid布局渲染器。

我的配置部分如下所示,其中MyAssemblyName包含布局渲染器:

<nlog autoReload="true">
<extensions>
<assembly name="MyAssemblyName" />
</extensions>
<variable name="brief" value="${longdate} ${session-guid} ${request-guid} ${level} ${replace:searchFor=^.*.([^.]+)$:replaceWith=$1:regex=true:inner=${logger}} ${message}${onexception:inner= ${exception:format=toString,Data}}" />
<variable name="verbose" value="${longdate} | ${machinename} | ${processid} | ${processname} | ${session-guid} ${request-guid} | ${level} | ${logger} | ${message}${onexception:inner= ${exception:format=toString,Data}}" />
<targets>
<target name="all_in" type="File" layout="${verbose}" fileName="C:/log/appx/current.txt" archiveFileName="C:/log/appx/archive/{#}.txt" archiveNumbering="DateAndSequence" archiveAboveSize="10485760" archiveDateFormat="yyyyMMdd" keepFileOpen="false" maxArchiveFiles="100" encoding="iso-8859-2" />
<target name="LogStreaming"  type="Trace" layout="${verbose}" />
</targets>
<rules>
<logger name="*" minlevel="Debug" writeTo="all_in" />
<logger name="*" minlevel="Error" writeTo="LogStreaming" />
</rules>
</nlog>

为了确保注册这些布局渲染器,我还在Web应用程序的Application_Start()开头注册它们,并在其他应用程序类型的Main()或等效版本中注册它们。

public static void Register()
{
LayoutRenderer.Register<RequestGuidLayoutRenderer>("request-guid");
LayoutRenderer.Register<SessionGuidLayoutRenderer>("session-guid");
LogManager.GetCurrentClassLogger().Error($"Registered NLog LayoutRenderers request-guid and session-guid.");
}

对于两个Web应用程序,这是完美的工作,但对于第三个应用程序,它没有为这些布局渲染器产生任何输出。内部日志证实,它在查找它们时遇到了问题,或者可能试图在它们注册之前使用它们。

Error parsing layout session-guid will be ignored. Exception: System.ArgumentException: LayoutRenderer cannot be found: 'session-guid'
at NLog.Config.Factory`2.CreateInstance(String itemName)
at NLog.Layouts.LayoutParser.GetLayoutRenderer(ConfigurationItemFactory configurationItemFactory, String name, Nullable`1 throwConfigExceptions)
Error parsing layout request-guid will be ignored. Exception: System.ArgumentException: LayoutRenderer cannot be found: 'request-guid'
at NLog.Config.Factory`2.CreateInstance(String itemName)
at NLog.Layouts.LayoutParser.GetLayoutRenderer(ConfigurationItemFactory configurationItemFactory, String name, Nullable`1 throwConfigExceptions)

我意外地发现,如果我在配置中设置throwConfigExceptions="true",它就会突然在Web应用程序中工作,否则它就不会工作!但为什么呢?有没有其他方法可以修复它,这样我就不必冒运行时错误的风险记录破坏我们的应用程序了?

由于某些原因,您注册得太晚了。

也许有一个静态调用在注册之前解析配置。

您可以在注册后重新加载配置:

LogManager.Configuration = LogManager.Configuration.Reload();
LogManager.ReconfigExistingLoggers();

最新更新