Update logging to filter health checks

Author: StuartFerguson

FileProcessor/RequestLoggingMiddleware.cs

@@ -0,0 +1,93 @@
+using System;
+using System.Collections.Generic;
+using System.IO;
+using System.Text;
+using System.Threading.Tasks;
+using Microsoft.AspNetCore.Http;
+using Microsoft.AspNetCore.Http.Extensions;
+using Shared.General;
+
+namespace Shared.Middleware
+{
+    using System.Security.Policy;
+    using NLog;
+    using Logger = Logger.Logger;
+
+    public class RequestLoggingMiddlewareTemp
+    {
+        #region Fields
+
+        /// <summary>
+        /// The next
+        /// </summary>
+        private readonly RequestDelegate next;
+
+        #endregion
+        
+        #region Constructors
+        /// <summary>
+        /// Initializes a new instance of the <see cref="RequestLoggingMiddleware"/> class.
+        /// </summary>
+        /// <param name="next">The next.</param>
+        public RequestLoggingMiddlewareTemp(RequestDelegate next)
+        {
+            this.next = next;
+        }
+        #endregion
+
+        #region Public Methods
+
+        #region public async Task Invoke(HttpContext context)        
+        /// <summary>
+        /// Invokes the specified context.
+        /// </summary>
+        /// <param name="context">The context.</param>
+        /// <returns></returns>
+        public async Task Invoke(HttpContext context)
+        {
+            var requestBodyStream = new MemoryStream();
+            var originalRequestBody = context.Request.Body;
+
+            await context.Request.Body.CopyToAsync(requestBodyStream);
+            requestBodyStream.Seek(0, SeekOrigin.Begin);
+
+            var url = UriHelper.GetDisplayUrl(context.Request);
+            var requestBodyText = new StreamReader(requestBodyStream).ReadToEnd();
+            StringBuilder logMessage = new StringBuilder();
+            logMessage.Append($"Request: Method: {context.Request.Method} Url: {url}");
+            if (!String.IsNullOrEmpty(requestBodyText))
+            {
+                logMessage.Append(" ");
+                logMessage.Append($"Body: {requestBodyText}");
+            }
+
+            LogMessage(url, logMessage);
+
+            requestBodyStream.Seek(0, SeekOrigin.Begin);
+            context.Request.Body = requestBodyStream;
+
+            await next(context);
+            context.Request.Body = originalRequestBody;
+        }
+
+        internal static Boolean IsHealthCheckRequest(String url) => url.EndsWith("/health");
+
+        internal static void LogMessage(String url,
+                                       StringBuilder message)
+        {
+            if (IsHealthCheckRequest(url))
+            {
+                // TODO: new logger method??
+                Logger.LogInformation($"HEALTH_CHECK | {message}");
+            }
+            else
+            {
+                Logger.LogInformation($"{message}");
+            }
+        }
+
+        #endregion
+
+        #endregion
+    }
+}

FileProcessor/ResponseLoggingMiddleware.cs

