fix: update logging in unhandled exception scenarios

Per Kops · Per Kops · commit 0276bc75920b · 2025-03-04T13:02:53.000+01:00
diff --git a/src/Atc.Hosting/BackgroundScheduleServiceBase.cs b/src/Atc.Hosting/BackgroundScheduleServiceBase.cs
@@ -163,7 +163,11 @@ public abstract Task DoWorkAsync(
     protected virtual Task OnExceptionAsync(
         Exception exception,
         CancellationToken stoppingToken)
-        => Task.CompletedTask;
+    {
+        logger.LogBackgroundServiceUnhandledException(exception, ServiceName);
+
+        return Task.CompletedTask;
+    }
 
     /// <inheritdoc />
     [SuppressMessage("Design", "CA1031:Do not catch general exception types", Justification = "OK - by design.")]
@@ -207,8 +211,7 @@ protected override async Task ExecuteAsync(
 
                         logger.LogBackgroundServiceRetrying(
                             ServiceName,
-                            ServiceOptions.CronExpression,
-                            ex);
+                            ServiceOptions.CronExpression);
                     }
 
                     nextOccurrence = cronExpression.GetNextOccurrence(DateTime.UtcNow);
@@ -225,7 +228,7 @@ protected override async Task ExecuteAsync(
         }
         catch (Exception ex)
         {
-            logger.LogBackgroundServiceUnhandledException(ServiceName, ex);
+            logger.LogBackgroundServiceUnhandledException(ex, ServiceName);
         }
         finally
         {
diff --git a/src/Atc.Hosting/BackgroundServiceBase.cs b/src/Atc.Hosting/BackgroundServiceBase.cs
@@ -168,7 +168,11 @@ public abstract Task DoWorkAsync(
     protected virtual Task OnExceptionAsync(
         Exception exception,
         CancellationToken stoppingToken)
-        => Task.CompletedTask;
+    {
+        logger.LogBackgroundServiceUnhandledException(exception, ServiceName);
+
+        return Task.CompletedTask;
+    }
 
     /// <inheritdoc />
     [SuppressMessage("Design", "CA1031:Do not catch general exception types", Justification = "OK - by design.")]
@@ -204,8 +208,7 @@ await Task
 
                     logger.LogBackgroundServiceRetrying(
                         ServiceName,
-                        ServiceOptions.RepeatIntervalSeconds,
-                        ex);
+                        ServiceOptions.RepeatIntervalSeconds);
                 }
 
                 await Task
