Orleans.RateLimiting is a library for Microsoft Orleans that provides a set of rate limiting algorithms for controlling
the flow of requests in your distributed applications.
It is designed to be easy to use and to integrate with your Orleans-based applications seamlessly.
With Orleans.RateLimiting, you can ensure your applications handle a safe number of requests without the risk of
overloading your system resources.
RateLimiting
on learn.microsoft.com
and devblogs.microsoft.com
Features
Supports 4 types of rate limiting algorithms:
Fixed Window Rate Limiter
Concurrency Limiter
Sliding Window Rate Limiter
Token Bucket Rate Limiter
Easy integration with Microsoft Orleans
Configurable rate limiting options
Comprehensive documentation and examples
Installation
You can install Orleans.RateLimiting via NuGet Package Manager:
// for Client
Install-Package ManagedCode.Orleans.RateLimiting.Client// for Server
Install-Package ManagedCode.Orleans.RateLimiting.Server
then add the following to your SiloHostBuilder or ClientBuilder:
// for Client
clientBuilder.AddOrleansRateLimiting();
// for Server
siloBuilder.AddOrleansRateLimiting();
Also if you would like to use incoming filter and Attributes, you have to add default options for Limiter:
await using var lease = await rateLimiter.AcquireAsync();
if (lease.IsAcquired)
{
// do something
}
else
{
Console.WriteLine(lease.Reason); // reason why the lease was not acquired
Console.WriteLine(lease.RetryAfter); //TimeSpan to wait before retrying
}
The following rate limiters are provided as extensions for IGrainFactory and IClusterClient
Fixed Window Rate Limiter
var fixedWindowRateLimiter = _factory.GetFixedWindowRateLimiter("key");
Concurrency Limiter
var concurrencyLimiter = _factory.GetConcurrencyLimiter("key");
Sliding Window Rate Limiter
var slidingWindowRateLimiter = _factory.GetSlidingWindowRateLimiter("key");
Token Bucket Rate Limiter
var tokenBucketRateLimiter = _factory.GetTokenBucketRateLimiter("key");
Attrubutes for Grains
You can use attributes to decorate your grain methods and apply rate limiting to them.
Make sure you check configuration section for default options.
public class TestFixedWindowRateLimiterGrain : Grain, ITestFixedWindowRateLimiterGrain
{
[FixedWindowRateLimiter] //GrainId as key, default options
public async Task<string> Do()
{
await Task.Delay(TimeSpan.FromSeconds(5));
return "Do";
}
[FixedWindowRateLimiter(KeyType.Key, "go")] //String as Key, default options
public async Task<string> Go()
{
await Task.Delay(TimeSpan.FromSeconds(5));
return "Go";
}
[FixedWindowRateLimiter(KeyType.GrainType, permitLimit:2, queueLimit:1)] //GrainType as Key, custom options, some of them are default (check Attribute)
public async Task<string> Take()
{
await Task.Delay(TimeSpan.FromSeconds(5));
return "Take";
}
}
Attrubutes for WebAPI
You can define OrleansRateLimiterOptions with specific name.
app.UseOrleansIpRateLimiting(); // as earlier as possible
.....
app.UseRouting();
app.UseCors();
app.MapControllers();
//Authentication should always be placed before Authorization.
app.UseAuthentication();
app.UseAuthorization();
app.UseOrleansUserRateLimiting(); // after Authorization and Authorization
.....
Finally you can add attributes to controller or single methods: