replace NServiceBus.logging in Audit.Persistence with Microsoft.Extensions.Logging

PhilBastian · PhilBastian · commit 4f25d490375b · 2025-06-12T10:49:57.000+08:00
diff --git a/src/ServiceControl.Audit.AcceptanceTests/TestSupport/ServiceControlComponentRunner.cs b/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;
@@ -55,9 +56,9 @@ async Task InitializeServiceControl(ScenarioContext context)
                 {
                     var id = messageContext.NativeMessageId;
                     var headers = messageContext.Headers;
-                    var log = NServiceBus.Logging.LogManager.GetLogger<ServiceControlComponentRunner>();
+                    var log = LoggerUtil.CreateStaticLogger<ServiceControlComponentRunner>();
                     headers.TryGetValue(Headers.MessageId, out var originalMessageId);
-                    log.Debug($"OnMessage for message '{id}'({originalMessageId ?? string.Empty}).");
+                    log.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 +77,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}'.");
+                        log.LogDebug("Discarding message '{MessageId}'({OriginalMessageId}) because it's session id is '{SessionId}' instead of '{CurrentSessionId}'.", id, originalMessageId ?? string.Empty, session, currentSession);
                         return true;
                     }
 
diff --git a/src/ServiceControl.Audit.Persistence.InMemory/InMemoryAuditIngestionUnitOfWorkFactory.cs b/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;
     }
 }
diff --git a/src/ServiceControl.Audit.Persistence.InMemory/InMemoryPersistence.cs b/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)
diff --git a/src/ServiceControl.Audit.Persistence.Tests.RavenDB/IndexSetupTests.cs b/src/ServiceControl.Audit.Persistence.Tests.RavenDB/IndexSetupTests.cs
@@ -1,7 +1,6 @@
 namespace ServiceControl.Audit.Persistence.Tests;
 
 using System;
-using System.Threading;
 using System.Threading.Tasks;
 using NUnit.Framework;
 using Persistence.RavenDB;
diff --git a/src/ServiceControl.Audit.Persistence/BodyStorageEnricher.cs b/src/ServiceControl.Audit.Persistence/BodyStorageEnricher.cs
@@ -5,12 +5,12 @@
     using System.Text;
     using System.Threading;
     using System.Threading.Tasks;
+    using Microsoft.Extensions.Logging;
     using NServiceBus;
-    using NServiceBus.Logging;
     using ServiceControl.Audit.Persistence;
     using ServiceControl.Infrastructure;
 
-    public class BodyStorageEnricher(IBodyStorage bodyStorage, PersistenceSettings settings)
+    public class BodyStorageEnricher(IBodyStorage bodyStorage, PersistenceSettings settings, ILogger<BodyStorageEnricher> logger)
     {
         public async ValueTask StoreAuditMessageBody(ReadOnlyMemory<byte> body, ProcessedMessage processedMessage, CancellationToken cancellationToken)
         {
@@ -66,7 +66,7 @@ async ValueTask<bool> TryStoreBody(ReadOnlyMemory<byte> body, ProcessedMessage p
                     catch (DecoderFallbackException e)
                     {
                         useBodyStore = true;
-                        log.Info($"Body for {bodyId} could not be stored embedded, fallback to body storage ({e.Message})");
+                        logger.LogInformation("Body for {BodyId} could not be stored embedded, fallback to body storage ({ErrorMessage})", bodyId, e.Message);
                     }
                 }
 
@@ -111,7 +111,6 @@ static bool IsBinary(IReadOnlyDictionary<string, string> headers)
         }
 
         static readonly Encoding enc = new UTF8Encoding(true, true);
-        static readonly ILog log = LogManager.GetLogger<BodyStorageEnricher>();
 
         // large object heap starts above 85000 bytes and not above 85 KB!
         public const int LargeObjectHeapThreshold = 85 * 1000;
diff --git a/src/ServiceControl.Audit.Persistence/PersistenceManifest.cs b/src/ServiceControl.Audit.Persistence/PersistenceManifest.cs
@@ -5,7 +5,8 @@
     using System.IO;
     using System.Linq;
     using System.Text.Json;
-    using NServiceBus.Logging;
+    using Microsoft.Extensions.Logging;
+    using ServiceControl.Infrastructure;
 
     public class PersistenceManifest
     {
@@ -51,7 +52,7 @@ static PersistenceManifestLibrary()
             }
             catch (Exception ex)
             {
-                logger.Warn($"Failed to load persistence manifests from {assemblyDirectory}", ex);
+                logger.LogWarning(ex, "Failed to load persistence manifests from {AssemblyDirectory}", assemblyDirectory);
             }
 
             try
@@ -66,10 +67,10 @@ static PersistenceManifestLibrary()
             }
             catch (Exception ex)
             {
-                logger.Warn($"Failed to load persistence manifests from development locations", ex);
+                logger.LogWarning(ex, "Failed to load persistence manifests from development locations");
             }
 
