Skip to content

doc: adds details about rss on process.memoryUsage #16566

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
profnandaa wants to merge 2 commits into from
Closed

doc: adds details about rss on process.memoryUsage #16566

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
cea1c2d
doc: adds details about rss on process.memoryUsage
profnandaa Oct 27, 2017
441a499
doc: adds more clarity on rss
profnandaa Oct 28, 2017
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
Next Next commit
doc: adds details about rss on process.memoryUsage 
`process.memoryUsage()` returns an object with 4 keys: `rss,
heapTotal, headUsed, external`. There were brief explanations for
the rest except `rss`. This commit adds this on the docs.
  • Loading branch information
@profnandaa
profnandaa committed Oct 27, 2017
commit cea1c2d52c4c65e50b9ab7527d863ce19a93b22d
7 changes: 6 additions & 1 deletion doc/api/process.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1282,7 +1282,12 @@ Will generate:

`heapTotal` and `heapUsed` refer to V8's memory usage.
`external` refers to the memory usage of C++ objects bound to JavaScript
objects managed by V8.
objects managed by V8. `rss`, Resident Set Size, is the total space allocated in
memory for the process, which includes the _heap_, _code segment_ and _stack_.

Copy link
Copy Markdown
Member

@gireeshpunathil gireeshpunathil Oct 28, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A little more clarity on rss will help people disambiguate it from the virtual memory size.
For example:
rss, Resident Set Size, is the amount of space occupied in the main memory device (that is a subset of the total allocated memory) for the process, which includes the heap, code segment and stack.

Copy link
Copy Markdown
Contributor Author

@profnandaa profnandaa Oct 28, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Makes sense, thanks. Fixing 👍

The _heap_ is where objects, strings and closures are stored. Variables are
stored in the _stack_ and the actual JavaScript code resides in the
_code segment_.

## process.nextTick(callback[, ...args])
<!-- YAML
Expand Down