Convert ServiceControl loggers to Microsoft.Extensions.Logging

src/Directory.Packages.props

@@ -24,6 +24,9 @@
     <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" />
     <PackageVersion Include="Microsoft-WindowsAPICodePack-Shell" Version="1.1.5" />
@@ -63,6 +66,7 @@
     <PackageVersion Include="PublicApiGenerator" Version="11.4.6" />
     <PackageVersion Include="RavenDB.Embedded" Version="6.2.6" />
     <PackageVersion Include="ReactiveUI.WPF" Version="20.1.63" />
+    <PackageVersion Include="Seq.Extensions.Logging" Version="8.0.0" />
     <PackageVersion Include="ServiceControl.Contracts" Version="5.0.0" />
     <PackageVersion Include="System.Configuration.ConfigurationManager" Version="8.0.1" />
     <PackageVersion Include="System.Diagnostics.PerformanceCounter" Version="8.0.1" />
@@ -91,4 +95,4 @@
     <GlobalPackageReference Include="Microsoft.Build.CopyOnWrite" Version="1.0.334" />
     <GlobalPackageReference Include="Particular.Packaging" Version="4.2.2" />
   </ItemGroup>
-</Project>
+</Project>

src/Particular.LicensingComponent/AuditThroughput/AuditThroughputCollectorHostedService.cs

