rate_limit_quota: Quota based rate limiting, part 1 by tyxia · Pull Request #22135 · envoyproxy/envoy

tyxia · 2022-07-12T15:14:49Z

First part of quota-based rate limiting feature. The majority of this PR is to lay out the basic framework and shape of major components with unit test coverage, other functionalities (e.g., periodically usage report, thread local cache, quota assignment, etc) will be added in next PRs. This PR includes:

Rate limit quota filter basic framework:
Filter factory, filter creation and registration, filter configuration, etc.
Bidirectional gRPC basic framework :
gRPC stream start and close, message send and receive, callback for the client and filter interaction, etc
Request matching:
1. matcher tree creation
2. perform request matching with request header and exact value_match field from the config
3. on_no_match support (empty bucketId with noassignmentBehavior for now for illustration purpose, will be
  modified in the next PRs)
BucketId generation:
Generates the BucketId via either static method (string_value) or dynamic method (custom_value with
typed_config).
Quota assignment caching:
UseBucketId as the key with customized hash/equal function. Will change to thread local storage
Unit tests for the config, filter and grpc client,
Doc changes has been completed and merged in PR rate_limit_quota: [Doc] add the docs for rate limit quota feature #22539.

Note to reviewers:
In sprit of small PRs and making review easier, I plan to divide the whole implementation into several parts. Hence, I

Removed some refer link in the proto for the ease of a boilerplate doc generation (this feature is WIP). Also, I have left
some TODOs that will be addressed in next PRs
Temporarily reduced the code coverage requirement for this extension as this is first part of the several PR. Currently, it is ~75% coverage.

Signed-off-by: Tianyu Xia tyxia@google.com

repokitteh-read-only · 2022-07-12T15:14:54Z

As a reminder, PRs marked as draft will not be automatically assigned reviewers,
or be handled by maintainer-oncall triage.

Please mark your PR as ready when you want it to be reviewed!

🐱

Caused by: #22135 was opened by tyxia.

see: more, trace.

repokitteh-read-only · 2022-07-12T15:15:00Z

CC @envoyproxy/api-shepherds: Your approval is needed for changes made to (api/envoy/|docs/root/api-docs/).
envoyproxy/api-shepherds assignee is @mattklein123
CC @envoyproxy/api-watchers: FYI only for changes made to (api/envoy/|docs/root/api-docs/).

🐱

Caused by: #22135 was opened by tyxia.

see: more, trace.

tyxia · 2022-07-12T15:18:55Z

/unassign @mattklein123

Initial commit that just adds back the docs as part of the implementation. Not ready for review yet.

envoyproxy#22116) Revert "build(deps): bump orjson from 3.6.7 to 3.7.7 in /tools/base (envoyproxy#22112)" This reverts commit 2f8b986. Signed-off-by: Ryan Northey <ryan@synca.io> Signed-off-by: Tianyu Xia <tyxia@google.com>

This reverts commit 3af90c1. Signed-off-by: Tianyu Xia <tyxia@google.com>

Signed-off-by: Tianyu Xia <tyxia@google.com>

repokitteh-read-only · 2022-07-12T16:42:32Z

CC @envoyproxy/dependency-shepherds: Your approval is needed for changes made to (bazel/.*repos.*\.bzl)|(bazel/dependency_imports\.bzl)|(api/bazel/.*\.bzl)|(.*/requirements\.txt)|(.*\.patch).
envoyproxy/dependency-shepherds assignee is @mattklein123

🐱

Caused by: #22135 was synchronize by tyxia.

see: more, trace.

Signed-off-by: Tianyu Xia <tyxia@google.com>

tyxia · 2022-07-12T16:45:44Z

/unassign @mattklein123

Initial commit that just adds back the docs as part of the implementation. Not ready for review yet.

Signed-off-by: Tianyu Xia <tyxia@google.com>

tyxia

Thanks for the review!

Signed-off-by: Tianyu Xia <tyxia@google.com>

tyxia · 2022-11-07T22:41:13Z

@yanavlasov PTAL. Thanks!

I have addressed the review comments. The CI doc failure in this PR will be resolved once PR #22539 is merged (That PR is also under review now).

