[xabt] Compute `$DOTNET_DiagnosticPorts` using MSBuild properties #10351

jonathanpeppers · 2025-07-28T21:03:54Z

If you run dotnet-trace collect --dsrouter android, it says:

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

Setting $DOTNET_DiagnosticPorts is non-trivial, so as a step to
simplify this, we are adding multiple MSBuild properties to configure
this value.

This would allow the log message to say:

Build and run an Android application such as:
[Default Tracing]
dotnet build -t:Run -c Release -p:DiagnosticAddress=127.0.0.1 -p:DiagnosticPort=9000 -p:DiagnosticSuspend=false -p:DiagnosticListenMode=connect
[Startup Tracing]
dotnet build -t:Run -c Release -p:DiagnosticAddress=127.0.0.1 -p:DiagnosticPort=9000 -p:DiagnosticSuspend=true -p:DiagnosticListenMode=connect

You could also set $(DiagnosticConfiguration), but you would need to
escape the , character with %2c.

Setting any of the new properties also implicitly means that
$(AndroidEnableProfiler) is set to true.

I updated a couple tests to verify the new properties work.

jonathanpeppers · 2025-07-29T16:02:07Z

Because of the issues with escaping , in MSBuild:

MSbuild on .NET Core can't parse properties with commas in the values msbuild#2999
Unable to pass in Property values containing a semicolon or comma in .Net Core MSBuild msbuild#471

Going to turn this into multiple properties to match the design we came up with here:

[msbuild] Compute DOTNET_DiagnosticPorts using MSBuild properties. macios#23429

If you run `dotnet-trace collect --dsrouter android`, it says: 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 Setting `$DOTNET_DiagnosticPorts` is non-trivial, so as a step to simplify this, we are adding multiple MSBuild properties to configure this value. This would allow the log message to say: Build and run an Android application such as: [Default Tracing] dotnet build -t:Run -c Release -p:DiagnosticAddress=127.0.0.1 -p:DiagnosticPort=9000 -p:DiagnosticSuspend=false -p:DiagnosticListenMode=connect [Startup Tracing] dotnet build -t:Run -c Release -p:DiagnosticAddress=127.0.0.1 -p:DiagnosticPort=9000 -p:DiagnosticSuspend=true -p:DiagnosticListenMode=connect You could also set `$(DiagnosticConfiguration)`, but you would need to escape the `,` character with `%2c`. Setting any of the new properties also implicitly means that `$(AndroidEnableProfiler)` is set to `true`. I updated a couple tests to verify the new properties work.

lateralusX

LGTM!

lateralusX · 2025-07-30T10:52:19Z

src/Xamarin.Android.Build.Tasks/Xamarin.Android.Common.targets

  <ItemGroup>
    <_GeneratedAndroidEnvironment Include="mono.enable_assembly_preload=0" Condition=" '$(AndroidEnablePreloadAssemblies)' != 'True' " />
    <_GeneratedAndroidEnvironment Include="DOTNET_MODIFIABLE_ASSEMBLIES=Debug" Condition=" '$(AndroidIncludeDebugSymbols)' == 'true' and '$(AndroidUseInterpreter)' == 'true' " />
+    <_GeneratedAndroidEnvironment Include="DOTNET_DiagnosticPorts=$(DiagnosticConfiguration)" Condition=" '$(DiagnosticConfiguration)' != '' " />


Any risk this might get stuck in the build or would a new build and/or run without any Diagnostic* properties set remove all diagnostic support in the build making sure this part of the build gets updated.

This part looks OK for incremental builds, this target has no Inputs/Outputs, so it always runs.

Then <WriteLinesToFile/> uses WriteOnlyWhenDifferent="True", which would update the timestamp on the @(AndroidEnvironment) file it writes if changed.

Later on, it looks like all the important targets will rerun if @(AndroidEnvironment) files change.

