fix(logging): correctly apply logging scopes in az sb messaging

Author: stijnmoreels

src/Arcus.Messaging.Abstractions/MessageHandling/MessageRouter.cs

@@ -168,6 +168,7 @@ private async Task<MessageProcessingResult> ProcessMessageHandlerAsync<TMessageC
             CancellationToken cancellation)
             where TMessageContext : MessageContext
         {
+            using var _ = Logger.BeginScope(new Dictionary<string, object> { ["JobId"] = context.JobId });
             var summary = new MessageHandlerSummary();
 
             if (!handler.MatchesMessageContext(context, summary))

src/Arcus.Messaging.Pumps.ServiceBus/ServiceBusMessagePump.cs

@@ -26,7 +26,6 @@ namespace Arcus.Messaging.Pumps.ServiceBus
     internal abstract class ServiceBusMessagePump : BackgroundService
     {
         private readonly ServiceBusMessageRouter _messageRouter;
-        private readonly IDisposable _loggingScope;
 
         /// <summary>
         /// Initializes a new instance of the <see cref="ServiceBusMessagePump"/> class.
@@ -57,7 +56,6 @@ protected ServiceBusMessagePump(
             ServiceProvider = serviceProvider;
             Logger = logger ?? NullLogger.Instance;
 
-            _loggingScope = Logger.BeginScope("Job: {JobId}", JobId);
             _messageRouter = new ServiceBusMessageRouter(serviceProvider, options.Routing, serviceProvider.GetService<ILogger<ServiceBusMessageRouter>>());
         }
 
@@ -197,9 +195,7 @@ protected virtual Task StopProcessingMessagesAsync()
         /// <returns>A <see cref="Task" /> that represents the asynchronous Stop operation.</returns>
         public override Task StopAsync(CancellationToken cancellationToken)
         {
-            _loggingScope?.Dispose();
             IsHostShuttingDown = true;
-
             return base.StopAsync(cancellationToken);
         }
     }

src/Arcus.Messaging.Pumps.ServiceBus/ServiceBusMessageRouter.cs

@@ -87,8 +87,12 @@ private async Task<MessageProcessingResult> TryRoutingMessageViaRegisteredMessag
             MessageCorrelationInfo correlationInfo,
             CancellationToken cancellationToken)
         {
-            using var _ = Logger.BeginScope(new Dictionary<string, string> { ["MessageId"] = messageContext.MessageId });
-
+            using var _ = Logger.BeginScope(new Dictionary<string, object>
+            {
+                ["JobId"] = messageContext.JobId,
+                ["Service Bus namespace"] = messageContext.FullyQualifiedNamespace,
+                ["Service Bus entity name"] = messageContext.EntityPath
+            });
             Logger.LogDebug("[Received] message (message ID={MessageId}) on Azure Service Bus {EntityType} message pump", messageContext.MessageId, messageContext.EntityType);
 
             string messageBody = LoadMessageBody(message, messageContext);