-            PersistenceManifests.ForEach(m => logger.Info($"Found persistence manifest for {m.DisplayName}"));
+            PersistenceManifests.ForEach(m => logger.LogInformation("Found persistence manifest for {ManifestDisplayName}", m.DisplayName));
         }
 
         static string GetAssemblyDirectory()
@@ -90,7 +91,7 @@ public static PersistenceManifest Find(string persistenceType)
             return persistenceManifest;
         }
 
-        static readonly ILog logger = LogManager.GetLogger(typeof(PersistenceManifestLibrary));
+        static readonly ILogger logger = LoggerUtil.CreateStaticLogger(typeof(PersistenceManifestLibrary));
     }
 }
 
diff --git a/src/ServiceControl.Audit.UnitTests/BodyStorage/BodyStorageEnricherTests.cs b/src/ServiceControl.Audit.UnitTests/BodyStorage/BodyStorageEnricherTests.cs
@@ -11,6 +11,7 @@ namespace ServiceControl.UnitTests.BodyStorage
     using NServiceBus;
     using NUnit.Framework;
     using ServiceControl.Audit.Persistence;
+    using ServiceControl.Infrastructure;
 
     [TestFixture]
     public class BodyStorageEnricherTests
@@ -21,7 +22,7 @@ public async Task Should_remove_body_when_above_threshold()
             var fakeStorage = new FakeBodyStorage();
             var maxBodySizeToStore = 20000;
 
-            var enricher = new BodyStorageEnricher(fakeStorage, new PersistenceSettings(TimeSpan.FromHours(1), true, maxBodySizeToStore));
+            var enricher = new BodyStorageEnricher(fakeStorage, new PersistenceSettings(TimeSpan.FromHours(1), true, maxBodySizeToStore), LoggerUtil.CreateStaticLogger<BodyStorageEnricher>());
             var body = Encoding.UTF8.GetBytes(new string('a', maxBodySizeToStore + 1));
             var metadata = new Dictionary<string, object>();
 
@@ -51,7 +52,7 @@ public async Task Should_remove_body_when_above_threshold_and_binary()
             var fakeStorage = new FakeBodyStorage();
             var maxBodySizeToStore = 20000;
 
-            var enricher = new BodyStorageEnricher(fakeStorage, new PersistenceSettings(TimeSpan.FromHours(1), true, maxBodySizeToStore));
+            var enricher = new BodyStorageEnricher(fakeStorage, new PersistenceSettings(TimeSpan.FromHours(1), true, maxBodySizeToStore), LoggerUtil.CreateStaticLogger<BodyStorageEnricher>());
             var body = Encoding.UTF8.GetBytes(new string('a', maxBodySizeToStore + 1));
             var metadata = new Dictionary<string, object>();
             var headers = new Dictionary<string, string>
@@ -81,7 +82,7 @@ public async Task Should_store_body_in_metadata_when_below_large_object_heap_and
             var fakeStorage = new FakeBodyStorage();
             var maxBodySizeToStore = 100000;
 
