[dotnet-trace][collect-linux] Reintroduce process specifier (#5623)

With microsoft/one-collect#209, we can now allow
specifying a particular process to be traced.

Author: mdh1418

src/Tools/Common/Commands/Utils.cs

@@ -72,6 +72,57 @@ public static bool ValidateArgumentsForChildProcess(int processId, string name,
             return true;
         }
 
+        /// <summary>
+        /// A helper method for validating --process-id, --name options for collect commands and resolving the process ID and name.
+        /// Only one of these options can be specified, so it checks for duplicate options specified and if there is
+        /// such duplication, it prints the appropriate error message.
+        /// </summary>
+        /// <param name="processId">process ID</param>
+        /// <param name="name">name</param>
+        /// <param name="resolvedProcessId">resolvedProcessId</param>
+        /// <param name="resolvedProcessName">resolvedProcessName</param>
+        /// <returns></returns>
+        public static bool ResolveProcess(int processId, string name, out int resolvedProcessId, out string resolvedProcessName)
+        {
+            resolvedProcessId = -1;
+            resolvedProcessName = name;
+            if (processId == 0 && string.IsNullOrEmpty(name))
+            {
+                Console.Error.WriteLine("Must specify either --process-id or --name.");
+                return false;
+            }
+            else if (processId < 0)
+            {
+                Console.Error.WriteLine($"{processId} is not a valid process ID");
+                return false;
+            }
+            else if ((processId != 0) && !string.IsNullOrEmpty(name))
+            {
+                Console.Error.WriteLine("Only one of the --name or --process-id options may be specified.");
+                return false;
+            }
+            try
+            {
+                if (processId != 0)
+                {
+                    Process process = Process.GetProcessById(processId);
+                    resolvedProcessId = processId;
+                    resolvedProcessName = process.ProcessName;
+                }
+                else
+                {
+                    resolvedProcessId = FindProcessIdWithName(name);
+                }
+            }
+            catch (ArgumentException)
+            {
+                Console.Error.WriteLine($"No process with ID {processId} is currently running.");
+                return false;
+            }
+
+            return resolvedProcessId != -1;
+        }
+
         /// <summary>
         /// A helper method for validating --process-id, --name, --diagnostic-port, --dsrouter options for collect commands and resolving the process ID.
         /// Only one of these options can be specified, so it checks for duplicate options specified and if there is

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

@@ -31,7 +31,9 @@ internal sealed record CollectLinuxArgs(
             string[] PerfEvents,
             string[] Profiles,
             FileInfo Output,
-            TimeSpan Duration);
+            TimeSpan Duration,
+            string Name,
+            int ProcessId);
 
         public CollectLinuxCommandHandler(IConsole console = null)
         {
@@ -51,6 +53,15 @@ internal int CollectLinux(CollectLinuxArgs args)
                 return (int)ReturnCode.PlatformNotSupportedError;
             }
 
+            if (args.ProcessId != 0 || !string.IsNullOrEmpty(args.Name))
+            {
+                if (!CommandUtils.ResolveProcess(args.ProcessId, args.Name, out int resolvedProcessId, out string resolvedProcessName))
+                {
+                    return (int)ReturnCode.ArgumentError;
+                }
+                args = args with { Name = resolvedProcessName, ProcessId = resolvedProcessId };
+            }
+
             Console.WriteLine("==========================================================================================");
             Console.WriteLine("The collect-linux verb is a new preview feature and relies on an updated version of the");
             Console.WriteLine(".nettrace file format. The latest PerfView release supports these trace files but other");
@@ -117,6 +128,8 @@ public static Command CollectLinuxCommand()
                 CommonOptions.ProfileOption,
                 CommonOptions.OutputPathOption,
                 CommonOptions.DurationOption,
+                CommonOptions.NameOption,
+                CommonOptions.ProcessIdOption
             };
             collectLinuxCommand.TreatUnmatchedTokensAsErrors = true; // collect-linux currently does not support child process tracing.
             collectLinuxCommand.Description = "Collects diagnostic traces using perf_events, a Linux OS technology. collect-linux requires admin privileges to capture kernel- and user-mode events, and by default, captures events from all processes. This Linux-only command includes the same .NET events as dotnet-trace collect, and it uses the kernel’s user_events mechanism to emit .NET events as perf events, enabling unification of user-space .NET events with kernel-space system events.";
