Skip to content

doc: edit the benchmark guide #12041

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
Trott wants to merge 2 commits into from
Closed

doc: edit the benchmark guide #12041

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6bdc2dd
doc: edit the benchmark guide
Trott Mar 25, 2017
88ccafc
squash: a -> an
Trott Mar 25, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
doc: edit the benchmark guide 
These are minor typographical and style improvements to the guide for
writing and running benchmarks.
  • Loading branch information
@Trott
Trott committed Mar 25, 2017
commit 6bdc2dd5e7d643131c8fdaf607a74e3b8215b70c
18 changes: 8 additions & 10 deletions doc/guides/writing-and-running-benchmarks.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,29 +22,28 @@ which need to be included in the global Windows `PATH`.

### 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].

`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
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.

`wrk` may be available through your preferred package manager. If not, you can
easily build it [from source][wrk] via `make`.

By default `wrk` will be used as benchmarker. If it is not available
`autocannon` will be used in it its place. When creating a HTTP benchmark you
can specify which benchmarker should be used. You can force a specific
benchmarker to be used by providing it as an argument, e. g.:
By default, `wrk` will be used as the benchmarker. If it is not available,
`autocannon` will be used in its place. When creating a HTTP benchmark, you can
Copy link
Copy Markdown
Contributor

@seishun seishun Mar 25, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

s/a /an /?

Copy link
Copy Markdown
Member Author

@Trott Trott Mar 25, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's my preference too. I'll update it. Thanks.

specify which benchmarker should be used by providing it as an argument:

`node benchmark/run.js --set benchmarker=autocannon http`

`node benchmark/http/simple.js benchmarker=autocannon`

### 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/.

The R packages `ggplot2` and `plyr` are also used and can be installed using
Expand All @@ -56,9 +55,8 @@ install.packages("ggplot2")
install.packages("plyr")
```

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.
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.

If we used the "http://cran.us.r-project.org" mirror, it could look something
like this:
Expand Down