Fix: Better SeriLog Override

Author: AnnaSasDev

src/CodeOfChaos.Extensions.AspNetCore/LoggingOverrideExtensions.cs

@@ -3,10 +3,10 @@
 // ---------------------------------------------------------------------------------------------------------------------
 using Microsoft.AspNetCore.Builder;
 using Microsoft.Extensions.DependencyInjection;
-using Microsoft.Extensions.Hosting;
 using Microsoft.Extensions.Logging;
 using Serilog;
 using Serilog.Core;
+using ILogger=Serilog.ILogger;
 
 namespace CodeOfChaos.Extensions.AspNetCore;
 // ---------------------------------------------------------------------------------------------------------------------
@@ -33,24 +33,12 @@ public static WebApplicationBuilder OverrideLoggingWithSerilog(
         configure?.Invoke(loggerConfig);
 
         Log.Logger = loggerConfig.CreateLogger();
-
-
+        
         // Clear default providers and setup Serilog
         builder.Logging.ClearProviders();
-        builder.Logging.AddSerilog(Log.Logger);
-        builder.Services.AddSingleton(Log.Logger);
-
-        builder.Services.AddHostedService<ApplicationShutdownLoggerCleanup>(); // Ensure cleanup
         builder.Services.AddLogging(loggingBuilder => loggingBuilder.AddSerilog(Log.Logger));
-
+        builder.Services.AddSingleton(Log.Logger);
+        
         return builder;
     }
-
-    public class ApplicationShutdownLoggerCleanup : IHostedService {
-        public Task StartAsync(CancellationToken cancellationToken) => Task.CompletedTask;
-
-        public async Task StopAsync(CancellationToken cancellationToken) {
-            await Log.CloseAndFlushAsync();
-        }
-    }
 }

src/CodeOfChaos.Extensions.Serilog/ConsoleFormats.cs

@@ -8,5 +8,5 @@ namespace CodeOfChaos.Extensions.Serilog;
 public static class ConsoleOutputTemplates {
     public const string Default = "[{Timestamp:HH:mm:ss} {Level:u3}] {Message:lj}{NewLine}{Exception}";
     public const string DefaultShort = "[{Timestamp:HH:mm:ss} {Level:u3}] {Message:lj}{NewLine}";
-    public const string AnnaSasDevServer = "[{Timestamp:HH:mm:ss} {Level:u3} {Section,-8}] {Message:lj}{NewLine}";
+    public const string AnnaSasDevServer = "[{Timestamp:HH:mm:ss} {Level:u3} {Section,-12}] {Message:lj}{NewLine}";
 }

src/CodeOfChaos.Extensions.Serilog/Enrichers/SectionEnricher.cs

@@ -0,0 +1,17 @@
+// ---------------------------------------------------------------------------------------------------------------------
+// Imports
+// ---------------------------------------------------------------------------------------------------------------------
+using Serilog.Core;
+using Serilog.Events;
+
+namespace CodeOfChaos.Extensions.Serilog.Enrichers;
+// ---------------------------------------------------------------------------------------------------------------------
+// Code
+// ---------------------------------------------------------------------------------------------------------------------
+// Define your section here (e.g., "auth" or "db")
+public class SectionEnricher(string sectionName) : ILogEventEnricher {
+    public void Enrich(LogEvent logEvent, ILogEventPropertyFactory propertyFactory) {
+        LogEventProperty sectionProperty = propertyFactory.CreateProperty("Section", sectionName);
+        logEvent.AddPropertyIfAbsent(sectionProperty);
+    }
+}

src/CodeOfChaos.Extensions.Serilog/LoggerConfigurationExtensions.cs

@@ -3,6 +3,7 @@
 // ---------------------------------------------------------------------------------------------------------------------
 using CodeOfChaos.Extensions.Serilog;
 using CodeOfChaos.Extensions.Serilog.Enrichers;
+using Serilog.Configuration;
 using Serilog.Core;
 using Serilog.Events;
 using Serilog.Sinks.SystemConsole.Themes;
@@ -43,12 +44,16 @@ public static LoggerConfiguration WithPaddedSectionEnricher(this LoggerConfigura
 
     public static LoggerConfiguration WithTruncateSourceContextEnricher(this LoggerConfiguration loggerConfiguration, int maxLength = 8)
         => loggerConfiguration.Enrich.With(new TruncateSourceContextEnricher(maxLength));
+    
+    public static LoggerConfiguration WithSectionEnricher(this LoggerConfiguration loggerConfiguration, string? defaultSection = null) 
+        => loggerConfiguration.Enrich.With(new SectionEnricher(defaultSection ?? string.Empty));
 
     // -----------------------------------------------------------------------------------------------------------------
     // Opinionated configurations
     // -----------------------------------------------------------------------------------------------------------------
     public static LoggerConfiguration AsAnnaSasDevServerConsole(this LoggerConfiguration loggerConfiguration) =>
         loggerConfiguration
+            .WithSectionEnricher()
             .WithPaddedSectionEnricher(maxLength: 12)
             .WriteToAsyncConsole(
                 outputTemplate: ConsoleOutputTemplates.AnnaSasDevServer,

tests/Tests.CodeOfChaos.Extensions.AspNetCore/LoggingOverrideExtensionTests.cs

@@ -76,49 +76,6 @@ await Assert.That(logger)
             .IsNotNull()
             .Because("Serilog should replace the existing providers when overriding logging.");
     }
-
-    [Test]
-    public async Task OverrideLoggingWithSerilog_ShouldRegisterApplicationShutdownCleanupService() {
-        // Arrange
-        WebApplicationBuilder builder = WebApplication.CreateBuilder();
-
-        // Act
-        builder.OverrideLoggingWithSerilog();
-
-        // Assert
-        ServiceProvider serviceProvider = builder.Services.BuildServiceProvider();
-        IEnumerable<IHostedService> hostedServices = serviceProvider.GetServices<IHostedService>().ToArray();
-        await Assert.That(hostedServices).IsNotNull().Because("IHostedService collection should be available.");
-        await Assert.That(hostedServices.Any(service => service is LoggingOverrideExtensions.ApplicationShutdownLoggerCleanup)).IsTrue().Because("There should be at least one hosted service.");
-    }
-
-    [Test]
-    public async Task ApplicationShutdownLoggerCleanup_ShouldFlushLogsOnStop() {
-        // Arrange
-        var cleanupService = new LoggingOverrideExtensions.ApplicationShutdownLoggerCleanup();
-        bool flushCalled = false;
-
-        // Replace the static Serilog Logger with a mock logger
-        ILogger originalLogger = Log.Logger;
-        Log.Logger = new LoggerConfiguration()
-            .WriteTo.Sink(new DelegatingSink(_ => flushCalled = true))// Custom sink to detect flush calls
-            .CreateLogger();
-
-
-        // Act
-        Log.Logger.Information("Test log message");// Log a message to verify it is flushed
-
-        await cleanupService.StartAsync(CancellationToken.None);
-        await cleanupService.StopAsync(CancellationToken.None);
-
-        // Assert
-        await Assert.That(flushCalled)
-            .IsTrue()
-            .Because("Log.CloseAndFlush should be triggered when the application stops.");
-
-        // Just to be sure
-        Log.Logger = originalLogger;// Restore the original logger
-    }
 }
 
 // ---------------------------------------------------------------------------------------------------------------------