From: José Rivero Date: Tue, 6 Aug 2019 18:40:01 +0000 (-0700) Subject: Removing Provider GUID references from EventPipe related files. (#416) X-Git-Tag: submit/tizen/20191015.063341~14^2^2~1 X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=278b3b349f37c44e83e6b1140ab538d21030ec42;p=platform%2Fcore%2Fdotnet%2Fdiagnostics.git Removing Provider GUID references from EventPipe related files. (#416) --- diff --git a/documentation/design-docs/dotnet-tools.md b/documentation/design-docs/dotnet-tools.md index b0674695c..5486d560d 100644 --- a/documentation/design-docs/dotnet-tools.md +++ b/documentation/design-docs/dotnet-tools.md @@ -11,8 +11,8 @@ These are some quick examples of the work we'd expect a .Net developer to want t > dotnet tool install -g dotnet-counters You can invoke the tool using the following command: dotnet-counters Tool 'dotnet-counters' (version '1.0.0') was successfully installed. - > dotnet-counters monitor --process-id 1902 --refresh-interval 1 System.Runtime - + > dotnet-counters monitor --process-id 1902 --refresh-interval 1 System.Runtime + Press p to pause, r to resume, q to quit. System.Runtime: CPU Usage (%) 24 @@ -175,7 +175,7 @@ MONITOR 1. Monitoring all counters from `System.Runtime` at a refresh interval of 3 seconds: - > dotnet-counters monitor --process-id 1902 --refresh-interval 3 System.Runtime + > dotnet-counters monitor --process-id 1902 --refresh-interval 3 System.Runtime Press p to pause, r to resume, q to quit. System.Runtime: CPU Usage (%) 24 @@ -189,7 +189,7 @@ MONITOR 2. Monitoring just CPU usage and GC heap size from `System.Runtime` at a refresh interval of 5 seconds: - > dotnet-counters monitor --process-id 1902 --refresh-interval 5 System.Runtime[cpu-usage,gc-heap-size] + > dotnet-counters monitor --process-id 1902 --refresh-interval 5 System.Runtime[cpu-usage,gc-heap-size] Press p to pause, r to resume, q to quit. System.Runtime: CPU Usage (%) 24 @@ -284,8 +284,8 @@ COLLECT A provider consists of the name and optionally the keywords, verbosity level, and custom key/value pairs. The string is written 'Provider[,Provider]' - Provider format: (GUID|KnownProviderName)[:Keywords[:Level][:KeyValueArgs]] - GUID|KnownProviderName - The provider's name + Provider format: KnownProviderName[:Keywords[:Level][:KeyValueArgs]] + KnownProviderName - The provider's name Keywords - 8 character hex number bit mask Level - A number in the range [0, 5] KeyValueArgs - A semicolon separated list of key=value @@ -364,12 +364,12 @@ COLLECT Options: -p, --process-id The process to collect a memory dump from. - + -h, --help Show command line help -o, --output - The path where collected dumps should be written. Defaults to '.\dump_YYYYMMDD_HHMMSS.dmp' on Windows and + The path where collected dumps should be written. Defaults to '.\dump_YYYYMMDD_HHMMSS.dmp' on Windows and './core_YYYYMMDD_HHMMSS' on Linux where YYYYMMDD is Year/Month/Day and HHMMSS is Hour/Minute/Second. Otherwise, it is the full path and file name of the dump. @@ -409,7 +409,7 @@ ANALYZE -h, --help Show command line help - -c, --command + -c, --command Run the command on start. Examples: diff --git a/documentation/dotnet-trace-instructions.md b/documentation/dotnet-trace-instructions.md index 7803ee5d1..f6f72565f 100644 --- a/documentation/dotnet-trace-instructions.md +++ b/documentation/dotnet-trace-instructions.md @@ -19,7 +19,7 @@ In order to collect traces using dotnet-trace, you will need to: - First, find out the process identifier (pid) of the .NET Core 3.0 application (using builds Preview 5 or after) to collect traces from. - On Windows, there are options such as using the task manager or the `tasklist` command on the cmd window. - - On Linux, the trivial option could be using `pidof` on the terminal window. + - On Linux, the trivial option could be using `pidof` on the terminal window. You may also use the command `dotnet-trace list-processes` command to find out what .NET Core processes are running, along with their process IDs. @@ -39,7 +39,7 @@ Collecting to file: /trace.nettrace ## Viewing the trace captured from dotnet-trace -On Windows, `.nettrace` files can be viewed on PerfView (https://github.com/microsoft/perfview) for analysis, just like traces collected with ETW or LTTng. For traces collected on Linux, you can either move the trace to a Windows machine to be viewed on PerfView. +On Windows, `.nettrace` files can be viewed on PerfView (https://github.com/microsoft/perfview) for analysis, just like traces collected with ETW or LTTng. For traces collected on Linux, you can either move the trace to a Windows machine to be viewed on PerfView. If you would rather view the trace on a Linux machine, you can do this by changing the output format of `dotnet-trace` to `speedscope`. You can change the output file format using the `-f|--format` option - `-f speedscope` will make `dotnet-trace` to produce a speedscope file. You can currently choose between `nettrace` (the default option) and `speedscope`. Speedscope files can be opened at https://www.speedscope.app. @@ -145,8 +145,8 @@ Options: A provider consists of the name and optionally the keywords, verbosity level, and custom key/value pairs. The string is written 'Provider[,Provider]' - Provider format: (GUID|KnownProviderName)[:Keywords[:Level][:KeyValueArgs]] - GUID|KnownProviderName - The provider's name + Provider format: KnownProviderName[:Keywords[:Level][:KeyValueArgs]] + KnownProviderName - The provider's name Keywords - 8 character hex number bit mask Level - A number in the range [0, 5] 0 - Always @@ -160,6 +160,6 @@ Options: --buffersize Sets the size of the in-memory circular buffer in megabytes. Default 256 MB. - + -f, --format The format of the output trace file. This defaults to "nettrace" on Windows and "speedscope" on other OSes. diff --git a/src/Tools/dotnet-trace/CommandLine/Commands/CollectCommand.cs b/src/Tools/dotnet-trace/CommandLine/Commands/CollectCommand.cs index 81ad437d2..b21ae51d4 100644 --- a/src/Tools/dotnet-trace/CommandLine/Commands/CollectCommand.cs +++ b/src/Tools/dotnet-trace/CommandLine/Commands/CollectCommand.cs @@ -28,7 +28,7 @@ namespace Microsoft.Diagnostics.Tools.Trace /// The process to collect the trace from. /// The output path for the collected trace data. /// Sets the size of the in-memory circular buffer in megabytes. - /// A list of EventPipe providers to be enabled. This is in the form 'Provider[,Provider]', where Provider is in the form: '(GUID|KnownProviderName)[:Flags[:Level][:KeyValueArgs]]', and KeyValueArgs is in the form: '[key1=value1][;key2=value2]' + /// A list of EventPipe providers to be enabled. This is in the form 'Provider[,Provider]', where Provider is in the form: 'KnownProviderName[:Flags[:Level][:KeyValueArgs]]', and KeyValueArgs is in the form: '[key1=value1][;key2=value2]' /// A named pre-defined set of provider configurations that allows common tracing scenarios to be specified succinctly. /// The desired format of the created trace file. /// @@ -259,7 +259,7 @@ namespace Microsoft.Diagnostics.Tools.Trace private static Option ProvidersOption() => new Option( alias: "--providers", - description: @"A list of EventPipe providers to be enabled. This is in the form 'Provider[,Provider]', where Provider is in the form: '(GUID|KnownProviderName)[:Flags[:Level][:KeyValueArgs]]', and KeyValueArgs is in the form: '[key1=value1][;key2=value2]'", + description: @"A list of EventPipe providers to be enabled. This is in the form 'Provider[,Provider]', where Provider is in the form: 'KnownProviderName[:Flags[:Level][:KeyValueArgs]]', and KeyValueArgs is in the form: '[key1=value1][;key2=value2]'", argument: new Argument(defaultValue: "") { Name = "list-of-comma-separated-providers" }, // TODO: Can we specify an actual type? isHidden: false);