Conditionally use compact json formatting for console sink

Author: Tsingis

src/Api/Api.csproj

@@ -16,6 +16,7 @@
     <PackageReference Include="Serilog" />
     <PackageReference Include="Serilog.Exceptions" />
     <PackageReference Include="Serilog.Extensions.Hosting" />
+    <PackageReference Include="Serilog.Formatting.Compact" />
     <PackageReference Include="Serilog.Settings.Configuration" />
     <PackageReference Include="Serilog.Sinks.ApplicationInsights" />
     <PackageReference Include="Serilog.Sinks.Async" />

src/Api/Program.cs

@@ -6,6 +6,9 @@
 using Microsoft.ApplicationInsights.Extensibility;
 using Serilog;
 using Serilog.Exceptions;
+using Serilog.Formatting;
+using Serilog.Formatting.Compact;
+using Serilog.Formatting.Display;
 
 DotNetEnv.Env.TraversePath().Load();
 
@@ -39,11 +42,18 @@
 
     builder.Host.UseSerilog((ctx, services, loggerConfig) =>
     {
+        ITextFormatter formatter = new MessageTemplateTextFormatter(outputTemplate: logFormat, formatProvider: CultureInfo.InvariantCulture);
+
+        if (EnvVarAccessors.UseJsonFormatting)
+        {
+            formatter = new CompactJsonFormatter();
+        }
+
         loggerConfig
             .ReadFrom.Configuration(ctx.Configuration)
             .Enrich.FromLogContext()
             .Enrich.WithExceptionDetails()
-            .WriteTo.Async(x => x.Console(outputTemplate: logFormat, formatProvider: CultureInfo.InvariantCulture));
+            .WriteTo.Async(x => x.Console(formatter));
 
         if (ctx.HostingEnvironment.IsProduction())
         {

src/Api/packages.lock.json

@@ -130,6 +130,15 @@
           "Serilog.Extensions.Logging": "9.0.0"
         }
       },
+      "Serilog.Formatting.Compact": {
+        "type": "Direct",
+        "requested": "[3.0.0, )",
+        "resolved": "3.0.0",
+        "contentHash": "wQsv14w9cqlfB5FX2MZpNsTawckN4a8dryuNGbebB/3Nh1pXnROHZov3swtu3Nj5oNG7Ba+xdu7Et/ulAUPanQ==",
+        "dependencies": {
+          "Serilog": "4.0.0"
+        }
+      },
       "Serilog.Settings.Configuration": {
         "type": "Direct",
         "requested": "[9.0.0, )",

src/Common/EnvVarsHelper.cs

@@ -3,6 +3,7 @@ namespace Common;
 public static class EnvVarKeys
 {
     public const string KeyVaultName = "KEY_VAULT_NAME";
+    public const string UseJsonFormatting = "USE_JSON_FORMATTING";
     public const string UseOutputCache = "USE_OUTPUT_CACHE";
     public const string MarketClientUrl = "MARKET_CLIENT_URL";
     public const string UseMocking = "USE_MOCKING";
@@ -12,4 +13,7 @@ public static class EnvVarAccessors
 {
     public static bool UseMocking =>
         bool.TryParse(Environment.GetEnvironmentVariable(EnvVarKeys.UseMocking), out var value) && value;
+
+    public static bool UseJsonFormatting =>
+        bool.TryParse(Environment.GetEnvironmentVariable(EnvVarKeys.UseJsonFormatting), out var value) && value;
 }

src/Directory.Packages.props

@@ -19,6 +19,7 @@
     <PackageVersion Include="Serilog" Version="4.3.0" />
     <PackageVersion Include="Serilog.Exceptions" Version="8.4.0" />
     <PackageVersion Include="Serilog.Extensions.Hosting" Version="9.0.0" />
+    <PackageVersion Include="Serilog.Formatting.Compact" Version="3.0.0" />
     <PackageVersion Include="Serilog.Settings.Configuration" Version="9.0.0" />
     <PackageVersion Include="Serilog.Sinks.ApplicationInsights" Version="4.0.0" />
     <PackageVersion Include="Serilog.Sinks.Async" Version="2.1.0" />

tests/ArchitectureTests/packages.lock.json

@@ -852,6 +852,14 @@
           "Serilog": "4.2.0"
         }
       },
+      "Serilog.Formatting.Compact": {
+        "type": "Transitive",
+        "resolved": "3.0.0",
+        "contentHash": "wQsv14w9cqlfB5FX2MZpNsTawckN4a8dryuNGbebB/3Nh1pXnROHZov3swtu3Nj5oNG7Ba+xdu7Et/ulAUPanQ==",
+        "dependencies": {
+          "Serilog": "4.0.0"
+        }
+      },
       "Serilog.Settings.Configuration": {
         "type": "Transitive",
         "resolved": "9.0.0",
@@ -1798,6 +1806,7 @@
           "Serilog": "[4.3.0, )",
           "Serilog.Exceptions": "[8.4.0, )",
           "Serilog.Extensions.Hosting": "[9.0.0, )",
+          "Serilog.Formatting.Compact": "[3.0.0, )",
           "Serilog.Settings.Configuration": "[9.0.0, )",
           "Serilog.Sinks.ApplicationInsights": "[4.0.0, )",
           "Serilog.Sinks.Async": "[2.1.0, )",

tests/IntegrationTests/packages.lock.json

@@ -1043,6 +1043,14 @@
           "Serilog": "4.2.0"
         }
       },
+      "Serilog.Formatting.Compact": {
+        "type": "Transitive",
+        "resolved": "3.0.0",
+        "contentHash": "wQsv14w9cqlfB5FX2MZpNsTawckN4a8dryuNGbebB/3Nh1pXnROHZov3swtu3Nj5oNG7Ba+xdu7Et/ulAUPanQ==",
+        "dependencies": {
+          "Serilog": "4.0.0"
+        }
+      },
       "Serilog.Settings.Configuration": {
         "type": "Transitive",
         "resolved": "9.0.0",
@@ -2020,6 +2028,7 @@
           "Serilog": "[4.3.0, )",
           "Serilog.Exceptions": "[8.4.0, )",
           "Serilog.Extensions.Hosting": "[9.0.0, )",
+          "Serilog.Formatting.Compact": "[3.0.0, )",
           "Serilog.Settings.Configuration": "[9.0.0, )",
           "Serilog.Sinks.ApplicationInsights": "[4.0.0, )",
           "Serilog.Sinks.Async": "[2.1.0, )",