…tnet#10351) If you run `dotnet-trace collect --dsrouter android`, it says: 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 Setting `$DOTNET_DiagnosticPorts` is non-trivial, so as a step to simplify this, we are adding multiple MSBuild properties to configure this value. This would allow the log message to say: Build and run an Android application such as: [Default Tracing] dotnet build -t:Run -c Release -p:DiagnosticAddress=127.0.0.1 -p:DiagnosticPort=9000 -p:DiagnosticSuspend=false -p:DiagnosticListenMode=connect [Startup Tracing] dotnet build -t:Run -c Release -p:DiagnosticAddress=127.0.0.1 -p:DiagnosticPort=9000 -p:DiagnosticSuspend=true -p:DiagnosticListenMode=connect You could also set `$(DiagnosticConfiguration)`, but you would need to escape the `,` character with `%2c`. Setting any of the new properties also implicitly means that `$(AndroidEnableProfiler)` is set to `true`.

Context: dotnet/android#10351 Context: dotnet/macios#23429 We are adding new MSBuild properties to simplify setting `$DOTNET_DiagnosticPorts` on mobile: * `$(DiagnosticAddress)` * `$(DiagnosticPort)` * `$(DiagnosticSuspend)` * `$(DiagnosticListenMode)` * `$(DiagnosticConfiguration)` if you want to specify the full value yourself, escape `,` with `%2c`, etc. We will ship these properties in future releases of .NET 9 and 10. To improve `dsrouter` the current log message: 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 Will change to: Build and run an Android application such as: [Default Tracing] dotnet build -t:Run -c Release -p:DiagnosticAddress=127.0.0.1 -p:DiagnosticPort=9000 -p:DiagnosticSuspend=false -p:DiagnosticListenMode=connect [Startup Tracing] dotnet build -t:Run -c Release -p:DiagnosticAddress=127.0.0.1 -p:DiagnosticPort=9000 -p:DiagnosticSuspend=true -p:DiagnosticListenMode=connect Note that `dotnet run` *does work*, but it doesn't show good progress on the build & deploy steps as compared to `dotnet build -t:Run` and MSBuild's terminal logger. It can take several seconds to run a `Release` build. I think it's better to recommend `-t:Run` until we improve `dotnet run`.

…0351) If you run `dotnet-trace collect --dsrouter android`, it says: 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 Setting `$DOTNET_DiagnosticPorts` is non-trivial, so as a step to simplify this, we are adding multiple MSBuild properties to configure this value. This would allow the log message to say: Build and run an Android application such as: [Default Tracing] dotnet build -t:Run -c Release -p:DiagnosticAddress=127.0.0.1 -p:DiagnosticPort=9000 -p:DiagnosticSuspend=false -p:DiagnosticListenMode=connect [Startup Tracing] dotnet build -t:Run -c Release -p:DiagnosticAddress=127.0.0.1 -p:DiagnosticPort=9000 -p:DiagnosticSuspend=true -p:DiagnosticListenMode=connect You could also set `$(DiagnosticConfiguration)`, but you would need to escape the `,` character with `%2c`. Setting any of the new properties also implicitly means that `$(AndroidEnableProfiler)` is set to `true`.

Context: dotnet/android#10351 Context: dotnet/macios#23429 We are adding new MSBuild properties to simplify setting `$DOTNET_DiagnosticPorts` on mobile: * `$(DiagnosticAddress)` * `$(DiagnosticPort)` * `$(DiagnosticSuspend)` * `$(DiagnosticListenMode)` * `$(DiagnosticConfiguration)` if you want to specify the full value yourself, escape `,` with `%2c`, etc. We will ship these properties in future releases of .NET 9 and 10. To improve `dsrouter` the current log message: 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 Will change to: Build and run an Android application such as: [Default Tracing] dotnet build -t:Run -c Release -p:DiagnosticAddress=127.0.0.1 -p:DiagnosticPort=9000 -p:DiagnosticSuspend=false -p:DiagnosticListenMode=connect [Startup Tracing] dotnet build -t:Run -c Release -p:DiagnosticAddress=127.0.0.1 -p:DiagnosticPort=9000 -p:DiagnosticSuspend=true -p:DiagnosticListenMode=connect Note that `dotnet run` *does work*, but it doesn't show good progress on the build & deploy steps as compared to `dotnet build -t:Run` and MSBuild's terminal logger. It can take several seconds to run a `Release` build. I think it's better to recommend `-t:Run` until we improve `dotnet run`.

