Skip to content

Update docs for dotnet-counters #47874

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update docs for dotnet-counters #47874

wants to merge 1 commit into from

Conversation

jonathanpeppers
Copy link
Member

@jonathanpeppers jonathanpeppers commented Aug 6, 2025 •
edited by github-actions bot
Loading

@jonathanpeppers
Update docs for dotnet-counters
a9828b9 
Add documentation for `--dsrouter` switch introduced in dotnet/diagnostics#5543
@jonathanpeppers jonathanpeppers requested review from tommcdon and a team as code owners August 6, 2025 21:30
@dotnetrepoman dotnetrepoman bot added this to the August 2025 milestone Aug 6, 2025
@jonathanpeppers jonathanpeppers mentioned this pull request Aug 6, 2025
Merged
jonathanpeppers added a commit to dotnet/diagnostics that referenced this pull request Aug 8, 2025
@jonathanpeppers
[counters] add --dsrouter switch (#5543)
3fe5132 
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
gewarren approved these changes Aug 8, 2025
View reviewed changes
docs/core/diagnostics/dotnet-counters.md
@@ -230,6 +230,10 @@ dotnet-counters monitor [-h|--help] [-p|--process-id] [-n|--name] [--diagnostic-

A comma-separated list of counters. Counters can be specified `provider_name[:counter_name]`. If the `provider_name` is used without a qualifying list of counters, then all counters from the provider are shown. To discover provider and counter names, use the [dotnet-counters list](#dotnet-counters-list) command. For [EventCounters](event-counters.md), `provider_name` is the name of the EventSource and for [Meters](metrics.md), `provider_name` is the name of the Meter.

- **`--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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

docs/core/diagnostics/dotnet-counters.md
ms.topic: reference
---
# 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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
**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.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@gewarren gewarren gewarren approved these changes

@tommcdon tommcdon Awaiting requested review from tommcdon tommcdon is a code owner

At least 1 approving review is required to merge this pull request.

Assignees
No one assigned
Labels
dotnet-fundamentals/svc
Projects
None yet
Milestone
August 2025
Development

Successfully merging this pull request may close these issues.
2 participants
@jonathanpeppers @gewarren