NServiceBus.RateLimiter 1.0.4

There is a newer version of this package available.
See the version list below for details.
dotnet add package NServiceBus.RateLimiter --version 1.0.4
NuGet\Install-Package NServiceBus.RateLimiter -Version 1.0.4
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="NServiceBus.RateLimiter" Version="1.0.4" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add NServiceBus.RateLimiter --version 1.0.4
#r "nuget: NServiceBus.RateLimiter, 1.0.4"
#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 NServiceBus.RateLimiter as a Cake Addin
#addin nuget:?package=NServiceBus.RateLimiter&version=1.0.4

// Install NServiceBus.RateLimiter as a Cake Tool
#tool nuget:?package=NServiceBus.RateLimiter&version=1.0.4

NServiceBus.RateLimiter

For NServiceBus 6+

Before NServiceBus 6 there was the ability to throttle the number of messages processed per second. This feature was deprecated because throttling can be conflicting with the different types of tranports and the way messages are retrieved.

Important

The packages registers itself in the first stage of the pipeline (ITransportReceiveContext) this means that when this behavior is called the message is actually already retrieved from the queue. If you use a transactional queue this means that your transport transaction duration will increase (MSMQ, SQL Server, etc.). If you use lease based transport (Azure Storage Queues).

For this reason a warning log entry is written is the delay takes more then 5 seconds.

Message 'A88A7826-79B3-4203-BB3C-266DE76754F0' delayed by 00:01:15 due to throttling or due to other handlers taking a lot of time to complete. This can conflict with message lease times or transaction timeouts. Consider lowering the concurrency level or to shorten the rate limiting duration.

Consider lowering the concurrency level as that might cause the rate limit to be reached very fast.

Installation

Install the Nuget package NServiceBus.RateLimiter

Configuration

Automatic interval calculation

Calculates the smallest interval based on rate expressed in items per second based on the allowed concurrency.

endpointConfiguration.ApplyRateLimiting(int limitPersecond, int concurrency)

Limits the processing rate per second based on limitPersecond. It will calculate the smallest interval based on the specified concurrency.

Example:

If you allow for 100 messages per second, with a concurrency of 4 then the logic will limit processing of 4 messages every 400 milliseconds.

endpointConfiguration.ApplyRateLimiting(limitPerSecond:10, concurrency:4);

Manual

Manual control over the rate limit and duration.

endpointConfiguration.ApplyRateLimiting(int limit, TimeSpan duration)

If you do not want to use the smallest interval, but want to allow for higher burst rates then set concurrency to the max burst size.

Example:

If you allow for burst of 250 items as a rate of 10 messages per second then the logic will limit processing of 250 messages every 25 seconds.

endpointConfiguration.ApplyRateLimiting(limitPerSecond:10, concurrency:250);

Using this logic you can cope with sudden peaks of incoming messages but still maintain - on average - your rate of 10 messages per second.

Product Compatible and additional computed target framework versions.
.NET Framework net452 is compatible.  net46 was computed.  net461 was computed.  net462 was computed.  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.
  • .NETFramework 4.5.2

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
4.0.0 84 6/14/2024
3.1.0 3,437 7/16/2023
3.0.0 316 12/9/2022
2.1.0 66,343 5/23/2020
2.0.0 5,419 9/24/2019
1.0.4 3,157 11/25/2017

First real working version based on EndpointConfiguration extensions.