Skip to content

Commit

Permalink
docs: add documentation for benchmarks
Browse files Browse the repository at this point in the history
closes #5312
  • Loading branch information
UlisesGascon authored and dougwilson committed Feb 19, 2024
1 parent 3abea7f commit e720c5a
Showing 1 changed file with 34 additions and 0 deletions.
34 changes: 34 additions & 0 deletions benchmarks/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# Express Benchmarks

## Installation

You will need to install [wrk](https://github.com/wg/wrk/blob/master/INSTALL) in order to run the benchmarks.

## Running

To run the benchmarks, first install the dependencies `npm i`, then run `make`

The output will look something like this:

```
50 connections
1 middleware
7.15ms
6784.01
[...redacted...]
1000 connections
10 middleware
139.21ms
6155.19
```

### Tip: Include Node.js version in output

You can use `make && node -v` to include the node.js version in the output.

### Tip: Save the results to a file

You can use `make > results.log` to save the results to a file `results.log`.

0 comments on commit e720c5a

Please sign in to comment.