node/benchmark
Rafael Gonzaga 9b3d22dcf6
benchmark: rename count to n
It's a common approach to use n as number of iterations over the
benchmark. Changing it from count to n will also make
./node benchmark/run.js --set n=X more meaningful among other
benchmarks

PR-URL: https://github.com/nodejs/node/pull/54271
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
2024-08-10 20:07:54 +00:00
..
abort_controller benchmark: add AbortSignal.abort benchmarks 2024-04-10 20:16:04 +00:00
assert benchmark: update iterations of assert/deepequal-typedarrays.js 2024-02-28 09:08:05 +00:00
async_hooks lib: rewrite AsyncLocalStorage without async_hooks 2024-08-02 19:44:20 +00:00
blob benchmark: reduce the buffer size for blob 2024-04-17 19:33:44 +00:00
buffers benchmark: use assert.ok instead of assert 2024-08-04 13:29:34 +00:00
child_process
cluster
crypto crypto: make timingSafeEqual faster for Uint8Array 2024-04-08 11:36:53 +00:00
dgram
diagnostics_channel
dns
domain benchmark: update iterations of benchmark/domain/domain-fn-args.js 2024-03-04 10:05:28 +00:00
error errors: fix stacktrace of SystemError 2023-12-23 09:04:45 -08:00
es Revert "util: move util._extend to eol" 2024-06-14 13:07:58 +00:00
esm benchmark: add require-esm benchmark 2024-07-11 18:59:30 +00:00
events
fixtures benchmark: rewrite import.meta benchmark 2023-11-18 00:46:42 +00:00
fs benchmark: change assert() to assert.ok() 2024-08-10 20:06:18 +00:00
http url,tools,benchmark: replace deprecated substr() 2024-05-12 22:35:31 +02:00
http2
https
mime
misc benchmark: rename count to n 2024-08-10 20:07:54 +00:00
module
napi node-api: add property keys benchmark 2024-07-29 11:19:52 +00:00
net stream: bump default highWaterMark 2024-03-13 19:02:14 +00:00
os
path path: fix relative on Windows 2024-08-06 09:40:23 +00:00
perf_hooks perf_hooks: performance milestone time origin timestamp improvement 2024-02-28 16:52:30 +00:00
permission benchmark: fix api restriction for the permission category 2024-05-18 20:37:31 +00:00
process
querystring
readline
streams stream: support typed arrays 2024-03-20 17:27:29 +00:00
string_decoder
test_runner
timers
tls
url url: remove #context from URLSearchParams 2024-01-24 14:36:36 +00:00
util benchmark: add style-text benchmark 2024-03-09 14:01:04 +00:00
v8
validators
vm
websocket lib: enable WebSocket by default 2024-02-04 14:03:39 +00:00
webstreams
worker
zlib
_benchmark_progress.js
_cli.js benchmark: support --help in CLI 2024-08-06 18:21:27 +00:00
_cli.R
_http-benchmarkers.js src: disallow direct .bat and .cmd file spawning 2024-04-10 17:11:15 -03:00
_test-double-benchmarker.js
bar.R
common.js
compare.js benchmark: inherit stdio/stderr instead of pipe 2024-04-13 18:01:28 +00:00
compare.R
eslint.config_partial.mjs tools: move ESLint tools to tools/eslint 2024-06-11 06:58:51 +00:00
README.md
run.js benchmark: inherit stdio/stderr instead of pipe 2024-04-13 18:01:28 +00:00
scatter.js
scatter.R

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

File tree structure

Directories

Benchmarks testing the performance of a single node submodule are placed into a directory with the corresponding name, so that they can be executed by submodule or individually. Benchmarks that span multiple submodules may either be placed into the misc directory or into a directory named after the feature they benchmark. E.g. benchmarks for various new ECMAScript features and their pre-ES2015 counterparts are placed in a directory named es. Fixtures that are not specific to a certain benchmark but can be reused throughout the benchmark suite should be placed in the fixtures directory.

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