Fix exception logging (#2578)

microsoft · Apr 10, 2024 · 79ed0a9 · 79ed0a9
1 parent 05ddcd8
commit 79ed0a9
Show file tree

Hide file tree

Showing 98 changed files with 217 additions and 222 deletions.
diff --git a/HyperVExtension/src/DevSetupAgent/DevAgentService.cs b/HyperVExtension/src/DevSetupAgent/DevAgentService.cs
@@ -41,13 +41,13 @@ protected async override Task ExecuteAsync(CancellationToken stoppingToken)
                 }
                 catch (Exception ex)
                 {
-                    _log.Error($"Exception in DevAgentService.", ex);
+                    _log.Error(ex, $"Exception in DevAgentService.");
                 }
             }
         }
         catch (Exception ex)
         {
-            _log.Error($"Failed to run DevSetupAgent.", ex);
+            _log.Error(ex, $"Failed to run DevSetupAgent.");
             throw;
         }
         finally

diff --git a/HyperVExtension/src/DevSetupAgent/HostRegistryChannel.cs b/HyperVExtension/src/DevSetupAgent/HostRegistryChannel.cs
@@ -113,7 +113,7 @@ await Task.Run(
                 }
                 catch (Exception ex)
                 {
-                    _log.Error($"Could not write host message. Response ID: {responseMessage.ResponseId}", ex);
+                    _log.Error(ex, $"Could not write host message. Response ID: {responseMessage.ResponseId}");
                 }
             },
             stoppingToken);
@@ -130,7 +130,7 @@ await Task.Run(
                 }
                 catch (Exception ex)
                 {
-                    _log.Error($"Could not delete host message. Response ID: {responseId}", ex);
+                    _log.Error(ex, $"Could not delete host message. Response ID: {responseId}");
                 }
             },
             stoppingToken);
@@ -207,7 +207,7 @@ private RequestMessage TryReadMessage()
                         }
                         catch (Exception ex)
                         {
-                            _log.Error($"Could not read host message {valueName}", ex);
+                            _log.Error(ex, $"Could not read host message {valueName}");
                         }
 
                         MessageHelper.DeleteAllMessages(_registryHiveKey, _fromHostRegistryKeyPath, s[0]);
@@ -218,7 +218,7 @@ private RequestMessage TryReadMessage()
         }
         catch (Exception ex)
         {
-            _log.Error("Could not read host message.", ex);
+            _log.Error(ex, "Could not read host message.");
         }
 
         return requestMessage;

diff --git a/HyperVExtension/src/DevSetupAgent/RegistryWatcher.cs b/HyperVExtension/src/DevSetupAgent/RegistryWatcher.cs
@@ -76,14 +76,14 @@ public void Start()
                                 }
                                 catch (Exception ex)
                                 {
-                                    _log.Error("RegistryChanged delegate failed.", ex);
+                                    _log.Error(ex, "RegistryChanged delegate failed.");
                                 }
                             }
                         }
                     }
                     catch (Exception ex)
                     {
-                        _log.Error("Registry Watcher thread failed.", ex);
+                        _log.Error(ex, "Registry Watcher thread failed.");
                     }
                 });
                 _log.Information("Registry Watcher thread started.");

diff --git a/HyperVExtension/src/DevSetupAgent/RequestManager.cs b/HyperVExtension/src/DevSetupAgent/RequestManager.cs
@@ -102,7 +102,7 @@ private void ProcessRequestQueue(CancellationToken stoppingToken)
             }
             catch (Exception ex)
             {
-                _log.Error($"Failed to execute request.", ex);
+                _log.Error(ex, $"Failed to execute request.");
             }
         }
     }

diff --git a/HyperVExtension/src/DevSetupAgent/Requests/RequestFactory.cs b/HyperVExtension/src/DevSetupAgent/Requests/RequestFactory.cs
@@ -64,7 +64,7 @@ public IHostRequest CreateRequest(IRequestContext requestContext)
         {
             var messageId = requestContext.RequestMessage.RequestId ?? "<unknown>";
             var requestData = requestContext.RequestMessage.RequestData ?? "<unknown>";
-            _log.Error($"Error processing message. Message ID: {messageId}. Request data: {requestData}", ex);
+            _log.Error(ex, $"Error processing message. Message ID: {messageId}. Request data: {requestData}");
             return new ErrorRequest(requestContext.RequestMessage);
         }
     }

