Update docs for dotnet-counters
#47874
Conversation
Add documentation for `--dsrouter` switch introduced in dotnet/diagnostics#5543
We added this to `dotnet-gcdump` in fcaeae3 and `dotnet-trace` in a29f26d. This allows `dsrouter` to be launched, such as: > dotnet-counters collect --dsrouter android For finer control over the dotnet-dsrouter options, run it separately and connect to it using -p WARNING: dotnet-dsrouter is a development tool not intended for production environments. How to connect current dotnet-dsrouter pid=40432 with android device and diagnostics tooling. Start an application on android device with ONE of the following environment variables set: [Default Tracing] DOTNET_DiagnosticPorts=127.0.0.1:9000,nosuspend,connect [Startup Tracing] DOTNET_DiagnosticPorts=127.0.0.1:9000,suspend,connect See https://learn.microsoft.com/en-us/dotnet/core/diagnostics/dotnet-dsrouter for additional details and examples. info: dotnet-dsrouter-40432[0] Starting dotnet-dsrouter using pid=40432 info: dotnet-dsrouter-40432[0] Looking for Android NDK... info: dotnet-dsrouter-40432[0] Looking for Android SDK... info: dotnet-dsrouter-40432[0] Starting IPC server (dotnet-diagnostic-dsrouter-40432) <--> TCP server (127.0.0.1:9001) router. --counters is unspecified. Monitoring System.Runtime counters by default. Documentation PR: * dotnet/docs#47874
|
|
||
| - **`--dsrouter {ios|ios-sim|android|android-emu}`** | ||
|
|
||
| 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. |
There was a problem hiding this comment.
| 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. | |
| (Available starting in .NET 10.) 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. |
| # Investigate performance counters (dotnet-counters) | ||
|
|
||
| **This article applies to:** ✔️ `dotnet-counters` version 3.0.47001 and later versions. | ||
| **This article applies to:** ✔️ `dotnet-counters` version 10.0 and later versions. |
There was a problem hiding this comment.
| **This article applies to:** ✔️ `dotnet-counters` version 10.0 and later versions. | |
| **This article applies to:** ✔️ `dotnet-counters` version 3.0.47001 and later versions. |
There was a problem hiding this comment.
If you change it to .NET 10, it implies people using .NET 9 can't use this doc, whereas they can still use most of it.
There was a problem hiding this comment.
In any case, the version number should match version numbers of the package at https://www.nuget.org/packages/dotnet-counters
There was a problem hiding this comment.
Sorry, I must have missed the comments here.
The version of dotnet-counters with this change doesn't look like it has shipped yet. Let me ask .NET diagnostics folks about it.
There was a problem hiding this comment.
There is a release, they are shipping "soon":
I'll update the docs here when this is on NuGet.org.
There was a problem hiding this comment.
Pull Request Overview
This PR updates the documentation for the dotnet-counters tool to include the new --dsrouter switch that was introduced in a recent diagnostics pull request. The documentation is also updated to reflect the current version requirements.
- Updates version requirement from 3.0.47001 to 10.0
- Adds
--dsrouterparameter to the command synopsis - Fixes a syntax error in the dotnet-gcdump documentation
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| docs/core/diagnostics/dotnet-counters.md | Updates version requirement and adds --dsrouter parameter to collect command synopsis |
| docs/core/diagnostics/dotnet-gcdump.md | Fixes missing closing backtick in --dsrouter parameter documentation |
|
|
||
| ```dotnetcli | ||
| dotnet-counters collect [-h|--help] [-p|--process-id] [-n|--name] [--diagnostic-port] [--refresh-interval] [--counters <COUNTERS>] [--format] [-o|--output] [-- <command>] | ||
| dotnet-counters collect [-h|--help] [-p|--process-id] [-n|--name] [--diagnostic-port] [--refresh-interval] [--counters <COUNTERS>] [--format] [-o|--output] [--dsrouter <ios|ios-sim|android|android-emu>] [-- <command>] |
There was a problem hiding this comment.
The --dsrouter parameter is added to the synopsis but there's no corresponding documentation explaining what this parameter does. Consider adding a description of the --dsrouter option in the Options section below the synopsis.
Copilot uses AI. Check for mistakes.
3 participants
Add documentation for
--dsrouterswitch introduced in dotnet/diagnostics#5543Internal previews