Plinth.Logging.NLog 1.4.3

Prefix Reserved
.NET 6.0 This package targets .NET 6.0. The package is compatible with this framework or higher. .NET Core 3.1 This package targets .NET Core 3.1. The package is compatible with this framework or higher.
There is a newer version of this package available.
See the version list below for details. 
dotnet add package Plinth.Logging.NLog --version 1.4.3                

                    
                

            
NuGet\Install-Package Plinth.Logging.NLog -Version 1.4.3
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.4.3" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
paket add Plinth.Logging.NLog --version 1.4.3                

                    
                

            
#r "nuget: Plinth.Logging.NLog, 1.4.3"
#r directive can be used in F# Interactive and Polyglot Notebooks. 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.4.3

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

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 Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 is compatible.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
.NET Core netcoreapp3.1 is compatible. 
Compatible target framework(s)
Included target framework(s) (in package)
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

Plinth NLog Target for Application Insights
Plinth.WindowsService

Plinth Windows Service Utilities

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
1.6.6 35 11/8/2024
1.6.5 182 8/31/2024
1.6.4 77 8/2/2024
1.6.3 176 5/15/2024
1.6.2 220 2/16/2024
1.6.1 3,034 1/5/2024
1.6.0 350 11/30/2023
1.5.10-b186.aca976b4 80 11/30/2023
1.5.9 166 11/29/2023
1.5.9-b174.64153841 85 11/23/2023
1.5.9-b172.dfc6e7bd 71 11/17/2023
1.5.9-b171.4e2b92e2 78 11/4/2023
1.5.8 183 10/23/2023
1.5.7 3,683 7/31/2023
1.5.6 3,367 7/13/2023
1.5.5 255 6/29/2023
1.5.4 713 3/7/2023
1.5.3 337 3/3/2023
1.5.2 604 1/11/2023
1.5.2-b92.7c961f5f 120 1/11/2023
1.5.0 634 11/9/2022
1.5.0-b88.7a7c20cd 117 11/9/2022
1.4.7 3,597 10/20/2022
1.4.6 1,023 10/17/2022
1.4.5 1,164 10/1/2022
1.4.4 978 8/16/2022
1.4.3 1,345 8/2/2022
1.4.2 1,117 7/19/2022
1.4.2-b80.7fdbfd04 132 7/19/2022
1.4.2-b74.acaf86f5 120 6/15/2022
1.4.1 1,088 6/13/2022
1.4.0 958 6/6/2022
1.3.8 2,250 4/12/2022
1.3.7 997 3/21/2022
1.3.6 992 3/17/2022
1.3.6-b67.ca5053f3 131 3/16/2022
1.3.6-b66.4a9683e6 126 3/16/2022
1.3.5 1,059 2/23/2022
1.3.4 1,499 1/20/2022
1.3.3 783 12/29/2021
1.3.2 697 12/11/2021
1.3.1 569 11/12/2021
1.3.0 619 11/8/2021
1.2.3 1,823 9/22/2021
1.2.2 843 8/20/2021
1.2.1 1,315 8/5/2021
1.2.0 721 8/1/2021
1.2.0-b37.a54030b9 167 6/24/2021
1.1.6 3,568 3/22/2021
1.1.5 844 3/9/2021
1.1.4 1,713 2/27/2021
1.1.3 770 2/17/2021
1.1.2 852 2/12/2021
1.1.1 1,130 2/1/2021
1.1.0 803 12/16/2020
1.1.0-b27.b66c309b 277 11/15/2020
1.0.12 2,652 10/18/2020
1.0.11 836 10/6/2020
1.0.10 827 9/30/2020
1.0.9 678 9/29/2020
1.0.8 759 9/26/2020
1.0.7 707 9/19/2020
1.0.6 638 9/3/2020
1.0.5 627 9/2/2020
1.0.4 993 9/1/2020
1.0.3 684 9/1/2020
1.0.2 640 8/29/2020
1.0.1 654 8/29/2020
1.0.0 682 8/29/2020
1.0.0-b1.c22f563d 242 8/28/2020

added detailed readme