That Limit

Rust-based distributed rate limit service.

Getting started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

• 🦀 Rust installed on your machine.
• 🐳 Docker to run dependant services.
• ⚙️ just to run the project with just commands.
• ⎈ Minikube to run in a test cluster

Build

# Clone the repository
git clone [email protected]:angelwing-io/that-limit.git
cd that-limit       # Navigate to the project directory
cargo build         # Build the project

Running and testing

Service provides two features: envoy and http. Each respective feature will serve either http or grpc (envoy compatible) backend. At least one feature should be enabled. If no features are specified, service will default to http.

cargo run \
    -p that-limit-server \
    --features http         # Run the project
cargo watch -x run          # Run the project with hot-reload
                            # (req: `cargo install cargo-watch`)
cargo test                  # Run the tests

just clippy                 # Run pedantic linter
just cov                    # Run tests with coverage

Optionally you can run the project with cargo run -p that-limit-server --release to enable optimizations.
To run the project in debug mode, you can use RUST_LOG=debug cargo run -p that-limit-server.
Or you could just use an IDE like RustRover or Zed 🚀.

With Docker

cd that-limit
docker build --build-arg provider=http -t that-limit:dev .
docker run -d -p 8000:8000 that-limit:dev

With just

Run just to see all available recipes:

Available recipes:
    clippy                   # Run pedantic linter
    cov                      # Run tests with coverage
    dev feature="http"       # Run app server with hot reload
    docker provider="http"   # Start in docker
    minikube provider="http" # Start in minikube cluster

Additionally you can run minikube dashboard to check cluster in web console.

Configuration

Application will not start without the required environment configuration.
Optional variables have default values, but it is highly recommended to override these once you have a working setup.

• Required environment variables:

N/A

• Optional environment variables:

RUST_LOG=info

CFG_PATH=static/config.json
HTTP_PORT=8000
ENVOY_PORT=55051

REDIS_HOST=127.0.0.1
REDIS_PORT=6379

HTTP Adapter stress test (v0.1.0)

Apple M1 Pro 10 cores (8p + 2e) - 32GB LPDDR5

wrk

$ wrk -t4 -c150 -d30s -s ./tests/performance/protected.lua http://127.0.0.1:8000/consume

Running 30s test @ http://127.0.0.1:8000/consume
  4 threads and 150 connections
  Thread Stats   Avg      Stdev     Max   +/- Stdev
    Latency   839.02us  143.68us   8.80ms   87.40%
    Req/Sec    41.22k     1.00k   43.17k    91.42%
  4922963 requests in 30.01s, 437.30MB read
Requests/sec: 164065.28
Transfer/sec:     14.57MB

k6

k6 run tests/performance/protected.js

100 Virtual users:

█ THRESHOLDS

http_req_duration
✓ 'p(99)<10' p(99)=2.8ms

http_req_failed
✓ 'rate<0.01' rate=0.00%

█ TOTAL RESULTS

checks_total.......: 13273019 110608.300867/s
checks_succeeded...: 100.00%  13273019 out of 13273019
checks_failed......: 0.00%    0 out of 13273019

✓ is status 200 or 429

HTTP
http_req_duration..............: avg=586.33µs min=21µs   med=416µs    max=46.62ms p(90)=1.24ms p(95)=1.64ms
{ expected_response:true }...: avg=586.33µs min=21µs   med=416µs    max=46.62ms p(90)=1.24ms p(95)=1.64ms
http_req_failed................: 0.00%    0 out of 13273019
http_reqs......................: 13273019 110608.300867/s

EXECUTION
iteration_duration.............: avg=654.79µs min=37.5µs med=472.25µs max=46.78ms p(90)=1.35ms p(95)=1.79ms
iterations.....................: 13273019 110608.300867/s
vus............................: 1        min=1             max=100
vus_max........................: 100      min=100           max=100

NETWORK
data_received..................: 1.2 GB   10 MB/s
data_sent......................: 1.5 GB   12 MB/s

500 Virtual users:

█ THRESHOLDS

  http_req_duration
  ✓ 'p(99)<10' p(99)=7.68ms

  http_req_failed
  ✓ 'rate<0.01' rate=0.00%

█ TOTAL RESULTS

  checks_total.......: 12201053 101675.096819/s
  checks_succeeded...: 100.00%  12201053 out of 12201053
  checks_failed......: 0.00%    0 out of 12201053

  ✓ is status 200 or 429

  HTTP
  http_req_duration..............: avg=2.01ms min=21µs    med=1.69ms max=103.73ms p(90)=4.08ms p(95)=4.9ms
    { expected_response:true }...: avg=2.01ms min=21µs    med=1.69ms max=103.73ms p(90)=4.08ms p(95)=4.9ms
  http_req_failed................: 0.00%    0 out of 12201053
  http_reqs......................: 12201053 101675.096819/s

  EXECUTION
  iteration_duration.............: avg=2.97ms min=38.95µs med=2.71ms max=119.23ms p(90)=5.39ms p(95)=6.76ms
  iterations.....................: 12201053 101675.096819/s
  vus............................: 1        min=1             max=500
  vus_max........................: 500      min=500           max=500

  NETWORK
  data_received..................: 1.1 GB   9.5 MB/s
  data_sent......................: 1.4 GB   11 MB/s