Skip to content

Commit a317510

Browse files
committed
Slight adjustments to follow implementing PR
1 parent 76c6a3d commit a317510

File tree

1 file changed

+12
-2
lines changed

1 file changed

+12
-2
lines changed

docs/core/diagnostics/dotnet-trace.md

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -221,7 +221,7 @@ dotnet-trace collect
221221

222222
| Profile | Description |
223223
|---------|-------------|
224-
|`dotnet-common`|Lightweight .NET runtime diagnostics designed to stay low overhead. Includes:<br/><ul><li>GC</li><li>AssemblyLoader</li><li>Loader</li><li>Jit</li><li>Exception</li><li>Threading</li><li>JittedMethodILToNativeMap</li><li>Compilation</li></ul>Equivalent to `--providers "Microsoft-Windows-DotNETRuntime:0x100003801D:4"`.|
224+
|`dotnet-common`|Lightweight .NET runtime diagnostics designed to stay low overhead.<br>Includes GC, AssemblyLoader, Loader, JIT, Exceptions, Threading, JittedMethodILToNativeMap, and Compilation events<br>Equivalent to `--providers "Microsoft-Windows-DotNETRuntime:0x100003801D:4"`.|
225225
|`dotnet-sampled-thread-time`|Samples .NET thread stacks (~100 Hz) to identify hotspots over time. Uses the runtime sample profiler with managed stacks.|
226226
|`gc-verbose`|Tracks GC collections and samples object allocations.|
227227
|`gc-collect`|Tracks GC collections only at very low overhead.|
@@ -281,6 +281,10 @@ dotnet-trace collect
281281
282282
## dotnet-trace collect-linux
283283

284+
> [!NOTE] The collect-linux verb is a new preview feature and relies on an updated version of the .nettrace file format. The latest PerfView release supports these trace files but other ways of using the trace file may not work yet.
285+
286+
> [!NOTE] The generated NetTrace is not fully compatible with [`convert`](#dotnet-trace-convert) and [`report`](#dotnet-trace-report).
287+
284288
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.
285289

286290
This Linux-only command includes the same .NET events as [`dotnet-trace collect`](#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.
@@ -412,7 +416,7 @@ dotnet-trace collect-linux
412416

413417
| Profile | Description |
414418
|---------|-------------|
415-
|`dotnet-common`|Lightweight .NET runtime diagnostics designed to stay low overhead. Includes:<br/><ul><li>GC</li><li>AssemblyLoader</li><li>Loader</li><li>Jit</li><li>Exception</li><li>Threading</li><li>JittedMethodILToNativeMap</li><li>Compilation</li></ul>Equivalent to `--providers "Microsoft-Windows-DotNETRuntime:0x100003801D:4"`.|
419+
|`dotnet-common`|Lightweight .NET runtime diagnostics designed to stay low overhead.<br>Includes GC, AssemblyLoader, Loader, JIT, Exceptions, Threading, JittedMethodILToNativeMap, and Compilation events<br>Equivalent to `--providers "Microsoft-Windows-DotNETRuntime:0x100003801D:4"`.|
416420
|`cpu-sampling`|Kernel CPU sampling (perf-based), emitted as `Universal.Events/cpu`, for precise on-CPU attribution.|
417421
|`thread-time`|Kernel thread context switches, emitted as `Universal.Events/cswitch`, for on/off-CPU and scheduler analysis.|
418422
|`gc-verbose`|Tracks GC collections and samples object allocations.|
@@ -654,6 +658,12 @@ To collect traces using `dotnet-trace collect-linux`:
654658
655659
```output
656660
$ sudo dotnet-trace collect-linux
661+
==========================================================================================
662+
The collect-linux verb is a new preview feature and relies on an updated version of the
663+
.nettrace file format. The latest PerfView release supports these trace files but other
664+
ways of using the trace file may not work yet. For more details, see the docs at
665+
https://learn.microsoft.com/dotnet/core/diagnostics/dotnet-trace.
666+
==========================================================================================
657667
No providers, profiles, ClrEvents, or PerfEvents were specified, defaulting to trace profiles 'dotnet-common' + 'cpu-sampling'.
658668
659669
Provider Name Keywords Level Enabled By

0 commit comments

Comments
 (0)