…23429) If you run `dotnet-dsrouter ios`, it says: Start an application on ios device with ONE of the following environment variables set: [Default Tracing] DOTNET_DiagnosticPorts=127.0.0.1:9000,nosuspend,listen [Startup Tracing] DOTNET_DiagnosticPorts=127.0.0.1:9000,suspend,listen Setting `$DOTNET_DiagnosticPorts` is non-trivial, so as a step to simplify this, we are adding multiple MSBuild properties to configure this value. This would allow the log message to say: Build and run an iOS application such as: [Default Tracing] dotnet run -c Release -p:ios-arm64 -p:DiagnosticAddress=127.0.0.1 -p:DiagnosticPort=9000 -p:DiagnosticSuspend=false -p:DiagnosticListenMode=listen [Startup Tracing] dotnet run -c Release -p:ios-arm64 -p:DiagnosticAddress=127.0.0.1 -p:DiagnosticPort=9000 -p:DiagnosticSuspend=true -p:DiagnosticListenMode=listen Since these are all default values, it can be simplified to: Build and run an iOS application such as: [Default Tracing] dotnet run -p:ios-arm64 -c Release -p:EnableDiagnostics=true [Startup Tracing] dotnet run -p:ios-arm64 -c Release -p:EnableDiagnostics=true Setting any of the new properties also implicitly means that `$(EnableDiagnostics)` is set to `true` (first example), or alternatively `$(EnableDiagnostics)` can be set to true to get the default value for all the new properties (second example). Ref: dotnet/android#10351 --------- Co-authored-by: Jonathan Peppers <jonathan.peppers@microsoft.com>

