cdscih/stairable

A tool to test whether or not an endpoint is able to work with the load it's supposed to handle.

stairable

A simple tool, based on autocannon, which tests whether or not the target scalability of an endpoint is reached based on the variability of:

• requests per second
• simultaneous connections
• variability of input size/quantity

Example output:

{
  url: 'localhost:3000',
  meetsRequirements: true,
  best: {
    connections: 1000,
    rps: 214092,
    avgMs: 47.82,
    stddev: 30.1,
    non2xx: 0
  }
}

Definition of a Scalable Endpoint

A Scalable Endpoint is an endpoint that, given a certain target of parameters, is able to handle all the expected traffic, respecting those parameters, in more than 99% of cases.

Instructions

Import the Stairable class and set it up like in the following snippet.

import { Stairable } from './../lib'

new Stairable().launch({
  url: 'localhost:3000',
  requirements: { maxResTime: 100, minRPS: 50000 }
}).then(console.log).catch(console.error)

Then run your server followed by the node file where you setup the class.

Dynamic Body creation

import { Stairable } from './../lib'

const createBody = (n: number): string => {
  const items = []
  for (let i = 0; i < n; i++) {
    items.push(i)
  }
  return JSON.stringify({ items })
}

new Stairable().launch({
  url: 'localhost:3000',
  requirements: { maxResTime: 100, minRPS: 50000 },
  body: { create: createBody, maxNs: 1000 }
}).then(console.log).catch(console.error)

Quick default test

For a quick test just run the script start-sample-server, which will run a sample node server on localhost:3000, and then the start-sample-test one to launch a Stairable test on that endpoint.