Added log correlation and revised background tasks layout (#230)

Author: michael-j-green

gaseous-server/Classes/Common.cs

@@ -1,4 +1,5 @@
 using System;
+using System.Collections.Concurrent;
 using System.Security.Cryptography;
 
 namespace gaseous_server.Classes
@@ -111,5 +112,30 @@ public static string NormalizePath(string path)
 					.TrimEnd(Path.DirectorySeparatorChar, Path.AltDirectorySeparatorChar);
 		}
     }
+
+	/// <summary>
+    /// Provides a way to set contextual data that flows with the call and 
+    /// async context of a test or invocation.
+    /// </summary>
+    public static class CallContext
+    {
+        static ConcurrentDictionary<string, AsyncLocal<object>> state = new ConcurrentDictionary<string, AsyncLocal<object>>();
+
+        /// <summary>
+        /// Stores a given object and associates it with the specified name.
+        /// </summary>
+        /// <param name="name">The name with which to associate the new item in the call context.</param>
+        /// <param name="data">The object to store in the call context.</param>
+        public static void SetData(string name, object data) =>
+            state.GetOrAdd(name, _ => new AsyncLocal<object>()).Value = data;
+
+        /// <summary>
+        /// Retrieves an object with the specified name from the <see cref="CallContext"/>.
+        /// </summary>
+        /// <param name="name">The name of the item in the call context.</param>
+        /// <returns>The object in the call context associated with the specified name, or <see langword="null"/> if not found.</returns>
+        public static object GetData(string name) =>
+            state.TryGetValue(name, out AsyncLocal<object> data) ? data.Value : null;
+    }
 }
 

gaseous-server/Classes/Logging.cs

@@ -75,15 +75,37 @@ static public void Log(LogType EventType, string ServerProcess, string Message,
                         LogToDisk(logItem, TraceOutput, null);
                     }
 
+                    string correlationId;
+                    if (CallContext.GetData("CorrelationId").ToString() == null)
+                    {
+                        correlationId = "";
+                    }
+                    else
+                    {
+                        correlationId = CallContext.GetData("CorrelationId").ToString();
+                    }
+
+                    string callingProcess;
+                    if (CallContext.GetData("CallingProcess").ToString() == null)
+                    {
+                        callingProcess = "";
+                    }
+                    else
+                    {
+                        callingProcess = CallContext.GetData("CallingProcess").ToString();
+                    }
+
                     Database db = new Database(Database.databaseType.MySql, Config.DatabaseConfiguration.ConnectionString);
-                    string sql = "DELETE FROM ServerLogs WHERE EventTime < @EventRententionDate; INSERT INTO ServerLogs (EventTime, EventType, Process, Message, Exception) VALUES (@EventTime, @EventType, @Process, @Message, @Exception);";
+                    string sql = "DELETE FROM ServerLogs WHERE EventTime < @EventRententionDate; INSERT INTO ServerLogs (EventTime, EventType, Process, Message, Exception, CorrelationId, CallingProcess) VALUES (@EventTime, @EventType, @Process, @Message, @Exception, @correlationid, @callingprocess);";
                     Dictionary<string, object> dbDict = new Dictionary<string, object>();
                     dbDict.Add("EventRententionDate", DateTime.UtcNow.AddDays(Config.LoggingConfiguration.LogRetention * -1));
                     dbDict.Add("EventTime", logItem.EventTime);
                     dbDict.Add("EventType", logItem.EventType);
                     dbDict.Add("Process", logItem.Process);
                     dbDict.Add("Message", logItem.Message);
                     dbDict.Add("Exception", Common.ReturnValueIfNull(logItem.ExceptionValue, "").ToString());
+                    dbDict.Add("correlationid", correlationId);
+                    dbDict.Add("callingprocess", callingProcess);
 
                     try
                     {
@@ -184,6 +206,24 @@ static public List<LogItem> GetLogs(LogsViewModel model)
                 }
             }
 
+            if (model.CorrelationId != null)
+            {
+                if (model.CorrelationId.Length > 0)
+                {
+                    dbDict.Add("correlationId", model.CorrelationId);
+                    whereClauses.Add("CorrelationId = @correlationId");
+                }
+            }
+
+            if (model.CallingProcess != null)
+            {
+                if (model.CallingProcess.Length > 0)
+                {
+                    dbDict.Add("callingProcess", model.CallingProcess);
+                    whereClauses.Add("CallingProcess = @callingProcess");
+                }
+            }
+
             // compile WHERE clause
             string whereClause = "";
             if (whereClauses.Count > 0)
@@ -220,7 +260,9 @@ static public List<LogItem> GetLogs(LogsViewModel model)
                     EventType = (LogType)row["EventType"],
                     Process = (string)row["Process"],
                     Message = (string)row["Message"],
-                    ExceptionValue = (string)row["Exception"]
+                    ExceptionValue = (string)row["Exception"],
+                    CorrelationId = (string)row["CorrelationId"],
+                    CallingProcess = (string)row["CallingProcess"]
                 };
 
                 logs.Add(log);
@@ -243,6 +285,8 @@ public class LogItem
             public DateTime EventTime { get; set; }
             public LogType? EventType { get; set; }
             public string Process { get; set; } = "";
+            public string CorrelationId { get; set; } = "";
+            public string? CallingProcess { get; set; } = "";
             private string _Message = "";
             public string Message
             {
@@ -267,6 +311,8 @@ public class LogsViewModel
             public DateTime? StartDateTime { get; set; }
             public DateTime? EndDateTime { get; set; }
             public string? SearchText { get; set; }
+            public string? CorrelationId { get; set; }
+            public string? CallingProcess { get; set; }
         }
     }
 }