Mention DOTNET_ env vars first in collect-dumps-crash.md #46788
+7
−7
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
Since .NET 7 the standardized prefix is `DOTNET_` so we should mention that variant first.
shethaadit
approved these changes
Jun 11, 2025
jkotas
reviewed
Jun 11, 2025
| |`COMPlus_EnableCrashReport` or `DOTNET_EnableCrashReport`|(Requires .NET 6 or later; not supported on Windows.)<br/>If set to 1, the runtime generates a JSON-formatted crash report that includes information about the threads and stack frames of the crashing application. The crash report name is the dump path or name with *.crashreport.json* appended.| | | ||
| |`COMPlus_CreateDumpVerboseDiagnostics` or `DOTNET_CreateDumpVerboseDiagnostics`|(Requires .NET 7 or later.)<br/>If set to 1, enables verbose diagnostic logging of the dump process.|0| | ||
| |`COMPlus_CreateDumpLogToFile` or `DOTNET_CreateDumpLogToFile`|(Requires .NET 7 or later.)<br/>The path of the file to which the diagnostic messages should be written. | If unset, the diagnostic messages are written to the console of the crashing application. | | ||
| |`DOTNET_DbgEnableMiniDump` or `COMPlus_DbgEnableMiniDump`|If set to 1, enable core dump generation.|0| |
There was a problem hiding this comment.
I do think we need to mention COMPlus at all. All supported versions understand the DOTNET_ prefix.
jkotas
reviewed
Jun 11, 2025
| |`DOTNET_DbgMiniDumpName` or `COMPlus_DbgMiniDumpName`|Path to a file to write the dump to. Ensure that the user under which the dotnet process is running has write permissions to the specified directory.|`/tmp/coredump.<pid>`| | ||
| |`DOTNET_CreateDumpDiagnostics` or `COMPlus_CreateDumpDiagnostics`|If set to 1, enables diagnostic logging of dump process.|0| | ||
| |`DOTNET_EnableCrashReport` or `COMPlus_EnableCrashReport`|(Requires .NET 6 or later; not supported on Windows.)<br/>If set to 1, the runtime generates a JSON-formatted crash report that includes information about the threads and stack frames of the crashing application. The crash report name is the dump path or name with *.crashreport.json* appended.| | | ||
| |`DOTNET_CreateDumpVerboseDiagnostics` or `COMPlus_CreateDumpVerboseDiagnostics`|(Requires .NET 7 or later.)<br/>If set to 1, enables verbose diagnostic logging of the dump process.|0| |
There was a problem hiding this comment.
I would drop "Requires .NET 7 or later.". We do not need to maintain docs for versions that have been out of support for a while.
jkotas
reviewed
Jun 11, 2025
Comment on lines
22
to
24
|
|
||
| > [!NOTE] | ||
| > .NET 7 standardizes on the prefix `DOTNET_` instead of `COMPlus_` for these environment variables. However, the `COMPlus_` prefix will continue to work. If you're using a previous version of the .NET runtime, you should still use the `COMPlus_` prefix for environment variables. |
There was a problem hiding this comment.
Suggested change
| > [!NOTE] | |
| > .NET 7 standardizes on the prefix `DOTNET_` instead of `COMPlus_` for these environment variables. However, the `COMPlus_` prefix will continue to work. If you're using a previous version of the .NET runtime, you should still use the `COMPlus_` prefix for environment variables. |
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.
Since .NET 7 the standardized prefix is
DOTNET_so we should mention that variant first.Internal previews