Enhanced LoggerUtil to include DisposeLoggerFactories for better resource management during shutdown.

Author: jasontaylordev

src/ServiceControl.Audit/HostApplicationBuilderExtensions.cs

@@ -39,7 +39,7 @@ public static void AddServiceControlAudit(this IHostApplicationBuilder builder,
         RecordStartup(settings, configuration, persistenceConfiguration);
 
         builder.Logging.ClearProviders();
-        builder.Logging.BuildServiceControlLogging(settings.LoggingSettings.LogLevel);
+        builder.Logging.ConfigureLogging(settings.LoggingSettings.LogLevel);
 
         var services = builder.Services;
         var transportSettings = settings.ToTransportSettings();

src/ServiceControl.Audit/Program.cs

@@ -58,5 +58,5 @@
 {
     // The following log statement is meant to leave a trail in the logs to determine if the process was killed
     logger?.LogInformation("Shutdown complete");
-    NLog.LogManager.Shutdown();
+    LoggerUtil.DisposeLoggerFactories();
 }

src/ServiceControl.Infrastructure/LoggerUtil.cs

@@ -1,6 +1,7 @@
 namespace ServiceControl.Infrastructure
 {
     using System;
+    using System.Collections.Concurrent;
     using Microsoft.Extensions.DependencyInjection;
     using Microsoft.Extensions.Logging;
     using NLog.Extensions.Logging;
@@ -28,8 +29,10 @@ public static bool IsLoggingTo(Loggers logger)
             return (logger & ActiveLoggers) == logger;
         }
 
-        public static void BuildServiceControlLogging(this ILoggingBuilder loggingBuilder, LogLevel level)
+        public static void ConfigureLogging(this ILoggingBuilder loggingBuilder, LogLevel level)
         {
+            loggingBuilder.SetMinimumLevel(level);
+
             if (IsLoggingTo(Loggers.Test))
             {
                 loggingBuilder.Services.AddSingleton<ILoggerProvider>(new TestContextProvider(level));
@@ -53,20 +56,41 @@ public static void BuildServiceControlLogging(this ILoggingBuilder loggingBuilde
             {
                 loggingBuilder.AddOpenTelemetry(configure => configure.AddOtlpExporter());
             }
+        }
 
-            loggingBuilder.SetMinimumLevel(level);
+        static readonly ConcurrentDictionary<LogLevel, ILoggerFactory> _factories = new();
+
+        static ILoggerFactory GetOrCreateLoggerFactory(LogLevel level)
+        {
+            if (!_factories.TryGetValue(level, out var factory))
+            {
+                factory = LoggerFactory.Create(configure => configure.ConfigureLogging(level));
+                _factories[level] = factory;
+            }
+
+            return factory;
         }
 
         public static ILogger<T> CreateStaticLogger<T>(LogLevel level = LogLevel.Information)
         {
-            var factory = LoggerFactory.Create(configure => configure.BuildServiceControlLogging(level));
+            var factory = GetOrCreateLoggerFactory(level);
             return factory.CreateLogger<T>();
         }
 
         public static ILogger CreateStaticLogger(Type type, LogLevel level = LogLevel.Information)
         {
-            var factory = LoggerFactory.Create(configure => configure.BuildServiceControlLogging(level));
+            var factory = GetOrCreateLoggerFactory(level);
             return factory.CreateLogger(type);
         }
+
+        public static void DisposeLoggerFactories()
+        {
+            foreach (var factory in _factories.Values)
+            {
+                factory.Dispose();
+            }
+
+            _factories.Clear();
+        }
     }
 }

src/ServiceControl.Infrastructure/LoggingConfigurator.cs

@@ -17,7 +17,7 @@ public static class LoggingConfigurator
         public static void ConfigureLogging(LoggingSettings loggingSettings)
         {
             //used for loggers outside of ServiceControl (i.e. transports and core) to use the logger factory defined here
-            LogManager.UseFactory(new ExtensionsLoggerFactory(LoggerFactory.Create(configure => configure.BuildServiceControlLogging(loggingSettings.LogLevel))));
+            LogManager.UseFactory(new ExtensionsLoggerFactory(LoggerFactory.Create(configure => configure.ConfigureLogging(loggingSettings.LogLevel))));
 
             if (!LoggerUtil.IsLoggingTo(Loggers.NLog) || NLog.LogManager.Configuration != null)
             {

src/ServiceControl.Monitoring.AcceptanceTests/TestSupport/ServiceControlComponentRunner.cs

@@ -94,7 +94,7 @@ async Task InitializeServiceControl(ScenarioContext context)
                     EnvironmentName = Environments.Development
                 });
                 hostBuilder.Logging.ClearProviders();
-                hostBuilder.Logging.BuildServiceControlLogging(LogLevel.Information);
+                hostBuilder.Logging.ConfigureLogging(LogLevel.Information);
 
                 hostBuilder.AddServiceControlMonitoring((criticalErrorContext, cancellationToken) =>
                 {

src/ServiceControl.Monitoring/HostApplicationBuilderExtensions.cs

@@ -31,7 +31,7 @@ public static void AddServiceControlMonitoring(this IHostApplicationBuilder host
         EndpointConfiguration endpointConfiguration)
     {
         hostBuilder.Services.AddLogging();
-        hostBuilder.Logging.BuildServiceControlLogging(settings.LoggingSettings.LogLevel);
+        hostBuilder.Logging.ConfigureLogging(settings.LoggingSettings.LogLevel);
 
         var services = hostBuilder.Services;
 

src/ServiceControl.Monitoring/Program.cs

@@ -49,6 +49,6 @@
 finally
 {
     // The following log statement is meant to leave a trail in the logs to determine if the process was killed
-    logger.LogInformation("Shutdown complete");
-    NLog.LogManager.Shutdown();
+    logger?.LogInformation("Shutdown complete");
+    LoggerUtil.DisposeLoggerFactories();
 }

src/ServiceControl.Persistence.Tests/PersistenceTestBase.cs

@@ -34,7 +34,7 @@ public async Task SetUp()
         var hostBuilder = Host.CreateApplicationBuilder();
 
         LoggerUtil.ActiveLoggers = Loggers.Test;
-        hostBuilder.Logging.BuildServiceControlLogging(LogLevel.Information);
+        hostBuilder.Logging.ConfigureLogging(LogLevel.Information);
 
         await PersistenceTestsContext.Setup(hostBuilder);
 

src/ServiceControl/HostApplicationBuilderExtensions.cs

@@ -42,7 +42,7 @@ public static void AddServiceControl(this IHostApplicationBuilder hostBuilder, S
             }
 
             hostBuilder.Logging.ClearProviders();
-            hostBuilder.Logging.BuildServiceControlLogging(settings.LoggingSettings.LogLevel);
+            hostBuilder.Logging.ConfigureLogging(settings.LoggingSettings.LogLevel);
 
             var services = hostBuilder.Services;
             var transportSettings = settings.ToTransportSettings();

src/ServiceControl/Program.cs

@@ -58,5 +58,5 @@
 {
     // The following log statement is meant to leave a trail in the logs to determine if the process was killed
     logger?.LogInformation("Shutdown complete");
-    NLog.LogManager.Shutdown();
+    LoggerUtil.DisposeLoggerFactories();
 }