Signed-off-by: tyxia <tyxia@google.com>

tyxia · 2022-11-22T17:04:10Z

/retest

repokitteh-read-only · 2022-11-22T17:04:17Z

Retrying Azure Pipelines:
Check envoy-presubmit didn't fail.

🐱

Caused by: a #22135 (comment) was created by @tyxia.

see: more, trace.

Signed-off-by: tyxia <tyxia@google.com>

tyxia · 2022-11-30T12:47:08Z

/retest

The CI failure should has nothing to do with this PR

repokitteh-read-only · 2022-11-30T12:47:18Z

Retrying Azure Pipelines:
Retried failed jobs in: envoy-presubmit

🐱

Caused by: a #22135 (comment) was created by @tyxia.

see: more, trace.

phlax · 2022-11-30T12:56:21Z

@tyxia i think the tsan problem has been fixed on main here #24252

the other problem is coverage, which is saying:

Code coverage 96.0 is lower than limit of 96.1

is it possible this fail is genuine ?

Signed-off-by: tyxia <tyxia@google.com>

tyxia · 2022-11-30T13:06:20Z

@tyxia i think the tsan problem has been fixed on main here #24252

the other problem is coverage, which is saying:
Code coverage 96.0 is lower than limit of 96.1
is it possible this fail is genuine ?

Thanks for information, @phlax. There was an accidental change to coverage file in my last merge. I just reverted it. Let see if CD/CI is happy this time.

Signed-off-by: tyxia <tyxia@google.com>

…xy#22135)" This reverts commit 9f1283f.

repokitteh-read-only Bot added the api label Jul 12, 2022

repokitteh-read-only Bot assigned mattklein123 Jul 12, 2022

tyxia force-pushed the rls_init branch from facc32d to bd62955 Compare July 12, 2022 15:17

repokitteh-read-only Bot unassigned mattklein123 Jul 12, 2022

tyxia force-pushed the rls_init branch from bd62955 to 86f354a Compare July 12, 2022 16:40

phlax and others added 3 commits July 12, 2022 16:40

Revert "RLQS: hide unimplemented documentation (envoyproxy#21966)"

9e11f3d

This reverts commit 3af90c1. Signed-off-by: Tianyu Xia <tyxia@google.com>

Add placeholder

e3251b5

Signed-off-by: Tianyu Xia <tyxia@google.com>

tyxia force-pushed the rls_init branch from 86f354a to e3251b5 Compare July 12, 2022 16:42

repokitteh-read-only Bot added the deps Approval required for changes to Envoy's external dependencies label Jul 12, 2022

repokitteh-read-only Bot assigned mattklein123 Jul 12, 2022

tyxia added 2 commits July 12, 2022 16:43

Merge branch 'main' of https://github.com/envoyproxy/envoy into rls_init

ecfdb9a

Signed-off-by: Tianyu Xia <tyxia@google.com>

add new line

bb0df1c

Signed-off-by: Tianyu Xia <tyxia@google.com>

repokitteh-read-only Bot unassigned mattklein123 Jul 12, 2022

tyxia changed the title ~~Initial implementation of rate limiting quota filter~~ [WIP, Not ready for review] Initial implementation of rate limiting quota filter Jul 20, 2022

tyxia changed the title ~~[WIP, Not ready for review] Initial implementation of rate limiting quota filter~~ [WIP] Initial implementation of rate limiting quota filter Jul 25, 2022

tyxia added 9 commits August 3, 2022 15:28

Initial implementation

2b36f05

Signed-off-by: Tianyu Xia <tyxia@google.com>

draft impl, grpc

ec773da

Signed-off-by: Tianyu Xia <tyxia@google.com>

undo the accidental change

047b893

Signed-off-by: Tianyu Xia <tyxia@google.com>

revert doc changes that is handled in a different PR

78c6853

Signed-off-by: Tianyu Xia <tyxia@google.com>

draft

d37bd7c

Signed-off-by: Tianyu Xia <tyxia@google.com>

Bucket ID builds and matcher resolve works

59d6632

Signed-off-by: Tianyu Xia <tyxia@google.com>

Request matching and macthing action (build bucker ID) works

07af49b

Signed-off-by: Tianyu Xia <tyxia@google.com>

code clean-up

5d2dc0d

Signed-off-by: Tianyu Xia <tyxia@google.com>

code clean-up

990b731

Signed-off-by: Tianyu Xia <tyxia@google.com>

yanavlasov reviewed Oct 28, 2022

View reviewed changes

Comment thread api/envoy/extensions/filters/http/rate_limit_quota/v3/rate_limit_quota.proto Outdated

tyxia commented Nov 3, 2022

View reviewed changes

revert the API proto changes

a873008

Signed-off-by: Tianyu Xia <tyxia@google.com>

repokitteh-read-only Bot removed the waiting label Nov 7, 2022

tyxia added 2 commits November 7, 2022 21:43

local1

4175290

Signed-off-by: Tianyu Xia <tyxia@google.com>

update per review

6b8473f

Signed-off-by: Tianyu Xia <tyxia@google.com>

tyxia mentioned this pull request Nov 18, 2022

rate_limit_quota: [API] Support Envoy node info in RateLimitQuotaUsageReports #24014

Closed

tyxia added 2 commits November 22, 2022 16:34

Merge branch 'main' of https://github.com/envoyproxy/envoy into rls_init

4540110

Signed-off-by: tyxia <tyxia@google.com>

remove the blank line in rst file

8fa06dd

Signed-off-by: tyxia <tyxia@google.com>

tyxia added 2 commits November 29, 2022 19:58

Merge branch 'main' of https://github.com/envoyproxy/envoy into rls_init

163348b

Signed-off-by: tyxia <tyxia@google.com>

Merge branch 'rls_init' of github.com:tyxia/envoy into rls_init

b5987f4

Signed-off-by: tyxia <tyxia@google.com>

tyxia added 2 commits November 30, 2022 13:01

Merge branch 'main' of https://github.com/envoyproxy/envoy into rls_init

4bd90f3

Signed-off-by: tyxia <tyxia@google.com>

revert accidental change during last merge

7547273

Signed-off-by: tyxia <tyxia@google.com>

tyxia added 2 commits November 30, 2022 16:28

Add test coverage

c8bbd1a

Signed-off-by: tyxia <tyxia@google.com>

fix format

d8841d6

Signed-off-by: tyxia <tyxia@google.com>

yanavlasov approved these changes Dec 1, 2022

View reviewed changes

yanavlasov merged commit 9f1283f into envoyproxy:main Dec 1, 2022

alyssawilk reviewed Dec 5, 2022

View reviewed changes

Comment thread test/per_file_coverage.sh

alyssawilk added a commit to alyssawilk/envoy that referenced this pull request Dec 5, 2022

Revert "rate_limit_quota: Quota based rate limiting, part 1 (envoypro…

dc16e8b

…xy#22135)" This reverts commit 9f1283f.

alyssawilk added a commit to alyssawilk/envoy that referenced this pull request Dec 5, 2022

Revert "rate_limit_quota: Quota based rate limiting, part 1 (envoypro…

0365a92

…xy#22135)" This reverts commit 9f1283f.

tyxia deleted the rls_init branch December 26, 2024 04:27

Conversation

tyxia commented Jul 12, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

repokitteh-read-only Bot commented Jul 12, 2022

Uh oh!

repokitteh-read-only Bot commented Jul 12, 2022

Uh oh!

tyxia commented Jul 12, 2022

Uh oh!

repokitteh-read-only Bot commented Jul 12, 2022

Uh oh!

tyxia commented Jul 12, 2022

Uh oh!

Uh oh!

tyxia left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

tyxia commented Nov 7, 2022

Uh oh!

tyxia commented Nov 22, 2022

Uh oh!

repokitteh-read-only Bot commented Nov 22, 2022

Uh oh!

tyxia commented Nov 30, 2022

Uh oh!

repokitteh-read-only Bot commented Nov 30, 2022

Uh oh!

phlax commented Nov 30, 2022

Uh oh!

tyxia commented Nov 30, 2022

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

tyxia commented Jul 12, 2022 •

edited

Loading