ToolsPack.NLog 3.1.0

ToolsPack.NLog

NLog helper - format the structured logs with Newtonsoft.Json as described in the NLog documentation

Usage:

JsonSerializerSettings jsonSerializerSettings = new JsonSerializerSettings { 
    NullValueHandling = NullValueHandling.Ignore, 
    ReferenceLoopHandling = ReferenceLoopHandling.Ignore, 
    Formatting=Formatting.Indented 
};
NLog.Config.ConfigurationItemFactory.Default.JsonConverter = new ToolsPack.NLog.NewtonsoftJsonSerializer(jsonSerializerSettings);

Shortcut:

LogQuickConfig.UseNewtonsoftJson()

Update:

You can also use the new System.Text.Json serializer.

LogQuickConfig.UseMicrosoftJson()

In unit test and for most basic logging needs:

LogQuickConfig.SetupConsole();

or

LogQuickConfig.SetupFile("./log/app.log");

or

LogQuickConfig.SetupFileAndConsole("./log/app.log");

once setup, you can write logs as usual:

private static readonly NLog.ILogger log = NLog.LogManager.GetCurrentClassLogger();
log.Info("{@request}", req); //structured logging

Some library (APS.NET Core) require a Microsoft.Extensions.Logging.ILogger for logging. You can use NLog to create one: https://stackoverflow.com/a/60859465/347051

private static readonly ILoggerFactory loggerFactory = LoggerFactory.Create(builder =>
{
    builder.AddNLog(LogQuickConfig.SetupFileAndConsole("./log/app.log"));
    //LogQuickConfig.UseMicrosoftJson();
});
private static readonly ILogger<Program> log = loggerFactory.CreateLogger<Program>();

log.LogInformation("{@request}", jsonRequest);