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

Add additional documentation for heap snapshot flag #28754

Closed
wants to merge 4 commits into from
Closed

Add additional documentation for heap snapshot flag #28754

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
3492d06
Add additional documentation for heap snapshot flag
tstirrat15 Jul 18, 2019
6346740
Lint fix
tstirrat15 Jul 19, 2019
47fb8b4
Add console highlighting
tstirrat15 Jul 19, 2019
7e008fa
Remove trailing whitespace
tstirrat15 Jul 19, 2019
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
13 changes: 13 additions & 0 deletions doc/api/cli.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -216,6 +216,19 @@ reference. Code may break under this flag.
added: v12.0.0
-->

Enables a signal handler that causes the Node.js process to write a heap dump
when the specified signal is received.

```console
$ node --heapsnapshot-signal=SIGUSR2 index.js &
$ ps aux
USER PID %CPU %MEM VSZ RSS TTY STAT START TIME COMMAND
node 1 5.5 6.1 787252 247004 ? Ssl 16:43 0:02 node --heapsnapshot-signal=SIGUSR2 index.js
$ kill -USR2 1
$ ls
Heap.20190718.133405.15554.0.001.heapsnapshot
```

### `--heap-prof`
<!-- YAML
added: v12.4.0
Expand Down