Runtime configuration options for debugging and profiling
This article details the settings you can use to configure .NET debugging and profiling.
Note
.NET 6 standardizes on the prefix DOTNET_
instead of COMPlus_
for environment variables that configure .NET run-time behavior. 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.
Enable diagnostics
- Configures whether the debugger, the profiler, and EventPipe diagnostics are enabled or disabled.
- If you omit this setting, diagnostics are enabled. This is equivalent to setting the value to
1
.
Setting name | Values | |
---|---|---|
runtimeconfig.json | N/A | N/A |
Environment variable | COMPlus_EnableDiagnostics or DOTNET_EnableDiagnostics |
1 - enabled0 - disabled |
Enable profiling
- Configures whether profiling is enabled for the currently running process.
- If you omit this setting, profiling is disabled. This is equivalent to setting the value to
0
.
Setting name | Values | |
---|---|---|
runtimeconfig.json | N/A | N/A |
Environment variable | CORECLR_ENABLE_PROFILING |
0 - disabled1 - enabled |
Profiler GUID
- Specifies the GUID of the profiler to load into the currently running process.
Setting name | Values | |
---|---|---|
runtimeconfig.json | N/A | N/A |
Environment variable | CORECLR_PROFILER |
string-guid |
Profiler location
- Specifies the path to the profiler DLL to load into the currently running process (or 32-bit or 64-bit process).
- If more than one variable is set, the bitness-specific variables take precedence. They specify which bitness of profiler to load.
- For more information, see Finding the profiler library.
Setting name | Values | |
---|---|---|
Environment variable | CORECLR_PROFILER_PATH |
string-path |
Environment variable | CORECLR_PROFILER_PATH_32 |
string-path |
Environment variable | CORECLR_PROFILER_PATH_64 |
string-path |
Export perf maps
- Enables or disables emitting perf maps to /tmp/perf-$pid.map. Perf maps allow third party tools, such as perf, to identify call sites from precompiled ReadyToRun (R2R) modules.
- If you omit this setting, writing the perf map is disabled. This is equivalent to setting the value to
0
. - When perf maps are disabled, not all managed callsites will be properly resolved.
- Enabling perf maps causes a 10-20% overhead.
Setting name | Values | |
---|---|---|
runtimeconfig.json | N/A | N/A |
Environment variable | COMPlus_PerfMapEnabled or DOTNET_PerfMapEnabled |
0 - disabled1 - enabled |
Perf log markers
- Enables or disables the specified signal to be accepted and ignored as a marker in the perf logs.
- If you omit this setting, the specified signal is not ignored. This is equivalent to setting the value to
0
.
Setting name | Values | |
---|---|---|
runtimeconfig.json | N/A | N/A |
Environment variable | COMPlus_PerfMapIgnoreSignal or DOTNET_PerfMapIgnoreSignal |
0 - disabled1 - enabled |
Note
This setting is ignored if DOTNET_PerfMapEnabled is omitted or set to 0
(that is, disabled).
Collaborate with us on GitHub
The source for this content can be found on GitHub, where you can also create and review issues and pull requests. For more information, see our contributor guide.
Feedback
Submit and view feedback for