Add correlation id to track log messages for a change

TechieGuy12 · TechieGuy12 · commit ce450db674b2 · 2025-12-15T14:32:40.000-05:00
diff --git a/src/Configuration/Action.cs b/src/Configuration/Action.cs
@@ -100,12 +100,14 @@ public override void Run(ChangeInfo change, TriggerType trigger)
                 if (Change != null)
                 {
                     Logger.WriteLine(
-                        $"The source file could not be determined. Watch path: {Change.WatchPath}, changed: {Change.FullPath}.",
+                        $"[{Change.CorrelationId}] The source file could not be determined. Watch path: {Change.WatchPath}, changed: {Change.FullPath}.",
                         LogLevel.ERROR);
                 }
                 return;
             }
 
+            string correlationPrefix = Change != null ? $"[{Change.CorrelationId}] " : "";
+
             try
             {
                 switch (Type)
@@ -114,31 +116,31 @@ public override void Run(ChangeInfo change, TriggerType trigger)
                         if (string.IsNullOrWhiteSpace(destination))
                         {
                             Logger.WriteLine(
-                                $"The file '{source}' could not be copied because the destination file could not be determined. Destination in config file: {Destination}.",
+                                $"{correlationPrefix}The file '{source}' could not be copied because the destination file could not be determined. Destination in config file: {Destination}.",
                                 LogLevel.ERROR);
                             return;
                         }
 
                         TEFS.File.Copy(source, destination, Verify, KeepTimestamps);
-                        Logger.WriteLine($"Copied {source} to {destination}. Verify: {Verify}. Keep timestamps: {KeepTimestamps}.");
+                        Logger.WriteLine($"{correlationPrefix}Copied {source} to {destination}. Verify: {Verify}. Keep timestamps: {KeepTimestamps}.");
                         break;
 
                     case ActionType.Move:
                         if (string.IsNullOrWhiteSpace(destination))
                         {
                             Logger.WriteLine(
-                                $"The file '{source}' could not be moved because the destination file could not be determined. Destination in config file: {Destination}.",
+                                $"{correlationPrefix}The file '{source}' could not be moved because the destination file could not be determined. Destination in config file: {Destination}.",
                                 LogLevel.ERROR);
                             return;
                         }
 
                         TEFS.File.Move(source, destination, Verify, KeepTimestamps);
-                        Logger.WriteLine($"Moved {source} to {destination}. Verify: {Verify}. Keep timestamps: {KeepTimestamps}.");
+                        Logger.WriteLine($"{correlationPrefix}Moved {source} to {destination}. Verify: {Verify}. Keep timestamps: {KeepTimestamps}.");
                         break;
 
                     case ActionType.Delete:
                         TEFS.File.Delete(source);
-                        Logger.WriteLine($"Deleted {source}.");
+                        Logger.WriteLine($"{correlationPrefix}Deleted {source}.");
                         break;
                 }
             }
