report: add `--report-exclude-network` option #51645

Ethan-Arrowood · 2024-02-02T03:17:12Z

New option --report-exclude-network, also available as report.excludeNetwork, enables the user to exclude networking interfaces in their diagnostic report. On some systems, this can cause the report to take minutes to generate so this option can be used to optimize that.

Fixes: #46060

Ethan-Arrowood · 2024-02-02T03:22:47Z

I'm not used to the tests not being in either sequential or parallel. I add some more tests that verify the header.networkInterfaces is missing when this option is set (either by CLI or configuration). I used new test syntax and what not so hopefully that still works in the test/report/ directory.

src/node_options.h

src/node_report_module.cc

test/report/test-report-disable-network.js

doc/api/report.md

lib/internal/process/report.js

src/node_report.cc

test/report/test-report-config.js

Adds a new option `process.report.networkDisabled` and cli option `--report-network-disabled` which will disable any netowkring operations for the `report` generation. Fixes: nodejs#46060 PR-URL: nodejs#51645

github-actions · 2024-02-05T23:12:54Z

The notable-change PRs with changes that should be highlighted in changelogs. label has been added by @anonrig.

Please suggest a text for the release notes if you'd like to include a more detailed summary, then proceed to update the PR description with the text or a link to the notable change suggested text comment. Otherwise, the commit will be placed in the Other Notable Changes section.

Ethan-Arrowood · 2024-02-05T23:13:24Z

@anonrig I'm getting a segmentation fault now (after I made the change Joyee recommended). Trying to debug but this is hard

src/node_report_module.cc

doc/api/report.md

nodejs-github-bot · 2024-03-01T16:27:31Z

CI: https://ci.nodejs.org/job/node-test-pull-request/57536/

nodejs-github-bot · 2024-03-01T17:35:13Z

Commit Queue failed