@@ -219,7 +222,7 @@ await Task
         }
         catch (Exception ex)
         {
-            logger.LogBackgroundServiceUnhandledException(ServiceName, ex);
+            logger.LogBackgroundServiceUnhandledException(ex, ServiceName);
         }
         finally
         {
diff --git a/src/Atc.Hosting/Extensions/LoggerExtensions.cs b/src/Atc.Hosting/Extensions/LoggerExtensions.cs
@@ -9,7 +9,7 @@ internal static partial class LoggerExtensions
     [LoggerMessage(
         EventId = LoggingEventIdConstants.BackgroundService.Started,
         Level = LogLevel.Information,
-        Message = "Started worker {serviceName}. Worker will run with {repeatIntervalSeconds} seconds interval",
+        Message = "Started worker {ServiceName}. Worker will run with {RepeatIntervalSeconds} seconds interval",
         SkipEnabledCheck = false)]
     internal static partial void LogBackgroundServiceStarted(
         this ILogger logger,
@@ -19,7 +19,7 @@ internal static partial void LogBackgroundServiceStarted(
     [LoggerMessage(
         EventId = LoggingEventIdConstants.BackgroundService.Started,
         Level = LogLevel.Information,
-        Message = "Started worker {serviceName}. Worker will run with cron expression {cronExpression}",
+        Message = "Started worker {ServiceName}. Worker will run with cron expression {CronExpression}",
         SkipEnabledCheck = false)]
     internal static partial void LogBackgroundServiceStarted(
         this ILogger logger,
@@ -29,7 +29,7 @@ internal static partial void LogBackgroundServiceStarted(
     [LoggerMessage(
         EventId = LoggingEventIdConstants.BackgroundService.Stopped,
         Level = LogLevel.Information,
-        Message = "Stopped worker {serviceName}",
+        Message = "Stopped worker {ServiceName}",
         SkipEnabledCheck = false)]
     internal static partial void LogBackgroundServiceStopped(
         this ILogger logger,
@@ -38,41 +38,39 @@ internal static partial void LogBackgroundServiceStopped(
     [LoggerMessage(
         EventId = LoggingEventIdConstants.BackgroundService.Cancelled,
         Level = LogLevel.Warning,
-        Message = "Cancellation invoked for worker {serviceName}",
+        Message = "Cancellation invoked for worker {ServiceName}",
         SkipEnabledCheck = false)]
     internal static partial void LogBackgroundServiceCancelled(
         this ILogger logger,
         string serviceName);
 
     [LoggerMessage(
         EventId = LoggingEventIdConstants.BackgroundService.Retrying,
-        Level = LogLevel.Warning,
-        Message = "Unhandled exception occurred in worker {serviceName}. Worker will retry after {repeatIntervalSeconds} seconds",
+        Level = LogLevel.Information,
+        Message = "Worker {ServiceName} will retry after {RepeatIntervalSeconds} seconds",
         SkipEnabledCheck = false)]
     internal static partial void LogBackgroundServiceRetrying(
         this ILogger logger,
         string serviceName,
-        int repeatIntervalSeconds,
-        Exception exception);
+        int repeatIntervalSeconds);
 
     [LoggerMessage(
         EventId = LoggingEventIdConstants.BackgroundService.Retrying,
-        Level = LogLevel.Warning,
-        Message = "Unhandled exception occurred in worker {serviceName}. Worker will retry on next defined in cron expression {cronExpression}",
+        Level = LogLevel.Information,
+        Message = "Worker {ServiceName} will retry on next occurence pr the cron expression {CronExpression}",
         SkipEnabledCheck = false)]
     internal static partial void LogBackgroundServiceRetrying(
         this ILogger logger,
         string serviceName,
-        string cronExpression,
-        Exception exception);
+        string cronExpression);
 
     [LoggerMessage(
         EventId = LoggingEventIdConstants.BackgroundService.UnhandledException,
         Level = LogLevel.Error,
-        Message = "Unhandled exception occurred in worker {serviceName}",
+        Message = "Unhandled exception occurred in worker {ServiceName}",
         SkipEnabledCheck = false)]
     internal static partial void LogBackgroundServiceUnhandledException(
         this ILogger logger,
-        string serviceName,
-        Exception exception);
+        Exception exception,
+        string serviceName);
 }
diff --git a/test/Atc.Hosting.Tests/BackgroundServiceBaseTests.cs b/test/Atc.Hosting.Tests/BackgroundServiceBaseTests.cs
@@ -128,9 +128,8 @@ public async Task Logging_Start_Retry_Cancel_Stop()
 
                 logger
                     .Log(
-                        LogLevel.Warning,
-                        $"Unhandled exception occurred in worker {serviceName}. Worker will retry after {options.RepeatIntervalSeconds} seconds",
-                        exception);
+                        LogLevel.Information,
+                        $"Worker {serviceName} will retry after {options.RepeatIntervalSeconds} seconds");
 
                 logger
                     .Log(

Original file line number	Diff line number	Diff line change
`@@ -163,7 +163,11 @@ public abstract Task DoWorkAsync(`
`163`	`163`	`protected virtual Task OnExceptionAsync(`
`164`	`164`	`Exception exception,`
`165`	`165`	`CancellationToken stoppingToken)`
`166`		`- => Task.CompletedTask;`
	`166`	`+ {`
	`167`	`+ logger.LogBackgroundServiceUnhandledException(exception, ServiceName);`
	`168`	`+`
	`169`	`+ return Task.CompletedTask;`
	`170`	`+ }`
`167`	`171`
`168`	`172`	`/// <inheritdoc />`
`169`	`173`	`[SuppressMessage("Design", "CA1031:Do not catch general exception types", Justification = "OK - by design.")]`
`@@ -207,8 +211,7 @@ protected override async Task ExecuteAsync(`
`207`	`211`
`208`	`212`	`logger.LogBackgroundServiceRetrying(`
`209`	`213`	`ServiceName,`
`210`		`- ServiceOptions.CronExpression,`
`211`		`- ex);`
	`214`	`+ ServiceOptions.CronExpression);`
`212`	`215`	`}`
`213`	`216`
`214`	`217`	`nextOccurrence = cronExpression.GetNextOccurrence(DateTime.UtcNow);`
`@@ -225,7 +228,7 @@ protected override async Task ExecuteAsync(`
`225`	`228`	`}`
`226`	`229`	`catch (Exception ex)`
`227`	`230`	`{`
`228`		`- logger.LogBackgroundServiceUnhandledException(ServiceName, ex);`
	`231`	`+ logger.LogBackgroundServiceUnhandledException(ex, ServiceName);`
`229`	`232`	`}`
`230`	`233`	`finally`
`231`	`234`	`{`
Original file line number	Diff line number	Diff line change
`@@ -168,7 +168,11 @@ public abstract Task DoWorkAsync(`
`168`	`168`	`protected virtual Task OnExceptionAsync(`
`169`	`169`	`Exception exception,`
`170`	`170`	`CancellationToken stoppingToken)`
`171`		`- => Task.CompletedTask;`
	`171`	`+ {`
	`172`	`+ logger.LogBackgroundServiceUnhandledException(exception, ServiceName);`
	`173`	`+`
	`174`	`+ return Task.CompletedTask;`
	`175`	`+ }`
`172`	`176`
`173`	`177`	`/// <inheritdoc />`
`174`	`178`	`[SuppressMessage("Design", "CA1031:Do not catch general exception types", Justification = "OK - by design.")]`
`@@ -204,8 +208,7 @@ await Task`
`204`	`208`
`205`	`209`	`logger.LogBackgroundServiceRetrying(`
`206`	`210`	`ServiceName,`
`207`		`- ServiceOptions.RepeatIntervalSeconds,`
`208`		`- ex);`
	`211`	`+ ServiceOptions.RepeatIntervalSeconds);`
`209`	`212`	`}`
`210`	`213`
`211`	`214`	`await Task`
`@@ -219,7 +222,7 @@ await Task`
`219`	`222`	`}`
`220`	`223`	`catch (Exception ex)`
`221`	`224`	`{`
`222`		`- logger.LogBackgroundServiceUnhandledException(ServiceName, ex);`
	`225`	`+ logger.LogBackgroundServiceUnhandledException(ex, ServiceName);`
`223`	`226`	`}`
`224`	`227`	`finally`
`225`	`228`	`{`