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

doc: edit the benchmark guide

Browse Source 
These are minor typographical and style improvements to the guide for
writing and running benchmarks.

PR-URL: https://github.com/nodejs/node/pull/12041
Reviewed-By: Nikolai Vavilov <vvnicholas@gmail.com>
Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
This commit is contained in:
Rich Trott 2017-03-25 11:01:06 -07:00 committed by James M Snell
parent 51b007aaa7
commit 45df578f62
1 changed files with 8 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
doc/guides/writing-and-running-benchmarks.md
View File

@ -22,21 +22,20 @@ which need to be included in the global Windows `PATH`.
### HTTP Benchmark Requirements ### HTTP Benchmark Requirements
Most of the HTTP benchmarks require a benchmarker to be installed, this can be Most of the HTTP benchmarks require a benchmarker to be installed. This can be
either [`wrk`][wrk] or [`autocannon`][autocannon]. either [`wrk`][wrk] or [`autocannon`][autocannon].
`Autocannon` is a Node.js script that can be installed using `Autocannon` is a Node.js script that can be installed using
`npm install -g autocannon`. It will use the Node.js executable that is in the `npm install -g autocannon`. It will use the Node.js executable that is in the
path, hence if you want to compare two HTTP benchmark runs make sure that the path. Hence if you want to compare two HTTP benchmark runs, make sure that the
Node.js version in the path is not altered. Node.js version in the path is not altered.
`wrk` may be available through your preferred package manager. If not, you can `wrk` may be available through your preferred package manager. If not, you can
easily build it [from source][wrk] via `make`. easily build it [from source][wrk] via `make`.
By default `wrk` will be used as benchmarker. If it is not available By default, `wrk` will be used as the benchmarker. If it is not available,
`autocannon` will be used in it its place. When creating a HTTP benchmark you `autocannon` will be used in its place. When creating an HTTP benchmark, you can
can specify which benchmarker should be used. You can force a specific specify which benchmarker should be used by providing it as an argument:
benchmarker to be used by providing it as an argument, e. g.:
`node benchmark/run.js --set benchmarker=autocannon http` `node benchmark/run.js --set benchmarker=autocannon http`
@ -44,7 +43,7 @@ benchmarker to be used by providing it as an argument, e. g.:
### Benchmark Analysis Requirements ### Benchmark Analysis Requirements
To analyze the results `R` should be installed. Check you package manager or To analyze the results, `R` should be installed. Use your package manager or
download it from https://www.r-project.org/. download it from https://www.r-project.org/.
The R packages `ggplot2` and `plyr` are also used and can be installed using The R packages `ggplot2` and `plyr` are also used and can be installed using
@ -56,9 +55,8 @@ install.packages("ggplot2")
install.packages("plyr") install.packages("plyr")
``` ```
In the event you get a message that you need to select a CRAN mirror first. In the event you get a message that you need to select a CRAN mirror first, you
can specify a mirror by adding in the repo parameter.
You can specify a mirror by adding in the repo parameter.
If we used the "http://cran.us.r-project.org" mirror, it could look something If we used the "http://cran.us.r-project.org" mirror, it could look something
like this: like this: