fix(worker): Improve logging and handle null arguments in Worker class

Author: hangy

example/ServiceDefaults/Extensions.cs

@@ -20,6 +20,8 @@ public static class Extensions
 
     public static TBuilder AddServiceDefaults<TBuilder>(this TBuilder builder) where TBuilder : IHostApplicationBuilder
     {
+        ArgumentNullException.ThrowIfNull(builder);
+
         builder.ConfigureOpenTelemetry();
 
         builder.AddDefaultHealthChecks();
@@ -46,6 +48,8 @@ public static TBuilder AddServiceDefaults<TBuilder>(this TBuilder builder) where
 
     public static TBuilder ConfigureOpenTelemetry<TBuilder>(this TBuilder builder) where TBuilder : IHostApplicationBuilder
     {
+        ArgumentNullException.ThrowIfNull(builder);
+
         builder.Logging.AddOpenTelemetry(logging =>
         {
             logging.IncludeFormattedMessage = true;
@@ -67,8 +71,8 @@ public static TBuilder ConfigureOpenTelemetry<TBuilder>(this TBuilder builder) w
                     .AddAspNetCoreInstrumentation(tracing =>
                         // Exclude health check requests from tracing
                         tracing.Filter = context =>
-                            !context.Request.Path.StartsWithSegments(HealthEndpointPath)
-                            && !context.Request.Path.StartsWithSegments(AlivenessEndpointPath)
+                            !context.Request.Path.StartsWithSegments(HealthEndpointPath, StringComparison.OrdinalIgnoreCase)
+                            && !context.Request.Path.StartsWithSegments(AlivenessEndpointPath, StringComparison.OrdinalIgnoreCase)
                     )
                     // Uncomment the following line to enable gRPC instrumentation (requires the OpenTelemetry.Instrumentation.GrpcNetClient package)
                     //.AddGrpcClientInstrumentation()
@@ -102,6 +106,8 @@ private static TBuilder AddOpenTelemetryExporters<TBuilder>(this TBuilder builde
 
     public static TBuilder AddDefaultHealthChecks<TBuilder>(this TBuilder builder) where TBuilder : IHostApplicationBuilder
     {
+        ArgumentNullException.ThrowIfNull(builder);
+
         builder.Services.AddHealthChecks()
             // Add a default liveness check to ensure app is responsive
             .AddCheck("self", () => HealthCheckResult.Healthy(), ["live"]);
@@ -111,6 +117,8 @@ public static TBuilder AddDefaultHealthChecks<TBuilder>(this TBuilder builder) w
 
     public static WebApplication MapDefaultEndpoints(this WebApplication app)
     {
+        ArgumentNullException.ThrowIfNull(app);
+
         // Adding health checks endpoints to applications in non-development environments has security implications.
         // See https://aka.ms/dotnet/aspire/healthchecks for details before enabling these endpoints in non-development environments.
         if (app.Environment.IsDevelopment())

example/WorkerService/Worker.cs

@@ -3,7 +3,9 @@
 
 namespace WorkerService;
 
-internal class Worker : BackgroundService
+#pragma warning disable CA1812 // False-positive: Class is instantiated by the generic host
+internal sealed partial class Worker : BackgroundService
+#pragma warning restore CA1812 // False-positive: Class is instantiated by the generic host
 {
     private readonly ILogger<Worker> _logger;
 
@@ -27,21 +29,46 @@ protected override async Task ExecuteAsync(CancellationToken stoppingToken)
                 {
                     using IServiceScope scope = _serviceProvider.CreateScope();
                     ILdapConnection ldapConnection = scope.ServiceProvider.GetRequiredService<ILdapConnection>();
-                    _logger.LogInformation("Worker running at: {time}", DateTimeOffset.Now);
+                    Log.WorkerRunning(_logger, DateTimeOffset.Now);
                     DirectoryResponse r = ldapConnection.SendRequest(new SearchRequest(
                         "dc=example,dc=com",
                         "(objectClass=*)",
                         SearchScope.Subtree,
                         "cn", "sn", "mail"));
-                    _logger.LogInformation("LDAP response: {response}", r);
+                    Log.LdapResponse(_logger, r);
                 }
+#pragma warning disable CA1031 // Catching general exception to log it
                 catch (Exception ex)
+#pragma warning restore CA1031 // Catching general exception to log it
                 {
-                    _logger.LogError(ex, "An error occurred while connecting to LDAP");
+                    Log.LdapError(_logger, ex);
                 }
             }
 
             await Task.Delay(1000, stoppingToken).ConfigureAwait(false);
         }
     }
+
+    internal static partial class Log
+    {
+        [LoggerMessage(
+            EventId = 0,
+            Level = LogLevel.Information,
+            Message = "Worker running at: {Time}")]
+        public static partial void WorkerRunning(
+            ILogger logger, DateTimeOffset time);
+
+        [LoggerMessage(
+            EventId = 1,
+            Level = LogLevel.Information,
+            Message = "LDAP response: {Response}")]
+        public static partial void LdapResponse(
+            ILogger logger, [LogProperties] DirectoryResponse response);
+
+        [LoggerMessage(
+            EventId = 2,
+            Level = LogLevel.Error,
+            Message = "An error occurred while connecting to LDAP")]
+        public static partial void LdapError(ILogger logger, Exception? exception = null);
+    }
 }