for _ in {1..11}; do
curl -i $KONNECT_PROXY_URL/anything
echo
doneApply multiple rate limits and window sizes
Deployment Platform
Related Documentation
Tags
Related Resources
Minimum Version
Kong Gateway - 3.4
TL;DR
You can use the Rate Limiting Advanced plugin to apply any number of rate limits and window sizes per plugin instance. This lets you create multiple rate limiting windows, for example, rate limit per minute and per hour, and per any arbitrary window size.
Prerequisites
Kong Konnect
This is a Konnect tutorial and requires a Konnect personal access token.
-
Create a new personal access token by opening the Konnect PAT page and selecting Generate Token.
-
Export your token to an environment variable:
export KONNECT_TOKEN='YOUR_KONNECT_PAT' -
Run the quickstart script to automatically provision a Control Plane and Data Plane, and configure your environment:
curl -Ls https://get.konghq.com/quickstart | bash -s -- -k $KONNECT_TOKEN \ --deck-outputThis sets up a Konnect Control Plane named
quickstart, provisions a local Data Plane, and prints out the following environment variable exports:export DECK_KONNECT_TOKEN=$KONNECT_TOKEN export DECK_KONNECT_CONTROL_PLANE_NAME=quickstart export DECK_KONNECT_ADDR=https://us.api.konghq.com export KONNECT_CONTROL_PLANE_URL=https://us.api.konghq.com export KONNECT_PROXY_URL='http://localhost:8000'Copy and paste these into your terminal to configure your session.
Kong Gateway running
This tutorial requires Kong Gateway Enterprise. If you don’t have Kong Gateway set up yet, you can use the quickstart script with an enterprise license to get an instance of Kong Gateway running almost instantly.
-
Export your license to an environment variable:
export KONG_LICENSE_DATA='LICENSE-CONTENTS-GO-HERE' -
Run the quickstart script:
curl -Ls https://get.konghq.com/quickstart | bash -s -- -e KONG_LICENSE_DATAOnce Kong Gateway is ready, you will see the following message:
Kong Gateway Ready
decK v1.66.1+
To complete this tutorial, install decK. We recommend keeping decK up to date with the latest version (1.66.1).
decK is a CLI tool for managing Kong Gateway declaratively with state files.
This guide uses deck gateway apply, which directly applies entity configuration to your Gateway instance.
You can check your current decK version with deck version.
Required entities
For this tutorial, you’ll need Kong Gateway entities, like Gateway Services and Routes, pre-configured. These entities are essential for Kong Gateway to function but installing them isn’t the focus of this guide. Follow these steps to pre-configure them:
-
Run the following command:
echo ' _format_version: "3.0" services: - name: example-service url: http://httpbin.konghq.com/anything routes: - name: example-route paths: - "/anything" service: name: example-service protocols: - http - https ' | deck gateway apply -
To learn more about entities, you can read our entities documentation.
Enable rate limiting
Enable the Rate Limiting Advanced plugin for the Gateway Service.
echo '
_format_version: "3.0"
plugins:
- name: rate-limiting-advanced
service: example-service
config:
namespace: example-namespace
limit:
- 10
- 100
window_size:
- 60
- 3600
' | deck gateway apply -Each nth limit will apply to each nth window size.
This example applies rate limiting policies, one of which will trip when 10 hits have been counted in 60 seconds, or the other when 100 hits have been counted in 3600 seconds.
The number of configured window sizes and limits parameters must be equal (as shown above); otherwise, an error occurs.
Validate
After configuring the Rate Limiting Advanced plugin, you can verify that it was configured correctly and is working, by sending more requests then allowed in the configured time limit.
for _ in {1..11}; do
curl -i http://localhost:8000/anything
echo
doneOn the last request, you should get a 429 response with the message API rate limit exceeded.
Cleanup
Clean up Konnect environment
If you created a new control plane and want to conserve your free trial credits or avoid unnecessary charges, delete the new control plane used in this tutorial.
Destroy the Kong Gateway container
curl -Ls https://get.konghq.com/quickstart | bash -s -- -dFAQs
Why can’t I use the regular Rate Limiting plugin to set multiple limits and window sizes?
You could use the regular Rate Limiting plugin to just set multiple limits, but the regular plugin doesn’t support configurable window sizes.