Add ReturnCode to DiagnosticToolException

Author: mdh1418

src/Tools/Common/Commands/Utils.cs

@@ -164,12 +164,12 @@ public static void ResolveProcessForAttach(int processId, string name, string po
                 {
                     if (processId == -2)
                     {
-                        throw new DiagnosticToolException($"Failed to launch dsrouter: {dsrouter}. Make sure that dotnet-dsrouter is not already running. You can connect to an already running dsrouter with -p.");
+                        throw new DiagnosticToolException($"Failed to launch dsrouter: {dsrouter}. Make sure that dotnet-dsrouter is not already running. You can connect to an already running dsrouter with -p.", (int)ReturnCode.TracingError);
                     }
                     else
                     {
                         throw new DiagnosticToolException($"Failed to launch dsrouter: {dsrouter}. Please make sure that dotnet-dsrouter is installed and available in the same directory as dotnet-trace.\n" +
-                                                             "You can install dotnet-dsrouter by running 'dotnet tool install --global dotnet-dsrouter'. More info at https://learn.microsoft.com/en-us/dotnet/core/diagnostics/dotnet-dsrouter");
+                                                             "You can install dotnet-dsrouter by running 'dotnet tool install --global dotnet-dsrouter'. More info at https://learn.microsoft.com/en-us/dotnet/core/diagnostics/dotnet-dsrouter", (int)ReturnCode.TracingError);
                     }
                 }
             }

src/Tools/Common/DiagnosticToolException.cs

@@ -18,6 +18,10 @@ namespace Microsoft.Diagnostics.Tools
     // contextualized error messages, don't use this type.
     internal sealed class DiagnosticToolException : Exception
     {
-        public DiagnosticToolException(string errorMessage) : base(errorMessage) { }
+        public int ReturnCode { get; }
+        public DiagnosticToolException(string errorMessage, int returnCode = 3 /* ReturnCode.ArgumentError */) : base(errorMessage)
+        {
+            ReturnCode = returnCode;
+        }
     }
 }

src/Tools/dotnet-counters/CounterMonitor.cs

@@ -244,7 +244,7 @@ public async Task<ReturnCode> Monitor(
             catch (DiagnosticToolException dte)
             {
                 _console.Error.WriteLine(dte.Message);
-                return ReturnCode.ArgumentError;
+                return (ReturnCode)dte.ReturnCode;
             }
             finally
             {
@@ -351,7 +351,7 @@ public async Task<ReturnCode> Collect(
             catch (DiagnosticToolException dte)
             {
                 _console.Error.WriteLine(dte.Message);
-                return ReturnCode.ArgumentError;
+                return (ReturnCode)dte.ReturnCode;
             }
             finally
             {

src/Tools/dotnet-trace/CommandLine/Commands/CollectCommand.cs

@@ -472,11 +472,7 @@ internal async Task<int> Collect(CancellationToken ct, CommandLineConfiguration
             {
                 Console.Error.WriteLine($"[ERROR] {dte.Message}");
                 collectionStopped = true;
-                ret = (int)ReturnCode.ArgumentError;
-                if (dte.Message.StartsWith("Failed to launch dsrouter", StringComparison.OrdinalIgnoreCase))
-                {
-                    ret = (int)ReturnCode.TracingError;
-                }
+                ret = dte.ReturnCode;
             }
             catch (OperationCanceledException)
             {

src/Tools/dotnet-trace/CommandLine/Commands/CollectLinuxCommand.cs

@@ -90,7 +90,7 @@ internal int CollectLinux(CollectLinuxArgs args)
             catch (DiagnosticToolException dte)
             {
                 Console.Error.WriteLine($"[ERROR] {dte.Message}");
-                ret = (int)ReturnCode.ArgumentError;
+                ret = dte.ReturnCode;
             }
             catch (Exception ex)
             {