Hotfix/small fix of documentation (#5)

denis-peshkov · web-flow · commit 0959fa9ecee8 · 2024-07-17T23:35:18.000+03:00
* small fix of documentation

* small fix
diff --git a/GitVersion.yml b/GitVersion.yml
@@ -1,4 +1,4 @@
-next-version: 7.0.0 #
+next-version: 7.0.0 #.
 branches:
   master:
     regex: ^master$|^main$
@@ -54,7 +54,7 @@ branches:
     regex: ^(pull|pull\-requests|pr|merge)[/-]
     mode: ContinuousDelivery
     tag: pr
-    tag-number-pattern: '[/-](?<number>\d+)[-/]'
+    tag-number-pattern: '(\d+)'
     increment: None
     source-branches:
       - dev
diff --git a/README.md b/README.md
@@ -61,7 +61,7 @@ or
 {
   "Serilog": {
     "MinimumLevel": "Debug",
-    "Using":  [ "Serilog.Enrichers.ClientInfo" ],
+    "Using":  [ "Serilog.Enrichers.HttpContext" ],
     "Enrich": [
       {
         "Name": "WithClientIp",
@@ -87,7 +87,7 @@ or
 {
   "Serilog": {
     "MinimumLevel": "Debug",
-    "Using":  [ "Serilog.Enrichers.ClientInfo" ],
+    "Using":  [ "Serilog.Enrichers.HttpContext" ],
     "Enrich": [
       {
         "Name": "WithCorrelationId",
@@ -114,7 +114,7 @@ or
 {
   "Serilog": {
     "MinimumLevel": "Debug",
-    "Using":  [ "Serilog.Enrichers.ClientInfo" ],
+    "Using":  [ "Serilog.Enrichers.HttpContext" ],
     "Enrich": [
       {
         "Name": "WithRequestHeader",
@@ -135,7 +135,7 @@ or
           "propertyName": "RequestLength"
         }
       }
-    ],
+    ]
   }
 }
 ```
diff --git a/src/Serilog.Enrichers.HttpContext/Enrichers/RequestHeaderEnricher.cs b/src/Serilog.Enrichers.HttpContext/Enrichers/RequestHeaderEnricher.cs
@@ -1,19 +1,19 @@
 ﻿namespace Serilog.Enrichers;
 
 /// <inheritdoc/>
-public class ClientHeaderEnricher : ILogEventEnricher
+public class RequestHeaderEnricher : ILogEventEnricher
 {
     private readonly string _clientHeaderItemKey;
     private readonly string _propertyName;
     private readonly string _headerKey;
     private readonly IHttpContextAccessor _contextAccessor;
 
-    public ClientHeaderEnricher(string headerKey, string propertyName)
+    public RequestHeaderEnricher(string headerKey, string propertyName)
         : this(headerKey, propertyName, new HttpContextAccessor())
     {
     }
 
-    internal ClientHeaderEnricher(string headerKey, string propertyName, IHttpContextAccessor contextAccessor)
+    internal RequestHeaderEnricher(string headerKey, string propertyName, IHttpContextAccessor contextAccessor)
     {
         _headerKey = headerKey;
         _propertyName = string.IsNullOrWhiteSpace(propertyName)
@@ -23,7 +23,7 @@ internal ClientHeaderEnricher(string headerKey, string propertyName, IHttpContex
         _contextAccessor = contextAccessor;
     }
 
-    internal ClientHeaderEnricher(IHttpContextAccessor contextAccessor)
+    internal RequestHeaderEnricher(IHttpContextAccessor contextAccessor)
     {
         _contextAccessor = contextAccessor;
     }
diff --git a/src/Serilog.Enrichers.HttpContext/Extensions/HttpContextLoggerConfigurationExtensions.cs b/src/Serilog.Enrichers.HttpContext/Extensions/HttpContextLoggerConfigurationExtensions.cs
@@ -60,44 +60,44 @@ public static LoggerConfiguration WithCorrelationId(
     ///   Registers the HTTP request header enricher to enrich logs with the header value.
     /// </summary>
     /// <param name="enrichmentConfiguration">The enrichment configuration.</param>
-    /// <param name="propertyName">The property name of log</param>
-    /// <param name="headerName">The header name to log its value</param>
     /// <exception cref="ArgumentNullException">enrichmentConfiguration</exception>
-    /// <exception cref="ArgumentNullException">headerName</exception>
     /// <returns>The logger configuration so that multiple calls can be chained.</returns>
-    public static LoggerConfiguration WithRequestHeader(
-        this LoggerEnrichmentConfiguration enrichmentConfiguration,
-        string headerName,
-        string propertyName = null)
+    public static LoggerConfiguration WithRequestBody(
+        this LoggerEnrichmentConfiguration enrichmentConfiguration)
     {
         if (enrichmentConfiguration == null)
         {
             throw new ArgumentNullException(nameof(enrichmentConfiguration));
         }
 
-        if (headerName == null)
-        {
-            throw new ArgumentNullException(nameof(headerName));
-        }
-
-        return enrichmentConfiguration.With(new ClientHeaderEnricher(headerName, propertyName));
+        return enrichmentConfiguration.With(new RequestBodyEnricher());
     }
 
     /// <summary>
     ///   Registers the HTTP request header enricher to enrich logs with the header value.
     /// </summary>
     /// <param name="enrichmentConfiguration">The enrichment configuration.</param>
+    /// <param name="propertyName">The property name of log</param>
+    /// <param name="headerName">The header name to log its value</param>
     /// <exception cref="ArgumentNullException">enrichmentConfiguration</exception>
+    /// <exception cref="ArgumentNullException">headerName</exception>
     /// <returns>The logger configuration so that multiple calls can be chained.</returns>
-    public static LoggerConfiguration WithRequestBody(
-        this LoggerEnrichmentConfiguration enrichmentConfiguration)
+    public static LoggerConfiguration WithRequestHeader(
+        this LoggerEnrichmentConfiguration enrichmentConfiguration,
+        string headerName,
+        string propertyName = null)
     {
         if (enrichmentConfiguration == null)
         {
             throw new ArgumentNullException(nameof(enrichmentConfiguration));
         }
 
-        return enrichmentConfiguration.With(new RequestBodyEnricher());
+        if (headerName == null)
+        {
+            throw new ArgumentNullException(nameof(headerName));
+        }
+
+        return enrichmentConfiguration.With(new RequestHeaderEnricher(headerName, propertyName));
     }
 
     /// <summary>
diff --git a/test/Serilog.Enrichers.HttpContext.Tests/Enrichers/RequestHeaderEnricherTests.cs b/test/Serilog.Enrichers.HttpContext.Tests/Enrichers/RequestHeaderEnricherTests.cs
@@ -1,10 +1,10 @@
 ﻿namespace Serilog.Enrichers.HttpContext.Tests.Enrichers;
 
-public class ClientHeaderEnricherTests
+public class RequestHeaderEnricherTests
 {
     private readonly IHttpContextAccessor _contextAccessor;
 
-    public ClientHeaderEnricherTests()
+    public RequestHeaderEnricherTests()
     {
         var httpContext = new DefaultHttpContext();
         _contextAccessor = Substitute.For<IHttpContextAccessor>();
@@ -20,7 +20,7 @@ public void EnrichLogWithClientHeader_WhenHttpRequestContainHeader_ShouldCreateN
         var headerValue = Guid.NewGuid().ToString();
         _contextAccessor.HttpContext.Request.Headers.Add(headerKey, headerValue);
 
-        var clientHeaderEnricher = new ClientHeaderEnricher(headerKey, propertyName, _contextAccessor);
+        var clientHeaderEnricher = new RequestHeaderEnricher(headerKey, propertyName, _contextAccessor);
 
         LogEvent evt = null;
         var log = new LoggerConfiguration()
@@ -46,7 +46,7 @@ public void EnrichLogWithClientHeader_WhenHttpRequestContainHeader_ShouldCreateH
         var headerValue = Guid.NewGuid().ToString();
         _contextAccessor.HttpContext.Request.Headers.Add(headerKey, headerValue);
 
-        var clientHeaderEnricher = new ClientHeaderEnricher(headerKey, propertyName:string.Empty, _contextAccessor);
+        var clientHeaderEnricher = new RequestHeaderEnricher(headerKey, propertyName:string.Empty, _contextAccessor);
 
         LogEvent evt = null;
         var log = new LoggerConfiguration()
@@ -75,8 +75,8 @@ public void EnrichLogWithMulitpleClientHeaderEnricher_WhenHttpRequestContainHead
         _contextAccessor.HttpContext.Request.Headers.Add(headerKey1, headerValue1);
         _contextAccessor.HttpContext.Request.Headers.Add(headerKey2, headerValue2);
 
-        var clientHeaderEnricher1 = new ClientHeaderEnricher(headerKey1, propertyName:string.Empty, _contextAccessor);
-        var clientHeaderEnricher2 = new ClientHeaderEnricher(headerKey2, propertyName:string.Empty, _contextAccessor);
+        var clientHeaderEnricher1 = new RequestHeaderEnricher(headerKey1, propertyName:string.Empty, _contextAccessor);
+        var clientHeaderEnricher2 = new RequestHeaderEnricher(headerKey2, propertyName:string.Empty, _contextAccessor);
 
         LogEvent evt = null;
         var log = new LoggerConfiguration()
@@ -102,7 +102,7 @@ public void EnrichLogWithClientHeader_WhenHttpRequestNotContainHeader_ShouldCrea
     {
         // Arrange
         var headerKey = "RequestId";
-        var clientHeaderEnricher = new ClientHeaderEnricher(headerKey, propertyName:string.Empty, _contextAccessor);
+        var clientHeaderEnricher = new RequestHeaderEnricher(headerKey, propertyName:string.Empty, _contextAccessor);
 
         LogEvent evt = null;
         var log = new LoggerConfiguration()

Original file line number	Diff line number	Diff line change
`@@ -61,7 +61,7 @@ or`
`61`	`61`	`{`
`62`	`62`	`"Serilog": {`
`63`	`63`	`"MinimumLevel": "Debug",`
`64`		`- "Using": [ "Serilog.Enrichers.ClientInfo" ],`
	`64`	`+ "Using": [ "Serilog.Enrichers.HttpContext" ],`
`65`	`65`	`"Enrich": [`
`66`	`66`	`{`
`67`	`67`	`"Name": "WithClientIp",`
`@@ -87,7 +87,7 @@ or`
`87`	`87`	`{`
`88`	`88`	`"Serilog": {`
`89`	`89`	`"MinimumLevel": "Debug",`
`90`		`- "Using": [ "Serilog.Enrichers.ClientInfo" ],`
	`90`	`+ "Using": [ "Serilog.Enrichers.HttpContext" ],`
`91`	`91`	`"Enrich": [`
`92`	`92`	`{`
`93`	`93`	`"Name": "WithCorrelationId",`
`@@ -114,7 +114,7 @@ or`
`114`	`114`	`{`
`115`	`115`	`"Serilog": {`
`116`	`116`	`"MinimumLevel": "Debug",`
`117`		`- "Using": [ "Serilog.Enrichers.ClientInfo" ],`
	`117`	`+ "Using": [ "Serilog.Enrichers.HttpContext" ],`
`118`	`118`	`"Enrich": [`
`119`	`119`	`{`
`120`	`120`	`"Name": "WithRequestHeader",`
`@@ -135,7 +135,7 @@ or`
`135`	`135`	`"propertyName": "RequestLength"`
`136`	`136`	`}`
`137`	`137`	`}`
`138`		`- ],`
	`138`	`+ ]`
`139`	`139`	`}`
`140`	`140`	`}`
`141`	`141`	```
Original file line number	Diff line number	Diff line change
`@@ -1,19 +1,19 @@`
`1`	`1`	`namespace Serilog.Enrichers;`
`2`	`2`
`3`	`3`	`/// <inheritdoc/>`
`4`		`-public class ClientHeaderEnricher : ILogEventEnricher`
	`4`	`+public class RequestHeaderEnricher : ILogEventEnricher`
`5`	`5`	`{`
`6`	`6`	`private readonly string _clientHeaderItemKey;`
`7`	`7`	`private readonly string _propertyName;`
`8`	`8`	`private readonly string _headerKey;`
`9`	`9`	`private readonly IHttpContextAccessor _contextAccessor;`
`10`	`10`
`11`		`- public ClientHeaderEnricher(string headerKey, string propertyName)`
	`11`	`+ public RequestHeaderEnricher(string headerKey, string propertyName)`
`12`	`12`	`: this(headerKey, propertyName, new HttpContextAccessor())`
`13`	`13`	`{`
`14`	`14`	`}`
`15`	`15`
`16`		`- internal ClientHeaderEnricher(string headerKey, string propertyName, IHttpContextAccessor contextAccessor)`
	`16`	`+ internal RequestHeaderEnricher(string headerKey, string propertyName, IHttpContextAccessor contextAccessor)`
`17`	`17`	`{`
`18`	`18`	`_headerKey = headerKey;`
`19`	`19`	`_propertyName = string.IsNullOrWhiteSpace(propertyName)`
`@@ -23,7 +23,7 @@ internal ClientHeaderEnricher(string headerKey, string propertyName, IHttpContex`
`23`	`23`	`_contextAccessor = contextAccessor;`
`24`	`24`	`}`
`25`	`25`
`26`		`- internal ClientHeaderEnricher(IHttpContextAccessor contextAccessor)`
	`26`	`+ internal RequestHeaderEnricher(IHttpContextAccessor contextAccessor)`
`27`	`27`	`{`
`28`	`28`	`_contextAccessor = contextAccessor;`
`29`	`29`	`}`