envoyproxy/envoy

Envoy to pass hits_addend to RateLimitService

Open

#12,969 opened on Sep 3, 2020

View on GitHubContributor guide
 (27 comments) (3 reactions) (0 assignees)C++ (5,373 forks)batch import
area/ratelimithelp wanted

Repository metrics

Stars
 (27,997 stars)
PR merge metrics
 (PR metrics pending)

Description

Description

The RLS v3 api describes the RateLimitService as able to injest a hits_addend field to determine number of tokens to use for the rate limiting request. Envoy should provide a method for extracting a value from a request header (or some other method) to populate this method on a per request basis. If hits_addend is only static, then it is effectively the same as modifying the ratelimit.

Use case

In the HTTP Rate Limit Filter allow for a configuration of a request header containing an integer hits_addend value to send with the rate limit request, allowing for greater configurability of rate limiting capabilities.

Contributor guide

Research direction
Examine the HTTP rate limit filter configuration and the RateLimitService proto. Implement an optional config field to specify a request header that provides hits addend. Follow the pattern of other header extractors in Envoy.
Tech stack
cpp
Domain
backendnetworking
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitC++
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40