Microsoft.Extensions.Http.Resilience
9.0.0
Prefix Reserved
dotnet add package Microsoft.Extensions.Http.Resilience --version 9.0.0
NuGet\Install-Package Microsoft.Extensions.Http.Resilience -Version 9.0.0
<PackageReference Include="Microsoft.Extensions.Http.Resilience" Version="9.0.0" />
paket add Microsoft.Extensions.Http.Resilience --version 9.0.0
#r "nuget: Microsoft.Extensions.Http.Resilience, 9.0.0"
// Install Microsoft.Extensions.Http.Resilience as a Cake Addin #addin nuget:?package=Microsoft.Extensions.Http.Resilience&version=9.0.0 // Install Microsoft.Extensions.Http.Resilience as a Cake Tool #tool nuget:?package=Microsoft.Extensions.Http.Resilience&version=9.0.0
Microsoft.Extensions.Http.Resilience
Resilience mechanisms for HttpClient
built on the Polly framework.
Install the package
From the command-line:
dotnet add package Microsoft.Extensions.Http.Resilience
Or directly in the C# project file:
<ItemGroup>
<PackageReference Include="Microsoft.Extensions.Http.Resilience" Version="[CURRENTVERSION]" />
</ItemGroup>
Usage Examples
When configuring an HttpClient through the HTTP client factory the following extensions can add a set of pre-configured hedging or resilience behaviors. These pipelines combine multiple resilience strategies with pre-configured defaults.
- The total request timeout pipeline applies an overall timeout to the execution, ensuring that the request including hedging attempts, does not exceed the configured limit.
- The retry pipeline retries the request in case the dependency is slow or returns a transient error.
- The rate limiter pipeline limits the maximum number of requests being send to the dependency.
- The circuit breaker blocks the execution if too many direct failures or timeouts are detected.
- The attempt timeout pipeline limits each request attempt duration and throws if its exceeded.
Resilience
The standard resilience pipeline makes use of the above strategies to ensure HTTP requests can be sent reliably.
var clientBuilder = services.AddHttpClient("MyClient");
clientBuilder.AddStandardResilienceHandler().Configure(o =>
{
o.CircuitBreaker.MinimumThroughput = 10;
});
Hedging
The standard hedging pipeline uses a pool of circuit breakers to ensure that unhealthy endpoints are not hedged against. By default, the selection from pool is based on the URL Authority (scheme + host + port). It is recommended that you configure the way the strategies are selected by calling the SelectPipelineByAuthority()
extensions. The last three strategies are applied to each individual endpoint.
var clientBuilder = services.AddHttpClient("MyClient");
clientBuilder.AddStandardHedgingHandler().Configure(o =>
{
o.TotalRequestTimeout.Timeout = TimeSpan.FromSeconds(10);
});
Custom Resilience
For more granular control a custom pipeline can be constructed.
var clientBuilder = services.AddHttpClient("MyClient");
clientBuilder.AddResilienceHandler("myHandler", b =>
{
b.AddFallback(new FallbackStrategyOptions<HttpResponseMessage>()
{
FallbackAction = _ => Outcome.FromResultAsValueTask(new HttpResponseMessage(HttpStatusCode.ServiceUnavailable))
})
.AddConcurrencyLimiter(100)
.AddRetry(new HttpRetryStrategyOptions())
.AddCircuitBreaker(new HttpCircuitBreakerStrategyOptions())
.AddTimeout(new HttpTimeoutStrategyOptions());
});
Known issues
The following sections detail various known issues.
Compatibility with the Grpc.Net.ClientFactory
package
If you're using Grpc.Net.ClientFactory
version 2.63.0
or earlier, then enabling the standard resilience or hedging handlers for a gRPC client could cause a runtime exception. Specifically, consider the following code sample:
services
.AddGrpcClient<Greeter.GreeterClient>()
.AddStandardResilienceHandler();
The preceding code results in the following exception:
System.InvalidOperationException: The ConfigureHttpClient method is not supported when creating gRPC clients. Unable to create client with name 'GreeterClient'.
To resolve this issue, we recommend upgrading to Grpc.Net.ClientFactory
version 2.64.0
or later.
There's a build time check that verifies if you're using Grpc.Net.ClientFactory
version 2.63.0
or earlier, and if you are the check produces a compilation warning. You can suppress the warning by setting the following property in your project file:
<PropertyGroup>
<SuppressCheckGrpcNetClientFactoryVersion>true</SuppressCheckGrpcNetClientFactoryVersion>
</PropertyGroup>
Compatibility with .NET Application Insights
If you're using .NET Application Insights, then enabling resilience functionality in your application could cause all Application Insights telemetry to be missing. The issue occurs when resilience functionality is registered before Application Insights services. Consider the following sample causing the issue:
// At first, we register resilience functionality.
services.AddHttpClient().AddStandardResilienceHandler();
// And then we register Application Insights. As a result, Application Insights doesn't work.
services.AddApplicationInsightsTelemetry();
The issue is caused by the following bug in Application Insights and can be fixed by registering Application Insights services before resilience functionality, as shown below:
// We register Application Insights first, and now it will be working correctly.
services.AddApplicationInsightsTelemetry();
services.AddHttpClient().AddStandardResilienceHandler();
Feedback & Contributing
We welcome feedback and contributions in our GitHub repo.
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net8.0 is compatible. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. net9.0 is compatible. |
.NET Framework | net462 is compatible. net463 was computed. net47 was computed. net471 was computed. net472 was computed. net48 was computed. net481 was computed. |
-
.NETFramework 4.6.2
- Microsoft.Extensions.Configuration.Binder (>= 8.0.2)
- Microsoft.Extensions.Http.Diagnostics (>= 9.0.0)
- Microsoft.Extensions.ObjectPool (>= 8.0.11)
- Microsoft.Extensions.Resilience (>= 9.0.0)
-
net8.0
- Microsoft.Extensions.Configuration.Binder (>= 8.0.2)
- Microsoft.Extensions.Http.Diagnostics (>= 9.0.0)
- Microsoft.Extensions.ObjectPool (>= 8.0.11)
- Microsoft.Extensions.Resilience (>= 9.0.0)
-
net9.0
- Microsoft.Extensions.Configuration.Binder (>= 9.0.0)
- Microsoft.Extensions.Http.Diagnostics (>= 9.0.0)
- Microsoft.Extensions.ObjectPool (>= 9.0.0)
- Microsoft.Extensions.Resilience (>= 9.0.0)
NuGet packages (76)
Showing the top 5 NuGet packages that depend on Microsoft.Extensions.Http.Resilience:
Package | Downloads |
---|---|
OpenIddict.Validation.SystemNetHttp
System.Net.Http integration package for the OpenIddict validation services. |
|
OpenIddict.Client.SystemNetHttp
System.Net.Http integration package for the OpenIddict client services. |
|
OrchardCore.Users
Orchard Core CMS is a Web Content Management System (CMS) built on top of the Orchard Core Framework. The Users module adds user management functionality. |
|
OrchardCore.OpenId
Orchard Core CMS is a Web Content Management System (CMS) built on top of the Orchard Core Framework. Provides OpenId Connect client, server and management features. |
|
OrchardCore.ReCaptcha.Core
Orchard Core CMS is a Web Content Management System (CMS) built on top of the Orchard Core Framework. Core implementation for OrchardCore ReCaptcha |
GitHub repositories (66)
Showing the top 5 popular GitHub repositories that depend on Microsoft.Extensions.Http.Resilience:
Repository | Stars |
---|---|
microsoft/semantic-kernel
Integrate cutting-edge LLM technology quickly and easily into your apps
|
|
jasontaylordev/CleanArchitecture
Clean Architecture Solution Template for ASP.NET Core
|
|
ardalis/CleanArchitecture
Clean Architecture Solution Template: A starting point for Clean Architecture with ASP.NET Core
|
|
App-vNext/Polly
Polly is a .NET resilience and transient-fault-handling library that allows developers to express policies such as Retry, Circuit Breaker, Timeout, Bulkhead Isolation, and Fallback in a fluent and thread-safe manner. From version 6.0.1, Polly targets .NET Standard 1.1 and 2.0+.
|
|
dotnet/orleans
Cloud Native application framework for .NET
|
Version | Downloads | Last updated |
---|---|---|
9.0.0 | 245,722 | 11/12/2024 |
9.0.0-preview.9.24507.7 | 30,844 | 10/8/2024 |
9.0.0-preview.8.24460.1 | 18,510 | 9/10/2024 |
9.0.0-preview.7.24412.10 | 5,915 | 8/14/2024 |
9.0.0-preview.6.24353.1 | 4,838 | 7/10/2024 |
9.0.0-preview.5.24311.7 | 5,473 | 6/11/2024 |
9.0.0-preview.4.24271.2 | 7,188 | 5/21/2024 |
9.0.0-preview.3.24209.3 | 8,369 | 4/11/2024 |
9.0.0-preview.2.24157.4 | 3,353 | 3/12/2024 |
9.0.0-preview.1.24108.1 | 2,029 | 2/13/2024 |
8.10.0 | 907,492 | 10/8/2024 |
8.9.1 | 777,142 | 9/6/2024 |
8.9.0 | 44,456 | 9/5/2024 |
8.8.0 | 623,893 | 8/13/2024 |
8.7.0 | 963,145 | 7/10/2024 |
8.6.0 | 671,233 | 6/11/2024 |
8.5.0 | 817,864 | 5/14/2024 |
8.4.0 | 1,293,613 | 4/9/2024 |
8.3.0 | 532,708 | 3/12/2024 |
8.2.0 | 875,105 | 2/13/2024 |
8.1.0 | 376,363 | 1/9/2024 |
8.0.0 | 591,656 | 11/14/2023 |
8.0.0-rc.2.23510.2 | 2,708 | 10/10/2023 |
8.0.0-rc.1.23453.1 | 1,320 | 9/12/2023 |
8.0.0-preview.7.23407.5 | 971 | 8/8/2023 |
8.0.0-preview.6.23360.2 | 712 | 7/12/2023 |
8.0.0-preview.5.23308.3 | 2,397 | 6/14/2023 |
8.0.0-preview.4.23273.7 | 2,080 | 5/23/2023 |