util: integrate node-heapdump into core #26501

jasnell · 2019-03-07T22:19:50Z

Adds v8.heapdump.getHeapdump() and v8.heapdump.triggerHeapdump(filename) methods with impl adapted from the node-heapdump module.

Not included is the SIGUSR2 signal, which can be handled by userland.

/cc nodejs/diagnostics#279
@nodejs/diagnostics

Also see: #26498

Checklist

make -j4 test (UNIX), or vcbuild test (Windows) passes
tests and/or benchmarks are included
documentation is changed or added
commit message follows commit guidelines

nodejs-github-bot · 2019-03-07T22:19:53Z

@jasnell build started: https://ci.nodejs.org/blue/organizations/jenkins/node-test-pull-request-lite-pipeline/detail/node-test-pull-request-lite-pipeline/2806/pipeline

doc/api/v8.md

tools/license-builder.sh

doc/api/v8.md

src/heap_utils.cc

tools/license-builder.sh

mcollina

Code LGTM

v8.heapdump.getHeapdump() data format is missing in the docs.

doc/api/v8.md

jasnell · 2019-03-08T14:58:04Z

Based on some conversations around this, I'm considering just removing the getHeapdump() option and just keeping the write-to-disk option only.

doc/api/v8.md

jasnell · 2019-03-09T11:14:57Z

Updated the PR to:

Remove the getHeapdump() function
Added a note indicating that the heapdump file format is V8 specific and intended to be loaded in tools like Chrome DevTools
Added a note about heapdumps being isolate/thread specific along with an example of taking heapdumps of the main thread and worker threads.
Since there is only the one method, changed from v8.heapdump.triggerHeapdump() to just v8.triggerHeapdump()

@bnoordhuis and @richardlau ... may I ask you both to reaffirm your sign-off with the updates.

@mcollina ... may I ask you to review the doc updates to see if they address your concerns.

src/heap_utils.cc

tools/license-builder.sh

mcollina

LGTM

jasnell · 2019-03-09T13:52:05Z

Ah! Nice.

…

On Sat, Mar 9, 2019, 13:44 Colin Ihrig ***@***.***> wrote: ***@***.**** commented on this pull request. ------------------------------ In doc/api/v8.md <#26501 (comment)>: > @@ -135,6 +135,31 @@ to get swapped out by the operating system. } ``` +## v8.heapdump.getHeapdump() + + +* Returns: {Object} + +Returns an object containing a snapshot of the current V8 heap. + +## v8.heapdump.triggerHeapdump([filename]) @jasnell <https://github.com/jasnell> see #26527 <#26527> — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#26501 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AAa2eatm0uknLHz91dYPrHfztyTSgNR5ks5vU7qjgaJpZM4bkOxw> .

doc/api/v8.md

vsemozhetbyt

Some doc nits.

doc/api/v8.md

jasnell · 2019-03-10T19:44:13Z

@joyeecheung ... PTAL, I added a getHeapdump() variant that returns a stream.Readable

doc/api/v8.md

src/heap_utils.cc

doc/api/v8.md

jasnell · 2019-03-11T00:23:08Z

@vsemozhetbyt @addaleax @richardlau ... PTAL

jasnell · 2019-03-11T00:24:07Z

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

jasnell · 2019-03-12T22:45:31Z

CI is good

lib/v8.js

src/heap_utils.cc

jasnell · 2019-03-13T14:24:25Z

Ok @joyeecheung ... hopefully that'll be the last few nits fixed. This should be ready to go.

addaleax · 2019-03-13T14:32:02Z

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

joyeecheung

LGTM. Thanks for following up with the reviews!

jasnell · 2019-03-13T15:31:55Z

Resume for flaky failure:https://ci.nodejs.org/job/node-test-pull-request/21505/

Adds `v8.writeHeapSnapshot(filename)` with impl adapted from the `node-heapdump` module. Also, adds a v8.getHeapSnapshot() alternative that returns a Readable Stream PR-URL: #26501 Reviewed-By: Richard Lau <riclau@uk.ibm.com> Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl> Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Sam Roberts <vieuxtech@gmail.com> Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>

jasnell · 2019-03-13T15:52:13Z

Landed in 5f38797 ... thanks all

