Search code examples
c#nlogasp.net-core-5.0

AspNet Core 5.0 and register custom NLog LayoutRenderer


I use NLog.Web.AspNetCore 4.10.0 in my ASP Net Core 5.0 application. And I created a simple custom ResultLayoutRenderer (shortened for simplicity):

[LayoutRenderer("result-payload")]
public class ResultLayoutRenderer : AspNetLayoutRendererBase
{
    protected override void DoAppend(StringBuilder builder, LogEventInfo logEvent)
    {
        var httpRequest = HttpContextAccessor?.HttpContext?.Request;
        var result = httpRequest.Headers["Result"];
        builder.Append(result);
    }
}

My NLog config is the following:

<?xml version="1.0" encoding="utf-8" ?>
<nlog xmlns="http://www.nlog-project.org/schemas/NLog.xsd"
      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
      autoReload="true">

    <!-- enable asp.net core layout renderers -->
    <extensions>
        <add assembly="NLog.Web.AspNetCore"/>
    </extensions>
    
    <targets>
        <target xsi:type="Null" name="blackhole" />
        <target name="database" xsi:type="Database"
            dbProvider="Npgsql.NpgsqlConnection, Npgsql"
            dbHost="${configsetting:name=NlogConnection.DbHost}"
            dbDatabase="${configsetting:name=NlogConnection.Database}"
            dbUserName="${configsetting:name=NlogConnection.User}"
            dbPassword="${configsetting:name=NlogConnection.Password}"">
            
            <commandText>
                INSERT INTO logs (Application, Logged, Level, Message, Logger, Result) 
                VALUES (@Application, @Logged, @Level, @Message, @Logger, @Result);
            </commandText>
            
            <parameter name="@application" layout="AspNetCoreNlog" />
            <parameter name="@logged" layout="${date}" />
            <parameter name="@level" layout="${level}" />
            <parameter name="@message" layout="${message}" />
            <parameter name="@logger" layout="${logger}" />

            <parameter name="@result" layout="${result-payload}" />
            
        </target>
    </targets>
</nlog>

I register the ResultLayoutRenderer in the Programm.cs:

public static void Main(string[] args)
{
    var logger = NLogBuilder.ConfigureNLog("nlog.config")
        .Setup()
        .SetupExtensions(s => s.RegisterLayoutRenderer<InputDataLayout>("result-payload"))
        .GetCurrentClassLogger();
        ..............
}

But the layout doesn't work. The NLog internal log file contains the following information:

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

Solution

  • You are very close. NLogBuilder.ConfigureNLog(...) is soon obsolete, instead it is recommended to use the fluent configuration api:

    var logger = NLog.LogFactory.Setup()
        .SetupExtensions(ext =>
              ext.RegisterLayoutRenderer<ResultLayoutRenderer>("result-payload")
        )
        .LoadConfigurationFromAppSettings()
        .GetCurrentClassLogger();
    

    See also: https://github.com/NLog/NLog.Web/blob/master/examples/ASP.NET%20Core%205/ASP.NET%20Core%205%20NLog%20Example/Program.cs