use pascal case for structured logging

PhilBastian · web-flow · commit ad7cc4ae87a8 · 2025-06-10T07:49:58.000+08:00
diff --git a/src/ServiceControl.Audit/Auditing/AuditIngestion.cs b/src/ServiceControl.Audit/Auditing/AuditIngestion.cs
@@ -70,7 +70,7 @@ ILogger<AuditIngestion> logger
 
         Task OnCriticalError(string failure, Exception exception)
         {
-            logger.LogCritical(exception, "OnCriticalError. '{failure}'", failure);
+            logger.LogCritical(exception, "OnCriticalError. '{Failure}'", failure);
             return watchdog.OnFailure(failure);
         }
 
@@ -82,7 +82,7 @@ async Task EnsureStarted(CancellationToken cancellationToken)
 
                 var canIngest = unitOfWorkFactory.CanIngestMore();
 
-                logger.LogDebug("Ensure started {canIngest}", canIngest);
+                logger.LogDebug("Ensure started {CanIngest}", canIngest);
 
                 if (canIngest)
                 {
diff --git a/src/ServiceControl.Audit/Auditing/AuditPersister.cs b/src/ServiceControl.Audit/Auditing/AuditPersister.cs
@@ -73,7 +73,7 @@ public async Task<IReadOnlyList<MessageContext>> Persist(IReadOnlyList<MessageCo
 
                 foreach (var endpoint in knownEndpoints.Values)
                 {
-                    logger.LogDebug("Adding known endpoint '{endpointName}' for bulk storage", endpoint.Name);
+                    logger.LogDebug("Adding known endpoint '{EndpointName}' for bulk storage", endpoint.Name);
 
                     await unitOfWork.RecordKnownEndpoint(endpoint, cancellationToken);
                 }
@@ -155,7 +155,7 @@ void ProcessSagaAuditMessage(MessageContext context)
             }
             catch (Exception e)
             {
-                logger.LogWarning(e, "Processing of saga audit message '{contextNativeMessageId}' failed.", context.NativeMessageId);
+                logger.LogWarning(e, "Processing of saga audit message '{NativeMessageId}' failed.", context.NativeMessageId);
 
                 // releasing the failed message context early so that they can be retried outside the current batch
                 context.GetTaskCompletionSource().TrySetException(e);
@@ -188,7 +188,7 @@ async Task ProcessAuditMessage(MessageContext context)
 
                 var auditMessage = new ProcessedMessage(context.Headers, new Dictionary<string, object>(metadata));
 
-                logger.LogDebug("Emitting {commandsToEmitCount} commands and {messagesToEmitCount} control messages.", commandsToEmit.Count, messagesToEmit.Count);
+                logger.LogDebug("Emitting {CommandsToEmitCount} commands and {MessagesToEmitCount} control messages.", commandsToEmit.Count, messagesToEmit.Count);
 
                 foreach (var commandToEmit in commandsToEmit)
                 {
@@ -198,7 +198,7 @@ async Task ProcessAuditMessage(MessageContext context)
                 await messageDispatcher.Value.Dispatch(new TransportOperations(messagesToEmit.ToArray()),
                     new TransportTransaction()); //Do not hook into the incoming transaction
 
-                logger.LogDebug("{commandsToEmitCount} commands and {messagesToEmitCount} control messages emitted.", commandsToEmit.Count, messagesToEmit.Count);
+                logger.LogDebug("{CommandsToEmitCount} commands and {MessagesToEmitCount} control messages emitted.", commandsToEmit.Count, messagesToEmit.Count);
 
                 if (metadata.TryGetValue("SendingEndpoint", out var sendingEndpoint))
                 {
@@ -215,7 +215,7 @@ await messageDispatcher.Value.Dispatch(new TransportOperations(messagesToEmit.To
             }
             catch (Exception e)
             {
-                logger.LogWarning(e, "Processing of message '{messageId}' failed.", messageId);
+                logger.LogWarning(e, "Processing of message '{MessageId}' failed.", messageId);
 
                 // releasing the failed message context early so that they can be retried outside the current batch
                 context.GetTaskCompletionSource().TrySetException(e);
diff --git a/src/ServiceControl.Audit/Auditing/ImportFailedAudits.cs b/src/ServiceControl.Audit/Auditing/ImportFailedAudits.cs
@@ -52,25 +52,25 @@ await failedAuditStore.ProcessFailedMessages(
 
                             await markComplete(token);
                             succeeded++;
-                            logger.LogDebug("Successfully re-imported failed audit message {transportMessageId}.", transportMessage.Id);
+                            logger.LogDebug("Successfully re-imported failed audit message {MessageId}.", transportMessage.Id);
                         }
                         catch (OperationCanceledException e) when (token.IsCancellationRequested)
                         {
                             logger.LogInformation(e, "Cancelled");
                         }
                         catch (Exception e)
                         {
-                            logger.LogError(e, "Error while attempting to re-import failed audit message {transportMessageId}.", transportMessage.Id);
+                            logger.LogError(e, "Error while attempting to re-import failed audit message {MessageId}.", transportMessage.Id);
                             failed++;
                         }
 
                     }, cancellationToken);
 
-            logger.LogInformation("Done re-importing failed audits. Successfully re-imported {succeeded} messages. Failed re-importing {failed} messages.", succeeded, failed);
+            logger.LogInformation("Done re-importing failed audits. Successfully re-imported {SuccessCount} messages. Failed re-importing {FailureCount} messages.", succeeded, failed);
 
             if (failed > 0)
             {
-                logger.LogWarning("{failed} messages could not be re-imported. This could indicate a problem with the data. Contact Particular support if you need help with recovering the messages.", failed);
+                logger.LogWarning("{FailureCount} messages could not be re-imported. This could indicate a problem with the data. Contact Particular support if you need help with recovering the messages.", failed);
             }
         }
 
diff --git a/src/ServiceControl.Infrastructure/Watchdog.cs b/src/ServiceControl.Infrastructure/Watchdog.cs
@@ -60,7 +60,7 @@ public Task Start(Action onFailedOnStartup, CancellationToken cancellationToken)
                         using var cancellationTokenSource = CancellationTokenSource.CreateLinkedTokenSource(shutdownTokenSource.Token);
                         cancellationTokenSource.CancelAfter(MaxStartDurationMs);
 
-                        log.LogDebug("Ensuring {taskName} is running", taskName);
+                        log.LogDebug("Ensuring {TaskName} is running", taskName);
                         await ensureStarted(cancellationTokenSource.Token).ConfigureAwait(false);
                         clearFailure();
                         startup = false;
@@ -76,12 +76,12 @@ public Task Start(Action onFailedOnStartup, CancellationToken cancellationToken)
 
                         if (startup)
                         {
-                            log.LogError(e, "Error during initial startup attempt for {taskName}.", taskName);
+                            log.LogError(e, "Error during initial startup attempt for {TaskName}.", taskName);
                             onFailedOnStartup();
                             return;
                         }
 
-                        log.LogError(e, "Error while trying to start {taskName}. Starting will be retried in {timeToWaitBetweenStartupAttempts}.", taskName, timeToWaitBetweenStartupAttempts);
+                        log.LogError(e, "Error while trying to start {TaskName}. Starting will be retried in {TimeToWaitBetweenStartupAttempts}.", taskName, timeToWaitBetweenStartupAttempts);
                     }
                     try
                     {
@@ -101,13 +101,13 @@ public async Task Stop(CancellationToken cancellationToken)
         {
             try
             {
-                log.LogDebug("Starting watching {taskName}", taskName);
+                log.LogDebug("Starting watching {TaskName}", taskName);
                 await shutdownTokenSource.CancelAsync().ConfigureAwait(false);
                 await watchdog.ConfigureAwait(false);
             }
             catch (Exception e)
             {
-                log.LogError(e, "Ensuring {taskName} is running", taskName);
+                log.LogError(e, "Ensuring {TaskName} is running", taskName);
                 throw;
             }
             finally
diff --git a/src/ServiceControl/App.config b/src/ServiceControl/App.config
@@ -46,7 +46,7 @@ These settings are only here so that we can debug ServiceControl while developin
     <!--PostgreSQL -->
     <!--<add name="NServiceBus/Transport" connectionString="Server=;Database=nservicebus;Port=5432;User Id=;Password=" />-->
 
-    <!--RabbitMQ.QuorumConventionalRouting--> 
+    <!--RabbitMQ.QuorumConventionalRouting -->
     <!--<add name="NServiceBus/Transport" connectionString="host=;username=;password=" />-->
 
     <!--SQLServer -->

Original file line number	Diff line number	Diff line change
`@@ -70,7 +70,7 @@ ILogger<AuditIngestion> logger`
`70`	`70`
`71`	`71`	`Task OnCriticalError(string failure, Exception exception)`
`72`	`72`	`{`
`73`		`- logger.LogCritical(exception, "OnCriticalError. '{failure}'", failure);`
	`73`	`+ logger.LogCritical(exception, "OnCriticalError. '{Failure}'", failure);`
`74`	`74`	`return watchdog.OnFailure(failure);`
`75`	`75`	`}`
`76`	`76`
`@@ -82,7 +82,7 @@ async Task EnsureStarted(CancellationToken cancellationToken)`
`82`	`82`
`83`	`83`	`var canIngest = unitOfWorkFactory.CanIngestMore();`
`84`	`84`
`85`		`- logger.LogDebug("Ensure started {canIngest}", canIngest);`
	`85`	`+ logger.LogDebug("Ensure started {CanIngest}", canIngest);`
`86`	`86`
`87`	`87`	`if (canIngest)`
`88`	`88`	`{`
Original file line number	Diff line number	Diff line change
`@@ -73,7 +73,7 @@ public async Task<IReadOnlyList<MessageContext>> Persist(IReadOnlyList<MessageCo`
`73`	`73`
`74`	`74`	`foreach (var endpoint in knownEndpoints.Values)`
`75`	`75`	`{`
`76`		`- logger.LogDebug("Adding known endpoint '{endpointName}' for bulk storage", endpoint.Name);`
	`76`	`+ logger.LogDebug("Adding known endpoint '{EndpointName}' for bulk storage", endpoint.Name);`
`77`	`77`
`78`	`78`	`await unitOfWork.RecordKnownEndpoint(endpoint, cancellationToken);`
`79`	`79`	`}`
`@@ -155,7 +155,7 @@ void ProcessSagaAuditMessage(MessageContext context)`
`155`	`155`	`}`
`156`	`156`	`catch (Exception e)`
`157`	`157`	`{`
`158`		`- logger.LogWarning(e, "Processing of saga audit message '{contextNativeMessageId}' failed.", context.NativeMessageId);`
	`158`	`+ logger.LogWarning(e, "Processing of saga audit message '{NativeMessageId}' failed.", context.NativeMessageId);`
`159`	`159`
`160`	`160`	`// releasing the failed message context early so that they can be retried outside the current batch`
`161`	`161`	`context.GetTaskCompletionSource().TrySetException(e);`
`@@ -188,7 +188,7 @@ async Task ProcessAuditMessage(MessageContext context)`
`188`	`188`
`189`	`189`	`var auditMessage = new ProcessedMessage(context.Headers, new Dictionary<string, object>(metadata));`
`190`	`190`
`191`		`- logger.LogDebug("Emitting {commandsToEmitCount} commands and {messagesToEmitCount} control messages.", commandsToEmit.Count, messagesToEmit.Count);`
	`191`	`+ logger.LogDebug("Emitting {CommandsToEmitCount} commands and {MessagesToEmitCount} control messages.", commandsToEmit.Count, messagesToEmit.Count);`
`192`	`192`
`193`	`193`	`foreach (var commandToEmit in commandsToEmit)`
`194`	`194`	`{`
`@@ -198,7 +198,7 @@ async Task ProcessAuditMessage(MessageContext context)`
`198`	`198`	`await messageDispatcher.Value.Dispatch(new TransportOperations(messagesToEmit.ToArray()),`
`199`	`199`	`new TransportTransaction()); //Do not hook into the incoming transaction`
`200`	`200`
`201`		`- logger.LogDebug("{commandsToEmitCount} commands and {messagesToEmitCount} control messages emitted.", commandsToEmit.Count, messagesToEmit.Count);`
	`201`	`+ logger.LogDebug("{CommandsToEmitCount} commands and {MessagesToEmitCount} control messages emitted.", commandsToEmit.Count, messagesToEmit.Count);`
`202`	`202`
`203`	`203`	`if (metadata.TryGetValue("SendingEndpoint", out var sendingEndpoint))`
`204`	`204`	`{`
`@@ -215,7 +215,7 @@ await messageDispatcher.Value.Dispatch(new TransportOperations(messagesToEmit.To`
`215`	`215`	`}`
`216`	`216`	`catch (Exception e)`
`217`	`217`	`{`
`218`		`- logger.LogWarning(e, "Processing of message '{messageId}' failed.", messageId);`
	`218`	`+ logger.LogWarning(e, "Processing of message '{MessageId}' failed.", messageId);`
`219`	`219`
`220`	`220`	`// releasing the failed message context early so that they can be retried outside the current batch`
`221`	`221`	`context.GetTaskCompletionSource().TrySetException(e);`
Original file line number	Diff line number	Diff line change
`@@ -52,25 +52,25 @@ await failedAuditStore.ProcessFailedMessages(`
`52`	`52`
`53`	`53`	`await markComplete(token);`
`54`	`54`	`succeeded++;`
`55`		`- logger.LogDebug("Successfully re-imported failed audit message {transportMessageId}.", transportMessage.Id);`
	`55`	`+ logger.LogDebug("Successfully re-imported failed audit message {MessageId}.", transportMessage.Id);`
`56`	`56`	`}`
`57`	`57`	`catch (OperationCanceledException e) when (token.IsCancellationRequested)`
`58`	`58`	`{`
`59`	`59`	`logger.LogInformation(e, "Cancelled");`
`60`	`60`	`}`
`61`	`61`	`catch (Exception e)`
`62`	`62`	`{`
`63`		`- logger.LogError(e, "Error while attempting to re-import failed audit message {transportMessageId}.", transportMessage.Id);`
	`63`	`+ logger.LogError(e, "Error while attempting to re-import failed audit message {MessageId}.", transportMessage.Id);`
`64`	`64`	`failed++;`
`65`	`65`	`}`
`66`	`66`
`67`	`67`	`}, cancellationToken);`
`68`	`68`
`69`		`- logger.LogInformation("Done re-importing failed audits. Successfully re-imported {succeeded} messages. Failed re-importing {failed} messages.", succeeded, failed);`
	`69`	`+ logger.LogInformation("Done re-importing failed audits. Successfully re-imported {SuccessCount} messages. Failed re-importing {FailureCount} messages.", succeeded, failed);`
`70`	`70`
`71`	`71`	`if (failed > 0)`
`72`	`72`	`{`
`73`		`- logger.LogWarning("{failed} messages could not be re-imported. This could indicate a problem with the data. Contact Particular support if you need help with recovering the messages.", failed);`
	`73`	`+ logger.LogWarning("{FailureCount} messages could not be re-imported. This could indicate a problem with the data. Contact Particular support if you need help with recovering the messages.", failed);`
`74`	`74`	`}`
`75`	`75`	`}`
`76`	`76`
Original file line number	Diff line number	Diff line change
`@@ -60,7 +60,7 @@ public Task Start(Action onFailedOnStartup, CancellationToken cancellationToken)`
`60`	`60`	`using var cancellationTokenSource = CancellationTokenSource.CreateLinkedTokenSource(shutdownTokenSource.Token);`
`61`	`61`	`cancellationTokenSource.CancelAfter(MaxStartDurationMs);`
`62`	`62`
`63`		`- log.LogDebug("Ensuring {taskName} is running", taskName);`
	`63`	`+ log.LogDebug("Ensuring {TaskName} is running", taskName);`
`64`	`64`	`await ensureStarted(cancellationTokenSource.Token).ConfigureAwait(false);`
`65`	`65`	`clearFailure();`
`66`	`66`	`startup = false;`
`@@ -76,12 +76,12 @@ public Task Start(Action onFailedOnStartup, CancellationToken cancellationToken)`
`76`	`76`
`77`	`77`	`if (startup)`
`78`	`78`	`{`
`79`		`- log.LogError(e, "Error during initial startup attempt for {taskName}.", taskName);`
	`79`	`+ log.LogError(e, "Error during initial startup attempt for {TaskName}.", taskName);`
`80`	`80`	`onFailedOnStartup();`
`81`	`81`	`return;`
`82`	`82`	`}`
`83`	`83`
`84`		`- log.LogError(e, "Error while trying to start {taskName}. Starting will be retried in {timeToWaitBetweenStartupAttempts}.", taskName, timeToWaitBetweenStartupAttempts);`
	`84`	`+ log.LogError(e, "Error while trying to start {TaskName}. Starting will be retried in {TimeToWaitBetweenStartupAttempts}.", taskName, timeToWaitBetweenStartupAttempts);`
`85`	`85`	`}`
`86`	`86`	`try`
`87`	`87`	`{`
`@@ -101,13 +101,13 @@ public async Task Stop(CancellationToken cancellationToken)`
`101`	`101`	`{`
`102`	`102`	`try`
`103`	`103`	`{`
`104`		`- log.LogDebug("Starting watching {taskName}", taskName);`
	`104`	`+ log.LogDebug("Starting watching {TaskName}", taskName);`
`105`	`105`	`await shutdownTokenSource.CancelAsync().ConfigureAwait(false);`
`106`	`106`	`await watchdog.ConfigureAwait(false);`
`107`	`107`	`}`
`108`	`108`	`catch (Exception e)`
`109`	`109`	`{`
`110`		`- log.LogError(e, "Ensuring {taskName} is running", taskName);`
	`110`	`+ log.LogError(e, "Ensuring {TaskName} is running", taskName);`
`111`	`111`	`throw;`
`112`	`112`	`}`
`113`	`113`	`finally`