pacemaker's Introduction

PaceMaker

Rate limit library

Implemented rate limits:

Fixed Window
Fixed Window (truncated)
Token bucket & Fixed Window variant

Fixed window rate limit

Fixed window limits—such as 3,000 requests per hour or 10 requests per day—are easy to state, but they are subject to have spikes at the edges of the window, as available quota resets. Consider, for example, a limit of 3,000 requests per hour, which still allows for a spike of all 3,000 requests to be made in the first minute of the hour, which might overwhelm the service.

Starts counting time windows when the first request arrives.

Example

Fixed truncated window rate limit

Same as Fixed Window rate limit but truncates the rate limit window to the rate interval configured in order to adjust to real time intervals passing. E.g:

Rate limit interval is configured for new windows every 10 seconds
First request arrives at 2022-02-05 10:23:23
Current rate limit window: from 2022-02-05 10:23:20 to 2022-02-05 10:23:30

Example

Fixed window with token bucket variant (token refill at window's rate)

Works as any other fixed-window rate limiter. However, the meaning of 'capacity' of the inner fixed-window rate limiter changes from the total amount of requests that can be made to the total amount of tokens (points) that can be spent in that same window. This variant is particularly useful, for instance, when working on the crypto game field as many crypto exchanges employ this strategy. Take for example, binance.

Example

You can refer to google architecture docs to read more about rate limits.

Storages

Memory. Useful for non-distributed applications and testing purposes. Do not use on production unless you deliberately don't care about keeping rate limit state.
Redis. github.com/go-redis/redis is employed as Redis client

TODO:

Token bucket rate limit
Leaky bucket rate limit
Composite rate limit
Service rate limit

pacemaker's People

Contributors

Stargazers

Watchers

pacemaker's Issues

FixedTruncatedWindowRateLimiter Check() does not work correctly

	rateLimit := pacemaker.NewTokenFixedWindowRateLimiter(
		pacemaker.NewFixedTruncatedWindowRateLimiter(
			pacemaker.FixedTruncatedWindowArgs{
				Capacity: cfg.Capacity,
				Rate: pacemaker.Rate{
					Unit:   cfg.Rate.Unit,
					Amount: cfg.Rate.Amount,
				},
				Clock: cfg.Clock,
				DB: pacemaker.NewFixedWindowRedisStorage(
					cfg.RedisCli,
					pacemaker.FixedWindowRedisStorageOpts{
						Prefix: cfg.Bucket,
					},
				),
			},
		),
	)

	result, err := rateLimit.Try(context.Background(), 1)
	if err != nil {
		log.Errorf("error try: '%v'", err)
	}

	log.Debugf("Try Result: '%v'", result)

	result, err = rateLimit.Check(context.Background(), 1)
	if err != nil {
		log.Errorf("error try: '%v'", err)
	}

	log.Debugf("Check Result: '%v'", result)

$ go run examples/rate_limits/main.go                                            
2022-11-04T12:48:03Z - DEBUG - {"service":"example"} - connected to redis
2022-11-04T12:48:03Z - DEBUG - {"service":"example"} - Try Result: '{0s 159990}'
2022-11-04T12:48:03Z - DEBUG - {"service":"example"} - Check Result: '{0s 159990}'
$ go run examples/rate_limits/main.go                                            
2022-11-04T12:48:07Z - DEBUG - {"service":"example"} - connected to redis
2022-11-04T12:48:07Z - DEBUG - {"service":"example"} - Try Result: '{0s 159989}'
2022-11-04T12:48:07Z - DEBUG - {"service":"example"} - Check Result: '{0s 159989}'
$ go run examples/rate_limits/main.go                                            
2022-11-04T12:48:24Z - DEBUG - {"service":"example"} - connected to redis
2022-11-04T12:48:24Z - DEBUG - {"service":"example"} - Try Result: '{0s 159988}'
$ go run examples/rate_limits/main.go                                            
2022-11-04T12:48:42Z - DEBUG - {"service":"example"} - connected to redis
2022-11-04T12:48:42Z - DEBUG - {"service":"example"} - Check Result: '{0s 160000}'
$ go run examples/rate_limits/main.go                                            
2022-11-04T12:48:45Z - DEBUG - {"service":"example"} - connected to redis
2022-11-04T12:48:45Z - DEBUG - {"service":"example"} - Check Result: '{0s 160000}'
$ go run examples/rate_limits/main.go                                            
2022-11-04T12:49:03Z - DEBUG - {"service":"example"} - connected to redis
2022-11-04T12:49:03Z - DEBUG - {"service":"example"} - Try Result: '{0s 159987}'
2022-11-04T12:49:03Z - DEBUG - {"service":"example"} - Check Result: '{0s 159987}'

If we run both(try/check) the returned value by Check method is correct.

If we run only the check method, the returned value of Check methods is the capacity of the bucket instead of the remaining value.

sonirico / pacemaker Goto Github PK

pacemaker's Introduction

PaceMaker

Implemented rate limits:

Fixed window rate limit

Fixed truncated window rate limit

Fixed window with token bucket variant (token refill at window's rate)

Storages

TODO:

pacemaker's People

Contributors

Stargazers

Watchers

pacemaker's Issues

FixedTruncatedWindowRateLimiter Check() does not work correctly

FixedWindowRateLimiter

refactor: smoothier builder interface

Recommend Projects

React

Vue.js

Typescript

TensorFlow

Django

Laravel

D3

Recommend Topics

javascript

web

server

Machine learning

Visualization

Game

Recommend Org

Facebook

Microsoft

Google

Alibaba

D3

Tencent