Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mcollina/autocannon-ci
run your benchmarks as part of your dev flow, for Node.js
https://github.com/mcollina/autocannon-ci
Last synced: 12 days ago
JSON representation
run your benchmarks as part of your dev flow, for Node.js
- Host: GitHub
- URL: https://github.com/mcollina/autocannon-ci
- Owner: mcollina
- License: mit
- Created: 2017-01-22T21:54:07.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2017-02-17T14:27:18.000Z (almost 8 years ago)
- Last Synced: 2024-12-25T09:46:55.440Z (15 days ago)
- Language: JavaScript
- Size: 29.3 KB
- Stars: 46
- Watchers: 7
- Forks: 7
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# autocannon-ci
**autocannon-ci** can store the results and generate the
[flamegraphs][0x] of your HTTP/1.1 benchmarks of Node.js server.
Run your [autocannon][] benchmarks as
part of your CI/dev flow, for Node.js.
It can also generate a little website containing all the result of your
benchmarking, including [flamegraphs with 0x][0x]:
* [Dashboard](https://s3-us-west-2.amazonaws.com/autocannon-ci-test/index.html)
* [Job page](https://s3-us-west-2.amazonaws.com/autocannon-ci-test/run-2/index.html)
## Install
```sh
npm i autocannon-ci -g
```
## Usage
```sh
autocannon-ci -c autocannon.yml
```
## Configuration Example
```yaml
server: ./server.js
benchmarks:
root:
connections: 100
duration: 5
url: localhost:3000
b:
connections: 100
duration: 5
url: localhost:3000/b
storage:
type: fs
path: perf-results
```
## Available commands and full options
autocannon-ci is a tool to run multiple HTTP/1.1 benchmarks, and generate the relative
flamegraphs, with the help of 0x.
Available commands:
* run (default)
* compare
* help
### Run
```
Usage: autocannon-ci run [OPTS]
Runs the benchmarks configured in the autocannon-ci configuration file, and
save them according to the storage configured in the config file. The job id
is used to identify the single run.
Options:
--config/-c CONFIG Use the given config file; default: `autocannon.yml`.
--job/-j ID Use the specific job id.
--flamegrah/-F Generate and store flamegraphs.
```
### Compare
```
Usage: autocannon-ci compare [OPTS] [A] [B]
Compare the job with id A against the job id B. A and B are defaulted to the
latest two jobs.
Options:
--config/-c CONFIG Use the given config file; default: `autocannon.yml`.
Launch 'autocannon-ci help [command]' to know more about the commands.
```
## Storage
**autocannon-ci** can store the results and flamegraphs within a
storage, which is configured in the config file.
### type: fs
```yaml
storage:
type: fs
path: perf-results
```
### type: s3
```yaml
storage:
type: s3
bucket: autocannon-ci-test
region: us-west-2
```
This will also require the environment variables `S3_ACCESS_KEY` and `S3_SECRET_KEY`
containing the proper credentials to access S3. It uses the
[aws-sdk](http://npm.im/aws-sdk), so any other way of configuring the
credential for that will work for **autocannon-ci** as well.
## Acknowledgements
This project was kindly sponsored by [nearForm](http://nearform.com).
## License
MIT
[autocannon]: https://github.com/mcollina/autocannon
[0x]: https://github.com/davidmarkclements/0x