Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/glentiki/autocannon-reporter
📈 A single-paged html reporter for Autocannon 📉
https://github.com/glentiki/autocannon-reporter
Last synced: 3 months ago
JSON representation
📈 A single-paged html reporter for Autocannon 📉
- Host: GitHub
- URL: https://github.com/glentiki/autocannon-reporter
- Owner: GlenTiki
- License: mit
- Created: 2016-07-12T14:26:15.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2023-12-14T23:15:10.000Z (about 1 year ago)
- Last Synced: 2024-09-18T03:58:11.859Z (4 months ago)
- Language: JavaScript
- Homepage:
- Size: 118 KB
- Stars: 9
- Watchers: 4
- Forks: 4
- Open Issues: 5
-
Metadata Files:
- Readme: readme.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Autocannon-reporter
[](https://travis-ci.org/thekemkid/autocannon-reporter)
A simple html reporter for autocannon.
## Usage
### Command Line
On *nix systems, you can use pipes:
```
$ autocannon -j http://localhost:3000 | autocannon-reporter
Running 10s test @ http://localhost:3000
10 connections
Stat Avg Stdev Max
Latency (ms) 0.13 0.55 14
Req/Sec 15276 0 15279
Bytes/Sec 1.67 MB 0 B 1.7 MB
15k requests in 1s, 1.7 MB read
Report written to: /some/*nix/path/report.html
```
On windows, you can supply a file to read
```
$ autocannon-reporter -i ./report.json
Report written to: C:/some/windows/path/report.html
```
### Programmatically
This tool can also be used programmatically
```js
var autocannon = require('autocannon')
var reporter = require('autocannon-reporter')
var path = require('path')
var reportOutputPath = path.join(process.cwd, 'report.html')
autocannon({
url: 'http://localhost:3000'
}, (err, result) => {
if (err) throw err
var report = reporter.buildReport(result, []) // the html structure
reporter.writeReport(report, reportOutputPath, (err, res) => {
if (err) console.err('Error writting report: ', err)
else console.log('Report written to: ', reportOutputPath)
}) //write the report
})
```
## API
### Command line
```
Usage: autocannon-reporter [opts]
Outputs a report at ./report.html
Available options:
-i/--input FILE
The path to the json results. Required when not piping into this tool.
-c/--compare FILES
The paths to multiple json results to be compared to the input.
-v/--version
Print the version number.
-h/--help
Print this menu.
You can also pipe in ndjson results, the first will be considered the input and
the rest are used for the comparison
```
### Programatically
#### buildReport(result, compare)
* `result`: The result of an autocannon run. `Object`. _Required_
* `compare`: An array of old autocannon results to compare against. `Array`. _optional_
Returns a string of html representing the results and comparison
#### writeReport(report, path[, cb])
* `report`: The report returned from `buildReport`. _Required_
* `path`: The full path to the output file/report. _Required_
* `cb`: A function that is called on finishing writing to the file. Passed an `err` param if it failed.
## Acknowledgements
Sponsored by [nearForm](http://www.nearform.com)
## License
[MIT](./LICENSE). Copyright (c) 2016 Glen Keane and other contributors.