diff --git a/HyperVExtension/src/DevSetupEngine/ConfigurationFileHelper.cs b/HyperVExtension/src/DevSetupEngine/ConfigurationFileHelper.cs
@@ -279,22 +279,21 @@ private void LogConfigurationDiagnostics(WinGet.IDiagnosticInformation diagnosti
     {
         _log.Information($"WinGet: {diagnosticInformation.Message}");
 
-        var sourceComponent = nameof(WinGet.ConfigurationProcessor);
         switch (diagnosticInformation.Level)
         {
             case WinGet.DiagnosticLevel.Warning:
-                _log.Warning(sourceComponent, diagnosticInformation.Message);
+                _log.Warning(diagnosticInformation.Message);
                 return;
             case WinGet.DiagnosticLevel.Error:
-                _log.Error(sourceComponent, diagnosticInformation.Message);
+                _log.Error(diagnosticInformation.Message);
                 return;
             case WinGet.DiagnosticLevel.Critical:
-                _log.Fatal(sourceComponent, diagnosticInformation.Message);
+                _log.Fatal(diagnosticInformation.Message);
                 return;
             case WinGet.DiagnosticLevel.Verbose:
             case WinGet.DiagnosticLevel.Informational:
             default:
-                _log.Information(sourceComponent, diagnosticInformation.Message);
+                _log.Information(diagnosticInformation.Message);
                 return;
         }
     }

diff --git a/HyperVExtension/src/DevSetupEngine/PackageOperationException.cs b/HyperVExtension/src/DevSetupEngine/PackageOperationException.cs
@@ -19,6 +19,6 @@ public PackageOperationException(ErrorCode errorCode, string message)
     {
         HResult = (int)errorCode;
         var log = Log.ForContext("SourceContext", nameof(PackageOperationException));
-        log.Error(message, this);
+        log.Error(this, message);
     }
 }
diff --git a/HyperVExtension/src/DevSetupEngine/Program.cs b/HyperVExtension/src/DevSetupEngine/Program.cs
@@ -58,7 +58,7 @@ public static int Main([System.Runtime.InteropServices.WindowsRuntime.ReadOnlyAr
         }
         catch (Exception ex)
         {
-            Log.Error($"Exception: {ex}", ex);
+            Log.Error(ex, $"Exception: {ex}");
             Log.CloseAndFlush();
             return ex.HResult;
         }

diff --git a/HyperVExtension/src/HyperVExtension.HostGuestCommunication/Providers/MessageHelper.cs b/HyperVExtension/src/HyperVExtension.HostGuestCommunication/Providers/MessageHelper.cs
@@ -110,7 +110,7 @@ public static Dictionary<string, string> MergeMessageParts(Dictionary<string, st
             catch (Exception ex)
             {
                 var log = Serilog.Log.ForContext("SourceContext", nameof(MessageHelper));
-                log.Error($"Could not read guest message {valueName}", ex);
+                log.Error(ex, $"Could not read guest message {valueName}");
             }
 
             messages.Add(name, value);

diff --git a/HyperVExtension/src/HyperVExtension/CommunicationWithGuest/Responses/ResponseFactory.cs b/HyperVExtension/src/HyperVExtension/CommunicationWithGuest/Responses/ResponseFactory.cs
@@ -66,7 +66,7 @@ public IGuestResponse CreateResponse(IResponseMessage message)
         {
             var messageId = message?.ResponseId ?? "<unknown>";
             var responseData = message?.ResponseData ?? "<unknown>";
-            _log.Error($"Error processing message. Message ID: {messageId}. Request data: {responseData}", ex);
+            _log.Error(ex, $"Error processing message. Message ID: {messageId}. Request data: {responseData}");
             return new ErrorResponse(message!);
         }
     }

diff --git a/HyperVExtension/src/HyperVExtension/Helpers/PsObjectHelper.cs b/HyperVExtension/src/HyperVExtension/Helpers/PsObjectHelper.cs
@@ -71,7 +71,7 @@ public PsObjectHelper(in PSObject pSObject)
         catch (Exception ex)
         {
             var log = Log.ForContext("SourceContext", nameof(PsObjectHelper));
-            log.Error($"Failed to get property value with name {propertyName} from object with type {type}.", ex);
+            log.Error(ex, $"Failed to get property value with name {propertyName} from object with type {type}.");
         }
 
         return default(T);

diff --git a/HyperVExtension/src/HyperVExtension/Helpers/Resources.cs b/HyperVExtension/src/HyperVExtension/Helpers/Resources.cs
@@ -23,7 +23,7 @@ public static string GetResource(string identifier, ILogger? log = null)
         }
         catch (Exception ex)
         {
-            log?.Error($"Failed loading resource: {identifier}", ex);
+            log?.Error(ex, $"Failed loading resource: {identifier}");
 
             // If we fail, load the original identifier so it is obvious which resource is missing.
             return identifier;

diff --git a/HyperVExtension/src/HyperVExtension/HyperVExtension.cs b/HyperVExtension/src/HyperVExtension/HyperVExtension.cs
@@ -57,7 +57,7 @@ public HyperVExtension(IHost host)
         }
         catch (Exception ex)
         {
-            log.Error($"Failed to get provider for provider type {providerType}", ex);
+            log.Error(ex, $"Failed to get provider for provider type {providerType}");
         }
 
         return provider;

