feat: exclude logging completely for configured paths

by default excludes /hc and /liveness
abhith · Jun 25, 2020 · 490d104 · 490d104
1 parent a45d9aa
commit 490d104
Show file tree

Hide file tree

Showing 5 changed files with 34 additions and 18 deletions.
diff --git a/Samples/AspNetCoreApp/Startup.cs b/Samples/AspNetCoreApp/Startup.cs
@@ -35,8 +35,8 @@ public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
 
             app.UseRequestResponseLogging(opt =>
             {
-                opt.ExcludePaths.RequestBody.Add("/secret");
-                opt.ExcludePaths.ResponseBody.Add("/secret");
+                opt.Exclude.RequestBody.Add("/secret");
+                opt.Exclude.ResponseBody.Add("/secret");
             });
             app.UseApiExceptionHandler();
 

diff --git a/Samples/AspNetCoreApp/appsettings.Development.json b/Samples/AspNetCoreApp/appsettings.Development.json
@@ -1,9 +1,2 @@
 {
-  "Logging": {
-    "LogLevel": {
-      "Default": "Information",
-      "Microsoft": "Warning",
-      "Microsoft.Hosting.Lifetime": "Information"
-    }
-  }
-}
+}
diff --git a/src/Code.Library.AspNetCore/Middleware/RequestResponseLoggingMiddleware.cs b/src/Code.Library.AspNetCore/Middleware/RequestResponseLoggingMiddleware.cs
@@ -25,8 +25,15 @@ public RequestResponseLoggingMiddleware(RequestDelegate next, ILoggerFactory log
 
         public async Task Invoke(HttpContext context)
         {
-            await LogRequest(context);
-            await LogResponse(context);
+            if (_options.Exclude.Paths.Any(path => context.Request.Path.Value.Contains(path, System.StringComparison.CurrentCultureIgnoreCase)))
+            {
+                await _next(context);
+            }
+            else
+            {
+                await LogRequest(context);
+                await LogResponse(context);
+            }
         }
 
         private static string ReadStreamInChunks(Stream stream)
@@ -52,7 +59,7 @@ private static string ReadStreamInChunks(Stream stream)
 
         private async Task LogRequest(HttpContext context)
         {
-            if (_options.ExcludePaths.RequestBody.Any(path => context.Request.Path.Value.Contains(path, System.StringComparison.CurrentCultureIgnoreCase)))
+            if (_options.Exclude.RequestBody.Any(path => context.Request.Path.Value.Contains(path, System.StringComparison.CurrentCultureIgnoreCase)))
             {
                 _logger.LogInformation("----- Handling HTTP Request {RequestUrl} (***)", context.Request.GetDisplayUrl());
             }
@@ -68,7 +75,7 @@ private async Task LogRequest(HttpContext context)
 
         private async Task LogResponse(HttpContext context)
         {
-            if (_options.ExcludePaths.ResponseBody.Any(path => context.Request.Path.Value.Contains(path, System.StringComparison.CurrentCultureIgnoreCase)))
+            if (_options.Exclude.ResponseBody.Any(path => context.Request.Path.Value.Contains(path, System.StringComparison.CurrentCultureIgnoreCase)))
             {
                 await _next(context);
                 _logger.LogInformation("----- Handled HTTP Request {RequestUrl} (***)", context.Request.GetDisplayUrl());

diff --git a/src/Code.Library.AspNetCore/Middleware/RequestResponseLoggingMiddlewareExtensions.cs b/src/Code.Library.AspNetCore/Middleware/RequestResponseLoggingMiddlewareExtensions.cs
@@ -29,7 +29,7 @@ private static IApplicationBuilder BuilderWithRequestResponseLogging(IApplicatio
                {
                    opts.EnrichDiagnosticContext = SerilogHelper.EnrichFromRequest;
 
-                   if (options.ExcludeHealthChecks)
+                   if (options.Exclude.HealthChecks)
                    {
                        opts.GetLevel = SerilogHelper.GetLevel(LogEventLevel.Verbose, "Health checks");
                    }

diff --git a/src/Code.Library.AspNetCore/Middleware/RequestResponseLoggingOptions.cs b/src/Code.Library.AspNetCore/Middleware/RequestResponseLoggingOptions.cs
@@ -2,15 +2,31 @@
 
 namespace Code.Library.AspNetCore.Middleware
 {
-    public class ExcludePathsInRequestResponseLoggingOptions
+    public class ExcludeInRequestResponseLoggingOptions
     {
+        public bool HealthChecks { get; set; } = true;
+
+        /// <summary>
+        /// No logs for matching paths
+        /// </summary>
+        public ICollection<string> Paths { get; set; } = new List<string>() { "/hc", "/liveness" };
+
+        /// <summary>
+        /// Request body will not be logged for matching paths
+        /// </summary>
         public ICollection<string> RequestBody { get; set; } = new List<string>();
+
+        /// <summary>
+        /// Response body will not be logged for matching paths
+        /// </summary>
         public ICollection<string> ResponseBody { get; set; } = new List<string>();
     }
 
     public class RequestResponseLoggingOptions
     {
-        public bool ExcludeHealthChecks { get; set; } = true;
-        public ExcludePathsInRequestResponseLoggingOptions ExcludePaths { get; set; } = new ExcludePathsInRequestResponseLoggingOptions();
+        /// <summary>
+        /// Excluded areas from logging
+        /// </summary>
+        public ExcludeInRequestResponseLoggingOptions Exclude { get; set; } = new ExcludeInRequestResponseLoggingOptions();
     }
 }