Configure X-Forwarded-Header in enricher registration. #11

Author: mesmailpour-spectra

src/Serilog.Enrichers.ClientInfo/Enrichers/ClientIpEnricher.cs

@@ -68,15 +68,15 @@ private string GetIpAddress()
         }
 
 #else
-     private string GetIpAddress()
-     {
-         var ipAddress = _contextAccessor.HttpContext?.Request?.Headers["X-forwarded-for"].FirstOrDefault();
+        private string GetIpAddress()
+        {
+            var ipAddress = _contextAccessor.HttpContext?.Request?.Headers[ClinetIpConfiguration.XForwardHeaderName].FirstOrDefault();
 
-         if (!string.IsNullOrEmpty(ipAddress))
-             return GetIpAddressFromProxy(ipAddress);
+            if (!string.IsNullOrEmpty(ipAddress))
+                return GetIpAddressFromProxy(ipAddress);
 
-         return _contextAccessor.HttpContext?.Connection?.RemoteIpAddress?.ToString();
-     }
+            return _contextAccessor.HttpContext?.Connection?.RemoteIpAddress?.ToString();
+        }
 #endif
 
         private string GetIpAddressFromProxy(string proxifiedIpList)

src/Serilog.Enrichers.ClientInfo/Enrichers/ClinetIpConfiguration.cs

@@ -0,0 +1,7 @@
+namespace Serilog.Enrichers
+{
+    internal class ClinetIpConfiguration
+    {
+        public static string XForwardHeaderName { get; set; } = "X-forwarded-for";
+    }
+}

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