diff --git a/HyperVExtension/src/HyperVExtension/Models/HyperVVirtualMachine.cs b/HyperVExtension/src/HyperVExtension/Models/HyperVVirtualMachine.cs
@@ -192,7 +192,7 @@ private ComputeSystemOperationResult Start(string options)
         catch (Exception ex)
         {
             StateChanged(this, ComputeSystemState.Unknown);
-            _log.Error(OperationErrorString(ComputeSystemOperations.Start), ex);
+            _log.Error(ex, OperationErrorString(ComputeSystemOperations.Start));
             return new ComputeSystemOperationResult(ex, OperationErrorUnknownString, ex.Message);
         }
     }
@@ -253,7 +253,7 @@ public IAsyncOperation<ComputeSystemOperationResult> TerminateAsync(string optio
             catch (Exception ex)
             {
                 StateChanged(this, ComputeSystemState.Unknown);
-                _log.Error(OperationErrorString(ComputeSystemOperations.Terminate), ex);
+                _log.Error(ex, OperationErrorString(ComputeSystemOperations.Terminate));
                 return new ComputeSystemOperationResult(ex, OperationErrorUnknownString, ex.Message);
             }
         }).AsAsyncOperation();
@@ -278,7 +278,7 @@ public IAsyncOperation<ComputeSystemOperationResult> DeleteAsync(string options)
             catch (Exception ex)
             {
                 StateChanged(this, ComputeSystemState.Unknown);
-                _log.Error(OperationErrorString(ComputeSystemOperations.Delete), ex);
+                _log.Error(ex, OperationErrorString(ComputeSystemOperations.Delete));
                 return new ComputeSystemOperationResult(ex, OperationErrorUnknownString, ex.Message);
             }
         }).AsAsyncOperation();
@@ -309,7 +309,7 @@ public IAsyncOperation<ComputeSystemOperationResult> SaveAsync(string options)
             catch (Exception ex)
             {
                 StateChanged(this, ComputeSystemState.Unknown);
-                _log.Error(OperationErrorString(ComputeSystemOperations.Save), ex);
+                _log.Error(ex, OperationErrorString(ComputeSystemOperations.Save));
                 return new ComputeSystemOperationResult(ex, OperationErrorUnknownString, ex.Message);
             }
         }).AsAsyncOperation();
@@ -340,7 +340,7 @@ public IAsyncOperation<ComputeSystemOperationResult> PauseAsync(string options)
             catch (Exception ex)
             {
                 StateChanged(this, ComputeSystemState.Unknown);
-                _log.Error(OperationErrorString(ComputeSystemOperations.Pause), ex);
+                _log.Error(ex, OperationErrorString(ComputeSystemOperations.Pause));
                 return new ComputeSystemOperationResult(ex, OperationErrorUnknownString, ex.Message);
             }
         }).AsAsyncOperation();
@@ -371,7 +371,7 @@ public IAsyncOperation<ComputeSystemOperationResult> ResumeAsync(string options)
             catch (Exception ex)
             {
                 StateChanged(this, ComputeSystemState.Unknown);
-                _log.Error(OperationErrorString(ComputeSystemOperations.Resume), ex);
+                _log.Error(ex, OperationErrorString(ComputeSystemOperations.Resume));
                 return new ComputeSystemOperationResult(ex, OperationErrorUnknownString, ex.Message);
             }
         }).AsAsyncOperation();
@@ -393,7 +393,7 @@ public IAsyncOperation<ComputeSystemOperationResult> CreateSnapshotAsync(string
             }
             catch (Exception ex)
             {
-                _log.Error(OperationErrorString(ComputeSystemOperations.CreateSnapshot), ex);
+                _log.Error(ex, OperationErrorString(ComputeSystemOperations.CreateSnapshot));
                 return new ComputeSystemOperationResult(ex, OperationErrorUnknownString, ex.Message);
             }
         }).AsAsyncOperation();