@@ -147,7 +149,7 @@ public override void Run(ChangeInfo change, TriggerType trigger)
             {
                 Exception exception = ex.InnerException ?? ex;
                 Logger.WriteLine(
-                    $"Could not {Type.ToString().ToLower(System.Globalization.CultureInfo.CurrentCulture)} file '{source}.' Reason: {exception.Message}",
+                    $"{correlationPrefix}Could not {Type.ToString().ToLower(System.Globalization.CultureInfo.CurrentCulture)} file '{source}.' Reason: {exception.Message}",
                     LogLevel.ERROR);
                 if (ex.StackTrace != null)
                 {
diff --git a/src/Configuration/ChangeInfo.cs b/src/Configuration/ChangeInfo.cs
@@ -5,6 +5,12 @@
     /// </summary>
     public class ChangeInfo
     {
+        /// <summary>
+        /// Gets the unique correlation ID for this change event.
+        /// This ID can be used to trace all operations related to this change in logs.
+        /// </summary>
+        public Guid CorrelationId { get; private set; }
+
         /// <summary>
         /// Gets the trigger for the change.
         /// </summary>
@@ -37,11 +43,6 @@ public class ChangeInfo
         /// </summary>
         public string WatchPath { get; private set; }
 
-        /// <summary>
-        /// Initializes an instance of the <see cref="ChangeInfo"/>.
-        /// </summary>
-        //public ChangeInfo() { }
-
         /// <summary>
         /// Initializes an instance of the <see cref="ChangeInfo"/> class when
         /// provided with the trigger, the file/folder name, and the full path
@@ -50,6 +51,9 @@ public class ChangeInfo
         /// <param name="trigger">
         /// The type of change.
         /// </param>
+        /// <param name="watchPath">
+        /// The path being watched.
+        /// </param>
         /// <param name="name">
         /// The name of the file or folder.
         /// </param>
@@ -67,6 +71,7 @@ public class ChangeInfo
         /// </exception>
         public ChangeInfo(TriggerType trigger, string watchPath, string name, string fullPath, string? oldName, string? oldPath)
         {
+            CorrelationId = Guid.NewGuid();
             Trigger = trigger;
             WatchPath = watchPath ?? throw new ArgumentNullException(nameof(watchPath));
             Name = name ?? throw new ArgumentNullException(nameof(name));
diff --git a/src/Configuration/Command.cs b/src/Configuration/Command.cs
@@ -75,17 +75,19 @@ public override void Run(ChangeInfo change, TriggerType trigger)
             string? arguments = GetArguments();
             string? workingDirectory = GetWorkingDirectory();
 
+            string correlationPrefix = Change != null ? $"[{Change.CorrelationId}] " : "";
+
             if (string.IsNullOrWhiteSpace(commandPath))
             {
-                Logger.WriteLine($"The command was not provided. Command was not run.",
+                Logger.WriteLine($"{correlationPrefix}The command was not provided. Command was not run.",
                     LogLevel.ERROR);
                 return;
             }
 
             if (!File.Exists(commandPath))
             {
                 Logger.WriteLine(
-                    $"The command '{commandPath}' was not found. Command was not run.",
+                    $"{correlationPrefix}The command '{commandPath}' was not found. Command was not run.",
                     LogLevel.ERROR);
                 return;
             }
@@ -111,11 +113,14 @@ public override void Run(ChangeInfo change, TriggerType trigger)
             _processInfo.Enqueue(startInfo);
             
             Logger.WriteLine(
-                $"Queue command: {startInfo.FileName} {startInfo.Arguments}. Queue Length: {_processInfo.Count}. (Command.Run)",
+                $"{correlationPrefix}Queue command: {startInfo.FileName} {startInfo.Arguments}. Queue Length: {_processInfo.Count}. (Command.Run)",
                 LogLevel.DEBUG);
 
             // Execute the next process in the queue
-            Execute();
+            if (Change != null)
+            {
+                Execute(Change.CorrelationId);
+            }
         }
 
         /// <summary>
@@ -151,9 +156,10 @@ protected virtual void Dispose(bool disposing)
         /// <summary>
         /// Executes the next command process from the queue.
         /// </summary>
-        private void Execute()
+        /// <param name="correlationId">The correlation ID for tracking this execution.</param>
+        private void Execute(Guid correlationId)
         {
-            // If the queue is null or empty, then no command is waiting to nbe
+            // If the queue is null or empty, then no command is waiting to be
             // executed
             if (_processInfo == null || _processInfo.IsEmpty)
             {
@@ -171,7 +177,7 @@ private void Execute()
                             using (Process process = new Process())
                             {
                                 Logger.WriteLine(
-                                    $"START: Process {startInfo.FileName} {startInfo.Arguments}.");
+                                    $"[{correlationId}] START: Process {startInfo.FileName} {startInfo.Arguments}.");
 
                                 process.StartInfo = startInfo;
                                 process.StartInfo.CreateNoWindow = true;
@@ -180,20 +186,20 @@ private void Execute()
                                 process.WaitForExit();
 
                                 Logger.WriteLine(
-                                    $"END: Process {process?.StartInfo.FileName} {process?.StartInfo.Arguments} has completed.");
+                                    $"[{correlationId}] END: Process {process?.StartInfo.FileName} {process?.StartInfo.Arguments} has completed.");
                             }
                         }
                         catch (Exception ex)
                         {
                             Logger.WriteLine(
-                                $"Could not run the command '{startInfo.FileName} {startInfo.Arguments}'. Reason: {ex.Message}",
+                                $"[{correlationId}] Could not run the command '{startInfo.FileName} {startInfo.Arguments}'. Reason: {ex.Message}",
                                 LogLevel.ERROR);
                         }
                     }
                     else
                     {
                         Logger.WriteLine(
-                            $"The command '{startInfo.FileName}' was not found. Command was not run.",
+                            $"[{correlationId}] The command '{startInfo.FileName}' was not found. Command was not run.",
                             LogLevel.ERROR);
                     }
                 }
diff --git a/src/Configuration/Notification.cs b/src/Configuration/Notification.cs
@@ -184,7 +184,8 @@ internal void QueueRequest(TriggerType trigger, ChangeInfo change)
                 }
             }
 
