Skip to content
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

benchmark: adds groups to better separate benchmarks #54393

Merged
merged 6 commits into from
Sep 4, 2024
Merged

benchmark: adds groups to better separate benchmarks #54393

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
d5e9cfc
benchmark: adds groups to better separate benchmarks
puskin94 Aug 15, 2024
699665f
doc: adjusted benchmarks docs to describe how to use the byGroups flag
puskin94 Aug 17, 2024
35abdb0
benchmark: updated the benchmark.js file to keep in consideration groups
puskin94 Aug 18, 2024
9d964a0
benchmark: updated the benchmark.js script to be more strict
puskin94 Aug 18, 2024
f9e929b
doc: update benchmark description
puskin94 Aug 19, 2024
8a06104
doc: linting in benchmark docs and in comments in benchmark.js
puskin94 Aug 20, 2024
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
Prev Previous commit
doc: linting in benchmark docs and in comments in benchmark.js
  • Loading branch information
@puskin94
puskin94 committed Aug 20, 2024
commit 8a0610454412f1e3b8f4f861db926794bd0c36ed
7 changes: 5 additions & 2 deletions doc/contributing/writing-and-running-benchmarks.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -274,9 +274,12 @@ process/bench-env.js operation="delete" n=1000000: 1,521,131.5742806569

#### Grouping benchmarks

Benchmarks can also have groups, giving the developer greater flexibility in differentiating between test cases and also helping reduce the time to run the combination of benchmark parameters.
Benchmarks can also have groups, giving the developer greater flexibility in differentiating between test cases
and also helping reduce the time to run the combination of benchmark parameters.

By default, all groups are executed when running the benchmark. However, it is possible to specify individual groups by setting the `NODE_RUN_BENCHMARK_GROUPS` environment variable when running `compare.js`:
By default, all groups are executed when running the benchmark.
However, it is possible to specify individual groups by setting the
`NODE_RUN_BENCHMARK_GROUPS` environment variable when running `compare.js`:

```bash
NODE_RUN_BENCHMARK_GROUPS=fewHeaders,manyHeaders node http/headers.js
Expand Down
2 changes: 1 addition & 1 deletion test/common/benchmark.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ function runBenchmark(name, env) {
child.on('exit', (code, signal) => {
assert.strictEqual(code, 0);
assert.strictEqual(signal, null);

// This bit makes sure that each benchmark file is being sent settings such
// that the benchmark file runs just one set of options. This helps keep the
// benchmark tests from taking a long time to run. Therefore, stdout should be composed as follows:
Expand Down
Loading