Document that dump collection isn't supported on mobile platforms#51765
Document that dump collection isn't supported on mobile platforms#51765steveisok wants to merge 1 commit intodotnet:mainfrom
Conversation
Add notes to dumps.md, collect-dumps-crash.md, and a new FAQ entry stating that dump collection isn't supported on Android and iOS because the Mono runtime doesn't support memory dump generation. Fixes dotnet/diagnostics#5098 Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
This PR documents that dump collection is not supported on mobile platforms (Android and iOS) due to the Mono runtime not supporting memory dump generation. The documentation is added to three files: the general dumps overview, the crash dumps documentation, and the FAQ.
Changes:
- Added a NOTE callout to dumps.md explaining that dump collection isn't supported on mobile platforms
- Added a NOTE callout to collect-dumps-crash.md stating mobile platform limitations
- Added a new FAQ entry explaining why dump collection fails on Android and iOS
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
| docs/core/diagnostics/faq-dumps.yml | Added new FAQ question and answer about dump collection limitations on Android and iOS |
| docs/core/diagnostics/dumps.md | Added NOTE callout explaining mobile platform dump collection limitations with technical explanation |
| docs/core/diagnostics/collect-dumps-crash.md | Added NOTE callout about mobile platform limitations |
| Configuring your application to collect a dump on crash is done by setting specific environment variables. This is helpful when you want to get an understanding of why a crash happened. For example, capturing a dump when an exception is thrown helps you identify an issue by examining the state of the app when it crashed. | ||
|
|
||
| > [!NOTE] | ||
| > Dump collection isn't supported on mobile platforms (Android and iOS). |
There was a problem hiding this comment.
The note should include tvOS along with Android and iOS, and should provide an explanation of why dump collection isn't supported. Throughout the diagnostics documentation, these three platforms are consistently grouped together as mobile platforms that use the Mono runtime. The note should read: "Dump collection isn't supported on mobile platforms (Android, iOS, and tvOS). The Mono runtime used on these platforms doesn't support memory dump generation."
| Dumps can be collected in a variety of ways depending on which platform your app is running on. | ||
|
|
||
| > [!NOTE] | ||
| > Dump collection isn't supported on mobile platforms (Android and iOS). The Mono runtime used on these platforms doesn't support memory dump generation. |
There was a problem hiding this comment.
The documentation should include tvOS along with Android and iOS. Throughout the diagnostics documentation (diagnostic-port.md, dotnet-counters.md, dotnet-gcdump.md, dotnet-trace.md, dotnet-dsrouter.md), these three platforms are consistently grouped together as mobile platforms that use the Mono runtime. The note should read: "Dump collection isn't supported on mobile platforms (Android, iOS, and tvOS). The Mono runtime used on these platforms doesn't support memory dump generation."
| Why can't I collect dumps on Android or iOS? | ||
| answer: | | ||
| Dump collection isn't supported on mobile platforms (Android and iOS). These platforms use the Mono runtime, which doesn't support memory dump generation. |
There was a problem hiding this comment.
The documentation should include tvOS along with Android and iOS. Throughout the diagnostics documentation (diagnostic-port.md, dotnet-counters.md, dotnet-gcdump.md, dotnet-trace.md, dotnet-dsrouter.md), these three platforms are consistently grouped together as mobile platforms that use the Mono runtime. The answer should mention all three platforms and include the explanation: "Dump collection isn't supported on mobile platforms (Android, iOS, and tvOS). These platforms use the Mono runtime, which doesn't support memory dump generation."
| Why can't I collect dumps on Android or iOS? | |
| answer: | | |
| Dump collection isn't supported on mobile platforms (Android and iOS). These platforms use the Mono runtime, which doesn't support memory dump generation. | |
| Why can't I collect dumps on Android, iOS, or tvOS? | |
| answer: | | |
| Dump collection isn't supported on mobile platforms (Android, iOS, and tvOS). These platforms use the Mono runtime, which doesn't support memory dump generation. |
| Why can't I collect dumps on Android or iOS? | ||
| answer: | | ||
| Dump collection isn't supported on mobile platforms (Android and iOS). These platforms use the Mono runtime, which doesn't support memory dump generation. |
There was a problem hiding this comment.
The question should include tvOS. Throughout the diagnostics documentation, Android, iOS, and tvOS are consistently grouped together as mobile platforms. The question should read: "Why can't I collect dumps on Android, iOS, or tvOS?"
| Why can't I collect dumps on Android or iOS? | |
| answer: | | |
| Dump collection isn't supported on mobile platforms (Android and iOS). These platforms use the Mono runtime, which doesn't support memory dump generation. | |
| Why can't I collect dumps on Android, iOS, or tvOS? | |
| answer: | | |
| Dump collection isn't supported on mobile platforms (Android, iOS, and tvOS). These platforms use the Mono runtime, which doesn't support memory dump generation. |
2 participants
Summary
Add notes to dumps.md, collect-dumps-crash.md, and a new FAQ entry stating that dump collection isn't supported on Android and iOS because the Mono runtime doesn't support memory dump generation.
Fixes dotnet/diagnostics#5098
Internal previews