Plinth.Logging.NLog 1.5.0

The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org. Prefix Reserved
.NET 6.0
dotnet add package Plinth.Logging.NLog --version 1.5.0
NuGet\Install-Package Plinth.Logging.NLog -Version 1.5.0
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Plinth.Logging.NLog" Version="1.5.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Plinth.Logging.NLog --version 1.5.0
#r "nuget: Plinth.Logging.NLog, 1.5.0"
#r directive can be used in F# Interactive, C# scripting and .NET Interactive. Copy this into the interactive tool or source code of the script to reference the package.
// Install Plinth.Logging.NLog as a Cake Addin
#addin nuget:?package=Plinth.Logging.NLog&version=1.5.0

// Install Plinth.Logging.NLog as a Cake Tool
#tool nuget:?package=Plinth.Logging.NLog&version=1.5.0

README

Plinth.Logging.NLog

NLog logging via Plinth

1. Create a new file called NLog.config in your project root.

  • Place the XML below inside this file.
  • Right Click - Properties - Copy to Output Directory - Set to "Copy If Newer"
  • {Project}.csproj
  <ItemGroup>
    <None Update="NLog.config">
      <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
    </None>
  </ItemGroup>
  • NLog.config
<?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"
  xsi:schemaLocation="http://www.nlog-project.org/schemas/NLog.xsd NLog.xsd" autoReload="true" throwExceptions="false" internalLogLevel="Off"
  internalLogFile="Logs/nlog-internal.log">

  
  <variable name="product" value="PRODUCT" />
  <variable name="component" value="COMPONENT" />

  
  
  -->

  
  <variable name="exceptionRootDirPrefixes" value="Plinth,YourNamespace" />

  <include file="${basedir}/NLog.Plinth.config" ignoreErrors="true" />

  <rules>
    

    
    

    
    

  </rules>

</nlog>

2. NLog.config configurations

  • Uncomment one of the logger lines unside the rules section
  • set environment to something like local, dev, prod, etc
  • set product to your product name
  • set component to the component name (like core, web, reports, etc)
  • set exceptionRootDirPrefixes to the beginning of the root path of your component (for filtering filenames in stack traces)

3a. Use this code in Program.cs

 public static class Program
 {
     public static void Main(string[] args)
     {
         var log = StaticLogManagerSetup.BasicNLogSetup();

         log.Debug("startup!");

3b. Add this to your host setup

        webBuilder.ConfigureLogging(builder => builder.AddNLog());

OR

        webBuilder.ConfigureServices(services => services.AddNLog());

3c. Add this code to your classes

using Microsoft.Extensions.Logging;

class MyClass
{
    private static readonly ILogger log = StaticLogManager.GetLogger();

OR inject via DI

public MyClass(ILogger<MyClass> logger)

4. Configuration

By default, Microsoft.* and System.* will be set to Warn and above only. To turn those on, add rules in NLog.config like this, which will enable Info and above

 <logger name="Microsoft.*" maxLevel="Debug" final="true" />

👉 NOTE: When using NLog, appsettings.json / "Logging" has no effect, it is all configured through NLog.config

5. Overrides

  • Use this to override file archiving parameters in NLog.Plinth.config

    • Create a new file called NLog.Plinth.Overrides.config in your root.
    • Place the XML below inside this file.
    • Right Click - Properties - Copy to Output Directory - Set to Copy If Newer
  • {Project}.csproj

  <ItemGroup>
    <None Update="NLog.Plinth.Overrides.config">
      <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
    </None>
  </ItemGroup>
  • NLog.Plinth.Overrides.config
<?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"
  xsi:schemaLocation="http://www.nlog-project.org/schemas/NLog.xsd NLog.xsd" autoReload="true" throwExceptions="false" internalLogLevel="Off"
  internalLogFile="Logs\nlog-internal.log">
  
  <variable name="file.archiveAboveSize" value="10485760"/>
  <variable name="file.maxArchiveFiles" value="10"/>
  <variable name="file.enableCompression" value="true"/>

</nlog> 
  • To override the file name for this config (for different environments, etc, add this above the include for NLog.Plinth.config)
  <variable name="plinthOverrideConfig" value="NLog.Plinth.Overrides.PROD.config"/>
Product Versions
.NET net6.0 net6.0-android net6.0-ios net6.0-maccatalyst net6.0-macos net6.0-tvos net6.0-windows net7.0 net7.0-android net7.0-ios net7.0-maccatalyst net7.0-macos net7.0-tvos net7.0-windows
Compatible target framework(s)
Additional computed target framework(s)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (2)

Showing the top 2 NuGet packages that depend on Plinth.Logging.NLog:

Package Downloads
Plinth.Logging.NLog.AppInsights The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org.

Plinth NLog Target for Application Insights

Plinth.WindowsService The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org.

Plinth Windows Service Utilities

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
1.5.0 110 11/9/2022
1.5.0-b88.7a7c20cd 34 11/9/2022
1.4.7 480 10/20/2022
1.4.6 401 10/17/2022
1.4.5 514 10/1/2022
1.4.4 392 8/16/2022
1.4.3 383 8/2/2022
1.4.2 571 7/19/2022
1.4.2-b80.7fdbfd04 77 7/19/2022
1.4.2-b74.acaf86f5 60 6/15/2022
1.4.1 538 6/13/2022
1.4.0 383 6/6/2022
1.3.8 1,630 4/12/2022
1.3.7 428 3/21/2022
1.3.6 434 3/17/2022
1.3.6-b67.ca5053f3 66 3/16/2022
1.3.6-b66.4a9683e6 61 3/16/2022
1.3.5 488 2/23/2022
1.3.4 938 1/20/2022
1.3.3 434 12/29/2021
1.3.2 437 12/11/2021
1.3.1 324 11/12/2021
1.3.0 351 11/8/2021
1.2.3 1,528 9/22/2021
1.2.2 548 8/20/2021
1.2.1 918 8/5/2021
1.2.0 456 8/1/2021
1.2.0-b37.a54030b9 109 6/24/2021
1.1.6 3,009 3/22/2021
1.1.5 597 3/9/2021
1.1.4 1,446 2/27/2021
1.1.3 473 2/17/2021
1.1.2 559 2/12/2021
1.1.1 867 2/1/2021
1.1.0 559 12/16/2020
1.1.0-b27.b66c309b 229 11/15/2020
1.0.12 1,724 10/18/2020
1.0.11 554 10/6/2020
1.0.10 598 9/30/2020
1.0.9 482 9/29/2020
1.0.8 573 9/26/2020
1.0.7 513 9/19/2020
1.0.6 434 9/3/2020
1.0.5 441 9/2/2020
1.0.4 797 9/1/2020
1.0.3 485 9/1/2020
1.0.2 459 8/29/2020
1.0.1 447 8/29/2020
1.0.0 483 8/29/2020
1.0.0-b1.c22f563d 200 8/28/2020

net7.0 support and removed netcoreapp3.1