Capture a few more errors in logging.

Author: brdeyo

src/VirtualClient/VirtualClient.Contracts/Exceptions.cs

@@ -486,10 +486,9 @@ public ProcessException(string message, Exception innerException, ErrorReason re
     }
 
     /// <summary>
-    /// Represents an exception/error that occurred during the execution of a process
-    /// on the system (i.e. an OS process).
+    /// Represents an exception/error that occurred during the startup of the application.
     /// </summary>
-    public class StartupException : Exception
+    public class StartupException : VirtualClientException
     {
         /// <summary>
         /// Initializes a new instance of the <see cref="StartupException"/> class.
@@ -509,6 +508,17 @@ public StartupException(string message)
         {
         }
 
+        /// <summary>
+        /// Initializes a new instance of the <see cref="StartupException"/> class with
+        /// the provided message.
+        /// </summary>
+        /// <param name="message">The exception message.</param>
+        /// <param name="reason">The error reason/category.</param>
+        public StartupException(string message, ErrorReason reason)
+            : base(message, reason)
+        {
+        }
+
         /// <summary>
         /// Initializes a new instance of the <see cref="StartupException"/> class with
         /// the provided message and inner exception.
@@ -519,6 +529,18 @@ public StartupException(string message, Exception innerException)
             : base(message, innerException)
         {
         }
+
+        /// <summary>
+        /// Initializes a new instance of the <see cref="StartupException"/> class with
+        /// the provided message and inner exception.
+        /// </summary>
+        /// <param name="message">The exception message.</param>
+        /// <param name="innerException">The inner exception.</param>
+        /// <param name="reason">The error reason/category.</param>
+        public StartupException(string message, Exception innerException, ErrorReason reason)
+            : base(message, innerException, reason)
+        {
+        }
     }
 
     /// <summary>

src/VirtualClient/VirtualClient.Core/ProfileExecutor.cs

@@ -520,10 +520,23 @@ protected async Task ExecuteMonitorsAsync(EventContext parentContext, Cancellati
                         monitoringTasks.Add(monitor.ExecuteAsync(cancellationToken));
                     }
                 }
-                catch (VirtualClientException)
+                catch (VirtualClientException exc) when ((int)exc.Reason >= 500 || this.FailFast || monitor?.FailFast == true)
                 {
+                    // Error reasons have numeric/integer values that indicate their severity. Error reasons
+                    // with a value >= 500 are terminal situations where the workload cannot run successfully
+                    // regardless of how many times we attempt it.
                     throw;
                 }
+                catch (VirtualClientException)
+                {
+                    // Exceptions with error reasons < 500 are potentially transient issues. We do not want to 
+                    // cause VC to exit in these cases but to give it a chance to retry the logic that failed on
+                    // subsequent rounds of processing.
+                    //
+                    // Exceptions having error reasons with a value between 400 - 499 are serious errors but they represent
+                    // issues that may be transient and that can be resolve after a period of time. When
+                    // we catch these type of errors, we may want to reset and start over in the test workflow.
+                }
                 catch (MissingMemberException exc)
                 {
                     throw new DependencyException(

src/VirtualClient/VirtualClient.Main/ExecuteProfileCommand.cs

@@ -164,12 +164,22 @@ public override async Task<int> ExecuteAsync(string[] args, CancellationTokenSou
                 Program.LogErrorMessage(logger, exc, EventContext.Persisted());
                 exitCode = (int)ErrorReason.NotSupported;
             }
+            catch (StartupException exc)
+            {
+                // The type of exceptions are captured upstream by the profile
+                // execution components.
+                Program.LogErrorMessage(logger, exc, EventContext.Persisted());
+                exitCode = (int)exc.Reason;
+            }
             catch (VirtualClientException exc)
             {
+                // The type of exceptions are captured upstream by the profile
+                // execution components.
                 exitCode = (int)exc.Reason;
             }
-            catch
+            catch (Exception exc)
             {
+                Program.LogErrorMessage(logger, exc, EventContext.Persisted());
                 exitCode = 1;
             }
             finally
@@ -304,7 +314,7 @@ protected virtual async Task DownloadProfileAsync(IServiceCollection dependencie
                     // If the profile defined is not a full path to a profile located on the system, then we
                     // fallback to looking for the profile in the 'profiles' directory within the Virtual Client
                     // parent directory itself or in any platform extensions locations.
-                    throw new DependencyException(
+                    throw new StartupException(
                         $"Profile not found. Profile does not exist at the path '{profileFullPath}' nor in any extensions location.",
                         ErrorReason.ProfileNotFound);
                 }
@@ -425,8 +435,9 @@ protected async Task<EnvironmentLayout> ReadEnvironmentLayoutAsync(IServiceColle
 
                     if (!systemManagement.FileSystem.File.Exists(layoutFullPath))
                     {
-                        throw new FileNotFoundException(
-                            $"Invalid path specified. An environment layout file does not exist at path '{layoutFullPath}'.");
+                        throw new StartupException(
+                            $"Invalid path specified. An environment layout file does not exist at path '{layoutFullPath}'.",
+                            ErrorReason.LayoutInvalid);
                     }
 
                     string layoutContent = await RetryPolicies.FileOperations

src/VirtualClient/VirtualClient.Main/Program.cs

@@ -133,12 +133,14 @@ public static int Main(string[] args)
                 // Certificate-related issues.
                 exitCode = (int)ErrorReason.InvalidCertificate;
                 Console.Error.WriteLine(exc.ToString(withCallStack: false, withErrorTypes: false));
+                Program.WriteCrashLog(exc);
             }
             catch (NotSupportedException exc)
             {
                 // Various usages that are not supported.
                 exitCode = (int)ErrorReason.NotSupported;
                 Console.Error.WriteLine(exc.ToString(withCallStack: false, withErrorTypes: false));
+                Program.WriteCrashLog(exc);
             }
             catch (Exception exc)
             {

website/docs/guides/0040-telemetry.md

@@ -656,7 +656,7 @@ Fields that are part of the custom dimensions.
 The following example illustrates the schema requirements for the various supported log file formats:
 
 * **JSON Schema and Requirements**  
-  The example below illustrates the supported JSON format for log files. Each JSON data point/fragment should be separated from the next using a ```---``` delimiter as is shown in 
+  The example below illustrates the supported JSON format for log files. Each JSON data point/fragment should be separated from the next using a ```-----``` delimiter as is shown in 
   the example.
 
   ``` json