Merge pull request #1154 from OctopusDeploy/sast/sl/more-activities-in-tentacle-client

xwipeoutx · web-flow · commit e827f8e0243a · 2025-10-24T09:31:42.000+10:00
Add activity traces for retries
diff --git a/source/Octopus.Tentacle.Client/Execution/RpcCallExecutor.cs b/source/Octopus.Tentacle.Client/Execution/RpcCallExecutor.cs
@@ -64,9 +64,16 @@ public async Task<T> ExecuteWithRetries<T>(
 
             try
             {
+                var attemptNumber = 1;
                 var response = await rpcCallRetryHandler.ExecuteWithRetries(
                         async ct =>
                         {
+                            using var attemptActivity = TentacleClient.ActivitySource.StartActivity($"{nameof(RpcCallExecutor)}.{nameof(ExecuteWithRetries)} - Attempt");
+                            attemptActivity?.AddTag("octopus.tentacle.rpc_call.service", rpcCall.Service);
+                            attemptActivity?.AddTag("octopus.tentacle.rpc_call.name", rpcCall.Name);
+                            attemptActivity?.AddTag("octopus.tentacle.rpc_call.attempt_number", attemptNumber);
+                            attemptNumber++;
+                            
                             var start = DateTimeOffset.UtcNow;
 
                             try
@@ -85,6 +92,7 @@ public async Task<T> ExecuteWithRetries<T>(
                         onRetryAction: async (lastException, sleepDuration, retryCount, totalRetryDuration, elapsedDuration, _) =>
                         {
                             await Task.CompletedTask;
+                            activity?.AddEvent(new ActivityEvent("Retry"));
 
                             onErrorAction?.Invoke(lastException);
 
@@ -95,6 +103,7 @@ public async Task<T> ExecuteWithRetries<T>(
                         onTimeoutAction: async (timeoutDuration, elapsedDuration, retryCount, _) =>
                         {
                             await Task.CompletedTask;
+                            activity?.AddEvent(new ActivityEvent("Timeout"));
 
                             if (retryCount > 0)
                             {

Original file line number	Diff line number	Diff line change
`@@ -64,9 +64,16 @@ public async Task<T> ExecuteWithRetries<T>(`
`64`	`64`
`65`	`65`	`try`
`66`	`66`	`{`
	`67`	`+ var attemptNumber = 1;`
`67`	`68`	`var response = await rpcCallRetryHandler.ExecuteWithRetries(`
`68`	`69`	`async ct =>`
`69`	`70`	`{`
	`71`	`+ using var attemptActivity = TentacleClient.ActivitySource.StartActivity($"{nameof(RpcCallExecutor)}.{nameof(ExecuteWithRetries)} - Attempt");`
	`72`	`+ attemptActivity?.AddTag("octopus.tentacle.rpc_call.service", rpcCall.Service);`
	`73`	`+ attemptActivity?.AddTag("octopus.tentacle.rpc_call.name", rpcCall.Name);`
	`74`	`+ attemptActivity?.AddTag("octopus.tentacle.rpc_call.attempt_number", attemptNumber);`
	`75`	`+ attemptNumber++;`
	`76`	`+`
`70`	`77`	`var start = DateTimeOffset.UtcNow;`
`71`	`78`
`72`	`79`	`try`
`@@ -85,6 +92,7 @@ public async Task<T> ExecuteWithRetries<T>(`
`85`	`92`	`onRetryAction: async (lastException, sleepDuration, retryCount, totalRetryDuration, elapsedDuration, _) =>`
`86`	`93`	`{`
`87`	`94`	`await Task.CompletedTask;`
	`95`	`+ activity?.AddEvent(new ActivityEvent("Retry"));`
`88`	`96`
`89`	`97`	`onErrorAction?.Invoke(lastException);`
`90`	`98`
`@@ -95,6 +103,7 @@ public async Task<T> ExecuteWithRetries<T>(`
`95`	`103`	`onTimeoutAction: async (timeoutDuration, elapsedDuration, retryCount, _) =>`
`96`	`104`	`{`
`97`	`105`	`await Task.CompletedTask;`
	`106`	`+ activity?.AddEvent(new ActivityEvent("Timeout"));`
`98`	`107`
`99`	`108`	`if (retryCount > 0)`
`100`	`109`	`{`