-            var enricher = new BodyStorageEnricher(fakeStorage, new PersistenceSettings(TimeSpan.FromHours(1), true, maxBodySizeToStore));
+            var enricher = new BodyStorageEnricher(fakeStorage, new PersistenceSettings(TimeSpan.FromHours(1), true, maxBodySizeToStore), LoggerUtil.CreateStaticLogger<BodyStorageEnricher>());
             var expectedBodySize = BodyStorageEnricher.LargeObjectHeapThreshold - 1;
             var body = Encoding.UTF8.GetBytes(new string('a', expectedBodySize));
             var metadata = new Dictionary<string, object>();
@@ -113,7 +114,7 @@ public async Task Should_store_body_in_body_property_when_full_text_disabled_and
             var fakeStorage = new FakeBodyStorage();
             var maxBodySizeToStore = 100000;
 
-            var enricher = new BodyStorageEnricher(fakeStorage, new PersistenceSettings(TimeSpan.FromHours(1), false, maxBodySizeToStore));
+            var enricher = new BodyStorageEnricher(fakeStorage, new PersistenceSettings(TimeSpan.FromHours(1), false, maxBodySizeToStore), LoggerUtil.CreateStaticLogger<BodyStorageEnricher>());
             var expectedBodySize = BodyStorageEnricher.LargeObjectHeapThreshold - 1;
             var body = Encoding.UTF8.GetBytes(new string('a', expectedBodySize));
             var metadata = new Dictionary<string, object>();
@@ -145,7 +146,7 @@ public async Task Should_store_body_in_storage_when_above_large_object_heap_but_
             var fakeStorage = new FakeBodyStorage();
             var maxBodySizeToStore = 100000;
 
-            var enricher = new BodyStorageEnricher(fakeStorage, new PersistenceSettings(TimeSpan.FromHours(1), true, maxBodySizeToStore));
+            var enricher = new BodyStorageEnricher(fakeStorage, new PersistenceSettings(TimeSpan.FromHours(1), true, maxBodySizeToStore), LoggerUtil.CreateStaticLogger<BodyStorageEnricher>());
             var expectedBodySize = BodyStorageEnricher.LargeObjectHeapThreshold + 1;
             var body = Encoding.UTF8.GetBytes(new string('a', expectedBodySize));
             var metadata = new Dictionary<string, object>();
@@ -177,7 +178,7 @@ public async Task Should_store_body_in_storage_when_below_threshold_and_binary()
             var fakeStorage = new FakeBodyStorage();
             var maxBodySizeToStore = 100000;
 
-            var enricher = new BodyStorageEnricher(fakeStorage, new PersistenceSettings(TimeSpan.FromHours(1), true, maxBodySizeToStore));
+            var enricher = new BodyStorageEnricher(fakeStorage, new PersistenceSettings(TimeSpan.FromHours(1), true, maxBodySizeToStore), LoggerUtil.CreateStaticLogger<BodyStorageEnricher>());
             var expectedBodySize = BodyStorageEnricher.LargeObjectHeapThreshold + 1;
             var body = Encoding.UTF8.GetBytes(new string('a', expectedBodySize));
             var metadata = new Dictionary<string, object>();
@@ -208,7 +209,7 @@ public async Task Should_store_body_in_storage_when_below_threshold()
             var fakeStorage = new FakeBodyStorage();
             var maxBodySizeToStore = 100000;
 
-            var enricher = new BodyStorageEnricher(fakeStorage, new PersistenceSettings(TimeSpan.FromHours(1), true, maxBodySizeToStore));
+            var enricher = new BodyStorageEnricher(fakeStorage, new PersistenceSettings(TimeSpan.FromHours(1), true, maxBodySizeToStore), LoggerUtil.CreateStaticLogger<BodyStorageEnricher>());
             var expectedBodySize = BodyStorageEnricher.LargeObjectHeapThreshold + 1;
             var body = Encoding.UTF8.GetBytes(new string('a', expectedBodySize));
             var metadata = new Dictionary<string, object>();
@@ -239,7 +240,7 @@ public async Task Should_store_body_in_storage_when_encoding_fails()
             var fakeStorage = new FakeBodyStorage();
             var maxBodySizeToStore = 100000;
 
