aspnet-request-endpoint-group - EndPoint Metadata Group DisplayName (#1101)

Author: snakefoot

examples/ASP.NET.Core8/nlog.config

@@ -19,7 +19,7 @@
 
     <!-- File Target for own log messages with extra web details using some ASP.NET core renderers -->
     <target xsi:type="File" name="ownFile-web" fileName="c:\temp\nlog-AspNetCore8-own-${shortdate}.log"
-            layout="${longdate}|${event-properties:item=EventId:whenEmpty=0}|${level:uppercase=true}|${logger}|${message} ${exception:format=tostring}|url: ${aspnet-request-url}" />
+            layout="${longdate}|${event-properties:item=EventId:whenEmpty=0}|${level:uppercase=true}|${logger}|${message} ${exception:format=tostring}|endpoint: ${aspnet-request-endpoint}|url: ${aspnet-request-url}" />
 
     <!--Console Target for hosting lifetime messages to improve Docker / Visual Studio startup detection -->
     <target xsi:type="Console" name="lifetimeConsole" layout="${MicrosoftConsoleLayout}" />

src/NLog.Web.AspNetCore/Internal/AssemblyExtensionTypes.cs

@@ -111,6 +111,7 @@ public static void RegisterTypes(this NLog.Config.ISetupExtensionsBuilder setupB
             setupBuilder.RegisterLayoutRenderer<NLog.Web.LayoutRenderers.AspNetResponseHttpsCompressionLayoutRenderer>("aspnet-response-https-compression");
             setupBuilder.RegisterLayoutRenderer<NLog.Web.LayoutRenderers.AspNetRequestServerVariableLayoutRenderer>("aspnet-request-servervariable");
             setupBuilder.RegisterLayoutRenderer<NLog.Web.LayoutRenderers.AspNetRequestEndPointLayoutRenderer>("aspnet-request-endpoint");
+            setupBuilder.RegisterLayoutRenderer<NLog.Web.LayoutRenderers.AspNetRequestEndPointGroupLayoutRenderer>("aspnet-request-endpoint-group");
 #endif
 
             #pragma warning restore CS0618 // Type or member is obsolete

src/NLog.Web.AspNetCore/Internal/AssemblyExtensionTypes.tt

@@ -127,6 +127,7 @@ namespace NLog.Web.Internal
             setupBuilder.RegisterLayoutRenderer<NLog.Web.LayoutRenderers.AspNetResponseHttpsCompressionLayoutRenderer>("aspnet-response-https-compression");
             setupBuilder.RegisterLayoutRenderer<NLog.Web.LayoutRenderers.AspNetRequestServerVariableLayoutRenderer>("aspnet-request-servervariable");
             setupBuilder.RegisterLayoutRenderer<NLog.Web.LayoutRenderers.AspNetRequestEndPointLayoutRenderer>("aspnet-request-endpoint");
+            setupBuilder.RegisterLayoutRenderer<NLog.Web.LayoutRenderers.AspNetRequestEndPointGroupLayoutRenderer>("aspnet-request-endpoint-group");
 #endif
 
             #pragma warning restore CS0618 // Type or member is obsolete

src/NLog.Web.AspNetCore/LayoutRenderers/AspNetRequestEndPointGroupLayoutRenderer.cs

@@ -0,0 +1,30 @@
+#if NETCOREAPP3_0_OR_GREATER
+
+using System;
+using System.Text;
+using NLog.LayoutRenderers;
+using NLog.Web.Internal;
+
+namespace NLog.Web.LayoutRenderers
+{
+    /// <summary>
+    /// ASP.NET request EndPoint Group DisplayName. Metadata-attribute assigned by WithGroupName or [EndpointGroupName]
+    /// </summary>
+    /// <remarks>
+    /// <code>${aspnet-request-endpoint-group}</code>
+    /// </remarks>
+    /// <seealso href="https://github.com/NLog/NLog/wiki/AspNet-Request-EndPoint-Group-Layout-Renderer">Documentation on NLog Wiki</seealso>
+    [LayoutRenderer("aspnet-request-endpoint-group")]
+    public class AspNetRequestEndPointGroupLayoutRenderer : AspNetLayoutRendererBase
+    {
+        /// <inheritdoc/>
+        protected override void Append(StringBuilder builder, LogEventInfo logEvent)
+        {
+            var endPoint = HttpContextAccessor?.HttpContext.TryGetFeature<Microsoft.AspNetCore.Http.Features.IEndpointFeature>()?.Endpoint;
+            var endPointGroup = endPoint?.Metadata.GetMetadata<Microsoft.AspNetCore.Routing.EndpointGroupNameAttribute>();
+            builder.Append(endPointGroup?.EndpointGroupName);
+        }
+    }
+}
+
+#endif

src/NLog.Web.AspNetCore/LayoutRenderers/AspNetRequestEndPointLayoutRenderer.cs

@@ -26,5 +26,4 @@ protected override void Append(StringBuilder builder, LogEventInfo logEvent)
     }
 }
 
-
 #endif

tests/NLog.Web.AspNetCore.Tests/LayoutRenderers/AspNetRequestEndPointGroupLayoutRendererTests.cs

@@ -0,0 +1,44 @@
+#if NETCOREAPP3_0_OR_GREATER
+using NLog.Web.LayoutRenderers;
+using Microsoft.AspNetCore.Connections.Features;
+using Microsoft.AspNetCore.Http.Features;
+using NSubstitute;
+using Xunit;
+
+namespace NLog.Web.Tests.LayoutRenderers
+{
+    public class AspNetRequestEndPointGroupLayoutRendererTests : LayoutRenderersTestBase<AspNetRequestEndPointGroupLayoutRenderer>
+    {
+        [Fact]
+        public void SuccessTest()
+        {
+            // Arrange
+            var (renderer, httpContext) = CreateWithHttpContext();
+            var endPointFeature = Substitute.For<IEndpointFeature>();
+            var endPointMetaData = new Microsoft.AspNetCore.Http.EndpointMetadataCollection(new Microsoft.AspNetCore.Routing.EndpointGroupNameAttribute("42"));
+            endPointFeature.Endpoint.Returns(new Microsoft.AspNetCore.Http.Endpoint(null, endPointMetaData, "DisplayName"));
+
+            var featureCollection = new FeatureCollection();
+            featureCollection.Set<IEndpointFeature>(endPointFeature);
+
+            httpContext.Features.Returns(featureCollection);
+            // Act
+            var result = renderer.Render(new LogEventInfo());
+            // Assert
+            Assert.Equal("42", result);
+        }
+
+        [Fact]
+        public void NullTest()
+        {
+            // Arrange
+            var (renderer, httpContext) = CreateWithHttpContext();
+            httpContext.Features.Returns(new FeatureCollection());
+            // Act
+            var result = renderer.Render(new LogEventInfo());
+            // Assert
+            Assert.Equal(string.Empty, result);
+        }
+    }
+}
+#endif