benchmarks/README.md

   1 # Poolifier Benchmarks
   2
   3 Welcome to poolifier benchmarks and thanks to look into this project.
   4
   5 ## Folder Structure
   6
   7 The internal folder contains poolifier internal benchmarks.
   8 The versus-external-pools folder contains benchmarks versus other Node.js pools.
   9
  10 ## Poolifier vs other pools benchmark
  11
  12 To compare poolifier pools performance vs other pools performance we chose to use [hyperfine](https://github.com/sharkdp/hyperfine).
  13 We chose to use this tool because it allows to run isolated Node.js processes so that each pool does not impact each other.
  14
  15 Those are our results:
  16
  17 - CPU Intensive task with 100k operations submitted to each pool [BENCH-100000.MD](./versus-external-pools/BENCH-100000.MD).
  18 This benchmark ran on a MacBook Pro 2015, 2,2 GHz Intel Core i7 quad-core, 16 GB 1600 MHz DDR3
  19
  20 ## How to run benchmarks
  21
  22 ### Internal
  23
  24 To run the internal benchmark you just need to navigate to the root of poolifier project and run `npm run benchmark`
  25
  26 ## Versus other pools
  27
  28 To run the benchmark versus other pools you will need to:
  29
  30 - [Install hyperfine](https://github.com/sharkdp/hyperfine#installation)
  31 - Run the `./bench.sh` into the `versus-external-pools` folder
  32
  33 > :warning: **Please be sure to use a quite PC when you run the benchmarks**