@@ -4,16 +4,37 @@
 
 namespace Serilog
 {
+    /// <summary>
+    ///     Extension methods for setting up client IP and client agent enrichers <see cref="LoggerEnrichmentConfiguration"/>.
+    /// </summary>
     public static class ClientInfoLoggerConfigurationExtensions
     {
-        public static LoggerConfiguration WithClientIp(this LoggerEnrichmentConfiguration enrichmentConfiguration)
+        /// <summary>
+        ///     Registers the client IP enricher to enrich logs with client IP with 'X-forwarded-for' header information.
+        /// </summary>
+        /// <param name="enrichmentConfiguration"> The enrichment configuration. </param>
+        /// <param name="xForwardHeaderName">
+        ///     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 xForwardHeaderName = null)
         {
             if (enrichmentConfiguration == null)
                 throw new ArgumentNullException(nameof(enrichmentConfiguration));
 
+            if (!string.IsNullOrEmpty(xForwardHeaderName))
+                ClinetIpConfiguration.XForwardHeaderName = xForwardHeaderName;
+
             return enrichmentConfiguration.With<ClientIpEnricher>();
         }
 
+        /// <summary>
+        ///     Registers the client Agent enricher to enrich logs with 'User-Agent' header information.
+        /// </summary>
+        /// <param name="enrichmentConfiguration"> The enrichment configuration. </param>
+        /// <exception cref="ArgumentNullException"> enrichmentConfiguration </exception>
+        /// <returns> The logger configuration so that multiple calls can be chained. </returns>
         public static LoggerConfiguration WithClientAgent(this LoggerEnrichmentConfiguration enrichmentConfiguration)
         {
             if (enrichmentConfiguration == null)

src/Serilog.Enrichers.ClientInfo/Serilog.Enrichers.ClientInfo.csproj

@@ -3,7 +3,7 @@
   <PropertyGroup>
     <AssemblyName>Serilog.Enrichers.ClientInfo</AssemblyName>
     <RootNamespace>Serilog</RootNamespace>
-    <TargetFrameworks>net452;netstandard2.0;netstandard2.1</TargetFrameworks>
+    <TargetFrameworks>net462;netstandard2.0;netstandard2.1</TargetFrameworks>
     <LangVersion>7.3</LangVersion>
     <GenerateAssemblyInfo>false</GenerateAssemblyInfo>
   </PropertyGroup>
@@ -14,7 +14,7 @@
   <PropertyGroup Condition=" '$(TargetFramework)' == 'netstandard2.1'">
     <DefineConstants>NETCORE;NETSTANDARD;NETSTANDARD2_1</DefineConstants>
   </PropertyGroup>
-  <PropertyGroup Condition=" '$(TargetFramework)' == 'net452'">
+  <PropertyGroup Condition=" '$(TargetFramework)' == 'net462'">
     <DefineConstants>NET45;NETFULL</DefineConstants>
   </PropertyGroup>
 
@@ -26,7 +26,7 @@
     <PackageReference Include="Microsoft.AspNetCore.Http" Version="2.2.2" />
     <PackageReference Include="Serilog" Version="2.9.0" />
   </ItemGroup>
-  <ItemGroup Condition=" '$(TargetFramework)' == 'net452'">
+  <ItemGroup Condition=" '$(TargetFramework)' == 'net462'">
     <Reference Include="System.Web" />
     <PackageReference Include="Serilog" Version="2.4.0" />
   </ItemGroup>

test/Serilog.Enrichers.ClientInfo.Tests/ClientIpEnricherTests.cs

@@ -68,7 +68,7 @@ public void When_Enrich_Log_Event_With_IpEnricher_AndRequest_Contain_ForwardHead
         {
             //Arrange
             _contextAccessor.HttpContext.Connection.RemoteIpAddress = IPAddress.Loopback;
-            _contextAccessor.HttpContext.Request.Headers.Add("X-forwarded-for", IPAddress.Broadcast.ToString());
+            _contextAccessor.HttpContext.Request.Headers.Add(ClinetIpConfiguration.XForwardHeaderName, IPAddress.Broadcast.ToString());
 
             var ipEnricher = new ClientIpEnricher(_contextAccessor);
 
@@ -88,48 +88,29 @@ public void When_Enrich_Log_Event_With_IpEnricher_AndRequest_Contain_ForwardHead
         }
 
         [Fact]
-        public void When_Enrich_Log_Event_ClientAgentEnricher_Should_Contain_ClientAgent_Property()
+        public void When_Enrich_Log_Event_With_IpEnricher_With_Custom_XForwardHeader_AndRequest_Contain_ForwardHeader_Should_Read_ClientIp_Value_From_Header_Value()
         {
-            var httpContext = new DefaultHttpContext();
-            var contextAccessor = Substitute.For<IHttpContextAccessor>();
-            contextAccessor.HttpContext.Returns(httpContext);
-
-            var agentEnricher = new ClientAgentEnricher(contextAccessor);
-
-            LogEvent evt = null;
-            var log = new LoggerConfiguration()
-                .Enrich.With(agentEnricher)
-                .WriteTo.Sink(new DelegatingSink(e => evt = e))
-                .CreateLogger();
-
-            log.Information(@"Has an Agent property");
-
-            Assert.NotNull(evt);
-            Assert.True(evt.Properties.ContainsKey("ClientAgent"));
-            Assert.True(string.IsNullOrEmpty(evt.Properties["ClientAgent"].LiteralValue().ToString()));
-        }
-
-        [Fact]
-        public void When_Enrich_Log_Event_ClientAgentEnricher_And_Request_Contain_UserAgentHeader_Should_ClientAgentProperty_Have_Value()
-        {
-            var httpContext = new DefaultHttpContext();
-            httpContext.Request.Headers.Add("User-Agent", "Test Agent");
-            var contextAccessor = Substitute.For<IHttpContextAccessor>();
-            contextAccessor.HttpContext.Returns(httpContext);
+            //Arrange
+            const string customForwardHeader = "CustomForwardHeader";
+            _contextAccessor.HttpContext.Connection.RemoteIpAddress = IPAddress.Loopback;
+            _contextAccessor.HttpContext.Request.Headers.Add(customForwardHeader, IPAddress.Broadcast.ToString());
 
-            var agentEnricher = new ClientAgentEnricher(contextAccessor);
+            var ipEnricher = new ClientIpEnricher(_contextAccessor);
+            ClinetIpConfiguration.XForwardHeaderName = customForwardHeader;
 
             LogEvent evt = null;
             var log = new LoggerConfiguration()
-                .Enrich.With(agentEnricher)
+                .Enrich.With(ipEnricher)
                 .WriteTo.Sink(new DelegatingSink(e => evt = e))
                 .CreateLogger();
 
-            log.Information(@"Has an Agent property");
+            // Act
+            log.Information(@"Has an IP property");
 
+            // Assert
             Assert.NotNull(evt);
-            Assert.True(evt.Properties.ContainsKey("ClientAgent"));
-            Assert.Equal("Test Agent", evt.Properties["ClientAgent"].LiteralValue().ToString());
+            Assert.True(evt.Properties.ContainsKey("ClientIp"));
+            Assert.Equal(IPAddress.Broadcast.ToString(), evt.Properties["ClientIp"].LiteralValue());
         }
     }
 }