…ild properties. (#23629) If you run `dotnet-dsrouter ios`, it says: Start an application on ios device with ONE of the following environment variables set: [Default Tracing] DOTNET_DiagnosticPorts=127.0.0.1:9000,nosuspend,listen [Startup Tracing] DOTNET_DiagnosticPorts=127.0.0.1:9000,suspend,listen Setting `$DOTNET_DiagnosticPorts` is non-trivial, so as a step to simplify this, we are adding multiple MSBuild properties to configure this value. This would allow the log message to say: Build and run an iOS application such as: [Default Tracing] dotnet run -c Release -p:ios-arm64 -p:DiagnosticAddress=127.0.0.1 -p:DiagnosticPort=9000 -p:DiagnosticSuspend=false -p:DiagnosticListenMode=listen [Startup Tracing] dotnet run -c Release -p:ios-arm64 -p:DiagnosticAddress=127.0.0.1 -p:DiagnosticPort=9000 -p:DiagnosticSuspend=true -p:DiagnosticListenMode=listen Since these are all default values, it can be simplified to: Build and run an iOS application such as: [Default Tracing] dotnet run -p:ios-arm64 -c Release -p:EnableDiagnostics=true [Startup Tracing] dotnet run -p:ios-arm64 -c Release -p:EnableDiagnostics=true Setting any of the new properties also implicitly means that `$(EnableDiagnostics)` is set to `true` (first example), or alternatively `$(EnableDiagnostics)` can be set to true to get the default value for all the new properties (second example). Ref: dotnet/android#10351 Backport of #23429. --------- Co-authored-by: Jonathan Peppers <jonathan.peppers@microsoft.com>

jonathanpeppers moved this to In Progress in .NET for Android Backlog Jul 28, 2025

jonathanpeppers added this to .NET for Android Backlog Jul 28, 2025

jonathanpeppers self-assigned this Jul 28, 2025

jonathanpeppers marked this pull request as ready for review July 29, 2025 14:44

jonathanpeppers requested a review from grendello as a code owner July 29, 2025 14:44

rolfbjarne mentioned this pull request Jul 29, 2025

[msbuild] Compute DOTNET_DiagnosticPorts using MSBuild properties. dotnet/macios#23429

Merged

jonathanpeppers force-pushed the dev/peppers/DiagnosticPorts branch from af1a622 to 4c20250 Compare July 29, 2025 16:29

jonathanpeppers changed the title ~~[xabt] implement $(DiagnosticPorts) for dotnet-dsrouter~~ [xabt] Compute $DOTNET_DiagnosticPorts using MSBuild properties Jul 29, 2025

jonathanpeppers added 2 commits July 29, 2025 12:20

Update InstallAndRunTests.cs

a1f0f93

Update Microsoft.Android.Sdk.DefaultProperties.targets

92514d0

simonrozsival approved these changes Jul 30, 2025

View reviewed changes

lateralusX approved these changes Jul 30, 2025

View reviewed changes

lateralusX reviewed Jul 30, 2025

View reviewed changes

jonathanpeppers added 2 commits July 30, 2025 09:13

Update Microsoft.Android.Sdk.DefaultProperties.targets

bef0e71

Update build-properties.md

a40e6fd

jonathanpeppers enabled auto-merge (squash) July 30, 2025 18:40

jonathanpeppers merged commit 36e9923 into main Jul 30, 2025
59 checks passed

jonathanpeppers deleted the dev/peppers/DiagnosticPorts branch July 30, 2025 19:28

github-project-automation bot moved this from In Progress to Done in .NET for Android Backlog Jul 30, 2025

jonathanpeppers mentioned this pull request Jul 30, 2025

[release/9.0.1xx] [xabt] Compute $DOTNET_DiagnosticPorts using MSBuild properties #10360

Merged

jonathanpeppers mentioned this pull request Jul 31, 2025

[dsrouter] improved instructions/log messages dotnet/diagnostics#5535

Merged

rolfbjarne mentioned this pull request Aug 18, 2025

[release/9.0.1xx] [msbuild] Compute DOTNET_DiagnosticPorts using MSBuild properties. dotnet/macios#23629

Merged

github-actions bot locked and limited conversation to collaborators Aug 30, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

[xabt] Compute `$DOTNET_DiagnosticPorts` using MSBuild properties #10351

[xabt] Compute `$DOTNET_DiagnosticPorts` using MSBuild properties #10351

jonathanpeppers commented Jul 28, 2025 •

edited

Loading

Uh oh!

jonathanpeppers commented Jul 29, 2025

Uh oh!

lateralusX left a comment

Uh oh!

lateralusX Jul 30, 2025

Uh oh!

jonathanpeppers Jul 30, 2025

Uh oh!

Uh oh!

Uh oh!

[xabt] Compute $DOTNET_DiagnosticPorts using MSBuild properties #10351

[xabt] Compute $DOTNET_DiagnosticPorts using MSBuild properties #10351

Conversation

jonathanpeppers commented Jul 28, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

jonathanpeppers commented Jul 29, 2025

Uh oh!

lateralusX left a comment

Choose a reason for hiding this comment

Uh oh!

lateralusX Jul 30, 2025

Choose a reason for hiding this comment

Uh oh!

jonathanpeppers Jul 30, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

[xabt] Compute `$DOTNET_DiagnosticPorts` using MSBuild properties #10351

[xabt] Compute `$DOTNET_DiagnosticPorts` using MSBuild properties #10351

jonathanpeppers commented Jul 28, 2025 •

edited

Loading