Skip to content

Commit

Permalink
doc: add more info to benchmark/README.md
Browse files Browse the repository at this point in the history
Adds info on the `wrk` prerequisite for http benchmarks and how to
run benchmarks with options.

PR-URL: #629
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
Reviewed-By: Evan Lucas <evanlucas@me.com>
  • Loading branch information
Fishrock123 committed Jan 28, 2015
1 parent 097fde7 commit 514b1d9
Showing 1 changed file with 22 additions and 0 deletions.
22 changes: 22 additions & 0 deletions benchmark/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down Expand Up @@ -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,
Expand Down

0 comments on commit 514b1d9

Please sign in to comment.