Run-time config knobs #16019
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,18 @@ | ||
| --- | ||
| title: Compilation config settings | ||
| description: Learn about run-time settings that configure how the JIT compiler works for .NET Core apps. | ||
| ms.date: 11/27/2019 | ||
| ms.topic: reference | ||
| --- | ||
| # Run-time configuration options for compilation | ||
|
|
||
| ## Tiered compilation | ||
|
|
||
| - Configures whether the JIT compiler uses [tiered compilation](../whats-new/dotnet-core-3-0.md#tiered-compilation). | ||
| - In .NET Core 3.0 and later, tiered compilation is enabled by default. | ||
| - In .NET Core 2.1 and 2.2, tiered compilation is disabled by default. | ||
|
|
||
| | | Setting name | Values | | ||
| | - | - | - | | ||
| | **runtimeconfig.json** | `System.Runtime.TieredCompilation` | `true` - enabled<br/>`false` - disabled | | ||
| | **Environment variable** | `COMPlus_TieredCompilation` | `1` - enabled<br/>`0` - disabled | | ||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,68 @@ | ||
| --- | ||
| title: Debugging profiling config settings | ||
| description: Learn about run-time settings that configure debugging and profiling for .NET Core apps. | ||
| ms.date: 11/27/2019 | ||
| ms.topic: reference | ||
| --- | ||
| # Run-time configuration options for debugging and profiling | ||
|
|
||
| ## Enable diagnostics | ||
|
|
||
| - Configures whether the debugger, the profiler, and EventPipe diagnostics are enabled or disabled. | ||
| - Default: Enabled (`1`). | ||
|
|
||
| | | Setting name | Values | | ||
| | - | - | - | | ||
| | **runtimeconfig.json** | N/A | N/A | | ||
| | **Environment variable** | `COMPlus_EnableDiagnostics` | `1` - enabled<br/>`0` - disabled | | ||
|
|
||
| ## Enable profiling | ||
|
|
||
| - Configures whether profiling is enabled for the currently running process. | ||
| - Default: Disabled (`0`). | ||
|
|
||
| | | Setting name | Values | | ||
| | - | - | - | | ||
| | **runtimeconfig.json** | N/A | N/A | | ||
| | **Environment variable** | `CORECLR_ENABLE_PROFILING` | `0` - disabled<br/>`1` - 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* | | ||
gewarren marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| ## 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](https://github.com/dotnet/runtime/blob/master/docs/design/coreclr/profiling/Profiler%20Loading.md). | ||
|
|
||
| | | Setting name | Values | | ||
| | - | - | - | | ||
| | **Environment variable** | `CORECLR_PROFILER_PATH` | *string-path* | | ||
gewarren marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| | **Environment variable** | `CORECLR_PROFILER_PATH_32` | *string-path* | | ||
| | **Environment variable** | `CORECLR_PROFILER_PATH_64` | *string-path* | | ||
|
|
||
| ## Write perf map | ||
|
|
||
| - Enables or disables writing */tmp/perf-$pid.map* on Linux systems. | ||
| - Default: Disabled (`0`). | ||
|
|
||
| | | Setting name | Values | | ||
| | - | - | - | | ||
| | **runtimeconfig.json** | N/A | N/A | | ||
| | **Environment variable** | `COMPlus_PerfMapEnabled` | `0` - disabled<br/>`1` - enabled | | ||
|
|
||
| ## Perf log markers | ||
|
|
||
| - When `COMPlus_PerfMapEnabled` is set to `1`, enables or disables the specified signal to be accepted and ignored as a marker in the perf logs. | ||
| - Default: Disabled (`0`). | ||
|
|
||
| | | Setting name | Values | | ||
| | - | - | - | | ||
| | **runtimeconfig.json** | N/A | N/A | | ||
| | **Environment variable** | `COMPlus_PerfMapIgnoreSignal` | `0` - disabled<br/>`1` - enabled | | ||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| [LocalizedFileNames] | ||
| compilation.md=@compilation.md,0 | ||
| threading.md=@threading.md,0 | ||
| profiling.md=@profiling.md,0 | ||
| networking.md=@networking.md,0 | ||
| globalization.md=@globalization.md,0 | ||
| debugging.md=@debugging.md,0 |
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,51 @@ | ||
| --- | ||
| title: Globalization config settings | ||
| description: Learn about run-time settings that configure globalization aspects of a .NET Core app, for example, how it parses Japanese dates. | ||
| ms.date: 11/27/2019 | ||
| ms.topic: reference | ||
| --- | ||
| # Run-time configuration options for globalization | ||
|
|
||
| ## Invariant mode | ||
|
|
||
| - Determines whether a .NET Core app runs in globalization invariant mode without access to culture-specific data and behavior or whether it has access to cultural data. | ||
| - Default: Run the app with access to cultural data (`false`). | ||
| - For more information, see [.NET Core globalization invariant mode](https://github.com/dotnet/corefx/blob/master/Documentation/architecture/globalization-invariant-mode.md). | ||
|
|
||
| | | Setting name | Values | | ||
| | - | - | - | | ||
| | **runtimeconfig.json** | `System.Globalization.Invariant` | `false` - access to cultural data<br/>`true` - run in invariant mode | | ||
| | **Environment variable** | `DOTNET_SYSTEM_GLOBALIZATION_INVARIANT` | `0` - access to cultural data<br/>`1` - run in invariant mode | | ||
|
|
||
| ## Era year ranges | ||
|
|
||
| - Determines whether range checks for calendars that support multiple eras are relaxed or whether dates that overflow an era's date range throw an <xref:System.ArgumentOutOfRangeException>. | ||
| - Default: Range checks are relaxed (`false`). | ||
| - For more information, see [Calendars, eras, and date ranges: Relaxed range checks](../../standard/datetime/working-with-calendars.md#calendars-eras-and-date-ranges-relaxed-range-checks). | ||
|
|
||
| | | Setting name | Values | | ||
| | - | - | - | | ||
| | **runtimeconfig.json** | `Switch.System.Globalization.EnforceJapaneseEraYearRanges` | `false` - relaxed range checks<br/>`true` - overflows cause an exception | | ||
| | **Environment variable** | N/A | N/A | | ||
|
|
||
| ## Japanese date parsing | ||
|
|
||
| - Determines whether a string that contains either "1" or "Gannen" as the year parses successfully or whether only "1" is supported. | ||
| - Default: Parse strings that contain either "1" or "Gannen" as the year (`false`). | ||
| - For more information, see [Represent dates in calendars with multiple eras](../../standard/datetime/working-with-calendars.md#represent-dates-in-calendars-with-multiple-eras). | ||
|
|
||
| | | Setting name | Values | | ||
| | - | - | - | | ||
| | **runtimeconfig.json** | `Switch.System.Globalization.EnforceLegacyJapaneseDateParsing` | `false` - "Gannen" or "1" is supported<br/>`true` - only "1" is supported | | ||
| | **Environment variable** | N/A | N/A | | ||
|
|
||
| ## Japanese year format | ||
|
|
||
| - Determines whether the first year of a Japanese calendar era is formatted as "Gannen" or as a number. | ||
| - Default: Format the first year as "Gannen" (`false`). | ||
| - For more information, see [Represent dates in calendars with multiple eras](../../standard/datetime/working-with-calendars.md#represent-dates-in-calendars-with-multiple-eras). | ||
|
|
||
| | | Setting name | Values | | ||
| | - | - | - | | ||
| | **runtimeconfig.json** | `Switch.System.Globalization.FormatJapaneseFirstYearAsANumber` | `false` - format as "Gannen"<br/>`true` - format as number | | ||
| | **Environment variable** | N/A | N/A | |
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,29 @@ | ||
| --- | ||
| title: Networking config settings | ||
| description: Learn about run-time settings that configure networking for .NET Core apps. | ||
| ms.date: 11/27/2019 | ||
| ms.topic: reference | ||
| --- | ||
| # Run-time configuration options for networking | ||
|
|
||
| ## HTTP/2 protocol | ||
|
|
||
| - Configures whether support for the HTTP/2 protocol is enabled. | ||
| - Default: Disabled (`false`). | ||
| - Introduced in .NET Core 3.0. | ||
|
|
||
| | | Setting name | Values | | ||
| | - | - | | ||
| | **runtimeconfig.json** | `System.Net.Http.SocketsHttpHandler.Http2Support` | `false` - disabled<br/>`true` - enabled | | ||
| | **Environment variable** | `DOTNET_SYSTEM_NET_HTTP_SOCKETSHTTPHANDLER_HTTP2SUPPORT` | `0` - disabled<br/>`1` - enabled | | ||
|
|
||
| ## Sockets HTTP handler | ||
|
There was a problem hiding this comment. We are removing these settings for .NET 5. Can we update the docs for this? cc @ManickaP There was a problem hiding this comment. We aren't supposed to talk about future functionality in docs, so I don't think we need to mention it yet. There was a problem hiding this comment. What is the right way to track updating the docs with this info once .NET 5 ships? |
||
|
|
||
| - Configures whether high-level networking APIs, such as <xref:System.Net.Http.HttpClient>, use <xref:System.Net.Http.SocketsHttpHandler?displayProperty=nameWithType> or the implementation of <xref:System.Net.Http.HttpClientHandler?displayProperty=nameWithType> that's based on [libcurl](https://curl.haxx.se/libcurl/). | ||
| - Default: Use <xref:System.Net.Http.SocketsHttpHandler?displayProperty=nameWithType> (`true`). | ||
| - You can configure this setting programmatically by calling the <xref:System.AppContext.SetSwitch%2A?displayProperty=nameWithType> method. | ||
|
|
||
| | | Setting name | Values | | ||
| | - | - | - | | ||
| | **runtimeconfig.json** | `System.Net.Http.UseSocketsHttpHandler` | `true` - enables the use of <xref:System.Net.Http.SocketsHttpHandler><br/>`false` - enables the use of <xref:System.Net.Http.HttpClientHandler> | | ||
| | **Environment variable** | `DOTNET_SYSTEM_NET_HTTP_USESOCKETSHTTPHANDLER` | `1` - enables the use of <xref:System.Net.Http.SocketsHttpHandler><br/>`0` - enables the use of <xref:System.Net.Http.HttpClientHandler> | | ||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,37 @@ | ||
| --- | ||
| title: Threading config settings | ||
| description: Learn about run-time settings that configure threading for .NET Core apps. | ||
| ms.date: 11/27/2019 | ||
| ms.topic: reference | ||
| --- | ||
| # Run-time configuration options for threading | ||
|
|
||
| ## CPU groups | ||
|
|
||
| - Configures whether threads are automatically distributed across CPU groups. | ||
| - Default: Disabled (`0`). | ||
|
|
||
| | | Setting name | Values | | ||
| | - | - | - | | ||
| | **runtimeconfig.json** | N/A | N/A | | ||
| | **Environment variable** | `COMPlus_Thread_UseAllCpuGroups` | `0` - disabled<br/>`1` - enabled | | ||
|
|
||
| ## Minimum threads | ||
|
|
||
| - Specifies the minimum number of threads for the worker threadpool. | ||
| - Corresponds to the <xref:System.Threading.ThreadPool.SetMinThreads%2A?displayProperty=nameWithType> method. | ||
|
|
||
| | | Setting name | Values | | ||
| | - | - | - | | ||
| | **runtimeconfig.json** | `System.Threading.ThreadPool.MinThreads` | An integer that represents the minimum number of threads | | ||
| | **Environment variable** | N/A | N/A | | ||
|
|
||
| ## Maximum threads | ||
|
|
||
| - Specifies the maximum number of threads for the worker threadpool. | ||
| - Corresponds to the <xref:System.Threading.ThreadPool.SetMaxThreads%2A?displayProperty=nameWithType> method. | ||
|
|
||
| | | Setting name | Values | | ||
| | - | - | - | | ||
| | **runtimeconfig.json** | `System.Threading.ThreadPool.MaxThreads` | An integer that represents the maximum number of threads | | ||
| | **Environment variable** | N/A | N/A | |
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
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.