@@ -20,7 +20,7 @@ public class AuditThroughputCollectorHostedService(
 
     protected override async Task ExecuteAsync(CancellationToken cancellationToken)
     {
-        logger.LogInformation($"Starting {nameof(AuditThroughputCollectorHostedService)}");
+        logger.LogInformation("Starting {ServiceName}", nameof(AuditThroughputCollectorHostedService));
 
         try
         {
@@ -42,14 +42,14 @@ protected override async Task ExecuteAsync(CancellationToken cancellationToken)
         }
         catch (OperationCanceledException) when (cancellationToken.IsCancellationRequested)
         {
-            logger.LogInformation($"Stopping {nameof(AuditThroughputCollectorHostedService)}");
+            logger.LogInformation("Stopping {ServiceName}", nameof(AuditThroughputCollectorHostedService));
         }
     }
 
     async Task GatherThroughput(CancellationToken cancellationToken)
     {
         var utcYesterday = DateOnly.FromDateTime(timeProvider.GetUtcNow().DateTime).AddDays(-1);
-        logger.LogInformation($"Gathering throughput from audit for {utcYesterday.ToShortDateString()}");
+        logger.LogInformation("Gathering throughput from audit for {AuditDate}", utcYesterday.ToShortDateString());
 
         await VerifyAuditInstances(cancellationToken);
 
@@ -59,7 +59,7 @@ async Task GatherThroughput(CancellationToken cancellationToken)
 
         if (!knownEndpoints.Any())
         {
-            logger.LogWarning("No known endpoints could be found.");
+            logger.LogWarning("No known endpoints could be found");
         }
 
         foreach (var tuple in await dataStore.GetEndpoints([.. knownEndpointsLookup.Keys], cancellationToken))
@@ -115,18 +115,18 @@ async Task VerifyAuditInstances(CancellationToken cancellationToken)
         {
             if (remote.Status == "online" || remote.SemanticVersion is not null)
             {
-                logger.LogInformation($"ServiceControl Audit instance at {remote.ApiUri} detected running version {remote.SemanticVersion}");
+                logger.LogInformation("ServiceControl Audit instance at {RemoteApiUri} detected running version {RemoteSemanticVersion}", remote.ApiUri, remote.SemanticVersion);
             }
             else
             {
-                logger.LogWarning($"Unable to determine the version of one or more ServiceControl Audit instances. For the instance with URI {remote.ApiUri}, the status was '{remote.Status}' and the version string returned was '{remote.VersionString}'.");
+                logger.LogWarning("Unable to determine the version of one or more ServiceControl Audit instances. For the instance with URI {RemoteApiUri}, the status was '{RemoteStatus}' and the version string returned was '{RemoteVersionString}'", remote.ApiUri, remote.Status, remote.VersionString);
             }
         }
 
         var allHaveAuditCounts = remotesInfo.All(auditQuery.ValidRemoteInstances);
         if (!allHaveAuditCounts)
         {
-            logger.LogWarning($"At least one ServiceControl Audit instance is either not running the required version ({auditQuery.MinAuditCountsVersion}) or is not configured for at least 2 days of retention. Audit throughput will not be available.");
+            logger.LogWarning("At least one ServiceControl Audit instance is either not running the required version ({RequiredAuditVersion}) or is not configured for at least 2 days of retention. Audit throughput will not be available", auditQuery.MinAuditCountsVersion);
         }
     }
 

src/Particular.LicensingComponent/BrokerThroughput/BrokerThroughputCollectorHostedService.cs

@@ -29,11 +29,11 @@ static ReadOnlyDictionary<string, string> LoadBrokerSettingValues(IEnumerable<Ke
 
         if (brokerThroughputQuery.HasInitialisationErrors(out var errorMessage))
         {
-            logger.LogError($"Could not start {nameof(BrokerThroughputCollectorHostedService)}, due to initialisation errors:\n{errorMessage}");
+            logger.LogError("Could not start {ServiceName}, due to initialisation errors:\n{InitializationErrors}", nameof(BrokerThroughputCollectorHostedService), errorMessage);
             return;
         }
 
-        logger.LogInformation($"Starting {nameof(BrokerThroughputCollectorHostedService)}");
+        logger.LogInformation("Starting {ServiceName}", nameof(BrokerThroughputCollectorHostedService));
 
         try
         {
@@ -55,7 +55,7 @@ static ReadOnlyDictionary<string, string> LoadBrokerSettingValues(IEnumerable<Ke
         }
         catch (OperationCanceledException) when (stoppingToken.IsCancellationRequested)
         {
-            logger.LogInformation($"Stopping {nameof(BrokerThroughputCollectorHostedService)}");
+            logger.LogInformation("Stopping {ServiceName}", nameof(BrokerThroughputCollectorHostedService));
         }
     }
 

src/Particular.LicensingComponent/MonitoringThroughput/MonitoringThroughputHostedService.cs

@@ -24,15 +24,15 @@ async Task Handle(MessageContext message, CancellationToken cancellationToken)
 
     public async Task StartAsync(CancellationToken cancellationToken)
     {
-        logger.LogInformation($"Starting {nameof(MonitoringThroughputHostedService)}");
+        logger.LogInformation("Starting {ServiceName}", nameof(MonitoringThroughputHostedService));
 
         transportInfrastructure = await transportCustomization.CreateTransportInfrastructure(ServiceControlSettings.ServiceControlThroughputDataQueue, transportSettings, Handle, (_, __) => Task.FromResult(ErrorHandleResult.Handled), (_, __) => Task.CompletedTask);
         await transportInfrastructure.Receivers[ServiceControlSettings.ServiceControlThroughputDataQueue].StartReceive(cancellationToken);
     }
 
     public async Task StopAsync(CancellationToken cancellationToken)
     {
-        logger.LogInformation($"Stopping {nameof(MonitoringThroughputHostedService)}");
+        logger.LogInformation("Stopping {ServiceName}", nameof(MonitoringThroughputHostedService));
 
         if (transportInfrastructure != null)
         {

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.RavenDB/StartupModeTests.cs

@@ -5,6 +5,7 @@
     using System.Threading.Tasks;
     using Hosting.Commands;
     using Microsoft.Extensions.Hosting;
+    using Microsoft.Extensions.Logging.Abstractions;
     using NServiceBus;
     using NUnit.Framework;
     using Particular.ServiceControl.Hosting;
@@ -57,7 +58,7 @@ public async Task CanRunMaintenanceMode()
         public async Task CanRunImportFailedMessagesMode()
             => await new TestableImportFailedErrorsCommand().Execute(new HostArguments(Array.Empty<string>()), settings);
 
-        class TestableImportFailedErrorsCommand : ImportFailedErrorsCommand
+        class TestableImportFailedErrorsCommand() : ImportFailedErrorsCommand()
         {
             protected override EndpointConfiguration CreateEndpointConfiguration(Settings settings)
             {

src/ServiceControl.AcceptanceTests/Recoverability/MessageFailures/When_a_retry_fails_to_be_sent.cs

@@ -8,6 +8,7 @@
     using AcceptanceTesting.EndpointTemplates;
     using Infrastructure;
     using Microsoft.Extensions.DependencyInjection;
+    using Microsoft.Extensions.Logging.Abstractions;
     using NServiceBus;
     using NServiceBus.AcceptanceTesting;
     using NServiceBus.Routing;
@@ -146,7 +147,7 @@ public class MyContext : ScenarioContext
         public class MessageThatWillFail : ICommand;
 
         public class FakeReturnToSender(IErrorMessageDataStore errorMessageStore, MyContext myContext)
-            : ReturnToSender(errorMessageStore)
+            : ReturnToSender(errorMessageStore, NullLogger<ReturnToSender>.Instance)
         {
             public override Task HandleMessage(MessageContext message, IMessageDispatcher sender, string errorQueueTransportAddress, CancellationToken cancellationToken = default)
             {

src/ServiceControl.AcceptanceTests/TestSupport/ServiceControlComponentRunner.cs

@@ -15,7 +15,7 @@
     using Microsoft.AspNetCore.TestHost;
     using Microsoft.Extensions.DependencyInjection;
     using Microsoft.Extensions.Hosting;
-    using NLog;
+    using Microsoft.Extensions.Logging;
     using NServiceBus;
     using NServiceBus.AcceptanceTesting;
     using NServiceBus.AcceptanceTesting.Support;
@@ -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

@@ -17,6 +17,7 @@ namespace ServiceControl.Audit.AcceptanceTests.TestSupport
     using Microsoft.AspNetCore.Builder;
     using Microsoft.AspNetCore.TestHost;
     using Microsoft.Extensions.Hosting;
+    using Microsoft.Extensions.Logging;
     using NServiceBus;
     using NServiceBus.AcceptanceTesting;
     using NServiceBus.AcceptanceTesting.Support;
@@ -43,7 +44,8 @@ async Task InitializeServiceControl(ScenarioContext context)
             var logPath = Path.Combine(Path.GetTempPath(), Path.GetRandomFileName());
             Directory.CreateDirectory(logPath);
 
-            var loggingSettings = new LoggingSettings(Settings.SettingsRootNamespace, defaultLevel: NLog.LogLevel.Debug, logPath: logPath);
+            var loggingSettings = new LoggingSettings(Settings.SettingsRootNamespace, defaultLevel: LogLevel.Debug, logPath: logPath);
+            LoggerUtil.ActiveLoggers = Loggers.Test;
 
             settings = new Settings(transportToUse.TypeName, persistenceToUse.PersistenceType, loggingSettings)
             {
@@ -55,9 +57,9 @@ async Task InitializeServiceControl(ScenarioContext context)
                 {
                     var id = messageContext.NativeMessageId;
                     var headers = messageContext.Headers;
-                    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)
@@ -76,7 +78,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.Persistence.InMemory/InMemoryAuditIngestionUnitOfWorkFactory.cs

@@ -5,23 +5,14 @@
     using ServiceControl.Audit.Auditing.BodyStorage;
     using ServiceControl.Audit.Persistence.UnitOfWork;
 
-    class InMemoryAuditIngestionUnitOfWorkFactory : IAuditIngestionUnitOfWorkFactory
+    class InMemoryAuditIngestionUnitOfWorkFactory(InMemoryAuditDataStore dataStore, BodyStorageEnricher bodyStorageEnricher) : IAuditIngestionUnitOfWorkFactory
     {
-        public InMemoryAuditIngestionUnitOfWorkFactory(InMemoryAuditDataStore dataStore, IBodyStorage bodyStorage, PersistenceSettings settings)
-        {
-            this.dataStore = dataStore;
-            bodyStorageEnricher = new BodyStorageEnricher(bodyStorage, settings);
-        }
-
         public ValueTask<IAuditIngestionUnitOfWork> StartNew(int batchSize, CancellationToken cancellationToken)
         {
             //The batchSize argument is ignored: the in-memory storage implementation doesn't support batching.
             return new ValueTask<IAuditIngestionUnitOfWork>(new InMemoryAuditIngestionUnitOfWork(dataStore, bodyStorageEnricher));
         }
 
         public bool CanIngestMore() => true;
-
-        InMemoryAuditDataStore dataStore;
-        BodyStorageEnricher bodyStorageEnricher;
     }
 }

src/ServiceControl.Audit.Persistence.InMemory/InMemoryPersistence.cs

@@ -14,6 +14,7 @@ public void AddPersistence(IServiceCollection services)
             services.AddSingleton<IBodyStorage, InMemoryAttachmentsBodyStorage>();
             services.AddSingleton<IFailedAuditStorage, InMemoryFailedAuditStorage>();
             services.AddSingleton<IAuditIngestionUnitOfWorkFactory, InMemoryAuditIngestionUnitOfWorkFactory>();
+            services.AddSingleton<BodyStorageEnricher>();
         }
 
         public void AddInstaller(IServiceCollection services)

src/ServiceControl.Audit.Persistence.RavenDB/CustomChecks/CheckDirtyMemory.cs

@@ -3,26 +3,24 @@ namespace ServiceControl.Audit.Persistence.RavenDB.CustomChecks;
 using System;
 using System.Threading;
 using System.Threading.Tasks;
+using Microsoft.Extensions.Logging;
 using NServiceBus.CustomChecks;
-using NServiceBus.Logging;
 
-class CheckDirtyMemory(MemoryInformationRetriever memoryInformationRetriever) : CustomCheck("RavenDB dirty memory", "ServiceControl.Audit Health", TimeSpan.FromMinutes(5))
+class CheckDirtyMemory(MemoryInformationRetriever memoryInformationRetriever, ILogger<CheckDirtyMemory> logger) : CustomCheck("RavenDB dirty memory", "ServiceControl.Audit Health", TimeSpan.FromMinutes(5))
 {
+
     public override async Task<CheckResult> PerformCheck(CancellationToken cancellationToken = default)
     {
         var (isHighDirty, dirtyMemory) = await memoryInformationRetriever.GetMemoryInformation(cancellationToken);
 
-        Log.Debug($"RavenDB dirty memory value: {dirtyMemory}.");
+        logger.LogDebug("RavenDB dirty memory value: {DirtyMemory}", dirtyMemory);
 
         if (isHighDirty)
         {
-            var message = $"There is a high level of RavenDB dirty memory ({dirtyMemory}). See https://docs.particular.net/servicecontrol/troubleshooting#ravendb-dirty-memory for guidance on how to mitigate the issue.";
-            Log.Warn(message);
-            return CheckResult.Failed(message);
+            logger.LogWarning("There is a high level of RavenDB dirty memory ({DirtyMemory}). See https://docs.particular.net/servicecontrol/troubleshooting#ravendb-dirty-memory for guidance on how to mitigate the issue", dirtyMemory);
+            return CheckResult.Failed($"There is a high level of RavenDB dirty memory ({dirtyMemory}). See https://docs.particular.net/servicecontrol/troubleshooting#ravendb-dirty-memory for guidance on how to mitigate the issue.");
         }
 
         return CheckResult.Pass;
     }
-
-    static readonly ILog Log = LogManager.GetLogger<CheckDirtyMemory>();
 }