remove/refactor remaining references to LogManager (#5023)

* convert SC transports from NServiceBus.Logging to Microsoft.Extensions.Logging

* remove signedassembly requirement so that infrastructure can be imported

* revert previous change and instead propogate signing back to servicecontrol.infrastructure

* fix signature of customisation classes that are dynamically created

* add ilogger to test services and remove direct construction with logger

* get tests to use ilogger

* Switch to .NET logging

* Work in progress

* Remove test code

* Improve logging format for storage space details

* Properly shutdown NLog in Program.cs

* Remove Seq logging and prepare for .NET logging migration

* Update LogLevel format

* Update LogLevel format in logging settings

* enable adding test logging provider as part of loggerutils and create framework for settings driven logger selection

* add ability to select logging provider from config

* handle setting not existing

* change logmanager logger factory to the standard one now used by the rest of SC

* ensure logger for transport tests

* domain events and persister loggers

* set default to nlog and pass loglevel to test context

* replace logmanager usage in persistence

* cleanup remaining references to LogManager

* missing files from last checkin

* fix different dependency version test failure

* move loggerutil setup before first static logger usage

* fix different dependency version test failure

---------

Co-authored-by: JasonTaylorDev <[email protected]>

Author: PhilBastian

src/Directory.Packages.props

@@ -24,6 +24,8 @@
     <PackageVersion Include="Microsoft.Extensions.Hosting" Version="8.0.1" />
     <PackageVersion Include="Microsoft.Extensions.Hosting.Abstractions" Version="8.0.1" />
     <PackageVersion Include="Microsoft.Extensions.Hosting.WindowsServices" Version="8.0.1" />
+    <PackageVersion Include="Microsoft.Extensions.Logging" Version="8.0.1" />
+    <PackageVersion Include="Microsoft.Extensions.Logging.Configuration" Version="8.0.1" />
     <PackageVersion Include="Microsoft.Extensions.Logging.Abstractions" Version="8.0.3" />
     <PackageVersion Include="Microsoft.Extensions.TimeProvider.Testing" Version="8.10.0" />
     <PackageVersion Include="Microsoft.NET.Test.Sdk" Version="17.13.0" />

src/ServiceControl.AcceptanceTesting/DiscardMessagesBehavior.cs

@@ -3,10 +3,11 @@ namespace ServiceControl.AcceptanceTesting
     using System;
     using System.Linq;
     using System.Threading.Tasks;
+    using Microsoft.Extensions.Logging;
     using NServiceBus;
     using NServiceBus.AcceptanceTesting;
-    using NServiceBus.Logging;
     using NServiceBus.Pipeline;
+    using ServiceControl.Infrastructure;
 
     public class DiscardMessagesBehavior : IBehavior<ITransportReceiveContext, ITransportReceiveContext>
     {
@@ -44,15 +45,20 @@ public Task Invoke(ITransportReceiveContext context, Func<ITransportReceiveConte
             {
                 context.Message.Headers.TryGetValue(Headers.MessageId, out var originalMessageId);
                 context.Message.Headers.TryGetValue(Headers.EnclosedMessageTypes, out var enclosedMessageTypes);
-                log.Debug($"Discarding message '{context.Message.MessageId}'({originalMessageId ?? string.Empty}) because it's session id is '{session}' instead of '{currentSession}' Message Types: {enclosedMessageTypes}.");
+                var logger = LoggerUtil.CreateStaticLogger<DiscardMessagesBehavior>();
+                logger.LogDebug("Discarding message '{MessageId}'({OriginalMessageId}) because it's session id is '{MessageSessionId}' instead of '{CurrentSessionId}' Message Types: {EnclosedMessageTypes}.",
+                    context.Message.MessageId,
+                    originalMessageId ?? string.Empty,
+                    session,
+                    currentSession,
+                    enclosedMessageTypes);
                 return Task.CompletedTask;
             }
 
             return next(context);
         }
 
         ScenarioContext scenarioContext;
-        static ILog log = LogManager.GetLogger<DiscardMessagesBehavior>();
 
         static string[] pluginMessages =
         {

src/ServiceControl.AcceptanceTests/TestSupport/ServiceControlComponentRunner.cs

@@ -50,6 +50,7 @@ async Task InitializeServiceControl(ScenarioContext context)
             var logPath = Path.Combine(Path.GetTempPath(), Path.GetRandomFileName());
             Directory.CreateDirectory(logPath);
             var loggingSettings = new LoggingSettings(Settings.SettingsRootNamespace, defaultLevel: LogLevel.Debug, logPath: logPath);
+            LoggerUtil.ActiveLoggers = Loggers.Test;
 
             var settings = new Settings(transportToUse.TypeName, persistenceToUse.PersistenceType, loggingSettings, forwardErrorMessages: false, errorRetentionPeriod: TimeSpan.FromDays(10))
             {
@@ -65,9 +66,9 @@ async Task InitializeServiceControl(ScenarioContext context)
                 {
                     var headers = messageContext.Headers;
                     var id = messageContext.NativeMessageId;
-                    var log = NServiceBus.Logging.LogManager.GetLogger<ServiceControlComponentRunner>();
+                    var logger = LoggerUtil.CreateStaticLogger<ServiceControlComponentRunner>(loggingSettings.LogLevel);
                     headers.TryGetValue(Headers.MessageId, out var originalMessageId);
-                    log.Debug($"OnMessage for message '{id}'({originalMessageId ?? string.Empty}).");
+                    logger.LogDebug("OnMessage for message '{MessageId}'({OriginalMessageId})", id, originalMessageId ?? string.Empty);
 
                     //Do not filter out CC, SA and HB messages as they can't be stamped
                     if (headers.TryGetValue(Headers.EnclosedMessageTypes, out var messageTypes)
@@ -86,7 +87,7 @@ async Task InitializeServiceControl(ScenarioContext context)
                     var currentSession = context.TestRunId.ToString();
                     if (!headers.TryGetValue("SC.SessionID", out var session) || session != currentSession)
                     {
-                        log.Debug($"Discarding message '{id}'({originalMessageId ?? string.Empty}) because it's session id is '{session}' instead of '{currentSession}'.");
+                        logger.LogDebug("Discarding message '{MessageId}'({OriginalMessageId}) because it's session id is '{SessionId}' instead of '{CurrentSessionId}'", id, originalMessageId ?? string.Empty, session, currentSession);
                         return true;
                     }
 

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

@@ -45,6 +45,7 @@ async Task InitializeServiceControl(ScenarioContext context)
             Directory.CreateDirectory(logPath);
 
             var loggingSettings = new LoggingSettings(Settings.SettingsRootNamespace, defaultLevel: LogLevel.Debug, logPath: logPath);
+            LoggerUtil.ActiveLoggers = Loggers.Test;
 
             settings = new Settings(transportToUse.TypeName, persistenceToUse.PersistenceType, loggingSettings)
             {
@@ -56,9 +57,9 @@ async Task InitializeServiceControl(ScenarioContext context)
                 {
                     var id = messageContext.NativeMessageId;
                     var headers = messageContext.Headers;
-                    var log = LoggerUtil.CreateStaticLogger<ServiceControlComponentRunner>();
+                    var logger = LoggerUtil.CreateStaticLogger<ServiceControlComponentRunner>(loggingSettings.LogLevel);
                     headers.TryGetValue(Headers.MessageId, out var originalMessageId);
-                    log.LogDebug("OnMessage for message '{MessageId}'({OriginalMessageId}).", id, originalMessageId ?? string.Empty);
+                    logger.LogDebug("OnMessage for message '{MessageId}'({OriginalMessageId}).", id, originalMessageId ?? string.Empty);
 
                     //Do not filter out CC, SA and HB messages as they can't be stamped
                     if (headers.TryGetValue(Headers.EnclosedMessageTypes, out var messageTypes)
@@ -77,7 +78,7 @@ async Task InitializeServiceControl(ScenarioContext context)
                     var currentSession = context.TestRunId.ToString();
                     if (!headers.TryGetValue("SC.SessionID", out var session) || session != currentSession)
                     {
-                        log.LogDebug("Discarding message '{MessageId}'({OriginalMessageId}) because it's session id is '{SessionId}' instead of '{CurrentSessionId}'.", id, originalMessageId ?? string.Empty, session, currentSession);
+                        logger.LogDebug("Discarding message '{MessageId}'({OriginalMessageId}) because it's session id is '{SessionId}' instead of '{CurrentSessionId}'.", id, originalMessageId ?? string.Empty, session, currentSession);
                         return true;
                     }
 

src/ServiceControl.Audit.Persistence.RavenDB/RavenPersistenceConfiguration.cs

@@ -108,7 +108,7 @@ internal static DatabaseConfiguration GetDatabaseConfiguration(PersistenceSettin
 
                 if (settings.PersisterSpecificSettings.TryGetValue(RavenDbLogLevelKey, out var ravenDbLogLevel))
                 {
-                    logsMode = RavenDbLogLevelToLogsModeMapper.Map(ravenDbLogLevel);
+                    logsMode = RavenDbLogLevelToLogsModeMapper.Map(ravenDbLogLevel, Logger);
                 }
 
                 serverConfiguration = new ServerConfiguration(dbPath, serverUrl, logPath, logsMode);

src/ServiceControl.DomainEvents/DomainEvents.cs

@@ -4,15 +4,10 @@
     using System.Threading;
     using System.Threading.Tasks;
     using Microsoft.Extensions.DependencyInjection;
-    using NServiceBus.Logging;
+    using Microsoft.Extensions.Logging;
 
-    public class DomainEvents : IDomainEvents
+    public class DomainEvents(IServiceProvider serviceProvider, ILogger<DomainEvents> logger) : IDomainEvents
     {
-        static readonly ILog Log = LogManager.GetLogger<DomainEvents>();
-
-        readonly IServiceProvider serviceProvider;
-        public DomainEvents(IServiceProvider serviceProvider) => this.serviceProvider = serviceProvider;
-
         public async Task Raise<T>(T domainEvent, CancellationToken cancellationToken) where T : IDomainEvent
         {
             var handlers = serviceProvider.GetServices<IDomainHandler<T>>();
@@ -25,7 +20,7 @@ await handler.Handle(domainEvent, cancellationToken)
                 }
                 catch (Exception e)
                 {
-                    Log.Error($"Unexpected error publishing domain event {typeof(T)}", e);
+                    logger.LogError(e, "Unexpected error publishing domain event {EventType}", typeof(T));
                     throw;
                 }
             }
@@ -40,7 +35,7 @@ await handler.Handle(domainEvent, cancellationToken)
                 }
                 catch (Exception e)
                 {
-                    Log.Error($"Unexpected error publishing domain event {typeof(T)}", e);
+                    logger.LogError(e, "Unexpected error publishing domain event {EventType}", typeof(T));
                     throw;
                 }
             }

src/ServiceControl.DomainEvents/ServiceControl.DomainEvents.csproj

@@ -6,6 +6,7 @@
 
   <ItemGroup>
     <PackageReference Include="Microsoft.Extensions.DependencyInjection" />
+    <PackageReference Include="Microsoft.Extensions.Logging.Abstractions" />
     <PackageReference Include="NServiceBus" />
   </ItemGroup>
 

src/ServiceControl.Infrastructure/LoggerUtil.cs

@@ -19,17 +19,22 @@ public static class LoggerUtil
     {
         public static Loggers ActiveLoggers { private get; set; } = Loggers.None;
 
+        public static bool IsLoggingTo(Loggers logger)
+        {
+            return (logger & ActiveLoggers) == logger;
+        }
+
         public static void BuildLogger(this ILoggingBuilder loggingBuilder, LogLevel level)
         {
-            if ((Loggers.Test & ActiveLoggers) == Loggers.Test)
+            if (IsLoggingTo(Loggers.Test))
             {
-                loggingBuilder.Services.AddSingleton<ILoggerProvider>(new TestContextProvider());
+                loggingBuilder.Services.AddSingleton<ILoggerProvider>(new TestContextProvider(level));
             }
-            if ((Loggers.NLog & ActiveLoggers) == Loggers.NLog)
+            if (IsLoggingTo(Loggers.NLog))
             {
                 loggingBuilder.AddNLog();
             }
-            if ((Loggers.Seq & ActiveLoggers) == Loggers.Seq)
+            if (IsLoggingTo(Loggers.Seq))
             {
                 loggingBuilder.AddSeq();
             }

src/ServiceControl.Infrastructure/LoggingConfigurator.cs

@@ -12,16 +12,19 @@ namespace ServiceControl.Infrastructure
     using LogManager = NServiceBus.Logging.LogManager;
     using LogLevel = NLog.LogLevel;
 
-    // TODO: Migrate from NLog to .NET logging
     public static class LoggingConfigurator
     {
         public static void ConfigureLogging(LoggingSettings loggingSettings)
         {
-            if (NLog.LogManager.Configuration != null)
+            //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.BuildLogger(loggingSettings.LogLevel))));
+
+            if (!LoggerUtil.IsLoggingTo(Loggers.NLog) || NLog.LogManager.Configuration != null)
             {
                 return;
             }
 
+            //configure NLog
             var nlogConfig = new LoggingConfiguration();
             var simpleLayout = new SimpleLayout("${longdate}|${processtime}|${threadid}|${level}|${logger}|${message}${onexception:|${exception:format=tostring}}");
 
@@ -76,8 +79,7 @@ public static void ConfigureLogging(LoggingSettings loggingSettings)
 
             NLog.LogManager.Configuration = nlogConfig;
 
-            LogManager.UseFactory(new ExtensionsLoggerFactory(LoggerFactory.Create(configure => configure.BuildLogger(loggingSettings.LogLevel))));
-
+            //using LogManager here rather than LoggerUtil.CreateStaticLogger since this is exclusive to NLog
             var logger = LogManager.GetLogger("LoggingConfiguration");
             var logEventInfo = new LogEventInfo { TimeStamp = DateTime.UtcNow };
             var loggingTo = AppEnvironment.RunningInContainer ? "console" : fileTarget.FileName.Render(logEventInfo);

src/ServiceControl.Infrastructure/LoggingSettings.cs

@@ -11,9 +11,6 @@ public class LoggingSettings
 {
     public LoggingSettings(SettingsRootNamespace rootNamespace, LogLevel defaultLevel = LogLevel.Information, string logPath = null)
     {
-        LogLevel = InitializeLogLevel(rootNamespace, defaultLevel);
-        LogPath = SettingsReader.Read(rootNamespace, logPathKey, Environment.ExpandEnvironmentVariables(logPath ?? DefaultLogLocation()));
-
         var loggingProviders = (SettingsReader.Read<string>(rootNamespace, loggingProvidersKey) ?? "").Split(",");
         var activeLoggers = Loggers.None;
         if (loggingProviders.Contains("NLog"))
@@ -26,6 +23,9 @@ public LoggingSettings(SettingsRootNamespace rootNamespace, LogLevel defaultLeve
         }
         //this defaults to NLog because historically that was the default, and we don't want to break existing installs that don't have the config key to define loggingProviders
         LoggerUtil.ActiveLoggers = activeLoggers == Loggers.None ? Loggers.NLog : activeLoggers;
+
+        LogLevel = InitializeLogLevel(rootNamespace, defaultLevel);
+        LogPath = SettingsReader.Read(rootNamespace, logPathKey, Environment.ExpandEnvironmentVariables(logPath ?? DefaultLogLocation()));
     }
 
     public LogLevel LogLevel { get; }