Skip to content

Commit a666306

Browse files
committed
[Diagnostics] Cleanup
1 parent 07934ac commit a666306

File tree

2 files changed

+23
-17
lines changed

2 files changed

+23
-17
lines changed

docs/core/diagnostics/dotnet-trace.md

Lines changed: 22 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ The `dotnet-trace` tool:
4343
* Is a cross-platform .NET Core tool.
4444
* Enables the collection of .NET Core traces of a running process without a native profiler.
4545
* Is built on [`EventPipe`](./eventpipe.md) of the .NET Core runtime.
46-
* Delivers the same experience on Windows, Linux, or macOS.
46+
* On Linux, provides additional integration with kernel user_events for native tracing tool compatibility.
4747

4848
## Options
4949

@@ -55,10 +55,6 @@ The `dotnet-trace` tool:
5555

5656
Displays the version of the dotnet-trace utility.
5757

58-
- **`--duration`**
59-
60-
How long to run the trace. `--duration 00:00:00:05` will run it for 5 seconds.
61-
6258
## Commands
6359

6460
| Command |
@@ -76,13 +72,23 @@ Collects a diagnostic trace from a running process or launches a child process a
7672
### Synopsis
7773

7874
```dotnetcli
79-
dotnet-trace collect [--buffersize <size>] [--clreventlevel <clreventlevel>] [--clrevents <clrevents>]
75+
dotnet-trace collect
76+
[--buffersize <size>]
77+
[--clreventlevel <clreventlevel>]
78+
[--clrevents <clrevents>]
8079
[--dsrouter <ios|ios-sim|android|android-emu>]
81-
[--format <Chromium|NetTrace|Speedscope>] [-h|--help] [--duration dd:hh:mm:ss]
82-
[-n, --name <name>] [--diagnostic-port] [-o|--output <trace-file-path>] [-p|--process-id <pid>]
83-
[--profile <profile-name>] [--providers <list-of-comma-separated-providers>]
80+
[--format <Chromium|NetTrace|Speedscope>]
81+
[-h|--help]
82+
[--duration dd:hh:mm:ss]
83+
[-n, --name <name>]
84+
[--diagnostic-port]
85+
[-o|--output <trace-file-path>]
86+
[-p|--process-id <pid>]
87+
[--profile <profile-name>]
88+
[--providers <list-of-comma-separated-providers>]
8489
[-- <command>] (for target applications running .NET 5 or later)
85-
[--show-child-io] [--resume-runtime]
90+
[--show-child-io]
91+
[--resume-runtime]
8692
[--stopping-event-provider-name <stoppingEventProviderName>]
8793
[--stopping-event-event-name <stoppingEventEventName>]
8894
[--stopping-event-payload-filter <stoppingEventPayloadFilter>]
@@ -158,7 +164,7 @@ dotnet-trace collect [--buffersize <size>] [--clreventlevel <clreventlevel>] [--
158164

159165
- **`--dsrouter {ios|ios-sim|android|android-emu}**
160166

161-
Starts [dotnet-dsrouter](dotnet-dsrouter.md) and connects to it. Requires [dotnet-dsrouter](dotnet-dsrouter.md) to be installed. Run `dotnet-dsrouter -h` for more information.
167+
Starts [dotnet-dsrouter](dotnet-dsrouter.md) and connects to it. Requires [dotnet-dsrouter](dotnet-dsrouter.md) to be installed. Run `dotnet-dsrouter -h` for more information.
162168

163169
- **`--format {Chromium|NetTrace|Speedscope}`**
164170

@@ -204,11 +210,11 @@ dotnet-trace collect [--buffersize <size>] [--clreventlevel <clreventlevel>] [--
204210

205211
A named pre-defined set of provider configurations that allows common tracing scenarios to be specified succinctly. The following profiles are available:
206212

207-
| Profile | Description |
208-
|---------|-------------|
209-
|`cpu-sampling`|Useful for tracking CPU usage and general .NET runtime information. This is the default option if no profile or providers are specified.|
210-
|`gc-verbose`|Tracks GC collections and samples object allocations.|
211-
|`gc-collect`|Tracks GC collections only at very low overhead.|
213+
| Profile | Description |
214+
|---------|-------------|
215+
|`cpu-sampling`|Useful for tracking CPU usage and general .NET runtime information. This is the default option if no profile or providers are specified.|
216+
|`gc-verbose`|Tracks GC collections and samples object allocations.|
217+
|`gc-collect`|Tracks GC collections only at very low overhead.|
212218

213219
- **`--providers <list-of-comma-separated-providers>`**
214220

docs/core/diagnostics/eventsource-collect-and-view-traces.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -214,7 +214,7 @@ into other formats, such as Chromium or [Speedscope](https://www.speedscope.app/
214214
Trace completed.
215215
```
216216

217-
dotnet-trace uses the [conventional text format](#conventions-for-describing-provider-configuration) for describing provider configuration in
217+
dotnet-trace uses a comma-delimited variant of the [conventional text format](#conventions-for-describing-provider-configuration) for describing provider configuration in
218218
the `--providers` argument. For more options on how to take traces using dotnet-trace, see the
219219
[dotnet-trace docs](./dotnet-trace.md#collect-a-trace-with-dotnet-trace).
220220

0 commit comments

Comments
 (0)