Update readme file.

Author: mesmailpour-spectra

README.md

@@ -1,5 +1,5 @@
 # serilog-enrichers-clientinfo [![NuGet](http://img.shields.io/nuget/v/Serilog.Enrichers.ClientInfo.svg?style=flat)](https://www.nuget.org/packages/Serilog.Enrichers.ClientInfo/)
-Enrich logs with client IP and UserAgent.
+Enrich logs with client IP, Correlation Id and HTTP request headers.
 
 Install the _Serilog.Enrichers.ClientInfo_ [NuGet package](https://www.nuget.org/packages/Serilog.Enrichers.ClientInfo/)
 
@@ -16,7 +16,8 @@ Apply the enricher to your `LoggerConfiguration` in code:
 ```csharp
 Log.Logger = new LoggerConfiguration()
     .Enrich.WithClientIp()
-    .Enrich.WithClientAgent()
+    .Enrich.WithCorrelationId()
+    .Enrich.WithRequestHeader("Header-Name1")
     // ...other configuration...
     .CreateLogger();
 ```
@@ -27,22 +28,30 @@ or in `appsettings.json` file:
   "Serilog": {
     "MinimumLevel": "Debug",
     "Using":  [ "Serilog.Enrichers.ClientInfo" ],
-    "Enrich": [ "WithClientIp", "WithClientAgent"],
+    "Enrich": [ 
+      "WithClientIp", 
+      "WithCorrelationId",
+      { 
+          "Name": "WithRequestHeader", 
+          "Args": { "headerName": "Cache-Control"}
+      }
+    ],
     "WriteTo": [
       { "Name": "Console" }
     ]
   }
 }
 ```
 
-The `WithClientIp()` enricher will add a `ClientIp` property and the `WithClientAgent()` enricher will add a `ClientAgent` property to produced events.
+---
 
-For `ClientIp` enricher you can configure the `X-forwarded-for` header if the proxy server uses a different header to forward IP address.
+For `ClientIp` enricher you can configure the `x-forwarded-for` header if the proxy server uses a different header to forward the IP address.
 ```csharp
 Log.Logger = new LoggerConfiguration()