@@ -0,0 +1,70 @@
+using System;
+using System.IO;
+using System.Text;
+using System.Threading.Tasks;
+using Microsoft.AspNetCore.Http;
+using Microsoft.AspNetCore.Http.Extensions;
+using Shared.General;
+
+namespace Shared.Middleware
+{
+    public class ResponseLoggingMiddlewareTemp
+    {
+        #region Fields
+
+        /// <summary>
+        /// The next
+        /// </summary>
+        private readonly RequestDelegate next;
+
+        #endregion
+        
+        #region Constructors
+        /// <summary>
+        /// Initializes a new instance of the <see cref="ResponseLoggingMiddleware"/> class.
+        /// </summary>
+        /// <param name="next">The next.</param>
+        public ResponseLoggingMiddlewareTemp(RequestDelegate next)
+        {
+            this.next = next;
+        }
+        #endregion
+
+        #region Public Methods
+
+        #region public async Task Invoke(HttpContext context)        
+        /// <summary>
+        /// Invokes the specified context.
+        /// </summary>
+        /// <param name="context">The context.</param>
+        /// <returns></returns>
+        public async Task Invoke(HttpContext context)
+        {
+            var url = UriHelper.GetDisplayUrl(context.Request);
+            var bodyStream = context.Response.Body;
+
+            var responseBodyStream = new MemoryStream();
+            context.Response.Body = responseBodyStream;
+
+            await next(context);
+
+            responseBodyStream.Seek(0, SeekOrigin.Begin);
+            var responseBody = new StreamReader(responseBodyStream).ReadToEnd();
+            StringBuilder logMessage = new StringBuilder();
+            logMessage.Append($"Response: Status Code: {context.Response.StatusCode}");
+            if (!String.IsNullOrEmpty(responseBody))
+            {
+                logMessage.Append(" ");
+                logMessage.Append($"Body: {responseBody}");
+            }
+            //Logger.Logger.LogInformation(logMessage.ToString());
+            RequestLoggingMiddlewareTemp.LogMessage(url, logMessage);
+            
+            responseBodyStream.Seek(0, SeekOrigin.Begin);
+            await responseBodyStream.CopyToAsync(bodyStream);
+        }
+        #endregion
+
+        #endregion
+    }
+}

FileProcessor/Startup.cs

@@ -54,6 +54,7 @@ namespace FileProcessor
     using Shared.Extensions;
     using Shared.General;
     using Shared.Logger;
+    using Shared.Middleware;
     using Shared.Repositories;
     using Swashbuckle.AspNetCore.Filters;
     using TransactionProcessor.Client;
@@ -418,9 +419,11 @@ public void Configure(IApplicationBuilder app, IWebHostEnvironment env, ILoggerF
 
             ConfigurationReader.Initialise(Startup.Configuration);
 
-            app.AddRequestLogging();
-            app.AddResponseLogging();
+            //app.AddRequestLogging();
+            //app.AddResponseLogging();
             app.AddExceptionHandler();
+            app.UseMiddleware<RequestLoggingMiddlewareTemp>();
+            app.UseMiddleware<ResponseLoggingMiddlewareTemp>();
 
             app.UseRouting();
 

FileProcessor/nlog.config

@@ -1,6 +1,5 @@
 <?xml version="1.0" encoding="utf-8"?>
 <nlog xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
-
 	<targets>
 		<target name="asyncFile" xsi:type="AsyncWrapper">
 			<target name="logfile" xsi:type="File"
@@ -10,11 +9,29 @@
 			        archiveDateFormat="yyyyMMdd-HH"
 			        archiveEvery="Hour"
 			        keepFileOpen="false"
-			        maxArchiveFiles="24"/>/>
+			        maxArchiveFiles="24"/>
+			<target name="healthlogfile" xsi:type="File"
+			        fileName="/home/txnproc/trace/fileprocessor_health.log"
+			        layout="${date:format=dd/MM/yyyy HH\:mm\:ss} | ${date:format=dd/MM/yyyy HH\:mm\:ss.ffff} | ${level} | ${callsite:className=true} | ${message} | ${exception:format=type,method:maxInnerExceptionLevel=5:innerFormat=shortType,message,method:InnerExceptionSeparator= | }"
+			        archiveNumbering="Date"
+			        archiveDateFormat="yyyyMMdd-HH"
+			        archiveEvery="Hour"
+			        keepFileOpen="false"
+			        maxArchiveFiles="24"/>
 		</target>
 	</targets>
 
 	<rules>
-		<logger name="*" minlevel="Debug" writeTo="logfile"/>
+		<logger name="Microsoft.*" minlevel="Debug" writeTo="" final="true" />
+		<logger name="*" minlevel="Debug" writeTo="logfile">
+			<filters defaultAction="Log">
+				<when condition="contains('${message}', 'HEALTH_CHECK')" action="Ignore"></when>
+			</filters>
+		</logger>
+		<logger name="*" minlevel="Debug" writeTo="healthlogfile">
+			<filters defaultAction="Ignore">
+				<when condition="contains('${message}', 'HEALTH_CHECK')" action="Log"></when>
+			</filters>
+		</logger>
 	</rules>
 </nlog>