AICentral.RateLimiting.DistributedRedis 0.20.5-pullrequest0148-0004

This is a prerelease version of AICentral.RateLimiting.DistributedRedis.
There is a newer version of this package available.
See the version list below for details.
dotnet add package AICentral.RateLimiting.DistributedRedis --version 0.20.5-pullrequest0148-0004
                    
NuGet\Install-Package AICentral.RateLimiting.DistributedRedis -Version 0.20.5-pullrequest0148-0004
                    
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="AICentral.RateLimiting.DistributedRedis" Version="0.20.5-pullrequest0148-0004" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="AICentral.RateLimiting.DistributedRedis" Version="0.20.5-pullrequest0148-0004" />
                    
Directory.Packages.props
<PackageReference Include="AICentral.RateLimiting.DistributedRedis" />
                    
Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add AICentral.RateLimiting.DistributedRedis --version 0.20.5-pullrequest0148-0004
                    
#r "nuget: AICentral.RateLimiting.DistributedRedis, 0.20.5-pullrequest0148-0004"
                    
#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.
#addin nuget:?package=AICentral.RateLimiting.DistributedRedis&version=0.20.5-pullrequest0148-0004&prerelease
                    
Install as a Cake Addin
#tool nuget:?package=AICentral.RateLimiting.DistributedRedis&version=0.20.5-pullrequest0148-0004&prerelease
                    
Install as a Cake Tool

AICentral.RateLimiting.DistributedRedis

A Distributed Rate Limiter for use with (AICentral)[www.github.com/microsoft/aicentral]

Configuration


dotnet add package AICentral.RateLimiting.DistributedRedis


builder.Services.AddAICentral(
    builder.Configuration,
    additionalComponentAssemblies:
    [
        typeof(DistributedRateLimiter).Assembly,
    ]);


{
  "AICentral": {
    "GenericSteps": [
      {
        "Type": "DistributedRateLimiter",
        "Name": "request-rate-limiter",
        "Properties": {
          "LimitType": "PerEndpoint|PerConsumer",
          "MetricType": "Tokens|Requests",
          "Window": "00:00:10",
          "PermitLimit": 100,
          "RedisConfiguration" : "<Redis connection string>"
        }
      }
    ]    
  }
}

How does it work?

For each pipeline a Redis Key is constructed which will identify this pipeline (optionally and the client) across AICentral Instances. We store a Hash against this Redis key which is the current count of requests or tokens used.

Importantly the Hash Key contains a value derived from a Static point in time and the window information. This means the Key will always be the same across instances.

The Rate Limiter checks the sum of all the Hashes for the current window and if it is greater than the limit then the request is rejected. The key automatically changes as we enter a new window meaning the totals are reset.

Product 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 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 was computed.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

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
0.21.0 120 12/9/2024
0.21.0-pullrequest0152-0005 109 12/9/2024
0.21.0-pullrequest0152-0004 94 12/9/2024
0.20.5 116 9/30/2024
0.20.5-pullrequest0148-0004 99 9/30/2024
0.20.5-pullrequest0148-0002 75 9/30/2024
0.20.3 121 9/5/2024
0.20.3-pullrequest0146-0005 104 9/5/2024
0.20.3-pullrequest0146-0004 101 9/5/2024
0.20.0 133 8/17/2024
0.20.0-pullrequest0143-0013 106 8/17/2024
0.20.0-pullrequest0143-0012 106 8/17/2024
0.20.0-pullrequest0143-0011 103 8/17/2024
0.20.0-pullrequest0143-0010 110 8/17/2024
0.20.0-pullrequest0143-0009 115 8/17/2024
0.19.6-pullrequest0143-0008 105 8/17/2024
0.19.0 109 7/29/2024
0.19.0-pullrequest0136-0014 86 7/29/2024
0.19.0-pullrequest0136-0013 83 7/29/2024
0.19.0-pullrequest0136-0012 88 7/29/2024
0.19.0-pullrequest0136-0011 90 7/29/2024
0.19.0-pullrequest0136-0010 91 7/29/2024
0.19.0-pullrequest0136-0009 98 7/27/2024
0.19.0-pullrequest0136-0008 90 7/27/2024
0.19.0-pullrequest0136-0007 93 7/27/2024
0.18.7-pullrequest0136-0006 95 7/27/2024
0.18.1 122 7/10/2024
0.18.1-pullrequest0129-0007 92 7/10/2024
0.18.0 151 7/10/2024
0.18.0-pullrequest0125-0014 96 7/10/2024
0.18.0-pullrequest0125-0013 109 7/10/2024
0.18.0-pullrequest0125-0012 100 7/10/2024
0.18.0-pullrequest0125-0011 100 7/10/2024
0.18.0-pullrequest0125-0010 108 7/10/2024
0.18.0-pullrequest0125-0009 100 7/10/2024
0.17.0 108 7/8/2024
0.17.0-pullrequest0123-0024 92 7/8/2024
0.17.0-pullrequest0123-0023 88 7/8/2024
0.17.0-pullrequest0123-0021 108 7/8/2024
0.17.0-pullrequest0123-0020 87 7/8/2024
0.17.0-pullrequest0123-0019 88 7/8/2024
0.17.0-pullrequest0123-0018 79 7/8/2024
0.17.0-pullrequest0123-0017 94 7/8/2024
0.17.0-pullrequest0123-0016 97 7/8/2024
0.17.0-pullrequest0123-0015 89 7/8/2024
0.17.0-pullrequest0123-0014 80 7/8/2024
0.17.0-pullrequest0123-0013 84 7/8/2024
0.17.0-pullrequest0123-0012 80 7/8/2024
0.17.0-pullrequest0123-0011 90 7/8/2024
0.17.0-pullrequest0123-0009 318 7/6/2024
0.17.0-pullrequest0123-0008 86 7/6/2024
0.16.23 102 6/12/2024
0.16.23-pullrequest0118-0005 92 6/12/2024
0.16.23-pullrequest0118-0004 85 6/12/2024
0.16.23-pullrequest0118-0003 88 6/12/2024