Merge pull request #44 from PandaTechAM/development

logging options added

Author: HaikAsatryan

Readme.md

@@ -297,15 +297,30 @@ Use the `AddSerilog` extension when building your `WebApplicationBuilder`. You c
 In your middleware pipeline, add the request and response logging middleware:
 
 ```csharp
-var builder = WebApplication.CreateBuilder(args);
-
-// Example: logs in Loki JSON format, keep logs for 14 days. (default = 7 days)
-builder.AddSerilog(logBackend: LogBackend.Loki, daysToRetain: 14);
-
-var app = builder.Build();
-app.UseRequestLogging();
+// 1) Synchronous logging with 7-day retention (default). 
+builder.AddSerilog(LogBackend.Loki);
+
+// 2) Asynchronous logging with 14-day retention and extra properties.
+//    Suitable for high-load (~1000+ RPS per pod) scenarios where slight risk of log loss is acceptable 
+//    in exchange for better performance.
+builder.AddSerilog(
+    logBackend: LogBackend.Loki,
+    logAdditionalProperties: new Dictionary<string, string>
+    {
+        ["ServiceName"] = "MyApp",
+        ["Environment"] = "Staging"
+    },
+    daysToRetain: 14,
+    asyncSinks: true
+);
 ```
 
+>- **Asynchronous Sinks (asyncSinks: true):** Recommended for very high-traffic environments (e.g., 1000+ requests per
+  second per pod) where performance is critical and the possibility of losing a small amount of log data (e.g., on
+  sudden process termination) is acceptable. <br><br>
+>- **Synchronous Sinks (asyncSinks: false):** Recommended if you can handle up to ~1000 requests per second per pod and must
+  retain every log entry without fail. This might incur slightly more overhead but ensures maximum reliability.
+
 Configure minimal Serilog settings in your environment JSON files as needed, for example in
 `appsettings.{Environment}.json`:
 
@@ -342,7 +357,7 @@ hosted service runs periodically to delete log files older than the specified re
     ```csharp
     builder.AddSerilog(
         logBackend: LogBackend.Loki,
-        valueByNameRepeatedLog: new Dictionary<string, string>
+        logAdditionalProperties: new Dictionary<string, string>
         {
             {"ServiceName", "MyService"},
             {"ServiceVersion", "1.0.0"}

src/SharedKernel/Logging/SerilogExtensions.cs

@@ -1,5 +1,4 @@
-using System.Diagnostics;
-using Elastic.CommonSchema.Serilog;
+using Elastic.CommonSchema.Serilog;
 using Microsoft.AspNetCore.Builder;
 using Microsoft.Extensions.DependencyInjection;
 using Microsoft.Extensions.Hosting;
@@ -17,22 +16,23 @@ public static class SerilogExtensions
 {
    public static WebApplicationBuilder AddSerilog(this WebApplicationBuilder builder,
       LogBackend logBackend,
+      Dictionary<string, string>? logAdditionalProperties = null,
       int daysToRetain = 7,
-      Dictionary<string, string>? valueByNameRepeatedLog = null)
+      bool asyncSinks = false)
    {
       builder.Logging.ClearProviders();
 
       var loggerConfig = new LoggerConfiguration()
                          .FilterOutUnwantedLogs()
                          .Enrich
                          .FromLogContext()
-                         .ConfigureDestinations(builder, logBackend)
+                         .ConfigureDestinations(builder, logBackend, asyncSinks)
                          .ReadFrom
                          .Configuration(builder.Configuration);
 
-      if (valueByNameRepeatedLog is not null)
+      if (logAdditionalProperties is not null)
       {
-         foreach (var (key, value) in valueByNameRepeatedLog)
+         foreach (var (key, value) in logAdditionalProperties)
          {
             loggerConfig.Enrich.WithProperty(key, value);
          }
@@ -60,30 +60,47 @@ public static WebApplicationBuilder AddSerilog(this WebApplicationBuilder builde
 
    private static LoggerConfiguration ConfigureDestinations(this LoggerConfiguration loggerConfig,
       WebApplicationBuilder builder,
-      LogBackend logBackend)
+      LogBackend logBackend,
+      bool asyncSinks)
    {
       if (builder.Environment.IsLocal())
       {
-         loggerConfig.WriteTo.Async(a => a.Console());
+         loggerConfig.WriteToConsole(asyncSinks);
+
          return loggerConfig;
       }
 
       if (!builder.Environment.IsProduction())
       {
-         loggerConfig.WriteTo.Async(a => a.Console());
+         loggerConfig.WriteToConsole(asyncSinks);
       }
 
       if (logBackend != LogBackend.None)
       {
-         loggerConfig.WriteToFileAsync(builder, logBackend);
+         loggerConfig.WriteToFile(builder, logBackend, asyncSinks);
       }
 
       return loggerConfig;
    }
 
-   private static LoggerConfiguration WriteToFileAsync(this LoggerConfiguration loggerConfig,
+   private static LoggerConfiguration WriteToConsole(this LoggerConfiguration loggerConfig, bool useAsync)
+   {
+      if (useAsync)
+      {
+         loggerConfig.WriteTo.Async(a => a.Console());
+      }
+      else
+      {
+         loggerConfig.WriteTo.Console();
+      }
+
+      return loggerConfig;
+   }
+
+   private static LoggerConfiguration WriteToFile(this LoggerConfiguration loggerConfig,
       WebApplicationBuilder builder,
-      LogBackend logBackend)
+      LogBackend logBackend,
+      bool useAsync)
    {
       // Choose the formatter based on the selected log backend
       ITextFormatter formatter = logBackend switch
@@ -94,11 +111,18 @@ private static LoggerConfiguration WriteToFileAsync(this LoggerConfiguration log
          _ => new CompactJsonFormatter() // Fallback
       };
 
-      return loggerConfig.WriteTo.Async(a =>
-         a.File(formatter,
-            builder.GetLogsPath(),
-            rollingInterval: RollingInterval.Day)
-      );
+      var logPath = builder.GetLogsPath();
+
+      if (useAsync)
+      {
+         return loggerConfig.WriteTo.Async(a =>
+            a.File(formatter,
+               logPath,
+               rollingInterval: RollingInterval.Day)
+         );
+      }
+
+      return loggerConfig.WriteTo.File(formatter, logPath, rollingInterval: RollingInterval.Day);
    }
 
    #region Filtering

src/SharedKernel/SharedKernel.csproj

@@ -8,13 +8,13 @@
         <PackageReadmeFile>Readme.md</PackageReadmeFile>
         <Authors>Pandatech</Authors>
         <Copyright>MIT</Copyright>
-        <Version>1.3.1</Version>
+        <Version>1.3.2</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>Added compact json support to log backend</PackageReleaseNotes>
+        <PackageReleaseNotes>Made sync and async optional in logging</PackageReleaseNotes>
     </PropertyGroup>
 
     <ItemGroup>