-    .Enrich.WithClientIp(xForwardHeaderName: "CF-Connecting-IP")
+    .Enrich.WithClientIp(headerName: "CF-Connecting-IP")
     ...
 ```
+or
 ```json
 {
   "Serilog": {
@@ -53,14 +62,81 @@ Log.Logger = new LoggerConfiguration()
       {
         "Name": "WithClientIp",
         "Args": {
-          "xForwardHeaderName": "CF-Connecting-IP"
+          "headerName": "CF-Connecting-IP"
+        }
+      }
+    ],
+  }
+}
+```
+
+For `CorrelationId` enricher you can:
+- Configure the header name and default header name is `x-correlation-id`
+- Set value for correlation id when the header is not available in request header collection and the default value is false
+```csharp
+Log.Logger = new LoggerConfiguration()
+    .Enrich.WithCorrelationId(headerName: "correlation-id", addValueIfHeaderAbsence: true)
+    ...
+```
+or
+```json
+{
+  "Serilog": {
+    "MinimumLevel": "Debug",
+    "Using":  [ "Serilog.Enrichers.ClientInfo" ],
+    "Enrich": [ 
+      "WithClientAgent",
+      {
+        "Name": "WithCorrelationId",
+        "Args": {
+          "headerName": "correlation-id"
+          "addValueIfHeaderAbsence": true
+        }
+      }
+    ],
+  }
+}
+```
+
+You can use multiple `WithRequestHeader` to log different request headers.
+```csharp
+Log.Logger = new LoggerConfiguration()
+    .Enrich.WithRequestHeader(headerName: "header-name-1")
+    .Enrich.WithRequestHeader(headerName: "header-name-2")
+    ...
+```
+or
+```json
+{
+  "Serilog": {
+    "MinimumLevel": "Debug",
+    "Using":  [ "Serilog.Enrichers.ClientInfo" ],
+    "Enrich": [ 
+      {
+        "Name": "WithRequestHeader",
+        "Args": {
+          "headerName": "Cache-Control"
+        }
+      },
+      {
+        "Name": "WithRequestHeader",
+        "Args": {
+          "headerName": "Connection"
         }
       }
     ],
   }
 }
 ```
 
+#### Note
+To include logged headers in `OutputTemplate`, the header name without `-` should be used. For example, if the header name is `Cache-Contol`, you should use `CacheContol`.
+```csharp
+Log.Logger = new LoggerConfiguration()
+    .MinimumLevel.Debug()
+    .WriteTo.Console(outputTemplate: "[{Timestamp:HH:mm:ss}] {Level:u3} {CacheContol} {Message:lj}{NewLine}{Exception}")
+```
+
 ## Installing into an ASP.NET Core Web Application
 You need to register the `IHttpContextAccessor` singleton so the enrichers have access to the requests `HttpContext` to extract client IP and client agent.
 This is what your `Startup` class should contain in order for this enricher to work as expected:
@@ -81,9 +157,10 @@ namespace MyWebApp
         {
             Log.Logger = new LoggerConfiguration()
                 .MinimumLevel.Debug()
-                .WriteTo.Console(outputTemplate: "[{Timestamp:HH:mm:ss} {Level:u3} {ClientIp} {ClientAgent}] {Message:lj}{NewLine}{Exception}")
+                .WriteTo.Console(outputTemplate: "[{Timestamp:HH:mm:ss}] {Level:u3} CLient IP: {ClientIp} Correlation Id: {CorrelationId} header-name: {headername} {Message:lj}{NewLine}{Exception}")
                 .Enrich.WithClientIp()
-                .Enrich.WithClientAgent()
+                .Enrich.WithCorrelationId()
+                .Enrich.WithRequestHeader("header-name")
                 .CreateLogger();
         }
 

Serilog.Enrichers.ClientInfo.sln

@@ -1,15 +1,23 @@
 
 Microsoft Visual Studio Solution File, Format Version 12.00
-# Visual Studio Version 16
-VisualStudioVersion = 16.0.29411.108
+# Visual Studio Version 17
+VisualStudioVersion = 17.1.32210.238
 MinimumVisualStudioVersion = 10.0.40219.1
 Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "src", "src", "{84342DE9-9E61-4802-9E77-305CFFD0D2B5}"
 EndProject
 Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "test", "test", "{F5A0A932-DD02-47C1-B81E-3F34F879FEEF}"
 EndProject
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Serilog.Enrichers.ClientInfo", "src\Serilog.Enrichers.ClientInfo\Serilog.Enrichers.ClientInfo.csproj", "{232EFC21-2E8D-44B0-8506-C0DCE122AAA2}"
 EndProject
-Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Serilog.Enrichers.ClientInfo.Tests", "test\Serilog.Enrichers.ClientInfo.Tests\Serilog.Enrichers.ClientInfo.Tests.csproj", "{A6AFC898-47F8-4F6D-9391-C79689885B7A}"
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Serilog.Enrichers.ClientInfo.Tests", "test\Serilog.Enrichers.ClientInfo.Tests\Serilog.Enrichers.ClientInfo.Tests.csproj", "{A6AFC898-47F8-4F6D-9391-C79689885B7A}"
+EndProject
+Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "assets", "assets", "{931596BA-056D-4E8C-9FED-6C60C0D1AB83}"
+	ProjectSection(SolutionItems) = preProject
+		.gitignore = .gitignore
+		LICENSE = LICENSE
+		README.md = README.md
+		Serilog.Enrichers.ClientInfo.nuspec = Serilog.Enrichers.ClientInfo.nuspec
+	EndProjectSection
 EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution

src/Serilog.Enrichers.ClientInfo/Extensions/ClientInfoLoggerConfigurationExtensions.cs

@@ -23,22 +23,22 @@ public static class ClientInfoLoggerConfigurationExtensions
     ///   header information.
     /// </summary>
     /// <param name="enrichmentConfiguration">The enrichment configuration.</param>
-    /// <param name="forwardHeaderName">
+    /// <param name="headerName">
     ///   Set the 'X-Forwarded-For' header in case if service is behind proxy server. Default value
     ///   is 'x-forwarded-for'.
     /// </param>
     /// <exception cref="ArgumentNullException">enrichmentConfiguration</exception>
     /// <returns>The logger configuration so that multiple calls can be chained.</returns>
     public static LoggerConfiguration WithClientIp(
         this LoggerEnrichmentConfiguration enrichmentConfiguration,
-        string forwardHeaderName = "x-forwarded-for")
+        string headerName = "x-forwarded-for")
     {
         if (enrichmentConfiguration == null)
         {
             throw new ArgumentNullException(nameof(enrichmentConfiguration));
         }
 
-        return enrichmentConfiguration.With(new ClientIpEnricher(forwardHeaderName));
+        return enrichmentConfiguration.With(new ClientIpEnricher(headerName));
     }
 
     /// <summary>