@@ -416,7 +416,7 @@ public IAsyncOperation<ComputeSystemOperationResult> RevertSnapshotAsync(string
             }
             catch (Exception ex)
             {
-                _log.Error(OperationErrorString(ComputeSystemOperations.RevertSnapshot), ex);
+                _log.Error(ex, OperationErrorString(ComputeSystemOperations.RevertSnapshot));
                 return new ComputeSystemOperationResult(ex, OperationErrorUnknownString, ex.Message);
             }
         }).AsAsyncOperation();
@@ -439,7 +439,7 @@ public IAsyncOperation<ComputeSystemOperationResult> DeleteSnapshotAsync(string
             }
             catch (Exception ex)
             {
-                _log.Error(OperationErrorString(ComputeSystemOperations.DeleteSnapshot), ex);
+                _log.Error(ex, OperationErrorString(ComputeSystemOperations.DeleteSnapshot));
                 return new ComputeSystemOperationResult(ex, OperationErrorUnknownString, ex.Message);
             }
         }).AsAsyncOperation();
@@ -457,7 +457,7 @@ public IAsyncOperation<ComputeSystemOperationResult> ConnectAsync(string options
             }
             catch (Exception ex)
             {
-                _log.Error($"Failed to launch vmconnect on {DateTime.Now}: VM details: {this}", ex);
+                _log.Error(ex, $"Failed to launch vmconnect on {DateTime.Now}: VM details: {this}");
                 return new ComputeSystemOperationResult(ex, OperationErrorUnknownString, ex.Message);
             }
         }).AsAsyncOperation();
@@ -487,7 +487,7 @@ public IAsyncOperation<ComputeSystemOperationResult> RestartAsync(string options
             catch (Exception ex)
             {
                 StateChanged(this, ComputeSystemState.Unknown);
-                _log.Error(OperationErrorString(ComputeSystemOperations.Restart), ex);
+                _log.Error(ex, OperationErrorString(ComputeSystemOperations.Restart));
                 return new ComputeSystemOperationResult(ex, OperationErrorUnknownString, ex.Message);
             }
         }).AsAsyncOperation();
@@ -536,7 +536,7 @@ public IAsyncOperation<IEnumerable<ComputeSystemProperty>> GetComputeSystemPrope
             }
             catch (Exception ex)
             {
-                _log.Error($"Failed to GetComputeSystemPropertiesAsync on {DateTime.Now}: VM details: {this}", ex);
+                _log.Error(ex, $"Failed to GetComputeSystemPropertiesAsync on {DateTime.Now}: VM details: {this}");
                 return new List<ComputeSystemProperty>();
             }
         }).AsAsyncOperation();
@@ -708,7 +708,7 @@ public SDK.ApplyConfigurationResult ApplyConfiguration(ApplyConfigurationOperati
         }
         catch (Exception ex)
         {
-            _log.Error($"Failed to apply configuration on {DateTime.Now}: VM details: {this}", ex);
+            _log.Error(ex, $"Failed to apply configuration on {DateTime.Now}: VM details: {this}");
             return operation.CompleteOperation(new HostGuestCommunication.ApplyConfigurationResult(ex.HResult, ex.Message));
         }
     }
@@ -721,7 +721,7 @@ public SDK.ApplyConfigurationResult ApplyConfiguration(ApplyConfigurationOperati
         }
         catch (Exception ex)
         {
-            _log.Error($"Failed to apply configuration on {DateTime.Now}: VM details: {this}", ex);
+            _log.Error(ex, $"Failed to apply configuration on {DateTime.Now}: VM details: {this}");
             return new ApplyConfigurationOperation(this, ex);
         }
     }

diff --git a/...tension/src/HyperVExtension/Models/VirtualMachineCreation/VMGalleryVMCreationOperation.cs b/...tension/src/HyperVExtension/Models/VirtualMachineCreation/VMGalleryVMCreationOperation.cs
@@ -139,7 +139,7 @@ public void Report(IOperationReport value)
             }
             catch (Exception ex)
             {
-                _log.Error("Operation to create compute system failed", ex);
+                _log.Error(ex, "Operation to create compute system failed");
                 ComputeSystemResult = new CreateComputeSystemResult(ex, ex.Message, ex.Message);
             }
 
