Update docs for dotnet-counters
#47874
Open
+8
−4
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add documentation for `--dsrouter` switch introduced in dotnet/diagnostics#5543
jonathanpeppers
added a commit
to dotnet/diagnostics
that referenced
this pull request
Aug 8, 2025
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
gewarren
approved these changes
Aug 8, 2025
|
|
||
| - **`--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. |
Contributor
There was a problem hiding this comment.
Suggested change
| 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. |
Member
Author
There was a problem hiding this comment.
I made it say "(Available in dotnet-counters 9.0.652701 and later versions.)"
Contributor
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 |
Co-authored-by: Genevieve Warren <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add documentation for
--dsrouterswitch introduced in dotnet/diagnostics#5543Internal previews