AICentral.RateLimiting.DistributedRedis 0.21.0-pullrequest0152-0005

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.21.0-pullrequest0152-0005

NuGet\Install-Package AICentral.RateLimiting.DistributedRedis -Version 0.21.0-pullrequest0152-0005

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.21.0-pullrequest0152-0005" />

For projects that support PackageReference, copy this XML node into the project file to reference the package.

<PackageVersion Include="AICentral.RateLimiting.DistributedRedis" Version="0.21.0-pullrequest0152-0005" />
                    

                            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.21.0-pullrequest0152-0005

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

#r "nuget: AICentral.RateLimiting.DistributedRedis, 0.21.0-pullrequest0152-0005"

#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.

#:package AICentral.RateLimiting.DistributedRedis@0.21.0-pullrequest0152-0005

#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.

#addin nuget:?package=AICentral.RateLimiting.DistributedRedis&version=0.21.0-pullrequest0152-0005&prerelease
                    

                            Install as a Cake Addin

#tool nuget:?package=AICentral.RateLimiting.DistributedRedis&version=0.21.0-pullrequest0152-0005&prerelease
                    

                            Install as a Cake Tool

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

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.

Product

.NET

Compatible target framework(s)

Included target framework(s) (in package)

Learn more about Target Frameworks and .NET Standard.

net8.0
- AICentral.Core (>= 0.21.0-pullrequest0152-0002)
- Aspire.StackExchange.Redis (>= 8.0.2)

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.