@@ -135,7 +148,9 @@ public static Command CollectLinuxCommand()
                     PerfEvents: perfEventsValue.Split(',', StringSplitOptions.RemoveEmptyEntries | StringSplitOptions.TrimEntries),
                     Profiles: profilesValue.Split(',', StringSplitOptions.RemoveEmptyEntries | StringSplitOptions.TrimEntries),
                     Output: parseResult.GetValue(CommonOptions.OutputPathOption) ?? new FileInfo(CommonOptions.DefaultTraceName),
-                    Duration: parseResult.GetValue(CommonOptions.DurationOption)));
+                    Duration: parseResult.GetValue(CommonOptions.DurationOption),
+                    Name: parseResult.GetValue(CommonOptions.NameOption) ?? string.Empty,
+                    ProcessId: parseResult.GetValue(CommonOptions.ProcessIdOption)));
                 return Task.FromResult(rc);
             });
 
@@ -220,7 +235,14 @@ private byte[] BuildRecordTraceArgs(CollectLinuxArgs args, out string scriptPath
             }
             Console.WriteLine();
 
-            FileInfo resolvedOutput = ResolveOutputPath(args.Output);
+            int pid = args.ProcessId;
+            if (pid > 0)
+            {
+                recordTraceArgs.Add($"--pid");
+                recordTraceArgs.Add($"{pid}");
+            }
+
+            FileInfo resolvedOutput = ResolveOutputPath(args.Output, args.Name);
             recordTraceArgs.Add($"--out");
             recordTraceArgs.Add(resolvedOutput.FullName);
             Console.WriteLine($"Output File    : {resolvedOutput.FullName}");
@@ -237,15 +259,21 @@ private byte[] BuildRecordTraceArgs(CollectLinuxArgs args, out string scriptPath
             return Encoding.UTF8.GetBytes(options);
         }
 
-        private static FileInfo ResolveOutputPath(FileInfo output)
+        private static FileInfo ResolveOutputPath(FileInfo output, string processName)
         {
             if (!string.Equals(output.Name, CommonOptions.DefaultTraceName, StringComparison.OrdinalIgnoreCase))
             {
                 return output;
             }
 
+            string traceName = "trace";
+            if (!string.IsNullOrEmpty(processName))
+            {
+                traceName = processName;
+            }
+
             DateTime now = DateTime.Now;
-            return new FileInfo($"trace_{now:yyyyMMdd}_{now:HHmmss}.nettrace");
+            return new FileInfo($"{traceName}_{now:yyyyMMdd}_{now:HHmmss}.nettrace");
         }
 
         private int OutputHandler(uint type, IntPtr data, UIntPtr dataLen)

src/Tools/dotnet-trace/dotnet-trace.csproj

@@ -14,7 +14,7 @@
   <ItemGroup>
     <PackageReference Include="System.CommandLine" Version="$(SystemCommandLineVersion)" />
     <PackageReference Include="Microsoft.Diagnostics.Tracing.TraceEvent" Version="$(MicrosoftDiagnosticsTracingTraceEventVersion)" GeneratePathProperty="true" />
-    <PackageReference Include="Microsoft.OneCollect.RecordTrace" Version="0.1.32151" PrivateAssets="All" GeneratePathProperty="true"
+    <PackageReference Include="Microsoft.OneCollect.RecordTrace" Version="0.1.32221" PrivateAssets="All" GeneratePathProperty="true"
                       Condition="'$(TargetRid)' != '' and $([System.String]::Copy('$(TargetRid)').StartsWith('linux'))" />
   </ItemGroup>
 

src/tests/dotnet-trace/CollectLinuxCommandFunctionalTests.cs

@@ -26,7 +26,9 @@ private static CollectLinuxCommandHandler.CollectLinuxArgs TestArgs(
             string[] perfEvents = null,
             string[] profile = null,
             FileInfo output = null,
-            TimeSpan duration = default)
+            TimeSpan duration = default,
+            string name = "",
+            int processId = 0)
         {
             return new CollectLinuxCommandHandler.CollectLinuxArgs(ct,
                                                                    providers ?? Array.Empty<string>(),
@@ -35,7 +37,9 @@ private static CollectLinuxCommandHandler.CollectLinuxArgs TestArgs(
                                                                    perfEvents ?? Array.Empty<string>(),
                                                                    profile ?? Array.Empty<string>(),
                                                                    output ?? new FileInfo("trace.nettrace"),
-                                                                   duration);
+                                                                   duration,
+                                                                   name,
+                                                                   processId);
         }
 
         [Theory]