Merge pull request #43 from PandaTechAM/development

HaikAsatryan · web-flow · commit ae754b1841a7 · 2025-03-15T14:29:25.000+04:00
compact json support
diff --git a/Readme.md b/Readme.md
@@ -18,7 +18,7 @@ By leveraging this shared kernel, we aim to:
 This package currently supports:
 
 - **OpenAPI Configuration** with SwaggerUI and Scalar.
-- **Logging** with Serilog (including ECS or Loki JSON file output, plus automatic log cleanup).
+- **Logging** with Serilog (including ECS, Loki and compact JSON file output, plus automatic log cleanup).
 - **MediatR and FluentValidation** configurations.
 - **Cors Configuration** with easy configuration options.
 - **Resilience Pipelines** for `HttpClient` operations.
@@ -270,7 +270,8 @@ Based on the above configuration, the UI will be accessible at the following URL
 - **Log Backend Option** Choose between:
     - `LogBackend.None` (disables file logging completely),
     - `LogBackend.ElasticSearch` (ECS formatter to file), or
-    - `LogBackend.Loki` (Loki formatter to file).
+    - `LogBackend.Loki` (Loki formatter to file), or
+    - `LogBackend.CompactJson` (compact JSON format to file).
 - **Environment-Specific Configuration:**
     - **Local:** Logs to console.
     - **Production:** Logs to file (in ECS or Loki format depending on the backend).
@@ -289,7 +290,7 @@ Based on the above configuration, the UI will be accessible at the following URL
 
 Use the `AddSerilog` extension when building your `WebApplicationBuilder`. You can specify:
 
-- `logBackend`: One of `None`, `ElasticSearch` (ECS file format), or `Loki` (Loki JSON file format).
+- `logBackend`: One of `None`, `ElasticSearch` (ECS file format), `Loki` (Loki JSON file format) or `CompactJson`.
 - `daysToRetain`: Number of days to keep log files. Older files are automatically removed by the background hosted
   service.
 
diff --git a/src/SharedKernel/Extensions/ConfigurationExtensions.cs b/src/SharedKernel/Extensions/ConfigurationExtensions.cs
@@ -8,8 +8,6 @@ internal static class ConfigurationExtensions
    private const string PersistentConfigurationPath = "PersistentStorage";
    private const string RepositoryNameConfigurationPath = "RepositoryName";
    private const string TimeZoneConfigurationPath = "DefaultTimeZone";
-   private const string RedisConfigurationPath = "Redis";
-   private const string LokiConfigurationPath = "Loki";
 
    internal static string GetAllowedCorsOrigins(this IConfiguration configuration)
    {
@@ -54,27 +52,4 @@ public static string GetDefaultTimeZone(this IConfiguration configuration)
 
       return timeZone;
    }
-
-   public static string GetRedisUrl(this IConfiguration configuration)
-   {
-      var redisConnectionString = configuration.GetConnectionString(RedisConfigurationPath);
-      if (redisConnectionString is null)
-      {
-         throw new InvalidOperationException("Redis connection string is not configured.");
-      }
-
-      return redisConnectionString;
-   }
-
-   public static string GetLokiUrl(this IConfiguration configuration)
-   {
-      var lokiUrl = configuration.GetConnectionString(LokiConfigurationPath);
-      
-      if (lokiUrl is null)
-      {
-         throw new InvalidOperationException("Loki URL is not configured.");
-      }
-
-      return lokiUrl;
-   }
 }
diff --git a/src/SharedKernel/Logging/LogBackend.cs b/src/SharedKernel/Logging/LogBackend.cs
@@ -4,5 +4,6 @@ public enum LogBackend
 {
    None = 1,
    ElasticSearch = 2,
-   Loki = 3
+   Loki = 3,
+   CompactJson = 4
 }
diff --git a/src/SharedKernel/Logging/SerilogExtensions.cs b/src/SharedKernel/Logging/SerilogExtensions.cs
@@ -1,10 +1,13 @@
-﻿using Elastic.CommonSchema.Serilog;
+﻿using System.Diagnostics;
+using Elastic.CommonSchema.Serilog;
 using Microsoft.AspNetCore.Builder;
 using Microsoft.Extensions.DependencyInjection;
 using Microsoft.Extensions.Hosting;
 using Microsoft.Extensions.Logging;
 using Serilog;
 using Serilog.Events;
