network filters: add tcp bandwidth limit by AntonKanug · Pull Request #42996 · envoyproxy/envoy

AntonKanug · 2026-01-13T22:20:21Z

Commit Message: network filters: add tcp bandwidth limit
Additional Description:
Risk Level:
Testing:
Docs Changes:
Release Notes:
Platform Specific Features:

repokitteh-read-only · 2026-01-13T22:20:27Z

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: #42996 was opened by AntonKanug.

see: more, trace.

repokitteh-read-only · 2026-01-13T22:20:32Z

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

🐱

Caused by: #42996 was opened by AntonKanug.

see: more, trace.

AntonKanug · 2026-01-14T10:53:32Z

/coverage

repokitteh-read-only · 2026-01-14T10:53:37Z

Coverage for this Pull Request will be rendered here:

https://storage.googleapis.com/envoy-cncf-pr/42996/coverage/index.html

For comparison, current coverage on main branch is here:

https://storage.googleapis.com/envoy-cncf-postsubmit/main/coverage/index.html

The coverage results are (re-)rendered each time the CI Envoy/Checks (coverage) job completes.

🐱

Caused by: a #42996 (comment) was created by @AntonKanug.

see: more, trace.

tyxia · 2026-01-18T17:55:57Z

CODEOWNERS

 /*/extensions/retry/priority/previous_priorities @ravenblackx @mattklein123
 /*/extensions/retry/host @ravenblackx @mattklein123
 /*/extensions/filters/network/http_connection_manager @yanavlasov @mattklein123
+/*/extensions/filters/network/tcp_bandwidth_limit @UNOWNED @UNOWNED


@AntonKanug Thanks for your contribution!

We will need owner here as well as maintainer sponsorship.

cc HTTP bandwith_limit owners @nitgoy @mattklein123 @yanavlasov @tonya11en for inputs

@AntonKanug Did you consider using Dynamic Modules for this use-case instead?

cc @wbpcode as well. I think these use-cases could be easily built on top of Dynamic Modules now and we should have a discussion to come up with a policy on new CPP extensions as they do add some maintenance burden on the maintainers.

cc @ggreenway (who may be interested to sponsor this extension)

I can sponsor this filter.

@AntonKanug please add @yanavlasov and @nezdolik and yourself as code owners. But next time before starting to write the code for new extension you should first find sponsors (among maintainers). Envoy extension policy: https://github.com/envoyproxy/envoy/blob/main/EXTENSION_POLICY.md

KBaichoo · 2026-02-06T16:31:27Z

/wait-any

This seems to be pending either finding a maintainer to sponsor or authoring this as a dynamic module.

nezdolik · 2026-02-16T09:08:55Z

docs/root/configuration/listeners/network_filters/tcp_bandwidth_limit_filter.rst

+
+The filter supports the following configuration options:
+
+* **download_limit_kbps**: The limit for download bandwidth in KiB/s (kibibytes per second).


this section is repetitive with what we already have in api proto file (api/envoy/extensions/filters/network/tcp_bandwidth_limit/v3/tcp_bandwidth_limit.proto). Could you move the missing information there?

nezdolik · 2026-02-16T09:49:18Z

source/extensions/filters/network/tcp_bandwidth_limit/tcp_bandwidth_limit.cc

+    : runtime_(runtime), time_source_(time_source),
+      has_download_limit_(config.has_download_limit_kbps()),
+      has_upload_limit_(config.has_upload_limit_kbps()),
+      download_limit_kbps_(PROTOBUF_GET_WRAPPED_OR_DEFAULT(config, download_limit_kbps, 0)),


you could get rid of 2 boolean fields has_download_limit_, has_upload_limit_ and instead initialize relevant fields like this:

download_token_bucket_(config.has_download_limit_kbps() ? std::make_shared<SharedTokenBucketImpl>( limit_bytes_per_sec, time_source_, static_cast<double>(kiloBytesToBytes(download_limit_kbps_))) : nullptr)

nezdolik · 2026-02-16T10:10:40Z

source/extensions/filters/network/tcp_bandwidth_limit/tcp_bandwidth_limit.h

+  Buffer::OwnedImpl upload_buffer_;
+
+  // Timers for processing buffered data
+  Event::TimerPtr download_timer_;


in filter destructor you will need to disable the timers like so (to avoid any race conditions when filter is being destroyed and timer gets invoked on half destroyed object):

if (download_timer_) { download_timer_->disableTimer(); download_timer_.reset(); }

nezdolik · 2026-02-16T10:12:13Z

source/extensions/filters/network/tcp_bandwidth_limit/tcp_bandwidth_limit.h

