npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

limitd

v5.11.0

Published

Daemon for rate limiting using tocket buckets.

Downloads

1

Readme

Build Status

limitd is a simple daemon for rate limiting highly available applications.

Usage

In order to use limitd you need to setup the server and consume it from the client.

This example assumes that you want to implement rate limiting for an express application.

node.js client

To instantiate the limitd client:

var LimitdClient = require('limitd-client');
var limitd = new LimitdClient('limitd://localhost:9001');

Add a middleware to your express application to reply with 429 Too Many Requests in case the limit is reached:

app.use(function (req, res, next) {
  limitd.take('user', req.username, function (err, resp) {
    if (err) return next(err);

    res.set({
      'X-RateLimit-Limit':     resp.limit,
      'X-RateLimit-Remaining': resp.remaining,
      'X-RateLimit-Reset':     resp.reset
    });

    if (resp.conformant) return next();

    // The 429 status code indicates that the user has sent too many
    // requests in a given amount of time ("rate limiting").
    res.send('429');
  });
})

The client API is documented below.

Server setup

Install on debian with

sudo sh -c 'echo deb http://debs.auth0.com/ stable main > /etc/apt/sources.list.d/auth0.list'
sudo apt-key adv --keyserver keyserver.ubuntu.com --recv F63E3D3A
sudo aptitude update
sudo aptitude install -y limitd

On other systems use node.js and npm:

npm i -g limitd

Configuration with a config file

Create a file named limitd.config for the server settings:

#port to listen on
port: 9001

#db path
db: /var/limitd/database

#define the bucket types
buckets:
  user:
    size: 10
    per_second: 5

Start the server:

limitd --config-file /etc/limitd.config

You can find all configuration options below.

Note: For production you would create a daemon (upstart, systemd, initd, etc.) that runs the aforementioned command.

Configuration with environment variables

#port to listen on
export PORT=9001

#db path
export DB=/var/limitd/database

#define the bucket types
export BUCKET_1_NAME=user
export BUCKET_1_SIZE=10
export BUCKET_1_PER_SECOND=5

export BUCKET_2_NAME=some_other_bucket
export BUCKET_2_SIZE=25
export BUCKET_2_PER_MINUTE=15

Note: Using environment variables for buckets has a limitation. The override config parameter is not supported yet.

Start the server:

limitd

You can find all configuration options below.

Note: For production you would create a daemon (upstart, systemd, initd, etc.) that runs the aforementioned command.

Motivation

While there are many solutions that relies on a central database like redis, these solutions typically put all the configuration, limits and logic on the application side.

Core concepts

The core concepts of limitd are:

  • Token Bucket: is the main algorithm used by limitd.
  • Bucket Type: defines the behavior of a bucket instance. Types are defined in the configuration of the server. Eg: ApiCall 150 per hour.
  • Bucket Instance: is the incarnation of a bucket. Eg: Customer 123 Api Call. Bucket instances are:
    • Created on demand.
    • Destroyed when not used.
  • Request: a request made by a client to take or wait N tokens from the bucket instance X of the bucket type y.
  • Response: is the response from the server to a client request indicating that the operation was successful or not.

Limitd protocol uses Protocol Buffers over tcp. The definition of the protocol are in protocol/messages.

Server operations

  • TAKE: remove one or more tokens from the bucket. The server will reply immediately with conformant true/false depending if there are sufficient tokens.
  • WAIT: remove one or more tokens from the bucket. If there aren't enough tokens in the bucket the server will not reply until there are.
  • PUT: put one or more tokens into the bucket. The max amount of tokens depends on the bucket size. This is useful when the application needs to reset a bucket that's not autofilled by limitd.

Server options

The server configuration file uses YAML.

port

  • Type: Number
  • Description: Specifies the port to use to run the server. If not provided the default is 9231.

db

  • Type: String
  • Description: Specifies the path for the server database. This is a mandatory parameter.

buckets

buckets.{type}

  • Type: Object
  • Description: Specifies the configuration for a bucket type.

buckets.{type}.size

  • Type: Number
  • Description: Specifies the size of the bucket. Defaults to 0.

buckets.{type}.per_{interval}

  • Type: Number
  • Values: per_second, per_minute, per_hour, per_day.
  • Description: Specifies the amount of tokens to add to the bucket per interval.
  • Notes: Only specify one interval.

buckets.{type}.override