+using Serilog.Formatting;
+using Serilog.Formatting.Compact;
 using Serilog.Sinks.Grafana.Loki;
 using SharedKernel.Extensions;
 
@@ -70,46 +73,31 @@ private static LoggerConfiguration ConfigureDestinations(this LoggerConfiguratio
          loggerConfig.WriteTo.Async(a => a.Console());
       }
 
-      switch (logBackend)
+      if (logBackend != LogBackend.None)
       {
-         case LogBackend.None:
-            break;
-
-         case LogBackend.ElasticSearch:
-            loggerConfig.WriteToEcsFileAsync(builder);
-            break;
-
-         case LogBackend.Loki:
-            loggerConfig.WriteToLokiAsync(builder);
-            break;
-         default:
-            throw new ArgumentOutOfRangeException(nameof(logBackend), logBackend, null);
+         loggerConfig.WriteToFileAsync(builder, logBackend);
       }
 
       return loggerConfig;
    }
 
-   private static LoggerConfiguration WriteToEcsFileAsync(this LoggerConfiguration loggerConfig,
-      WebApplicationBuilder builder)
+   private static LoggerConfiguration WriteToFileAsync(this LoggerConfiguration loggerConfig,
+      WebApplicationBuilder builder,
+      LogBackend logBackend)
    {
-      return loggerConfig.WriteTo.Async(a =>
-         a.File(
-            new EcsTextFormatter(),
-            builder.GetLogsPath(),
-            rollingInterval: RollingInterval.Day
-         )
-      );
-   }
+      // Choose the formatter based on the selected log backend
+      ITextFormatter formatter = logBackend switch
+      {
+         LogBackend.ElasticSearch => new EcsTextFormatter(),
+         LogBackend.Loki => new LokiJsonTextFormatter(),
+         LogBackend.CompactJson => new CompactJsonFormatter(),
+         _ => new CompactJsonFormatter() // Fallback
+      };
 
-   private static LoggerConfiguration WriteToLokiAsync(this LoggerConfiguration loggerConfig,
-      WebApplicationBuilder builder)
-   {
       return loggerConfig.WriteTo.Async(a =>
-         a.File(
-            new LokiJsonTextFormatter(),
+         a.File(formatter,
             builder.GetLogsPath(),
-            rollingInterval: RollingInterval.Day
-         )
+            rollingInterval: RollingInterval.Day)
       );
    }
 
@@ -155,9 +143,7 @@ private static bool ShouldExcludeSwaggerLogs(this LogEvent logEvent)
    private static bool ShouldExcludeMassTransitHealthCheckLogs(this LogEvent logEvent)
    {
       var message = logEvent.RenderMessage();
-      return message.Contains("Health check masstransit-bus", StringComparison.OrdinalIgnoreCase)
-             && message.Contains("Unhealthy", StringComparison.OrdinalIgnoreCase)
-             && message.Contains("Not ready: not started", StringComparison.OrdinalIgnoreCase);
+      return message.StartsWith("Health check masstransit-bus with status Unhealthy completed after");
    }
 
    #endregion