+  Network::WriteFilterCallbacks* write_callbacks_{};
+
+  // Buffered data waiting for tokens
+  Buffer::OwnedImpl download_buffer_;


i think we want to use watermark buffer (Buffer::WatermarkBuffer) here?

markdroth · 2026-02-18T20:44:38Z

/lgtm api

yanavlasov

Looks good. Would you be able to also add an integration test, that tests this filter in a complete Envoy setup, please? It does not need to be complicated, maybe just two tests for upload and download.

/wait-any

AntonKanug · 2026-02-19T16:10:28Z

@yanavlasov @nezdolik ready for review, addressed the comments and added integrations tests.

precheck is failing but its failing with same error on main as well, tests are passing locally (edit: rebased with the fix)

Signed-off-by: Anton Kanugalawattage <antondilon@gmail.com>

repokitteh-read-only bot added the api label Jan 13, 2026

repokitteh-read-only bot assigned markdroth Jan 13, 2026

AntonKanug force-pushed the antonk/tcp-bandwidth branch 6 times, most recently from 185fc45 to 10215ba Compare January 14, 2026 00:22

AntonKanug force-pushed the antonk/tcp-bandwidth branch 8 times, most recently from 9527d53 to 8b858b4 Compare January 14, 2026 22:52

AntonKanug marked this pull request as ready for review January 15, 2026 00:10

AntonKanug force-pushed the antonk/tcp-bandwidth branch 2 times, most recently from 15062e0 to 449992c Compare January 15, 2026 11:01

tyxia reviewed Jan 18, 2026

View reviewed changes

mattklein123 assigned tyxia Jan 20, 2026

repokitteh-read-only bot added waiting:any and removed waiting:any labels Feb 6, 2026

yanavlasov self-assigned this Feb 10, 2026

nezdolik self-assigned this Feb 16, 2026

nezdolik unassigned tyxia Feb 16, 2026

nezdolik reviewed Feb 16, 2026

View reviewed changes

repokitteh-read-only bot removed the api label Feb 18, 2026

yanavlasov reviewed Feb 18, 2026

View reviewed changes

repokitteh-read-only bot added waiting:any api and removed waiting:any labels Feb 18, 2026

AntonKanug force-pushed the antonk/tcp-bandwidth branch from f6007e1 to ed3650e Compare February 19, 2026 15:46

AntonKanug requested review from nezdolik and yanavlasov February 19, 2026 16:10

AntonKanug added 4 commits February 19, 2026 13:41

network filters: add tcp bandwidth limit

d188f52

Signed-off-by: Anton Kanugalawattage <antondilon@gmail.com>

comments

1fbb8ad

Signed-off-by: Anton Kanugalawattage <antondilon@gmail.com>

integration_tests

0c5371d

Signed-off-by: Anton Kanugalawattage <antondilon@gmail.com>

fix

31e3337

Signed-off-by: Anton Kanugalawattage <antondilon@gmail.com>

AntonKanug force-pushed the antonk/tcp-bandwidth branch from ed3650e to 31e3337 Compare February 19, 2026 18:41


		The filter supports the following configuration options:

		* download_limit_kbps: The limit for download bandwidth in KiB/s (kibibytes per second).

Conversation

AntonKanug commented Jan 13, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

repokitteh-read-only bot commented Jan 13, 2026

Uh oh!

repokitteh-read-only bot commented Jan 13, 2026

Uh oh!

AntonKanug commented Jan 14, 2026

Uh oh!

repokitteh-read-only bot commented Jan 14, 2026

Uh oh!

tyxia Jan 18, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

agrawroh Jan 22, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

nezdolik Jan 30, 2026

Choose a reason for hiding this comment

Uh oh!

yanavlasov Feb 10, 2026

Choose a reason for hiding this comment

Uh oh!

nezdolik Feb 16, 2026

Choose a reason for hiding this comment

Uh oh!

KBaichoo commented Feb 6, 2026

Uh oh!

nezdolik Feb 16, 2026

Choose a reason for hiding this comment

Uh oh!

nezdolik Feb 16, 2026

Choose a reason for hiding this comment

Uh oh!

nezdolik Feb 16, 2026

Choose a reason for hiding this comment

Uh oh!

nezdolik Feb 16, 2026

Choose a reason for hiding this comment

Uh oh!

markdroth commented Feb 18, 2026

Uh oh!

yanavlasov left a comment

Choose a reason for hiding this comment

Uh oh!

AntonKanug commented Feb 19, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

Comments

AntonKanug commented Jan 13, 2026 •

edited

Loading

tyxia Jan 18, 2026 •

edited

Loading

agrawroh Jan 22, 2026 •

edited

Loading

AntonKanug commented Feb 19, 2026 •

edited

Loading