From bbe6a5c07b887297afe3baa03f9509be10fc67b3 Mon Sep 17 00:00:00 2001 From: mpl Date: Tue, 14 Mar 2023 14:58:06 +0100 Subject: [PATCH] doc: clarify ratelimit middleware --- docs/content/middlewares/http/ratelimit.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/content/middlewares/http/ratelimit.md b/docs/content/middlewares/http/ratelimit.md index 923f01d0c..74f9c6476 100644 --- a/docs/content/middlewares/http/ratelimit.md +++ b/docs/content/middlewares/http/ratelimit.md @@ -10,6 +10,8 @@ To Control the Number of Requests Going to a Service The RateLimit middleware ensures that services will receive a _fair_ amount of requests, and allows one to define what fair is. +It is based on a [token bucket](https://en.wikipedia.org/wiki/Token_bucket) implementation. In this analogy, the [average](#average) parameter (defined below) is the rate at which the bucket refills, and the [burst](#burst) is the size (volume) of the bucket. + ## Configuration Example ```yaml tab="Docker"