Skip to content

Latest commit

 

History

History
97 lines (68 loc) · 2.34 KB

README.md

File metadata and controls

97 lines (68 loc) · 2.34 KB
Raw

Rate - A rate limiting service

Build Status

Rate is a simple rate limiting service which can be deployed infront of a downstream service. It is intended to impose a per minute limit on the number of requests started for each distinct resource.

see design documents for more complete design thoughts

Usage

rate [flags] <proxied_url>

Usage of rate:
  -etcd-addresses string
    	addresses for etcd cluster (if left blank an in-memory semaphore is used instead)
  -log-level string
    	logging level (default "debug")
  -port string
    	port on which to service rate limiter (default "4040")
  -rpm int
    	requests per minute (default 100)
Metrics

Hitting this endpoint will give a current snapshot of system metrics.

curl http://limiter:4040/debug/vars

Development

Dependencies

  • Go 1.11+
  • cmake
  • Docker
  • docker-compose
  • etcd

see output of make for a list of commands

Build

see out of make:

install                  › Install rate into Go global bin folder
build                    › Build rate into local bin/ directory
test                     › Test all the things
integration-test         › Run integration tests (requires access to etcd)
docker-integration-test  › Run integration tests using docker to bootstrap and run etcd
deps                     › Fetch and vendor dependencies
lint                     › Lint project
todos                    › Print out any TODO comments
ready-to-submit          › Prints a message when the project is ready to be submitted
docker                   › Builds rate into a docker container
compose-up               › Brings up a demonstration of the rate limiter in docker (requires docker + compose)

Test

Unit Tests
make test

// optionally

GO_FLAGS=-cover make test
Integration Test

with docker:

make docker-integration-test

without docker: run etcd locally at localhost:2379 (or reconfigure with the ETCD_ADDRESSES env var) and then

make integration-test

Docker + Playground

make compose-up # brings up a mini demo

make attack # uses vegeta to hit the demo with requests over time and plots results