-            var enricher = new BodyStorageEnricher(fakeStorage, new PersistenceSettings(TimeSpan.FromHours(1), true, maxBodySizeToStore));
+            var enricher = new BodyStorageEnricher(fakeStorage, new PersistenceSettings(TimeSpan.FromHours(1), true, maxBodySizeToStore), LoggerUtil.CreateStaticLogger<BodyStorageEnricher>());
             var body = new byte[] { 0x00, 0xDE };
             var metadata = new Dictionary<string, object>();
 
diff --git a/src/ServiceControl.Audit.UnitTests/Infrastructure/When_instance_is_setup.cs b/src/ServiceControl.Audit.UnitTests/Infrastructure/When_instance_is_setup.cs
@@ -12,7 +12,6 @@
     using NServiceBus;
     using NServiceBus.Transport;
     using NUnit.Framework;
-    using ServiceControl.Infrastructure;
     using Transports;
 
     class When_instance_is_setup

Original file line number	Diff line number	Diff line change
`@@ -5,23 +5,14 @@`
`5`	`5`	`using ServiceControl.Audit.Auditing.BodyStorage;`
`6`	`6`	`using ServiceControl.Audit.Persistence.UnitOfWork;`
`7`	`7`
`8`		`- class InMemoryAuditIngestionUnitOfWorkFactory : IAuditIngestionUnitOfWorkFactory`
	`8`	`+ class InMemoryAuditIngestionUnitOfWorkFactory(InMemoryAuditDataStore dataStore, BodyStorageEnricher bodyStorageEnricher) : IAuditIngestionUnitOfWorkFactory`
`9`	`9`	`{`
`10`		`- public InMemoryAuditIngestionUnitOfWorkFactory(InMemoryAuditDataStore dataStore, IBodyStorage bodyStorage, PersistenceSettings settings)`
`11`		`- {`
`12`		`- this.dataStore = dataStore;`
`13`		`- bodyStorageEnricher = new BodyStorageEnricher(bodyStorage, settings);`
`14`		`- }`
`15`		`-`
`16`	`10`	`public ValueTask<IAuditIngestionUnitOfWork> StartNew(int batchSize, CancellationToken cancellationToken)`
`17`	`11`	`{`
`18`	`12`	`//The batchSize argument is ignored: the in-memory storage implementation doesn't support batching.`
`19`	`13`	`return new ValueTask<IAuditIngestionUnitOfWork>(new InMemoryAuditIngestionUnitOfWork(dataStore, bodyStorageEnricher));`
`20`	`14`	`}`
`21`	`15`
`22`	`16`	`public bool CanIngestMore() => true;`
`23`		`-`
`24`		`- InMemoryAuditDataStore dataStore;`
`25`		`- BodyStorageEnricher bodyStorageEnricher;`
`26`	`17`	`}`
`27`	`18`	`}`
Original file line number	Diff line number	Diff line change
`@@ -14,6 +14,7 @@ public void AddPersistence(IServiceCollection services)`
`14`	`14`	`services.AddSingleton<IBodyStorage, InMemoryAttachmentsBodyStorage>();`
`15`	`15`	`services.AddSingleton<IFailedAuditStorage, InMemoryFailedAuditStorage>();`
`16`	`16`	`services.AddSingleton<IAuditIngestionUnitOfWorkFactory, InMemoryAuditIngestionUnitOfWorkFactory>();`
	`17`	`+ services.AddSingleton<BodyStorageEnricher>();`
`17`	`18`	`}`
`18`	`19`
`19`	`20`	`public void AddInstaller(IServiceCollection services)`
Original file line number	Diff line number	Diff line change
`@@ -5,12 +5,12 @@`
`5`	`5`	`using System.Text;`
`6`	`6`	`using System.Threading;`
`7`	`7`	`using System.Threading.Tasks;`
	`8`	`+ using Microsoft.Extensions.Logging;`
`8`	`9`	`using NServiceBus;`
`9`		`- using NServiceBus.Logging;`
`10`	`10`	`using ServiceControl.Audit.Persistence;`
`11`	`11`	`using ServiceControl.Infrastructure;`
`12`	`12`
`13`		`- public class BodyStorageEnricher(IBodyStorage bodyStorage, PersistenceSettings settings)`
	`13`	`+ public class BodyStorageEnricher(IBodyStorage bodyStorage, PersistenceSettings settings, ILogger<BodyStorageEnricher> logger)`