Lazy loading `v8` in `lib/internal/error-serdes.js` reduces the number of loaded modules by the bootstrap code for Worker threads by seven. Refs: nodejs#26501 (comment)

Lazy loading `v8` in `lib/internal/error-serdes.js` reduces the number of loaded modules by the bootstrap code for Worker threads by seven. PR-URL: nodejs#26689 Refs: nodejs#26501 (comment) Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com>

Adds `v8.writeHeapSnapshot(filename)` with impl adapted from the `node-heapdump` module. Also, adds a v8.getHeapSnapshot() alternative that returns a Readable Stream PR-URL: nodejs#26501 Reviewed-By: Richard Lau <riclau@uk.ibm.com> Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl> Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Sam Roberts <vieuxtech@gmail.com> Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>

Lazy loading `v8` in `lib/internal/error-serdes.js` reduces the number of loaded modules by the bootstrap code for Worker threads by seven. PR-URL: #26689 Refs: #26501 (comment) Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com>

Notable changes: * events: * Added a `once` function to use `EventEmitter` with promises (#26078). * tty: * Added a `hasColors` method to `WriteStream` (#26247). * Added NO_COLOR and FORCE_COLOR support (#26485). * v8: * Added `v8.getHeapSnapshot` and `v8.writeHeapSnapshot` to generate snapshots in the format used by tools such as Chrome DevTools (#26501). * meta: * Gireesh Punathil is now a member of the Technical Steering Committee (#26657). * Added ZYSzys to collaborators (#26730). PR-URL: #26949

Notable changes: * crypto * Allow deriving public from private keys (Tobias Nießen) [#26278](#26278). * events * Added a `once` function to use `EventEmitter` with promises (Matteo Collina) [#26078](#26078). * tty * Added a `hasColors` method to `WriteStream` (Ruben Bridgewater) [#26247](#26247). * Added NO_COLOR and FORCE_COLOR support (Ruben Bridgewater) [#26485](#26485). * v8 * Added `v8.getHeapSnapshot` and `v8.writeHeapSnapshot` to generate snapshots in the format used by tools such as Chrome DevTools (James M Snell) [#26501](#26501). * worker * Added `worker.moveMessagePortToContext`. This enables using MessagePorts in different vm.Contexts, aiding with the isolation that the vm module seeks to provide (Anna Henningsen) [#26497](#26497). * C++ API * `AddPromiseHook` is now deprecated. This API was added to fill an use case that is served by `async_hooks`, since that has `Promise` support (Anna Henningsen) [#26529](#26529). * Added a `Stop` API to shut down Node.js while it is running (Gireesh Punathil) [#21283](#21283). * meta * [Gireesh Punathil](https://github.com/gireeshpunathil) is now a member of the Technical Steering Committee [#26657](#26657). * Added [Yongsheng Zhang](https://github.com/ZYSzys) to collaborators [#26730](#26730). PR-URL: #26949

BethGriggs · 2019-08-20T15:35:38Z

@jasnell, should this land on v10.x? Please add the lts-watch label if so

nodejs-github-bot added c++ Issues and PRs that require attention from people who are familiar with C++. tools Issues and PRs related to the tools directory. labels Mar 7, 2019

richardlau approved these changes Mar 7, 2019

View reviewed changes

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

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

richardlau reviewed Mar 8, 2019

View reviewed changes

tools/license-builder.sh Show resolved Hide resolved

ronkorving reviewed Mar 8, 2019

View reviewed changes

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

ronkorving reviewed Mar 8, 2019

View reviewed changes

src/heap_utils.cc Show resolved Hide resolved

bnoordhuis approved these changes Mar 8, 2019

View reviewed changes

tools/license-builder.sh Outdated Show resolved Hide resolved

mcollina requested changes Mar 8, 2019

View reviewed changes

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

joyeecheung reviewed Mar 8, 2019

View reviewed changes

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

cjihrig mentioned this pull request Mar 8, 2019

report: rename triggerReport() to writeReport() #26527

Merged

4 tasks

jasnell force-pushed the heapdump branch from 0890c08 to af77a99 Compare March 9, 2019 11:10

addaleax approved these changes Mar 9, 2019

View reviewed changes

src/heap_utils.cc Show resolved Hide resolved

src/heap_utils.cc Outdated Show resolved Hide resolved

tools/license-builder.sh Show resolved Hide resolved

mcollina approved these changes Mar 9, 2019

View reviewed changes

joyeecheung reviewed Mar 9, 2019

View reviewed changes

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

vsemozhetbyt added v8 engine Issues and PRs related to the V8 dependency. semver-minor PRs that contain new features and should be released in the next minor version. labels Mar 9, 2019

vsemozhetbyt reviewed Mar 9, 2019

View reviewed changes

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

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

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

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

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

vsemozhetbyt added the memory Issues and PRs related to the memory management or memory footprint. label Mar 9, 2019

jasnell force-pushed the heapdump branch from 6fe05dd to f7bb696 Compare March 10, 2019 03:06

vsemozhetbyt reviewed Mar 10, 2019

View reviewed changes

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

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

addaleax reviewed Mar 10, 2019

View reviewed changes

src/heap_utils.cc Outdated Show resolved Hide resolved

src/heap_utils.cc Outdated Show resolved Hide resolved

src/heap_utils.cc Outdated Show resolved Hide resolved

src/heap_utils.cc Outdated Show resolved Hide resolved

richardlau reviewed Mar 10, 2019

View reviewed changes

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

jasnell force-pushed the heapdump branch from f7bb696 to 73ac155 Compare March 11, 2019 00:22

jasnell force-pushed the heapdump branch from b4c7696 to 8124e76 Compare March 12, 2019 22:38

joyeecheung reviewed Mar 13, 2019

View reviewed changes

lib/v8.js Outdated Show resolved Hide resolved

src/heap_utils.cc Outdated Show resolved Hide resolved

[Squash] moar nits

4d5292d

joyeecheung approved these changes Mar 13, 2019

View reviewed changes

jasnell closed this Mar 13, 2019

richardlau mentioned this pull request Mar 13, 2019

test: whitelist the expected modules in test-bootstrap-modules.js #26531

Merged

3 tasks

richardlau mentioned this pull request Mar 15, 2019

lib: lazy load v8 in error-serdes #26689

Closed

2 tasks

targos mentioned this pull request Mar 27, 2019

v11.13.0 release proposal #26949

Merged

BethGriggs added the dont-land-on-v10.x label Sep 3, 2019

ggrossetie mentioned this pull request Sep 13, 2020

Remplacer la session MemoryStore (fuite mémoire) pour connect-mongo EcrituresNumeriques/stylo#183

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

util: integrate node-heapdump into core #26501

util: integrate node-heapdump into core #26501

jasnell commented Mar 7, 2019

nodejs-github-bot commented Mar 7, 2019

mcollina left a comment

jasnell commented Mar 8, 2019

jasnell commented Mar 9, 2019

mcollina left a comment

jasnell commented Mar 9, 2019 via email

vsemozhetbyt left a comment

jasnell commented Mar 10, 2019

jasnell commented Mar 11, 2019

jasnell commented Mar 11, 2019

jasnell commented Mar 12, 2019

jasnell commented Mar 13, 2019

addaleax commented Mar 13, 2019

joyeecheung left a comment

jasnell commented Mar 13, 2019

jasnell commented Mar 13, 2019

BethGriggs commented Aug 20, 2019

util: integrate node-heapdump into core #26501

util: integrate node-heapdump into core #26501

Conversation

jasnell commented Mar 7, 2019

Checklist

nodejs-github-bot commented Mar 7, 2019

mcollina left a comment

Choose a reason for hiding this comment

jasnell commented Mar 8, 2019

jasnell commented Mar 9, 2019

mcollina left a comment

Choose a reason for hiding this comment

jasnell commented Mar 9, 2019 via email

vsemozhetbyt left a comment

Choose a reason for hiding this comment

jasnell commented Mar 10, 2019

jasnell commented Mar 11, 2019

jasnell commented Mar 11, 2019

jasnell commented Mar 12, 2019

jasnell commented Mar 13, 2019

addaleax commented Mar 13, 2019

joyeecheung left a comment

Choose a reason for hiding this comment

jasnell commented Mar 13, 2019

jasnell commented Mar 13, 2019

BethGriggs commented Aug 20, 2019