Use IHttpRequestFeature.Path in RequestLoggingMiddleware to log RequestPath (#265)

Co-authored-by: Ivan Maximov <[email protected]>

Author: jarronshih

src/Serilog.AspNetCore/AspNetCore/RequestLoggingMiddleware.cs

@@ -33,6 +33,7 @@ class RequestLoggingMiddleware
         readonly Action<IDiagnosticContext, HttpContext> _enrichDiagnosticContext;
         readonly Func<HttpContext, double, Exception, LogEventLevel> _getLevel;
         readonly ILogger _logger;
+        readonly bool _includeQueryInRequestPath;
         static readonly LogEventProperty[] NoProperties = new LogEventProperty[0];
 
         public RequestLoggingMiddleware(RequestDelegate next, DiagnosticContext diagnosticContext, RequestLoggingOptions options)
@@ -45,6 +46,7 @@ public RequestLoggingMiddleware(RequestDelegate next, DiagnosticContext diagnost
             _enrichDiagnosticContext = options.EnrichDiagnosticContext;
             _messageTemplate = new MessageTemplateParser().Parse(options.MessageTemplate);
             _logger = options.Logger?.ForContext<RequestLoggingMiddleware>();
+            _includeQueryInRequestPath = options.IncludeQueryInRequestPath;
         }
 
         // ReSharper disable once UnusedMember.Global
@@ -91,7 +93,7 @@ bool LogCompletion(HttpContext httpContext, DiagnosticContextCollector collector
             var properties = collectedProperties.Concat(new[]
             {
                 new LogEventProperty("RequestMethod", new ScalarValue(httpContext.Request.Method)),
-                new LogEventProperty("RequestPath", new ScalarValue(GetPath(httpContext))),
+                new LogEventProperty("RequestPath", new ScalarValue(GetPath(httpContext, _includeQueryInRequestPath))),
                 new LogEventProperty("StatusCode", new ScalarValue(statusCode)),
                 new LogEventProperty("Elapsed", new ScalarValue(elapsedMs))
             });
@@ -107,14 +109,16 @@ static double GetElapsedMilliseconds(long start, long stop)
             return (stop - start) * 1000 / (double)Stopwatch.Frequency;
         }
 
-        static string GetPath(HttpContext httpContext)
+        static string GetPath(HttpContext httpContext, bool includeQueryInRequestPath)
         {
             /*
                 In some cases, like when running integration tests with WebApplicationFactory<T>
-                the RawTarget returns an empty string instead of null, in that case we can't use
+                the Path returns an empty string instead of null, in that case we can't use
                 ?? as fallback.
             */
-            var requestPath = httpContext.Features.Get<IHttpRequestFeature>()?.RawTarget;
+            var requestPath = includeQueryInRequestPath
+                ? httpContext.Features.Get<IHttpRequestFeature>()?.RawTarget
+                : httpContext.Features.Get<IHttpRequestFeature>()?.Path;
             if (string.IsNullOrEmpty(requestPath))
             {
                 requestPath = httpContext.Request.Path.ToString();

src/Serilog.AspNetCore/AspNetCore/RequestLoggingOptions.cs

@@ -68,6 +68,12 @@ static LogEventLevel DefaultGetLevel(HttpContext ctx, double _, Exception ex) =>
         /// </summary>
         public ILogger Logger { get; set; }
 
+        /// <summary>
+        /// Include the full URL query string in the <c>RequestPath</c> property
+        /// that is attached to request log events. The default is <c>true</c>.
+        /// </summary>
+        public bool IncludeQueryInRequestPath { get; set; } = true;
+
         /// <summary>
         /// Constructor
         /// </summary>