

RateLimit¶

To Control the Number of Requests Going to a Service

The RateLimit middleware ensures that services will receive a fair number of requests, and allows you define what is fair.

Configuration Example¶

# Here, an average of 100 requests per second is allowed.
# In addition, a burst of 50 requests is allowed.
labels:
  - "traefik.http.middlewares.test-ratelimit.ratelimit.average=100"
  - "traefik.http.middlewares.test-ratelimit.ratelimit.burst=50"

Configuration Options¶

average¶

Average is the maximum rate, in requests/s, allowed for the given source. It defaults to 0, which means no rate limiting.

labels:
  - "traefik.http.middlewares.test-ratelimit.ratelimit.average=100"

burst¶

Burst is the maximum number of requests allowed to go through in the same arbitrarily small period of time. It defaults to 1.

labels:
  - "traefik.http.middlewares.test-ratelimit.ratelimit.burst=100"

sourceCriterion¶

SourceCriterion defines what criterion is used to group requests as originating from a common source. The precedence order is ipStrategy, then requestHeaderName, then requestHost. If none are set, the default is to use the request's remote address field (as an ipStrategy).

sourceCriterion.ipStrategy¶

The ipStrategy option defines two parameters that sets how Traefik will determine the client IP: depth, and excludedIPs.

ipStrategy.depth¶

The depth option tells Traefik to use the X-Forwarded-For header and take the IP located at the depth position (starting from the right).

• If depth is greater than the total number of IPs in X-Forwarded-For, then the client IP will be empty.
• depth is ignored if its value is lesser than or equal to 0.

ipStrategy.excludedIPs¶

labels:
  - "traefik.http.middlewares.test-ratelimit.ratelimit.sourcecriterion.ipstrategy.excludedips=127.0.0.1/32, 192.168.1.7"

excludedIPs tells Traefik to scan the X-Forwarded-For header and pick the first IP not in the list.

sourceCriterion.requestHeaderName¶

Requests having the same value for the given header are grouped as coming from the same source.

labels:
  - "traefik.http.middlewares.test-ratelimit.ratelimit.sourcecriterion.requestheadername=username"

sourceCriterion.requestHost¶

Whether to consider the request host as the source.

labels:
  - "traefik.http.middlewares.test-ratelimit.ratelimit.sourcecriterion.requesthost=true"