[xabt] Compute $DOTNET_DiagnosticPorts using MSBuild properties#10351
Merged
jonathanpeppers merged 5 commits intomainfrom Jul 30, 2025
Merged
[xabt] Compute $DOTNET_DiagnosticPorts using MSBuild properties#10351jonathanpeppers merged 5 commits intomainfrom
$DOTNET_DiagnosticPorts using MSBuild properties#10351jonathanpeppers merged 5 commits intomainfrom
Conversation
Member
Author
|
Because of the issues with escaping
Going to turn this into multiple properties to match the design we came up with here: |
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.
af1a622 to
4c20250
Compare
$(DiagnosticPorts) for dotnet-dsrouter$DOTNET_DiagnosticPorts using MSBuild properties
simonrozsival
approved these changes
Jul 30, 2025
lateralusX
reviewed
Jul 30, 2025
| <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)' != '' " /> |
Member
There was a problem hiding this comment.
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.
Member
Author
There was a problem hiding this comment.
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.
jonathanpeppers
added a commit
to jonathanpeppers/xamarin-android
that referenced
this pull request
Jul 30, 2025
…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`.
jonathanpeppers
added a commit
to dotnet/diagnostics
that referenced
this pull request
Jul 31, 2025
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`.
jonathanpeppers
added a commit
that referenced
this pull request
Jul 31, 2025
…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`.
jonathanpeppers
added a commit
that referenced
this pull request
Aug 1, 2025
…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`.
jonathanpeppers
added a commit
to dotnet/diagnostics
that referenced
this pull request
Aug 6, 2025
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`.
rolfbjarne
added a commit
to dotnet/macios
that referenced
this pull request
Aug 18, 2025
…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>
rolfbjarne
added a commit
to dotnet/macios
that referenced
this pull request
Aug 19, 2025
…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>
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
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
3 participants
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.
If you run
dotnet-trace collect --dsrouter android, it says:Setting
$DOTNET_DiagnosticPortsis non-trivial, so as a step tosimplify this, we are adding multiple MSBuild properties to configure
this value.
This would allow the log message to say:
You could also set
$(DiagnosticConfiguration), but you would need toescape the
,character with%2c.Setting any of the new properties also implicitly means that
$(AndroidEnableProfiler)is set totrue.I updated a couple tests to verify the new properties work.