buckets.{type}.override.{key}

  • Type: Object
  • Description: Specifies custom configuration for a bucket with the specified key for the particular type.

buckets.{type}.override.{key}.size

  • Type: Number
  • Description: Specifies the size of the bucket. Defaults to 0.

buckets.{type}.override.{key}.per_{interval}

  • Type: Number
  • Values: per_second, per_minute, per_hour, per_day.
  • Description: Specifies the amount of tokens to add to the bucket per interval.
  • Notes: Only specify one interval.

buckets.{type}.override.{key}.match

  • Type: String
  • Description: When {key} contains dynamic values (i.e: IPs) you can filter using a regular expression over the key.
  • Usage: !!js/regexp /pattern/gim where the pattern is a javascript regular expression pattern and gim are the options to be applied.

Client API

LimitdClient(serverUri)

Constructor. Creates an instance of the LimitdClient passing the server's uri.

Parameters

  • serverUri: String - A valid URI with "limitd" schema with the TCP address of the server. If no port is provided the default port is 9231.

LimitdClient(options)

Constructor. Creates an instance of the LimitdClient passing the server's uri.

Parameters

  • options?: Object - An optional object whose properties are the client configuration settings.
    • host?: String - The limitd server host name or IP address. If not provided "localhost" is used.
    • port?: Number - The limitd server port number. If not provided 9231 is used.

client.connect(done)

Connects the client to the server.

Parameters

  • done?: () => any - An optional function to be invoked when a connection is established. It receives no parameters.

client.take(type, key, count, done)

Removes count tokens from the key bucket in of the type token type. If there weren't enough tokens then response.conformant will be false, true otherwise.

Parameters

  • type: String - The bucket type.
  • key: String - The bucket key inside type.
  • count?: Number - An optional amount of tokens to take from the bucket. Defaults to 1 if not provided.
  • done?: (err, response: TakeResponse) - An optional callback. If an error occurs it will be in err. Otherwise, the result will be in response.

client.wait(type, key, count, done)

Removes count tokens from the key bucket in of the type token type. If there were not enough tokens the response is delayed until there are.

Parameters

  • type: String - The bucket type.
  • key: String - The bucket key inside type.
  • count?: Number - An optional amount of tokens to take from the bucket. Defaults to 1 if not provided.
  • done?: (err, response: WaitResponse) - An optional callback. If an error occurs it will be in err. Otherwise, the result will be in response.

client.reset(type, key, done)

Fills the key bucket of the type bucket type.

Parameters

  • type: String - The bucket type.
  • key: String - The bucket key inside type.
  • done?: (err, response: Response) - An optional callback. If an error occurs it will be in err. Otherwise, the result will be in response.

client.put(type, key, count, done)

Put count tokens in the key bucket of the type bucket type.

Parameters

  • type: String - The bucket type.
  • key: String - The bucket key inside type.
  • count?: Number - An optional amount of tokens to put in the bucket. If not provided it is the same as invoking client.reset(type, key, done).
  • done?: (err, response: Response) - An optional callback. If an error occurs it will be in err. Otherwise, the result will be in response.

class: Response

The TakeResponse is a class with the following properties:

  • remaining: Number: The amount of tokens remaining in the bucket after the operation.
  • limit: Number: The maximum amount of tokens available in the token.
  • reset: Number: A UNIX timestamp of the expected time at which the bucket will be full again (full means remaining === limit).

class: TakeResponse extends Response

The TakeResponse is a class with the following properties:

  • conformant: Boolean: true if there were enough tokens in the bucket, false otherwise.

class: WaitResponse extends Response

The WaitResponse is a class with the following properties:

  • delayed: Boolean: true if the request was delayed waiting for enough tokens, false otherwise.

Friends

limitd is a node.js module that works as:

  • limitd server implementation: this repository.
  • limitdctl is a command line utility: https://github.com/limitd/limitdctl
  • node.js client library for limitd: https://github.com/limitd/node-client

Running Tests

To run the tests you need to have redis running on the default port (6379).

git clone --recurse [email protected]:auth0/limitd.git
cd limitd
npm i
npm test

Issue Reporting

If you have found a bug or if you have a feature request, please report them at this repository issues section. Please do not report security vulnerabilities on the public GitHub issue tracker. The Responsible Disclosure Program details the procedure for disclosing security issues.

Author

Auth0

License

This project is licensed under the MIT license. See the LICENSE file for more info.