`14`	`14`	`{`
`15`	`15`	`public async ValueTask StoreAuditMessageBody(ReadOnlyMemory<byte> body, ProcessedMessage processedMessage, CancellationToken cancellationToken)`
`16`	`16`	`{`
`@@ -66,7 +66,7 @@ async ValueTask<bool> TryStoreBody(ReadOnlyMemory<byte> body, ProcessedMessage p`
`66`	`66`	`catch (DecoderFallbackException e)`
`67`	`67`	`{`
`68`	`68`	`useBodyStore = true;`
`69`		`- log.Info($"Body for {bodyId} could not be stored embedded, fallback to body storage ({e.Message})");`
	`69`	`+ logger.LogInformation("Body for {BodyId} could not be stored embedded, fallback to body storage ({ErrorMessage})", bodyId, e.Message);`
`70`	`70`	`}`
`71`	`71`	`}`
`72`	`72`
`@@ -111,7 +111,6 @@ static bool IsBinary(IReadOnlyDictionary<string, string> headers)`
`111`	`111`	`}`
`112`	`112`
`113`	`113`	`static readonly Encoding enc = new UTF8Encoding(true, true);`
`114`		`- static readonly ILog log = LogManager.GetLogger<BodyStorageEnricher>();`
`115`	`114`
`116`	`115`	`// large object heap starts above 85000 bytes and not above 85 KB!`
`117`	`116`	`public const int LargeObjectHeapThreshold = 85 * 1000;`
Original file line number	Diff line number	Diff line change
`@@ -5,7 +5,8 @@`
`5`	`5`	`using System.IO;`
`6`	`6`	`using System.Linq;`
`7`	`7`	`using System.Text.Json;`
`8`		`- using NServiceBus.Logging;`
	`8`	`+ using Microsoft.Extensions.Logging;`
	`9`	`+ using ServiceControl.Infrastructure;`
`9`	`10`
`10`	`11`	`public class PersistenceManifest`
`11`	`12`	`{`
`@@ -51,7 +52,7 @@ static PersistenceManifestLibrary()`
`51`	`52`	`}`
`52`	`53`	`catch (Exception ex)`
`53`	`54`	`{`
`54`		`- logger.Warn($"Failed to load persistence manifests from {assemblyDirectory}", ex);`
	`55`	`+ logger.LogWarning(ex, "Failed to load persistence manifests from {AssemblyDirectory}", assemblyDirectory);`
`55`	`56`	`}`
`56`	`57`
`57`	`58`	`try`
`@@ -66,10 +67,10 @@ static PersistenceManifestLibrary()`
`66`	`67`	`}`
`67`	`68`	`catch (Exception ex)`
`68`	`69`	`{`
`69`		`- logger.Warn($"Failed to load persistence manifests from development locations", ex);`
	`70`	`+ logger.LogWarning(ex, "Failed to load persistence manifests from development locations");`
`70`	`71`	`}`
`71`	`72`
`72`		`- PersistenceManifests.ForEach(m => logger.Info($"Found persistence manifest for {m.DisplayName}"));`
	`73`	`+ PersistenceManifests.ForEach(m => logger.LogInformation("Found persistence manifest for {ManifestDisplayName}", m.DisplayName));`
`73`	`74`	`}`
`74`	`75`
`75`	`76`	`static string GetAssemblyDirectory()`
`@@ -90,7 +91,7 @@ public static PersistenceManifest Find(string persistenceType)`
`90`	`91`	`return persistenceManifest;`
`91`	`92`	`}`
`92`	`93`
`93`		`- static readonly ILog logger = LogManager.GetLogger(typeof(PersistenceManifestLibrary));`
	`94`	`+ static readonly ILogger logger = LoggerUtil.CreateStaticLogger(typeof(PersistenceManifestLibrary));`
`94`	`95`	`}`
`95`	`96`	`}`
`96`	`97`