NLogAspNetCoreOptions - Added ReplaceLoggerFactory and RemoveLoggerFa…

…ctoryFilter (#657)
NLog · Mar 28, 2021 · 4430692 · 4430692
1 parent 1df472e
commit 4430692
Show file tree

Hide file tree

Showing 2 changed files with 35 additions and 2 deletions.
diff --git a/src/NLog.Web.AspNetCore/AspNetExtensions.cs b/src/NLog.Web.AspNetCore/AspNetExtensions.cs
@@ -312,7 +312,24 @@ private static void AddNLogLoggerProvider(IServiceCollection services, IConfigur
             ConfigurationItemFactory.Default.RegisterItemsFromAssembly(typeof(AspNetExtensions).GetTypeInfo().Assembly);
             LogManager.AddHiddenAssembly(typeof(AspNetExtensions).GetTypeInfo().Assembly);
 
-            services.TryAddEnumerable(ServiceDescriptor.Singleton<ILoggerProvider, NLogLoggerProvider>(serviceProvider => factory(serviceProvider, configuration, options)));
+            var sharedFactory = factory;
+
+            if ((options ?? NLogAspNetCoreOptions.Default).ReplaceLoggerFactory)
+            {
+                NLogLoggerProvider singleInstance = null;   // Ensure that registration of ILoggerFactory and ILoggerProvider shares the same single instance
+                sharedFactory = (provider, cfg, opt) => singleInstance ?? (singleInstance = factory(provider, cfg, opt));
+
+                services.AddLogging(builder => builder?.ClearProviders());  // Cleanup the existing LoggerFactory, before replacing it with NLogLoggerFactory
+                services.Replace(ServiceDescriptor.Singleton<ILoggerFactory, NLogLoggerFactory>(serviceProvider => new NLogLoggerFactory(sharedFactory(serviceProvider, configuration, options))));
+            }
+
+            services.TryAddEnumerable(ServiceDescriptor.Singleton<ILoggerProvider, NLogLoggerProvider>(serviceProvider => sharedFactory(serviceProvider, configuration, options)));
+
+            if ((options ?? NLogAspNetCoreOptions.Default).RemoveLoggerFactoryFilter)
+            {
+                // Will forward all messages to NLog if not specifically overridden by user
+                services.AddLogging(builder => builder?.AddFilter<NLogLoggerProvider>(null, Microsoft.Extensions.Logging.LogLevel.Trace));
+            }
 
             //note: this one is called before  services.AddSingleton<ILoggerFactory>
             if ((options ?? NLogAspNetCoreOptions.Default).RegisterHttpContextAccessor)

diff --git a/tests/NLog.Web.AspNetCore.Tests/AspNetCoreTests.cs b/tests/NLog.Web.AspNetCore.Tests/AspNetCoreTests.cs
@@ -54,6 +54,22 @@ public void UseNLogShouldLogTest()
             Assert.Equal("logger1|error1", logged.First());
         }
 
+#if !ASP_NET_CORE1
+        [Fact]
+        public void UseNLog_ReplaceLoggerFactory()
+        {
+            var webhost = CreateWebHost(new NLogAspNetCoreOptions() { ReplaceLoggerFactory = true });
+
+            // Act
+            var loggerFactory = webhost.Services.GetService<ILoggerFactory>();
+            var loggerProvider = webhost.Services.GetService<ILoggerProvider>();
+
+            // Assert
+            Assert.Equal(typeof(NLogLoggerFactory), loggerFactory.GetType());
+            Assert.Equal(typeof(NLogLoggerProvider), loggerProvider.GetType());
+        }
+#endif
+
 #if !ASP_NET_CORE1 && !ASP_NET_CORE2
         [Fact]
         public void LoadConfigurationFromAppSettingsShouldLogTest()
@@ -235,7 +251,7 @@ private static ILoggerFactory GetLoggerFactory(IWebHost webhost)
             return webhost.Services.GetService<Microsoft.Extensions.Logging.ILoggerFactory>();
         }
 
-#if !ASP_NET_CORE2 && !ASP_NET_CORE3
+#if ASP_NET_CORE1
         public class Startup
         {
             public Startup()