Microsoft.Extensions.Http.Resilience 8.4.0

The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org. Prefix Reserved
There is a newer prerelease version of this package available.
See the version list below for details.
dotnet add package Microsoft.Extensions.Http.Resilience --version 8.4.0
NuGet\Install-Package Microsoft.Extensions.Http.Resilience -Version 8.4.0
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Microsoft.Extensions.Http.Resilience" Version="8.4.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Microsoft.Extensions.Http.Resilience --version 8.4.0
#r "nuget: Microsoft.Extensions.Http.Resilience, 8.4.0"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install Microsoft.Extensions.Http.Resilience as a Cake Addin
#addin nuget:?package=Microsoft.Extensions.Http.Resilience&version=8.4.0

// Install Microsoft.Extensions.Http.Resilience as a Cake Tool
#tool nuget:?package=Microsoft.Extensions.Http.Resilience&version=8.4.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());
});

Feedback & Contributing

We welcome feedback and contributions in our GitHub repo.

Product Compatible and additional computed target framework versions.
.NET net6.0 is compatible.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  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. 
.NET Framework net462 is compatible.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (20)

Showing the top 5 NuGet packages that depend on Microsoft.Extensions.Http.Resilience:

Package Downloads
OpenIddict.Validation.SystemNetHttp The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org.

System.Net.Http integration package for the OpenIddict validation services.

OpenIddict.Client.SystemNetHttp The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org.

System.Net.Http integration package for the OpenIddict client services.

Phoesion.Glow.SDK.Firefly.SrvHost.DotNet.Dependencies The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org.

Phoesion Glow SDK Firefly SrvHost Runner (DotNet) Dependencies

Hexalith.Infrastructure.WebApis

Hexalith is a set of libraries to build a micro-service architecture.

YahooQuotesApi

Yahoo Finance API to retrieve quote snapshots, and quote, dividend and split history.

GitHub repositories (9)

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
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/eShop
A reference .NET application implementing an eCommerce site
dotnet/aspire
An opinionated, cloud ready stack for building observable, production ready, distributed applications in .NET
CodeMazeBlog/CodeMazeGuides
The main repository for all the Code Maze guides
Version Downloads Last updated
9.0.0-preview.3.24209.3 736 4/11/2024
9.0.0-preview.2.24157.4 2,605 3/12/2024
9.0.0-preview.1.24108.1 1,845 2/13/2024
8.4.0 20,983 4/9/2024
8.3.0 85,536 3/12/2024
8.2.0 213,966 2/13/2024
8.1.0 173,318 1/9/2024
8.0.0 261,268 11/14/2023
8.0.0-rc.2.23510.2 2,647 10/10/2023
8.0.0-rc.1.23453.1 1,272 9/12/2023
8.0.0-preview.7.23407.5 916 8/8/2023
8.0.0-preview.6.23360.2 658 7/12/2023
8.0.0-preview.5.23308.3 2,360 6/14/2023
8.0.0-preview.4.23273.7 1,996 5/23/2023