Skip to content

Added the option of not having an interactive console output. #2398

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
guerrerotook wants to merge 1 commit into from
Closed

Added the option of not having an interactive console output. #2398

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 29 additions & 13 deletions src/Tools/dotnet-trace/CommandLine/Commands/CollectCommand.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ namespace Microsoft.Diagnostics.Tools.Trace
{
internal static class CollectCommandHandler
{
delegate Task<int> CollectDelegate(CancellationToken ct, IConsole console, int processId, FileInfo output, uint buffersize, string providers, string profile, TraceFileFormat format, TimeSpan duration, string clrevents, string clreventlevel, string name, string port, bool showchildio, bool resumeRuntime);
delegate Task<int> CollectDelegate(CancellationToken ct, IConsole console, int processId, FileInfo output, uint buffersize, string providers, string profile, TraceFileFormat format, TimeSpan duration, string clrevents, string clreventlevel, string name, string port, bool showchildio, bool resumeRuntime, bool nonInteractiveConsole);

/// <summary>
/// Collects a diagnostic trace from a currently running process or launch a child process and trace it.
Expand All @@ -43,7 +43,7 @@ internal static class CollectCommandHandler
/// <param name="showchildio">Should IO from a child process be hidden.</param>
/// <param name="resumeRuntime">Resume runtime once session has been initialized.</param>
/// <returns></returns>
private static async Task<int> Collect(CancellationToken ct, IConsole console, int processId, FileInfo output, uint buffersize, string providers, string profile, TraceFileFormat format, TimeSpan duration, string clrevents, string clreventlevel, string name, string diagnosticPort, bool showchildio, bool resumeRuntime)
private static async Task<int> Collect(CancellationToken ct, IConsole console, int processId, FileInfo output, uint buffersize, string providers, string profile, TraceFileFormat format, TimeSpan duration, string clrevents, string clreventlevel, string name, string diagnosticPort, bool showchildio, bool resumeRuntime, bool nonInteractiveConsole)
{
int ret = 0;
bool collectionStopped = false;
Expand Down Expand Up @@ -272,8 +272,15 @@ private static async Task<int> Collect(CancellationToken ct, IConsole console, i
Console.Out.WriteLine("Stopping the trace. This may take up to minutes depending on the application being traced.");
};


while (!shouldExit.WaitOne(100) && !(cancelOnEnter && Console.KeyAvailable && Console.ReadKey(true).Key == ConsoleKey.Enter))
printStatus();
{
if (!nonInteractiveConsole)
{
printStatus();
}
}


// if the CopyToAsync ended early (target program exited, etc.), the we don't need to stop the session.
if (!copyTask.Wait(0))
Expand Down Expand Up @@ -335,7 +342,7 @@ private static async Task<int> Collect(CancellationToken ct, IConsole console, i
if (console.GetTerminal() != null)
Console.CursorVisible = true;
}

if (ProcessLauncher.Launcher.HasChildProc)
{
if (!collectionStopped || ct.IsCancellationRequested)
Expand All @@ -356,9 +363,9 @@ private static async Task<int> Collect(CancellationToken ct, IConsole console, i
private static void PrintProviders(IReadOnlyList<EventPipeProvider> providers, Dictionary<string, string> enabledBy)
{
Console.Out.WriteLine("");
Console.Out.Write(String.Format("{0, -40}","Provider Name")); // +4 is for the tab
Console.Out.Write(String.Format("{0, -20}","Keywords"));
Console.Out.Write(String.Format("{0, -20}","Level"));
Console.Out.Write(String.Format("{0, -40}", "Provider Name")); // +4 is for the tab
Console.Out.Write(String.Format("{0, -20}", "Keywords"));
Console.Out.Write(String.Format("{0, -20}", "Level"));
Console.Out.Write("Enabled By\r\n");
foreach (var provider in providers)
{
Expand All @@ -384,7 +391,7 @@ private static string GetSize(long length)
public static Command CollectCommand() =>
new Command(
name: "collect",
description: "Collects a diagnostic trace from a currently running process or launch a child process and trace it. Append -- to the collect command to instruct the tool to run a command and trace it immediately. When tracing a child process, the exit code of dotnet-trace shall be that of the traced process unless the trace process encounters an error.")
description: "Collects a diagnostic trace from a currently running process or launch a child process and trace it. Append -- to the collect command to instruct the tool to run a command and trace it immediately. When tracing a child process, the exit code of dotnet-trace shall be that of the traced process unless the trace process encounters an error.")
{
// Handler
HandlerDescriptor.FromDelegate((CollectDelegate)Collect).GetCommandHandler(),
Expand All @@ -401,7 +408,8 @@ public static Command CollectCommand() =>
CommonOptions.NameOption(),
DiagnosticPortOption(),
ShowChildIOOption(),
ResumeRuntimeOption()
ResumeRuntimeOption(),
NonInteractiveConsoleOption()
};

private static uint DefaultCircularBufferSizeInMB() => 256;
Expand Down Expand Up @@ -454,16 +462,16 @@ private static Option DurationOption() =>
{
Argument = new Argument<TimeSpan>(name: "duration-timespan", getDefaultValue: () => default)
};
private static Option CLREventsOption() =>

private static Option CLREventsOption() =>
new Option(
alias: "--clrevents",
description: @"List of CLR runtime events to emit.")
{
Argument = new Argument<string>(name: "clrevents", getDefaultValue: () => string.Empty)
};

private static Option CLREventLevelOption() =>
private static Option CLREventLevelOption() =>
new Option(
alias: "--clreventlevel",
description: @"Verbosity of CLR events to be emitted.")
Expand Down Expand Up @@ -492,5 +500,13 @@ private static Option ResumeRuntimeOption() =>
{
Argument = new Argument<bool>(name: "resumeRuntime", getDefaultValue: () => true)
};

private static Option NonInteractiveConsoleOption() =>
new Option(
alias: "--non-interactive-console",
description: @"This make the the console output non interactive. This is may help preventing the app to fail where there is no console.")
{
Argument = new Argument<bool>(name: "nonInteractiveConsole", getDefaultValue: () => false)
};
}
}
}