-            Logger.WriteLine($"Sending request: {Method} {uri}.");
+            string correlationIdLog = Change != null ? $"[{Change.CorrelationId}] " : "";
+            Logger.WriteLine($"{correlationIdLog}Sending request: {Method} {uri}.");
             Response response =
                 await Request.SendAsync(
                     Method,
diff --git a/src/Configuration/Watch.cs b/src/Configuration/Watch.cs
@@ -442,27 +442,33 @@ public void ProcessChange()
         private void ProcessSingleChange(ChangeInfo change)
         {
             Logger.WriteLine(
-                $"{IdLogString}: Change: {change.FullPath}, {change.Trigger} (Watch.ProcessChange)",
+                $"[{change.CorrelationId}] {IdLogString}: Change: {change.FullPath}, {change.Trigger} (Watch.ProcessChange)",
                 LogLevel.DEBUG);
 
             if (!PassesFilters(change))
             {
+                Logger.WriteLine(
+                    $"[{change.CorrelationId}] {IdLogString}: Change filtered out: {change.FullPath}",
+                    LogLevel.DEBUG);
                 return;
             }
 
             if (!PassesExclusions(change))
             {
+                Logger.WriteLine(
+                    $"[{change.CorrelationId}] {IdLogString}: Change excluded: {change.FullPath}",
+                    LogLevel.DEBUG);
                 return;
             }
 
             Logger.WriteLine(
-                $"{IdLogString}: Started: {change.FullPath}, {change.Trigger} (Watch.ProcessChange)",
+                $"[{change.CorrelationId}] {IdLogString}: Started: {change.FullPath}, {change.Trigger} (Watch.ProcessChange)",
                 LogLevel.DEBUG);
 
             ExecuteWorkflows(change);
 
             Logger.WriteLine(
-                $"{IdLogString}: Completed: {change.FullPath}, {change.Trigger} (Watch.ProcessChange)",
+                $"[{change.CorrelationId}] {IdLogString}: Completed: {change.FullPath}, {change.Trigger} (Watch.ProcessChange)",
                 LogLevel.DEBUG);
         }
 

Original file line number	Diff line number	Diff line change
`@@ -100,12 +100,14 @@ public override void Run(ChangeInfo change, TriggerType trigger)`
`100`	`100`	`if (Change != null)`
`101`	`101`	`{`
`102`	`102`	`Logger.WriteLine(`
`103`		`- $"The source file could not be determined. Watch path: {Change.WatchPath}, changed: {Change.FullPath}.",`
	`103`	`+ $"[{Change.CorrelationId}] The source file could not be determined. Watch path: {Change.WatchPath}, changed: {Change.FullPath}.",`
`104`	`104`	`LogLevel.ERROR);`
`105`	`105`	`}`
`106`	`106`	`return;`
`107`	`107`	`}`
`108`	`108`
	`109`	`+ string correlationPrefix = Change != null ? $"[{Change.CorrelationId}] " : "";`
	`110`	`+`
`109`	`111`	`try`
`110`	`112`	`{`
`111`	`113`	`switch (Type)`
`@@ -114,31 +116,31 @@ public override void Run(ChangeInfo change, TriggerType trigger)`
`114`	`116`	`if (string.IsNullOrWhiteSpace(destination))`
`115`	`117`	`{`
`116`	`118`	`Logger.WriteLine(`
`117`		`- $"The file '{source}' could not be copied because the destination file could not be determined. Destination in config file: {Destination}.",`
	`119`	`+ $"{correlationPrefix}The file '{source}' could not be copied because the destination file could not be determined. Destination in config file: {Destination}.",`
`118`	`120`	`LogLevel.ERROR);`
`119`	`121`	`return;`
`120`	`122`	`}`
`121`	`123`
`122`	`124`	`TEFS.File.Copy(source, destination, Verify, KeepTimestamps);`
`123`		`- Logger.WriteLine($"Copied {source} to {destination}. Verify: {Verify}. Keep timestamps: {KeepTimestamps}.");`
	`125`	`+ Logger.WriteLine($"{correlationPrefix}Copied {source} to {destination}. Verify: {Verify}. Keep timestamps: {KeepTimestamps}.");`
`124`	`126`	`break;`
`125`	`127`
`126`	`128`	`case ActionType.Move:`
`127`	`129`	`if (string.IsNullOrWhiteSpace(destination))`
`128`	`130`	`{`
`129`	`131`	`Logger.WriteLine(`
`130`		`- $"The file '{source}' could not be moved because the destination file could not be determined. Destination in config file: {Destination}.",`
	`132`	`+ $"{correlationPrefix}The file '{source}' could not be moved because the destination file could not be determined. Destination in config file: {Destination}.",`
`131`	`133`	`LogLevel.ERROR);`
`132`	`134`	`return;`
`133`	`135`	`}`
`134`	`136`
`135`	`137`	`TEFS.File.Move(source, destination, Verify, KeepTimestamps);`
`136`		`- Logger.WriteLine($"Moved {source} to {destination}. Verify: {Verify}. Keep timestamps: {KeepTimestamps}.");`
	`138`	`+ Logger.WriteLine($"{correlationPrefix}Moved {source} to {destination}. Verify: {Verify}. Keep timestamps: {KeepTimestamps}.");`
`137`	`139`	`break;`
`138`	`140`
`139`	`141`	`case ActionType.Delete:`
`140`	`142`	`TEFS.File.Delete(source);`
`141`		`- Logger.WriteLine($"Deleted {source}.");`
	`143`	`+ Logger.WriteLine($"{correlationPrefix}Deleted {source}.");`
`142`	`144`	`break;`
`143`	`145`	`}`
`144`	`146`	`}`
`@@ -147,7 +149,7 @@ public override void Run(ChangeInfo change, TriggerType trigger)`
`147`	`149`	`{`
`148`	`150`	`Exception exception = ex.InnerException ?? ex;`
`149`	`151`	`Logger.WriteLine(`
`150`		`- $"Could not {Type.ToString().ToLower(System.Globalization.CultureInfo.CurrentCulture)} file '{source}.' Reason: {exception.Message}",`
	`152`	`+ $"{correlationPrefix}Could not {Type.ToString().ToLower(System.Globalization.CultureInfo.CurrentCulture)} file '{source}.' Reason: {exception.Message}",`
`151`	`153`	`LogLevel.ERROR);`
`152`	`154`	`if (ex.StackTrace != null)`
`153`	`155`	`{`
Original file line number	Diff line number	Diff line change
`@@ -75,17 +75,19 @@ public override void Run(ChangeInfo change, TriggerType trigger)`
`75`	`75`	`string? arguments = GetArguments();`
`76`	`76`	`string? workingDirectory = GetWorkingDirectory();`
`77`	`77`
	`78`	`+ string correlationPrefix = Change != null ? $"[{Change.CorrelationId}] " : "";`
	`79`	`+`
`78`	`80`	`if (string.IsNullOrWhiteSpace(commandPath))`
`79`	`81`	`{`
`80`		`- Logger.WriteLine($"The command was not provided. Command was not run.",`
	`82`	`+ Logger.WriteLine($"{correlationPrefix}The command was not provided. Command was not run.",`
`81`	`83`	`LogLevel.ERROR);`
`82`	`84`	`return;`
`83`	`85`	`}`
`84`	`86`
`85`	`87`	`if (!File.Exists(commandPath))`
`86`	`88`	`{`
`87`	`89`	`Logger.WriteLine(`
`88`		`- $"The command '{commandPath}' was not found. Command was not run.",`
	`90`	`+ $"{correlationPrefix}The command '{commandPath}' was not found. Command was not run.",`
`89`	`91`	`LogLevel.ERROR);`
`90`	`92`	`return;`
`91`	`93`	`}`
`@@ -111,11 +113,14 @@ public override void Run(ChangeInfo change, TriggerType trigger)`
`111`	`113`	`_processInfo.Enqueue(startInfo);`
`112`	`114`
`113`	`115`	`Logger.WriteLine(`
`114`		`- $"Queue command: {startInfo.FileName} {startInfo.Arguments}. Queue Length: {_processInfo.Count}. (Command.Run)",`
	`116`	`+ $"{correlationPrefix}Queue command: {startInfo.FileName} {startInfo.Arguments}. Queue Length: {_processInfo.Count}. (Command.Run)",`
`115`	`117`	`LogLevel.DEBUG);`
`116`	`118`
`117`	`119`	`// Execute the next process in the queue`
`118`		`- Execute();`
	`120`	`+ if (Change != null)`
	`121`	`+ {`
	`122`	`+ Execute(Change.CorrelationId);`
	`123`	`+ }`
`119`	`124`	`}`
`120`	`125`
`121`	`126`	`/// <summary>`
`@@ -151,9 +156,10 @@ protected virtual void Dispose(bool disposing)`
`151`	`156`	`/// <summary>`
`152`	`157`	`/// Executes the next command process from the queue.`
`153`	`158`	`/// </summary>`
`154`		`- private void Execute()`
	`159`	`+ /// <param name="correlationId">The correlation ID for tracking this execution.</param>`
	`160`	`+ private void Execute(Guid correlationId)`
`155`	`161`	`{`
`156`		`- // If the queue is null or empty, then no command is waiting to nbe`
	`162`	`+ // If the queue is null or empty, then no command is waiting to be`
`157`	`163`	`// executed`
`158`	`164`	`if (_processInfo == null \|\| _processInfo.IsEmpty)`
`159`	`165`	`{`
`@@ -171,7 +177,7 @@ private void Execute()`
`171`	`177`	`using (Process process = new Process())`
`172`	`178`	`{`
`173`	`179`	`Logger.WriteLine(`
`174`		`- $"START: Process {startInfo.FileName} {startInfo.Arguments}.");`
	`180`	`+ $"[{correlationId}] START: Process {startInfo.FileName} {startInfo.Arguments}.");`
`175`	`181`
`176`	`182`	`process.StartInfo = startInfo;`
`177`	`183`	`process.StartInfo.CreateNoWindow = true;`
`@@ -180,20 +186,20 @@ private void Execute()`
`180`	`186`	`process.WaitForExit();`
`181`	`187`
`182`	`188`	`Logger.WriteLine(`
`183`		`- $"END: Process {process?.StartInfo.FileName} {process?.StartInfo.Arguments} has completed.");`
	`189`	`+ $"[{correlationId}] END: Process {process?.StartInfo.FileName} {process?.StartInfo.Arguments} has completed.");`
`184`	`190`	`}`
`185`	`191`	`}`
`186`	`192`	`catch (Exception ex)`
`187`	`193`	`{`
`188`	`194`	`Logger.WriteLine(`
`189`		`- $"Could not run the command '{startInfo.FileName} {startInfo.Arguments}'. Reason: {ex.Message}",`
	`195`	`+ $"[{correlationId}] Could not run the command '{startInfo.FileName} {startInfo.Arguments}'. Reason: {ex.Message}",`
`190`	`196`	`LogLevel.ERROR);`
`191`	`197`	`}`
`192`	`198`	`}`
`193`	`199`	`else`
`194`	`200`	`{`
`195`	`201`	`Logger.WriteLine(`
`196`		`- $"The command '{startInfo.FileName}' was not found. Command was not run.",`
	`202`	`+ $"[{correlationId}] The command '{startInfo.FileName}' was not found. Command was not run.",`
`197`	`203`	`LogLevel.ERROR);`
`198`	`204`	`}`
`199`	`205`	`}`
Original file line number	Diff line number	Diff line change
`@@ -184,7 +184,8 @@ internal void QueueRequest(TriggerType trigger, ChangeInfo change)`
`184`	`184`	`}`
`185`	`185`	`}`
`186`	`186`
`187`		`- Logger.WriteLine($"Sending request: {Method} {uri}.");`
	`187`	`+ string correlationIdLog = Change != null ? $"[{Change.CorrelationId}] " : "";`
	`188`	`+ Logger.WriteLine($"{correlationIdLog}Sending request: {Method} {uri}.");`
`188`	`189`	`Response response =`
`189`	`190`	`await Request.SendAsync(`
`190`	`191`	`Method,`
Original file line number	Diff line number	Diff line change
`@@ -442,27 +442,33 @@ public void ProcessChange()`
`442`	`442`	`private void ProcessSingleChange(ChangeInfo change)`
`443`	`443`	`{`
`444`	`444`	`Logger.WriteLine(`
`445`		`- $"{IdLogString}: Change: {change.FullPath}, {change.Trigger} (Watch.ProcessChange)",`
	`445`	`+ $"[{change.CorrelationId}] {IdLogString}: Change: {change.FullPath}, {change.Trigger} (Watch.ProcessChange)",`
`446`	`446`	`LogLevel.DEBUG);`
`447`	`447`
`448`	`448`	`if (!PassesFilters(change))`
`449`	`449`	`{`
	`450`	`+ Logger.WriteLine(`
	`451`	`+ $"[{change.CorrelationId}] {IdLogString}: Change filtered out: {change.FullPath}",`
	`452`	`+ LogLevel.DEBUG);`
`450`	`453`	`return;`
`451`	`454`	`}`
`452`	`455`
`453`	`456`	`if (!PassesExclusions(change))`
`454`	`457`	`{`
	`458`	`+ Logger.WriteLine(`
	`459`	`+ $"[{change.CorrelationId}] {IdLogString}: Change excluded: {change.FullPath}",`
	`460`	`+ LogLevel.DEBUG);`
`455`	`461`	`return;`
`456`	`462`	`}`
`457`	`463`
`458`	`464`	`Logger.WriteLine(`
`459`		`- $"{IdLogString}: Started: {change.FullPath}, {change.Trigger} (Watch.ProcessChange)",`
	`465`	`+ $"[{change.CorrelationId}] {IdLogString}: Started: {change.FullPath}, {change.Trigger} (Watch.ProcessChange)",`
`460`	`466`	`LogLevel.DEBUG);`
`461`	`467`
`462`	`468`	`ExecuteWorkflows(change);`
`463`	`469`
`464`	`470`	`Logger.WriteLine(`
`465`		`- $"{IdLogString}: Completed: {change.FullPath}, {change.Trigger} (Watch.ProcessChange)",`
	`471`	`+ $"[{change.CorrelationId}] {IdLogString}: Completed: {change.FullPath}, {change.Trigger} (Watch.ProcessChange)",`
`466`	`472`	`LogLevel.DEBUG);`
`467`	`473`	`}`
`468`	`474`