1berry/nodejs
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

doc: add more info to benchmark/README.md

Browse Source 
Adds info on the `wrk` prerequisite for http benchmarks and how to
run benchmarks with options.

PR-URL: https://github.com/iojs/io.js/pull/629
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
Reviewed-By: Evan Lucas <evanlucas@me.com>
This commit is contained in:
Fishrock123 2015-01-27 18:28:41 -05:00
parent 097fde7129
commit 514b1d964b
1 changed files with 22 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
benchmark/README.md
View File

@ -3,6 +3,14 @@
This folder contains benchmark tests to measure the performance for certain
io.js APIs.
## prerequisites
Most of the http benchmarks require `wrk` to be compiled beforehand.
```sh
make wrk
```
## How to run tests
There are two ways to run benchmark tests:
@ -80,6 +88,20 @@ buffers/buffer-read.js noAssert=false buffer=fast type=UInt16BE millions=1: 245.
...
```
3. Run tests with options
This example will run only the first type of url test, with one iteration.
(Note: benchmarks require __many__ iterations to be statistically accurate.)
```sh
iojs benchmark/url/url-parse.js type=one n=1
```
Output:
```
url/url-parse.js type=one n=1: 1663.74402
```
## How to write a benchmark test
The benchmark tests are grouped by types. Each type corresponds to a subdirectory,