Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

A0-4318: rate-limiter for all #1857

Merged
merged 49 commits into from
Nov 27, 2024
Merged

Conversation

fixxxedpoint
Copy link
Contributor

Description

Implementation of a shared-bandwidth rate-limiter for both substrate-based and alephbft networks.
In a next PR I will introduce a new e2e-test that should help to verify these changes.

Type of change

  • New feature (non-breaking change which adds functionality)

Checklist:

  • I have added tests
  • I have made corresponding changes to the existing documentation
  • I have created new documentation

- parametrized by TimeProvider instead of taking `now: Instant` as argument for `rate_limit`
- simplified rate_limit method
- re-aligned tests of TokenBucket
- TokenBucket can be set to rate_per_second = 0 - no data will be read
- seperate RateLimiter implementations for [`tokio::io::AsyncRead`] and [`futures::AsyncRead`]
- using [`std::sync::Mutex`] for TokenBucket in RateLimiter - it should allow for `global` rate-limit, not just per connection
… substrate's [`sc_client::network::NetworkWorker`]
- s/alephbft_bit_rate/alephbft_network_bit_rate
… [`finality-aleph/src/network/build/transport.rs`]
…port.rs`]

- removed references to [`libp2p`] from [`finality-aleph/src/network/build/mod.rs`]
…d of `requeste` and `available`. It should be also easier now to transform it into wait-free version.
… - so far only tested locally using 7 instances of aleph-node.
- added ShareTokenBucket, AsyncTokenBucket and ShredBandwidthManager - used for sharing bandwidth between multiple connections
…and Socket-based networks (sync + alephbft)

- new default values for rate-limiters (sync + alephbft). 768Kib for alephbft and 5Mib for sync. These values were tested using t3a.xlarge aws instances - nodes were not able to handle more.
…docker/docker_entrypoint.sh to allow configuration of rate-limiting for both sync and alephbft networks
… types in its hierarchy). It is more readable this way - previous version was using `Clone`, which could be confusing regarding if bandwidth was shared or each node uses separate rate.
@fixxxedpoint fixxxedpoint force-pushed the A0-4318_rate_limited_substrate_network branch from d12abfd to 1fbf91b Compare November 14, 2024 23:19
Copy link
Contributor

@timorleph timorleph left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cool stuff, only one readability comment in the end.

finality-aleph/src/network/build/transport.rs Show resolved Hide resolved
Copy link
Contributor

@lesniak43 lesniak43 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice job! But please, make this PR fit the limit of 300 lines.

Copy link
Contributor

@Marcin-Radecki Marcin-Radecki left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This was really a splendid chunk of work. Please make sure we add an e2e for this as well.

rate-limiter/src/token_bucket.rs Outdated Show resolved Hide resolved
bin/node/src/aleph_cli.rs Show resolved Hide resolved
@fixxxedpoint fixxxedpoint added this pull request to the merge queue Nov 27, 2024
Merged via the queue into main with commit 79d7908 Nov 27, 2024
17 checks passed
@fixxxedpoint fixxxedpoint deleted the A0-4318_rate_limited_substrate_network branch November 27, 2024 10:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants