envoyproxy/envoy

Fix inconsistency in rate limit filter names

Open

#8,799 opened on Oct 29, 2019

View on GitHub
 (6 comments) (0 reactions) (1 assignee)C++ (5,373 forks)batch import
area/ratelimitbeginnerhelp wantedtech debt

Repository metrics

Stars
 (27,997 stars)
PR merge metrics
 (Avg merge 8d) (378 merged PRs in 30d)

Description

Minor cleanup related to PR #8796, for HTTP filters we have envoy.rate_limit but for networking filters we have envoy.ratelimit. We should update the network filter to match HTTP/Thrift. In order to avoid naming collisions, the network filter should be updated to the new style of envoy.filters.network.rate_limit. This would involve

  1. Register a second definition of the rate limit filter's config factory with the new name.
  2. Deprecation period for the old config factory
  3. Removal of the old config factory

(while here, we could extend this to updating all the networking filter names to the new format, this one just stood out as a potential nuisance)

Contributor guide

Research direction
Inspect the existing rate limit filter configurations for HTTP and network filters in the source files, then follow the outlined steps: register a second definition with the new name, deprecate the old config factory, and after the deprecation period, remove it. Also consider extending this to update all networking filter names to the new format.
Tech stack
cpp
Domain
networking
Issue type
Refactor
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.
1-3 hours
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.
70