NLog v6 RC2 (#784)

Author: snakefoot

CHANGELOG.MD

@@ -2,6 +2,17 @@
 
 Date format: (year/month/day)
 
+### Version 6.0 RC2 (2025/06/02)
+
+- Updated to NLog v6.0-RC2
+- Removed support for NetStandard 1.3 + 1.5
+- Enabled nullable references
+- Avoid boxing when extracting LogEvent properties from struct
+- Reduce allocation when creating LogEvent with properties by using ReadOnlySpan
+- Enabled <IsAotCompatible>
+
+List of major changes in NLog 6.0: https://nlog-project.org/2025/04/29/nlog-6-0-major-changes.html
+
 ### Version 5.5 (2025/05/29)
 
 **Improvements**

build.ps1

@@ -2,8 +2,8 @@
 # creates NuGet package at \artifacts
 dotnet --version
 
-$versionPrefix = "5.5.0"
-$versionSuffix = ""
+$versionPrefix = "6.0.0"
+$versionSuffix = "rc2"
 $versionFile = $versionPrefix + "." + ${env:APPVEYOR_BUILD_NUMBER}
 $versionProduct = $versionPrefix;
 
@@ -26,7 +26,7 @@ if (-Not $LastExitCode -eq 0) {
     exit $LastExitCode 
 }
 
-msbuild /t:Pack .\src\NLog.Extensions.Logging\ /p:targetFrameworks='"net461;netstandard1.3;netstandard1.5;netstandard2.0;netstandard2.1;net6.0;net8.0"' /p:VersionPrefix=$versionPrefix /p:VersionSuffix=$versionSuffix /p:FileVersion=$versionFile /p:ProductVersion=$versionProduct /p:Configuration=Release /p:IncludeSymbols=true /p:SymbolPackageFormat=snupkg /p:PackageOutputPath=..\..\artifacts /verbosity:minimal /p:ContinuousIntegrationBuild=true
+msbuild /t:Pack .\src\NLog.Extensions.Logging\ /p:targetFrameworks='"net461;netstandard2.0;netstandard2.1;net6.0;net8.0"' /p:VersionPrefix=$versionPrefix /p:VersionSuffix=$versionSuffix /p:FileVersion=$versionFile /p:ProductVersion=$versionProduct /p:Configuration=Release /p:IncludeSymbols=true /p:SymbolPackageFormat=snupkg /p:PackageOutputPath=..\..\artifacts /verbosity:minimal /p:ContinuousIntegrationBuild=true
 if (-Not $LastExitCode -eq 0) {
     exit $LastExitCode 
 }

examples/NetCore2/ConsoleExample/nlog.config

@@ -1,6 +1,7 @@
 <?xml version="1.0" encoding="utf-8" ?>
-<!-- XSD manual extracted from package NLog.Schema: https://www.nuget.org/packages/NLog.Schema-->
-<nlog xmlns="http://www.nlog-project.org/schemas/NLog.xsd" xsi:schemaLocation="NLog NLog.xsd"
+<!-- Local NLog.XSD from nuget-package NLog.Schema -->
+<nlog xmlns="http://www.nlog-project.org/schemas/NLog.xsd"
+      xsi:schemaLocation="http://www.nlog-project.org/schemas/NLog.xsd NLog.xsd"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       autoReload="true"
       internalLogFile="c:\temp\console-example-internal.log"

examples/NetCore2/HostingExample/nlog.config

@@ -1,6 +1,7 @@
 <?xml version="1.0" encoding="utf-8" ?>
-<!-- XSD manual extracted from package NLog.Schema: https://www.nuget.org/packages/NLog.Schema-->
-<nlog xmlns="http://www.nlog-project.org/schemas/NLog.xsd" xsi:schemaLocation="NLog NLog.xsd"
+<!-- Local NLog.XSD from nuget-package NLog.Schema -->
+<nlog xmlns="http://www.nlog-project.org/schemas/NLog.xsd"
+      xsi:schemaLocation="http://www.nlog-project.org/schemas/NLog.xsd NLog.xsd"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       autoReload="true"
       internalLogFile="c:\temp\console-example-internal.log"

src/NLog.Extensions.Hosting/Extensions/ConfigureExtensions.cs

@@ -1,6 +1,5 @@
 using System;
 using System.IO;
-using System.Reflection;
 using Microsoft.Extensions.Configuration;
 using Microsoft.Extensions.DependencyInjection;
 using Microsoft.Extensions.Hosting;
@@ -34,7 +33,7 @@ public static IHostBuilder UseNLog(this IHostBuilder builder)
         /// <param name="builder"></param>
         /// <param name="options">NLogProviderOptions object to configure NLog behavior</param>
         /// <returns>IHostBuilder for chaining</returns>
-        public static IHostBuilder UseNLog(this IHostBuilder builder, NLogProviderOptions options)
+        public static IHostBuilder UseNLog(this IHostBuilder builder, NLogProviderOptions? options)
         {
             Guard.ThrowIfNull(builder);
 #if NETSTANDARD2_0
@@ -89,7 +88,7 @@ public static IHostApplicationBuilder UseNLog(this IHostApplicationBuilder build
         /// <param name="builder"></param>
         /// <param name="options">NLogProviderOptions object to configure NLog behavior</param>
         /// <returns>IHostApplicationBuilder for chaining</returns>
-        public static IHostApplicationBuilder UseNLog(this IHostApplicationBuilder builder, NLogProviderOptions options)
+        public static IHostApplicationBuilder UseNLog(this IHostApplicationBuilder builder, NLogProviderOptions? options)
         {
             Guard.ThrowIfNull(builder);
             builder.Services.TryAddNLogLoggingProvider((svc, addlogging) => svc.AddLogging(addlogging), builder.Configuration, options, (serviceProvider, config, opt) => CreateNLogLoggerProvider(serviceProvider, config, builder.Environment, opt));
@@ -119,31 +118,33 @@ public static IHostApplicationBuilder UseNLog(this IHostApplicationBuilder build
         }
 #endif
 
-        private static void AddNLogLoggerProvider(IServiceCollection services, IConfiguration hostConfiguration, IHostEnvironment hostEnvironment, NLogProviderOptions options, Func<IServiceProvider, IConfiguration, IHostEnvironment, NLogProviderOptions, NLogLoggerProvider> factory)
+        private static void AddNLogLoggerProvider(IServiceCollection services, IConfiguration? hostConfiguration, IHostEnvironment? hostEnvironment, NLogProviderOptions? options, Func<IServiceProvider, IConfiguration?, IHostEnvironment?, NLogProviderOptions, NLogLoggerProvider> factory)
         {
             services.TryAddNLogLoggingProvider((svc, addlogging) => svc.AddLogging(addlogging), hostConfiguration, options, (provider, cfg, opt) => factory(provider, cfg, hostEnvironment, opt));
         }
 
-        private static NLogLoggerProvider CreateNLogLoggerProvider(IServiceProvider serviceProvider, IConfiguration hostConfiguration, IHostEnvironment hostEnvironment, NLogProviderOptions options)
+        private static NLogLoggerProvider CreateNLogLoggerProvider(IServiceProvider serviceProvider, IConfiguration? hostConfiguration, IHostEnvironment? hostEnvironment, NLogProviderOptions options)
         {
             return serviceProvider.CreateNLogLoggerProvider(hostConfiguration, options, LogManager.LogFactory);
         }
 
-        private static NLogLoggerProvider CreateNLogLoggerProvider(IServiceProvider serviceProvider, IConfiguration hostConfiguration, IHostEnvironment hostEnvironment, NLogProviderOptions options, LogFactory logFactory)
+        private static NLogLoggerProvider CreateNLogLoggerProvider(IServiceProvider serviceProvider, IConfiguration? hostConfiguration, IHostEnvironment? hostEnvironment, NLogProviderOptions options, LogFactory logFactory)
         {
             NLogLoggerProvider provider = serviceProvider.CreateNLogLoggerProvider(hostConfiguration, options, logFactory);
 
             string nlogConfigFile = string.Empty;
-            string contentRootPath = hostEnvironment?.ContentRootPath;
-            string environmentName = hostEnvironment?.EnvironmentName;
+            var contentRootPath = hostEnvironment?.ContentRootPath;
+            var environmentName = hostEnvironment?.EnvironmentName;
             if (!string.IsNullOrWhiteSpace(contentRootPath) || !string.IsNullOrWhiteSpace(environmentName))
             {
                 provider.LogFactory.Setup().LoadConfiguration(cfg =>
                 {
                     if (!IsLoggingConfigurationLoaded(cfg.Configuration))
                     {
                         nlogConfigFile = ResolveEnvironmentNLogConfigFile(contentRootPath, environmentName);
+#pragma warning disable CS8625 // Cannot convert null literal to non-nullable reference type.
                         cfg.Configuration = null;
+#pragma warning restore CS8625 // Cannot convert null literal to non-nullable reference type.
                     }
                 });
             }
@@ -157,7 +158,7 @@ private static NLogLoggerProvider CreateNLogLoggerProvider(IServiceProvider serv
             return provider;
         }
 
-        private static string ResolveEnvironmentNLogConfigFile(string basePath, string environmentName)
+        private static string ResolveEnvironmentNLogConfigFile(string? basePath, string? environmentName)
         {
             if (!string.IsNullOrWhiteSpace(basePath))
             {
@@ -182,7 +183,7 @@ private static string ResolveEnvironmentNLogConfigFile(string basePath, string e
             if (!string.IsNullOrWhiteSpace(environmentName))
                 return $"nlog.{environmentName}.config";
 
-            return null;
+            return string.Empty;
         }
 
         private static bool IsLoggingConfigurationLoaded(LoggingConfiguration cfg)

src/NLog.Extensions.Hosting/ILLink.Descriptors.xml

@@ -3,8 +3,6 @@
   <PropertyGroup>
     <TargetFrameworks>netstandard2.0;netstandard2.1;net6.0;net8.0</TargetFrameworks>
     <DebugType Condition=" '$(Configuration)' == 'Debug' ">Full</DebugType>
-    <TreatWarningsAsErrors>true</TreatWarningsAsErrors>
-    <GenerateDocumentationFile>true</GenerateDocumentationFile>
 
     <Product>NLog.Extensions.Hosting v$(ProductVersion)</Product>
     <InformationalVersion>$(ProductVersion)</InformationalVersion>
@@ -31,14 +29,18 @@ For ASP.NET Core, check: https://www.nuget.org/packages/NLog.Web.AspNetCore
     <!-- SonarQube needs ProjectGuid -->
     <ProjectGuid>{548E65CE-0378-4812-AE00-B173F1251D3C}</ProjectGuid>
     <SignAssembly>true</SignAssembly>
-    <AssemblyVersion>5.0.0.0</AssemblyVersion>
+    <AssemblyVersion>6.0.0.0</AssemblyVersion>
     <AssemblyOriginatorKeyFile>..\NLog.snk</AssemblyOriginatorKeyFile>
     <PublicSign Condition=" '$(OS)' != 'Windows_NT' ">true</PublicSign>
     <LangVersion>latest</LangVersion>
     <!-- EmbedUntrackedSources for deterministic build -->
-    <EmbedUntrackedSources>true</EmbedUntrackedSources>
+    <TreatWarningsAsErrors>true</TreatWarningsAsErrors>
+    <GenerateDocumentationFile>true</GenerateDocumentationFile>
+    <Nullable>enable</Nullable>
+    <LangVersion>9</LangVersion>
     <EnableTrimAnalyzer>true</EnableTrimAnalyzer>
-    <IsTrimmable>true</IsTrimmable>
+    <IsTrimmable Condition="$([MSBuild]::IsTargetFrameworkCompatible('$(TargetFramework)', 'net6.0'))">true</IsTrimmable>
+    <IsAotCompatible Condition="$([MSBuild]::IsTargetFrameworkCompatible('$(TargetFramework)', 'net7.0'))">true</IsAotCompatible>
   </PropertyGroup>
 
   <ItemGroup Condition=" '$(TargetFramework)' == 'netstandard2.0' ">
@@ -67,12 +69,6 @@ For ASP.NET Core, check: https://www.nuget.org/packages/NLog.Web.AspNetCore
     <ProjectReference Include="..\NLog.Extensions.Logging\NLog.Extensions.Logging.csproj" />
   </ItemGroup>
 
-  <ItemGroup>
-    <EmbeddedResource Include="ILLink.Descriptors.xml">
-      <LogicalName>ILLink.Descriptors.xml</LogicalName>
-    </EmbeddedResource>
-  </ItemGroup>
-
   <ItemGroup>
     <None Include="N.png" Pack="true" PackagePath="" Visible="false" />
     <None Include="README.md" Pack="true" PackagePath="" />