tree: cd02ebdca165960b1bdd6932219402de30bf93a1 [path history] [tgz]
  1. .eslintrc.yaml
  2. README.md
  3. _benchmark_progress.js
  4. _cli.R
  5. _cli.js
  6. _http-benchmarkers.js
  7. _test-double-benchmarker.js
  8. assert/
  9. async_hooks/
  10. buffers/
  11. child_process/
  12. cluster/
  13. common.js
  14. compare.R
  15. compare.js
  16. crypto/
  17. dgram/
  18. dns/
  19. domain/
  20. es/
  21. events/
  22. fixtures/
  23. fs/
  24. http/
  25. http2/
  26. misc/
  27. module/
  28. napi/
  29. net/
  30. os/
  31. path/
  32. process/
  33. querystring/
  34. run.js
  35. scatter.R
  36. scatter.js
  37. streams/
  38. string_decoder/
  39. timers/
  40. tls/
  41. url/
  42. util/
  43. v8/
  44. vm/
  45. worker/
  46. zlib/
benchmark/README.md

Node.js Core Benchmarks

This folder contains code and data used to measure performance of different Node.js implementations and different ways of writing JavaScript run by the built-in JavaScript engine.

For a detailed guide on how to write and run benchmarks in this directory, see the guide on benchmarks.

Table of Contents

Benchmark Directories

DirectoryPurpose
assertBenchmarks for the assert subsystem.
buffersBenchmarks for the buffer subsystem.
child_processBenchmarks for the child_process subsystem.
cryptoBenchmarks for the crypto subsystem.
dgramBenchmarks for the dgram subsystem.
domainBenchmarks for the domain subsystem.
esBenchmarks for various new ECMAScript features and their pre-ES2015 counterparts.
eventsBenchmarks for the events subsystem.
fixturesBenchmarks fixtures used in various benchmarks throughout the benchmark suite.
fsBenchmarks for the fs subsystem.
httpBenchmarks for the http subsystem.
http2Benchmarks for the http2 subsystem.
miscMiscellaneous benchmarks and benchmarks for shared internal modules.
moduleBenchmarks for the module subsystem.
netBenchmarks for the net subsystem.
pathBenchmarks for the path subsystem.
processBenchmarks for the process subsystem.
querystringBenchmarks for the querystring subsystem.
streamsBenchmarks for the streams subsystem.
string_decoderBenchmarks for the string_decoder subsystem.
timersBenchmarks for the timers subsystem, including setTimeout, setInterval, .etc.
tlsBenchmarks for the tls subsystem.
urlBenchmarks for the url subsystem, including the legacy url implementation and the WHATWG URL implementation.
utilBenchmarks for the util subsystem.
vmBenchmarks for the vm subsystem.

Other Top-level files

The top-level files include common dependencies of the benchmarks and the tools for launching benchmarks and visualizing their output. The actual benchmark scripts should be placed in their corresponding directories.

  • _benchmark_progress.js: implements the progress bar displayed when running compare.js
  • _cli.js: parses the command line arguments passed to compare.js, run.js and scatter.js
  • _cli.R: parses the command line arguments passed to compare.R
  • _http-benchmarkers.js: selects and runs external tools for benchmarking the http subsystem.
  • common.js: see Common API.
  • compare.js: command line tool for comparing performance between different Node.js binaries.
  • compare.R: R script for statistically analyzing the output of compare.js
  • run.js: command line tool for running individual benchmark suite(s).
  • scatter.js: command line tool for comparing the performance between different parameters in benchmark configurations, for example to analyze the time complexity.
  • scatter.R: R script for visualizing the output of scatter.js with scatter plots.

Common API

The common.js module is used by benchmarks for consistency across repeated tasks. It has a number of helpful functions and properties to help with writing benchmarks.

createBenchmark(fn, configs[, options])

See the guide on writing benchmarks.

default_http_benchmarker

The default benchmarker used to run HTTP benchmarks. See the guide on writing HTTP benchmarks.

PORT

The default port used to run HTTP benchmarks. See the guide on writing HTTP benchmarks.

sendResult(data)

Used in special benchmarks that can't use createBenchmark and the object it returns to accomplish what they need. This function reports timing data to the parent process (usually created by running compare.js, run.js or scatter.js).