feat: add option to enable elasticsearch formatter for console logs

abhith · Jul 18, 2020 · 8957576 · 8957576
1 parent cb92625
commit 8957576
Show file tree

Hide file tree

Showing 4 changed files with 17 additions and 3 deletions.
diff --git a/Samples/AspNetCoreApp/appsettings.json b/Samples/AspNetCoreApp/appsettings.json
@@ -11,6 +11,7 @@
       }
     },
     "SeqServerUrl": "http://localhost:5341/",
-    "WriteToFile": true
+    "WriteToFile": true,
+    "UseElasticsearchFormatter": false
   }
 }
diff --git a/docs/articles/aspnet-core/logging.md b/docs/articles/aspnet-core/logging.md
@@ -117,6 +117,10 @@ If `SeqServerUrl` is provided (ex. "http://localhost:5341/"), then seq sink gets
 
 To enable logging to file, set it to `true`. Default value is `false`.
 
+### UseElasticsearchFormatter
+
+Set this to `true` if you want your console logs to written in elasticsearch format, useful in case of hosting in k8s where EFK configured to collect logs. Default value is `false`.
+
 We don't need the default **Logging** configuration in the **appsettings.json** anymore, remove it.
 
 ```json

diff --git a/src/Code.Library.AspNetCore/Code.Library.AspNetCore.csproj b/src/Code.Library.AspNetCore/Code.Library.AspNetCore.csproj
@@ -26,6 +26,7 @@ Specific to ASP.NET Core project.</Description>
     <PackageReference Include="Serilog.Enrichers.Environment" Version="2.1.3" />
     <PackageReference Include="Serilog.Exceptions" Version="5.6.0+build.406" />
     <PackageReference Include="Serilog.Formatting.Compact" Version="1.1.0" />
+    <PackageReference Include="Serilog.Formatting.Elasticsearch" Version="8.2.0" />
     <PackageReference Include="Serilog.Settings.Configuration" Version="3.1.0" />
     <PackageReference Include="Serilog.Sinks.ApplicationInsights" Version="3.1.0" />
     <PackageReference Include="Serilog.Sinks.Console" Version="3.1.1" />

diff --git a/src/Code.Library.AspNetCore/Helpers/SerilogHelper.cs b/src/Code.Library.AspNetCore/Helpers/SerilogHelper.cs
@@ -9,6 +9,7 @@
 using System.Collections.Generic;
 using System.Linq;
 using System.Reflection;
+using Serilog.Formatting.Elasticsearch;
 
 namespace Code.Library.AspNetCore.Helpers
 {
@@ -98,11 +99,18 @@ public static class SerilogHelper
                 .Enrich.WithProperty("Assembly", $"{name.Name}")
                 .Enrich.WithProperty("Version", $"{name.Version}")
                 .Destructure.UsingAttributes()
-                .WriteTo.Console()
-
                 // TODO(abhith): find alternative for TelemetryConfiguration.Active
                 .WriteTo.ApplicationInsights(TelemetryConfiguration.Active, TelemetryConverter.Traces);
 
+            if (configuration.GetValue<bool>("Serilog:UseElasticsearchFormatter", false))
+            {
+                loggerConfig.WriteTo.Console(new ElasticsearchJsonFormatter());
+            }
+            else
+            {
+                loggerConfig.WriteTo.Console();
+            }
+
             if (configuration.GetValue<bool>("Serilog:WriteToFile", false))
             {
                 loggerConfig.WriteTo.File(new RenderedCompactJsonFormatter(),