diff --git a/src/SharedKernel/Logging/StartupLoggerExtensions.cs b/src/SharedKernel/Logging/StartupLoggerExtensions.cs
@@ -13,7 +13,7 @@ public static WebApplicationBuilder LogStartAttempt(this WebApplicationBuilder b
       var now = DateTime.UtcNow.ToString("yyyy-MM-dd HH:mm:ss.fff", CultureInfo.InvariantCulture);
 
       Console.ForegroundColor = ConsoleColor.DarkYellow;
-      Console.WriteLine("============================================================");
+      Console.WriteLine("===============================================================");
       Console.ResetColor();
 
       Console.WriteLine("APPLICATION START ATTEMPT");
@@ -24,7 +24,7 @@ public static WebApplicationBuilder LogStartAttempt(this WebApplicationBuilder b
       Console.WriteLine($"Machine Name : {Environment.MachineName}");
 
       Console.ForegroundColor = ConsoleColor.DarkYellow;
-      Console.WriteLine("============================================================");
+      Console.WriteLine("===============================================================");
       Console.ResetColor();
 
       return builder;
@@ -37,15 +37,15 @@ public static WebApplication LogStartSuccess(this WebApplication app)
       var now = DateTime.UtcNow.ToString("yyyy-MM-dd HH:mm:ss.fff", CultureInfo.InvariantCulture);
 
       Console.ForegroundColor = ConsoleColor.DarkGreen;
-      Console.WriteLine("\n============================================================");
+      Console.WriteLine("\n===============================================================");
       Console.ResetColor();
 
       Console.WriteLine("APPLICATION START SUCCESS");
       Console.WriteLine($"Timestamp         : {now}");
       Console.WriteLine($"Initialization    : {deltaInSeconds} seconds");
 
       Console.ForegroundColor = ConsoleColor.DarkGreen;
-      Console.WriteLine("============================================================");
+      Console.WriteLine("===============================================================");
       Console.ResetColor();
 
       return app;
@@ -57,15 +57,15 @@ public static WebApplicationBuilder LogModuleRegistrationSuccess(
       var now = DateTime.UtcNow.ToString("yyyy-MM-dd HH:mm:ss.fff", CultureInfo.InvariantCulture);
 
       Console.ForegroundColor = ConsoleColor.DarkYellow;
-      Console.WriteLine("\n============================================================");
+      Console.WriteLine("\n===============================================================");
       Console.ResetColor();
 
       Console.WriteLine("MODULE REGISTRATION SUCCESS");
       Console.WriteLine($"Timestamp   : {now}");
       Console.WriteLine($"Module Name : {moduleName}");
 
       Console.ForegroundColor = ConsoleColor.DarkYellow;
-      Console.WriteLine("============================================================");
+      Console.WriteLine("===============================================================");
       Console.ResetColor();
 
       return builder;
@@ -76,15 +76,15 @@ public static WebApplication LogModuleUseSuccess(this WebApplication app, string
       var now = DateTime.UtcNow.ToString("yyyy-MM-dd HH:mm:ss.fff", CultureInfo.InvariantCulture);
 
       Console.ForegroundColor = ConsoleColor.DarkYellow;
-      Console.WriteLine("\n============================================================");
+      Console.WriteLine("\n===============================================================");
       Console.ResetColor();
 
       Console.WriteLine("MODULE USE SUCCESS");
       Console.WriteLine($"Timestamp   : {now}");
       Console.WriteLine($"Module Name : {moduleName}");
 
       Console.ForegroundColor = ConsoleColor.DarkYellow;
-      Console.WriteLine("============================================================");
+      Console.WriteLine("===============================================================");
       Console.ResetColor();
 
       return app;
diff --git a/src/SharedKernel/SharedKernel.csproj b/src/SharedKernel/SharedKernel.csproj
@@ -8,13 +8,13 @@
         <PackageReadmeFile>Readme.md</PackageReadmeFile>
         <Authors>Pandatech</Authors>
         <Copyright>MIT</Copyright>
-        <Version>1.3.0</Version>
+        <Version>1.3.1</Version>
         <PackageId>Pandatech.SharedKernel</PackageId>
         <Title>Pandatech Shared Kernel Library</Title>
         <PackageTags>Pandatech, shared kernel, library, OpenAPI, Swagger, utilities, scalar</PackageTags>
         <Description>Pandatech.SharedKernel provides centralized configurations, utilities, and extensions for ASP.NET Core projects. For more information refere to readme.md document.</Description>
         <RepositoryUrl>https://github.com/PandaTechAM/be-lib-sharedkernel</RepositoryUrl>
-        <PackageReleaseNotes>Logging upgrade</PackageReleaseNotes>
+        <PackageReleaseNotes>Added compact json support to log backend</PackageReleaseNotes>
     </PropertyGroup>
 
     <ItemGroup>

Original file line number	Diff line number	Diff line change
`@@ -4,5 +4,6 @@ public enum LogBackend`
`4`	`4`	`{`
`5`	`5`	`None = 1,`
`6`	`6`	`ElasticSearch = 2,`
`7`		`- Loki = 3`
	`7`	`+ Loki = 3,`
	`8`	`+ CompactJson = 4`
`8`	`9`	`}`