- Loading data for nodejs/node/pull/51645
✔  Done loading data for nodejs/node/pull/51645
----------------------------------- PR info ------------------------------------
Title      report: add `--report-exclude-network` option (#51645)
Author     Ethan Arrowood  (@Ethan-Arrowood)
Branch     Ethan-Arrowood:fix/process-getreport -> nodejs:main
Labels     c++, semver-minor, lib / src, notable-change, needs-ci, report
Commits    1
 - report: add `--report-exclude-network` option
Committers 1
 - Ethan Arrowood 
PR-URL: https://github.com/nodejs/node/pull/51645
Fixes: https://github.com/nodejs/node/issues/46060
Reviewed-By: Yagiz Nizipli 
Reviewed-By: Joyee Cheung 
------------------------------ Generated metadata ------------------------------
PR-URL: https://github.com/nodejs/node/pull/51645
Fixes: https://github.com/nodejs/node/issues/46060
Reviewed-By: Yagiz Nizipli 
Reviewed-By: Joyee Cheung 
--------------------------------------------------------------------------------
   ⚠  Commits were pushed since the last approving review:
   ⚠  - report: add `--report-exclude-network` option
   ℹ  This PR was created on Fri, 02 Feb 2024 03:17:12 GMT
   ✔  Approvals: 2
   ✔  - Yagiz Nizipli (@anonrig) (TSC): https://github.com/nodejs/node/pull/51645#pullrequestreview-1864004600
   ✔  - Joyee Cheung (@joyeecheung) (TSC): https://github.com/nodejs/node/pull/51645#pullrequestreview-1881176781
   ✔  Last GitHub CI successful
   ℹ  Last Full PR CI on 2024-03-01T16:27:31Z: https://ci.nodejs.org/job/node-test-pull-request/57536/
- Querying data for job/node-test-pull-request/57536/
   ✔  Last Jenkins CI successful
--------------------------------------------------------------------------------
   ✔  Aborted `git node land` session in /home/runner/work/node/node/.ncu

https://github.com/nodejs/node/actions/runs/8114994573

Ethan-Arrowood · 2024-03-01T17:36:32Z

Commit-queue failed because I pushed a rebase after latest reviews. Can someone reapprove this please? @anonrig @joyeecheung

nodejs-github-bot · 2024-03-01T21:50:06Z

Landed in 009665f

New option `--report-exclude-network`, also available as `report.excludeNetwork`, enables the user to exclude networking interfaces in their diagnostic report. On some systems, this can cause the report to take minutes to generate so this option can be used to optimize that. Fixes: nodejs#46060 PR-URL: nodejs#51645 Co-authored-by: Joyee Cheung <joyeec9h3@gmail.com> Reviewed-By: Yagiz Nizipli <yagiz.nizipli@sentry.io> Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>

New option `--report-exclude-network`, also available as `report.excludeNetwork`, enables the user to exclude networking interfaces in their diagnostic report. On some systems, this can cause the report to take minutes to generate so this option can be used to optimize that. Fixes: #46060 PR-URL: #51645 Co-authored-by: Joyee Cheung <joyeec9h3@gmail.com> Reviewed-By: Yagiz Nizipli <yagiz.nizipli@sentry.io> Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>

Notable changes: benchmark: * add AbortSignal.abort benchmarks (Raz Luvaton) #52408 buffer: * improve `base64` and `base64url` performance (Yagiz Nizipli) #52428 crypto: * deprecate implicitly shortened GCM tags (Tobias Nießen) #52345 deps: * (SEMVER-MINOR) update simdutf to 5.0.0 (Daniel Lemire) #52138 * (SEMVER-MINOR) update undici to 6.3.0 (Node.js GitHub Bot) #51462 * (SEMVER-MINOR) update undici to 6.2.1 (Node.js GitHub Bot) #51278 dns: * (SEMVER-MINOR) add order option and support ipv6first (Paolo Insogna) #52492 doc: * update release gpg keyserver (marco-ippolito) #52257 * add release key for marco-ippolito (marco-ippolito) #52257 * add UlisesGascon as a collaborator (Ulises Gascón) #51991 * (SEMVER-MINOR) deprecate fs.Stats public constructor (Marco Ippolito) #51879 events,doc: * mark CustomEvent as stable (Daeyeon Jeong) #52618 fs: * add stacktrace to fs/promises (翠 / green) #49849 lib, url: * (SEMVER-MINOR) add a `windows` option to path parsing (Aviv Keller) #52509 net: * (SEMVER-MINOR) add CLI option for autoSelectFamilyAttemptTimeout (Paolo Insogna) #52474 report: * (SEMVER-MINOR) add `--report-exclude-network` option (Ethan Arrowood) #51645 src: * (SEMVER-MINOR) add `string_view` overload to snapshot FromBlob (Anna Henningsen) #52595 * (SEMVER-MINOR) add C++ ProcessEmitWarningSync() (Joyee Cheung) #51977 * (SEMVER-MINOR) add uv_get_available_memory to report and process (theanarkh) #52023 * (SEMVER-MINOR) preload function for Environment (Cheng Zhao) #51539 stream: * (SEMVER-MINOR) support typed arrays (IlyasShabi) #51866 test_runner: * (SEMVER-MINOR) add suite() (Colin Ihrig) #52127 * (SEMVER-MINOR) support forced exit (Colin Ihrig) #52038 * (SEMVER-MINOR) add `test:complete` event to reflect execution order (Moshe Atlow) #51909 util: * (SEMVER-MINOR) support array of formats in util.styleText (Marco Ippolito) #52040 v8: * (SEMVER-MINOR) implement v8.queryObjects() for memory leak regression testing (Joyee Cheung) #51927 watch: * mark as stable (Moshe Atlow) #52074 PR-URL: TODO

Notable changes: benchmark: * add AbortSignal.abort benchmarks (Raz Luvaton) #52408 buffer: * improve `base64` and `base64url` performance (Yagiz Nizipli) #52428 crypto: * deprecate implicitly shortened GCM tags (Tobias Nießen) #52345 deps: * (SEMVER-MINOR) update simdutf to 5.0.0 (Daniel Lemire) #52138 * (SEMVER-MINOR) update undici to 6.3.0 (Node.js GitHub Bot) #51462 * (SEMVER-MINOR) update undici to 6.2.1 (Node.js GitHub Bot) #51278 dns: * (SEMVER-MINOR) add order option and support ipv6first (Paolo Insogna) #52492 doc: * update release gpg keyserver (marco-ippolito) #52257 * add release key for marco-ippolito (marco-ippolito) #52257 * add UlisesGascon as a collaborator (Ulises Gascón) #51991 * (SEMVER-MINOR) deprecate fs.Stats public constructor (Marco Ippolito) #51879 events,doc: * mark CustomEvent as stable (Daeyeon Jeong) #52618 fs: * add stacktrace to fs/promises (翠 / green) #49849 lib, url: * (SEMVER-MINOR) add a `windows` option to path parsing (Aviv Keller) #52509 net: * (SEMVER-MINOR) add CLI option for autoSelectFamilyAttemptTimeout (Paolo Insogna) #52474 report: * (SEMVER-MINOR) add `--report-exclude-network` option (Ethan Arrowood) #51645 src: * (SEMVER-MINOR) add `string_view` overload to snapshot FromBlob (Anna Henningsen) #52595 * (SEMVER-MINOR) add C++ ProcessEmitWarningSync() (Joyee Cheung) #51977 * (SEMVER-MINOR) add uv_get_available_memory to report and process (theanarkh) #52023 * (SEMVER-MINOR) preload function for Environment (Cheng Zhao) #51539 stream: * (SEMVER-MINOR) support typed arrays (IlyasShabi) #51866 test_runner: * (SEMVER-MINOR) add suite() (Colin Ihrig) #52127 * (SEMVER-MINOR) support forced exit (Colin Ihrig) #52038 * (SEMVER-MINOR) add `test:complete` event to reflect execution order (Moshe Atlow) #51909 util: * (SEMVER-MINOR) support array of formats in util.styleText (Marco Ippolito) #52040 v8: * (SEMVER-MINOR) implement v8.queryObjects() for memory leak regression testing (Joyee Cheung) #51927 watch: * mark as stable (Moshe Atlow) #52074 PR-URL: #52793

Notable changes: benchmark: * add AbortSignal.abort benchmarks (Raz Luvaton) #52408 buffer: * improve `base64` and `base64url` performance (Yagiz Nizipli) #52428 crypto: * deprecate implicitly shortened GCM tags (Tobias Nießen) #52345 deps: * (SEMVER-MINOR) update simdutf to 5.0.0 (Daniel Lemire) #52138 * (SEMVER-MINOR) update undici to 6.3.0 (Node.js GitHub Bot) #51462 * (SEMVER-MINOR) update undici to 6.2.1 (Node.js GitHub Bot) #51278 dns: * (SEMVER-MINOR) add order option and support ipv6first (Paolo Insogna) #52492 doc: * update release gpg keyserver (marco-ippolito) #52257 * add release key for marco-ippolito (marco-ippolito) #52257 * add UlisesGascon as a collaborator (Ulises Gascón) #51991 * (SEMVER-MINOR) deprecate fs.Stats public constructor (Marco Ippolito) #51879 events,doc: * mark CustomEvent as stable (Daeyeon Jeong) #52618 fs: * add stacktrace to fs/promises (翠 / green) #49849 lib, url: * (SEMVER-MINOR) add a `windows` option to path parsing (Aviv Keller) #52509 net: * (SEMVER-MINOR) add CLI option for autoSelectFamilyAttemptTimeout (Paolo Insogna) #52474 report: * (SEMVER-MINOR) add `--report-exclude-network` option (Ethan Arrowood) #51645 src: * (SEMVER-MINOR) add `string_view` overload to snapshot FromBlob (Anna Henningsen) #52595 * (SEMVER-MINOR) add C++ ProcessEmitWarningSync() (Joyee Cheung) #51977 * (SEMVER-MINOR) add uv_get_available_memory to report and process (theanarkh) #52023 * (SEMVER-MINOR) preload function for Environment (Cheng Zhao) #51539 stream: * (SEMVER-MINOR) support typed arrays (IlyasShabi) #51866 test_runner: * (SEMVER-MINOR) add suite() (Colin Ihrig) #52127 * (SEMVER-MINOR) add `test:complete` event to reflect execution order (Moshe Atlow) #51909 util: * (SEMVER-MINOR) support array of formats in util.styleText (Marco Ippolito) #52040 v8: * (SEMVER-MINOR) implement v8.queryObjects() for memory leak regression testing (Joyee Cheung) #51927 watch: * mark as stable (Moshe Atlow) #52074 PR-URL: #52793

Notable changes: benchmark: * add AbortSignal.abort benchmarks (Raz Luvaton) nodejs#52408 buffer: * improve `base64` and `base64url` performance (Yagiz Nizipli) nodejs#52428 crypto: * deprecate implicitly shortened GCM tags (Tobias Nießen) nodejs#52345 deps: * (SEMVER-MINOR) update simdutf to 5.0.0 (Daniel Lemire) nodejs#52138 * (SEMVER-MINOR) update undici to 6.3.0 (Node.js GitHub Bot) nodejs#51462 * (SEMVER-MINOR) update undici to 6.2.1 (Node.js GitHub Bot) nodejs#51278 dns: * (SEMVER-MINOR) add order option and support ipv6first (Paolo Insogna) nodejs#52492 doc: * update release gpg keyserver (marco-ippolito) nodejs#52257 * add release key for marco-ippolito (marco-ippolito) nodejs#52257 * add UlisesGascon as a collaborator (Ulises Gascón) nodejs#51991 * (SEMVER-MINOR) deprecate fs.Stats public constructor (Marco Ippolito) nodejs#51879 events,doc: * mark CustomEvent as stable (Daeyeon Jeong) nodejs#52618 fs: * add stacktrace to fs/promises (翠 / green) nodejs#49849 lib, url: * (SEMVER-MINOR) add a `windows` option to path parsing (Aviv Keller) nodejs#52509 net: * (SEMVER-MINOR) add CLI option for autoSelectFamilyAttemptTimeout (Paolo Insogna) nodejs#52474 report: * (SEMVER-MINOR) add `--report-exclude-network` option (Ethan Arrowood) nodejs#51645 src: * (SEMVER-MINOR) add `string_view` overload to snapshot FromBlob (Anna Henningsen) nodejs#52595 * (SEMVER-MINOR) add C++ ProcessEmitWarningSync() (Joyee Cheung) nodejs#51977 * (SEMVER-MINOR) add uv_get_available_memory to report and process (theanarkh) nodejs#52023 * (SEMVER-MINOR) preload function for Environment (Cheng Zhao) nodejs#51539 stream: * (SEMVER-MINOR) support typed arrays (IlyasShabi) nodejs#51866 test_runner: * (SEMVER-MINOR) add suite() (Colin Ihrig) nodejs#52127 * (SEMVER-MINOR) add `test:complete` event to reflect execution order (Moshe Atlow) nodejs#51909 util: * (SEMVER-MINOR) support array of formats in util.styleText (Marco Ippolito) nodejs#52040 v8: * (SEMVER-MINOR) implement v8.queryObjects() for memory leak regression testing (Joyee Cheung) nodejs#51927 watch: * mark as stable (Moshe Atlow) nodejs#52074 PR-URL: nodejs#52793

nodejs-github-bot added c++ Issues and PRs that require attention from people who are familiar with C++. lib / src Issues and PRs related to general changes in the lib or src directory. needs-ci PRs that need a full CI run. labels Feb 2, 2024

Ethan-Arrowood requested a review from joyeecheung February 2, 2024 03:17

Ethan-Arrowood force-pushed the fix/process-getreport branch from 8b03a57 to 0f094cb Compare February 2, 2024 03:21

Ethan-Arrowood marked this pull request as ready for review February 2, 2024 03:21

anonrig self-requested a review February 2, 2024 03:39

Ethan-Arrowood force-pushed the fix/process-getreport branch 2 times, most recently from 8341898 to 1f12672 Compare February 2, 2024 04:18

Ethan-Arrowood added the report Issues and PRs related to process.report. label Feb 2, 2024

joyeecheung reviewed Feb 2, 2024

View reviewed changes

src/node_options.h Outdated Show resolved Hide resolved

src/node_report_module.cc Outdated Show resolved Hide resolved

styfle reviewed Feb 2, 2024

View reviewed changes

test/report/test-report-disable-network.js Outdated Show resolved Hide resolved

anonrig reviewed Feb 2, 2024

View reviewed changes

Ethan-Arrowood changed the title ~~report: add --report-disable-network option~~ report: add --report-network-disabled option Feb 5, 2024

Ethan-Arrowood requested review from anonrig, joyeecheung and styfle February 5, 2024 18:29

Ethan-Arrowood force-pushed the fix/process-getreport branch from 43125e2 to 2d5fb4e Compare February 5, 2024 20:21

Ethan-Arrowood force-pushed the fix/process-getreport branch from 2d5fb4e to 25be48a Compare February 5, 2024 20:28

Ethan-Arrowood force-pushed the fix/process-getreport branch from 0ca3be5 to e485abb Compare February 5, 2024 20:36

anonrig approved these changes Feb 5, 2024

View reviewed changes

anonrig added semver-minor PRs that contain new features and should be released in the next minor version. notable-change PRs with changes that should be highlighted in changelogs. labels Feb 5, 2024

Ethan-Arrowood commented Feb 6, 2024

View reviewed changes

src/node_report_module.cc Outdated Show resolved Hide resolved

richardlau reviewed Feb 6, 2024

View reviewed changes

doc/api/report.md Outdated Show resolved Hide resolved

Ethan-Arrowood added the commit-queue Add this label to land a pull request using GitHub Actions. label Mar 1, 2024

nodejs-github-bot added commit-queue-failed An error occurred while landing this pull request using GitHub Actions. and removed commit-queue Add this label to land a pull request using GitHub Actions. labels Mar 1, 2024

Ethan-Arrowood requested review from anonrig and joyeecheung March 1, 2024 17:36

joyeecheung approved these changes Mar 1, 2024

View reviewed changes

joyeecheung added commit-queue Add this label to land a pull request using GitHub Actions. and removed commit-queue-failed An error occurred while landing this pull request using GitHub Actions. labels Mar 1, 2024

nodejs-github-bot removed the commit-queue Add this label to land a pull request using GitHub Actions. label Mar 1, 2024

nodejs-github-bot merged commit 009665f into nodejs:main Mar 1, 2024
70 checks passed

styfle mentioned this pull request Mar 1, 2024

fix: improve performance of getReport() lovell/detect-libc#21

Merged

dstaley mentioned this pull request Mar 18, 2024

[BUG] process.report.getReport() is very very slow on win32 npm/npm-install-checks#95

Open

1 task

RafaelGSS mentioned this pull request Apr 15, 2024

2024-04-24, Version 22.0.0 (Current) #52505

Merged

marco-ippolito mentioned this pull request May 2, 2024

v20.13.0 proposal #52793

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

report: add `--report-exclude-network` option #51645

report: add `--report-exclude-network` option #51645

Ethan-Arrowood commented Feb 2, 2024 •

edited

Loading

Ethan-Arrowood commented Feb 2, 2024 •

edited

Loading

github-actions bot commented Feb 5, 2024

Ethan-Arrowood commented Feb 5, 2024

nodejs-github-bot commented Mar 1, 2024

nodejs-github-bot commented Mar 1, 2024

Ethan-Arrowood commented Mar 1, 2024

nodejs-github-bot commented Mar 1, 2024

report: add --report-exclude-network option #51645

report: add --report-exclude-network option #51645

Conversation

Ethan-Arrowood commented Feb 2, 2024 • edited Loading

Ethan-Arrowood commented Feb 2, 2024 • edited Loading

github-actions bot commented Feb 5, 2024

Ethan-Arrowood commented Feb 5, 2024

nodejs-github-bot commented Mar 1, 2024

nodejs-github-bot commented Mar 1, 2024

Ethan-Arrowood commented Mar 1, 2024

nodejs-github-bot commented Mar 1, 2024

report: add `--report-exclude-network` option #51645

report: add `--report-exclude-network` option #51645

Ethan-Arrowood commented Feb 2, 2024 •

edited

Loading

Ethan-Arrowood commented Feb 2, 2024 •

edited

Loading