Skip to content

doc: add note on process memoryUsage #59026

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

Closed
wants to merge 5 commits into from
Closed

doc: add note on process memoryUsage #59026

Changes from 3 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
bc40868
doc: add rss leak note on process memoryUsage
fengmk2 Jul 11, 2025
bc0ba24
Update process.md
fengmk2 Jul 11, 2025
d0c487e
Update process.md
fengmk2 Jul 11, 2025
2dbee98
Update doc/api/process.md
fengmk2 Jul 11, 2025
223213f
Update process.md
fengmk2 Jul 11, 2025
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
10 changes: 10 additions & 0 deletions doc/api/process.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2807,6 +2807,14 @@ The `process.memoryUsage()` method iterates over each page to gather
information about memory usage which might be slow depending on the
program memory allocations.

### A note on process memoryUsage

Once you notice that the `rss` continues to rise while the `heapTotal` shows normal,
and the `rss` is more than three times higher than the `heapTotal`,
it is very likely that there is an issue with an external memory leak.
Referer to the discussions in [nodejs/node#21973][] and [nodejs/help#1942][] for
suggestions on switching the system's default `malloc` to `jemalloc` to try to resolve such issues.

## `process.memoryUsage.rss()`

<!-- YAML
Expand Down Expand Up @@ -4547,6 +4555,8 @@ cases:
[debugger]: debugger.md
[deprecation code]: deprecations.md
[loading ECMAScript modules using `require()`]: modules.md#loading-ecmascript-modules-using-require
[nodejs/help#1942]: https://github.com/nodejs/help/issues/1942
[nodejs/node#21973]: https://github.com/nodejs/node/issues/21973
[note on process I/O]: #a-note-on-process-io
[process.cpuUsage]: #processcpuusagepreviousvalue
[process_emit_warning]: #processemitwarningwarning-type-code-ctor
Expand Down
Loading