@@ -161,7 +161,7 @@ private void UpdateProgress(IOperationReport report, string localizedKey, string
         }
         catch (Exception ex)
         {
-            _log.Error("Failed to update progress", ex);
+            _log.Error(ex, "Failed to update progress");
         }
     }
 
@@ -173,7 +173,7 @@ private void UpdateProgress(string localizedString, uint percentage = 0u)
         }
         catch (Exception ex)
         {
-            _log.Error("Failed to update progress", ex);
+            _log.Error(ex, "Failed to update progress");
         }
     }
 
@@ -221,7 +221,7 @@ private async Task DeleteFileIfExists(StorageFile file)
         }
         catch (Exception ex)
         {
-            _log.Error($"Failed to delete file {file.Path}", ex);
+            _log.Error(ex, $"Failed to delete file {file.Path}");
         }
     }
 

diff --git a/HyperVExtension/src/HyperVExtension/Models/VmCredentialAdaptiveCardSession.cs b/HyperVExtension/src/HyperVExtension/Models/VmCredentialAdaptiveCardSession.cs
@@ -163,7 +163,7 @@ public IAsyncOperation<ProviderOperationResult> OnAction(string action, string i
             }
             catch (Exception ex)
             {
-                _log.Error($"Exception in OnAction: {ex}");
+                _log.Error(ex, $"Exception in OnAction: {ex}");
                 operationResult = new ProviderOperationResult(ProviderOperationStatus.Failure, ex, "Something went wrong", ex.Message);
             }
 

diff --git a/HyperVExtension/src/HyperVExtension/Models/WaitForLoginAdaptiveCardSession.cs b/HyperVExtension/src/HyperVExtension/Models/WaitForLoginAdaptiveCardSession.cs
@@ -144,7 +144,7 @@ public IAsyncOperation<ProviderOperationResult> OnAction(string action, string i
             }
             catch (Exception ex)
             {
-                _log.Error($"Exception in OnAction: {ex}");
+                _log.Error(ex, $"Exception in OnAction: {ex}");
                 operationResult = new ProviderOperationResult(ProviderOperationStatus.Failure, ex, "Something went wrong", ex.Message);
             }
 

diff --git a/HyperVExtension/src/HyperVExtension/Providers/HyperVProvider.cs b/HyperVExtension/src/HyperVExtension/Providers/HyperVProvider.cs
@@ -75,7 +75,7 @@ public IAsyncOperation<ComputeSystemsResult> GetComputeSystemsAsync(IDeveloperId
             }
             catch (Exception ex)
             {
-                _log.Error($"Failed to retrieved all virtual machines on: {DateTime.Now}", ex);
+                _log.Error(ex, $"Failed to retrieved all virtual machines on: {DateTime.Now}");
                 return new ComputeSystemsResult(ex, OperationErrorString, ex.Message);
             }
         }).AsAsyncOperation();
@@ -105,7 +105,7 @@ public ComputeSystemAdaptiveCardResult CreateAdaptiveCardSessionForComputeSystem
         }
         catch (Exception ex)
         {
-            _log.Error($"Failed to create a new virtual machine on: {DateTime.Now}", ex);
+            _log.Error(ex, $"Failed to create a new virtual machine on: {DateTime.Now}");
 
             // Dev Home will handle null values as failed operations. We can't throw because this is an out of proc
             // COM call, so we'll lose the error information. We'll log the error and return null.

diff --git a/HyperVExtension/src/HyperVExtension/Services/PowerShellService.cs b/HyperVExtension/src/HyperVExtension/Services/PowerShellService.cs
@@ -60,7 +60,7 @@ public PowerShellResult Execute(IEnumerable<PowerShellCommandlineStatement> comm
         catch (Exception ex)
         {
             var commandStrings = string.Join(Environment.NewLine, commandLineStatements.Select(cmd => cmd.ToString()));
-            _log.Error($"Error running PowerShell commands: {commandStrings}", ex);
+            _log.Error(ex, $"Error running PowerShell commands: {commandStrings}");
             throw;
         }
     }

diff --git a/HyperVExtension/src/HyperVExtension/Services/VMGalleryService.cs b/HyperVExtension/src/HyperVExtension/Services/VMGalleryService.cs
@@ -87,7 +87,7 @@ public async Task<VMGalleryImageList> GetGalleryImagesAsync()
         }
         catch (Exception ex)
         {
-            _log.Error($"Unable to retrieve VM gallery images", ex);
+            _log.Error(ex, $"Unable to retrieve VM gallery images");
         }
 
         return _imageList;