Skip to content

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

Closed
profnandaa wants to merge 2 commits intonodejs:masterfrom
profnandaa:docs-process-memory-usage
Closed

doc: adds details about rss on process.memoryUsage#16566
profnandaa wants to merge 2 commits intonodejs:masterfrom
profnandaa:docs-process-memory-usage

Conversation

@profnandaa
Copy link
Contributor

@profnandaa profnandaa commented Oct 27, 2017 •
edited
Loading

Checklist
Affected core subsystem(s)

doc

cc. @refack

@profnandaa
doc: adds details about rss on process.memoryUsage
cea1c2d 
`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.
@nodejs-github-bot nodejs-github-bot added doc Issues and PRs related to the documentations. process Issues and PRs related to the process subsystem. labels Oct 27, 2017
@vsemozhetbyt vsemozhetbyt added the memory Issues and PRs related to the memory management or memory footprint. label Oct 27, 2017
@refack
Copy link
Contributor

refack commented Oct 27, 2017

@profnandaa welcome. If you haven't already, it's recommended you take a look at CONTRIBUTING.md guide (especially the part about "discuss and update"). Customarily PRs are kept open for at least 48 hours so that anyone interested gets a chance to comment or review.
Also documentation changes, while easy to do are more difficult to validate. With code we can write tests and the CI can validate the change. With documentation the only way to validate is with human eyes, so don't be dismayed if you get a lot of feedback.
Anyway thank you for the contribution, and good luck 🥇

P.S. If you have any question you can also feel free to contact me directly.

@profnandaa
Copy link
Contributor Author

profnandaa commented Oct 27, 2017

@refack - sure, I was actually still reading through it, came across that. Sounds good. Thanks for the encouragement, I know I'll learn from all the comments that are going to come through :)

gireeshpunathil
gireeshpunathil reviewed Oct 28, 2017
View reviewed changes
doc/api/process.md
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
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
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 👍

@profnandaa
doc: adds more clarity on rss
441a499 
A little more clarity on `rss` to help people disambiguate it from
the virtual memory size.

Refs: nodejs#16566 (comment)
@andela-anandaa andela-anandaa force-pushed the docs-process-memory-usage branch from 93b7e9b to 441a499 Compare October 28, 2017 08:08
@watilde
Copy link
Member

watilde commented Oct 28, 2017

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

vsemozhetbyt pushed a commit that referenced this pull request Nov 2, 2017
@profnandaa @vsemozhetbyt
doc: add details about rss on process.memoryUsage
367db92 
1. `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.

2. A little more clarity on `rss` to help people disambiguate it from
the virtual memory size.

PR-URL: #16566
Refs: #16566 (comment)
Reviewed-By: Refael Ackermann <refack@gmail.com>
Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
@vsemozhetbyt
Copy link
Contributor

vsemozhetbyt commented Nov 2, 2017

Landed in 367db92

Thank you!

@andela-anandaa andela-anandaa deleted the docs-process-memory-usage branch November 2, 2017 19:09
@andela-anandaa andela-anandaa restored the docs-process-memory-usage branch November 2, 2017 19:09
@profnandaa profnandaa deleted the docs-process-memory-usage branch November 2, 2017 19:10
cjihrig pushed a commit to cjihrig/node that referenced this pull request Nov 6, 2017
@profnandaa @cjihrig
doc: add details about rss on process.memoryUsage
09181eb 
1. `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.

2. A little more clarity on `rss` to help people disambiguate it from
the virtual memory size.

PR-URL: nodejs#16566
Refs: nodejs#16566 (comment)
Reviewed-By: Refael Ackermann <refack@gmail.com>
Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
@cjihrig cjihrig mentioned this pull request Nov 6, 2017
Merged
gibfahn pushed a commit that referenced this pull request Nov 14, 2017
@profnandaa @gibfahn
doc: add details about rss on process.memoryUsage
542f3b9 
1. `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.

2. A little more clarity on `rss` to help people disambiguate it from
the virtual memory size.

PR-URL: #16566
Refs: #16566 (comment)
Reviewed-By: Refael Ackermann <refack@gmail.com>
Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
MylesBorins pushed a commit that referenced this pull request Nov 14, 2017
@profnandaa @MylesBorins
doc: add details about rss on process.memoryUsage
290df5a 
1. `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.

2. A little more clarity on `rss` to help people disambiguate it from
the virtual memory size.

PR-URL: #16566
Refs: #16566 (comment)
Reviewed-By: Refael Ackermann <refack@gmail.com>
Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
@MylesBorins MylesBorins mentioned this pull request Nov 21, 2017
Merged
@gibfahn gibfahn mentioned this pull request Nov 21, 2017
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@jasnell jasnell jasnell approved these changes

@lpinca lpinca lpinca approved these changes

@gireeshpunathil gireeshpunathil gireeshpunathil approved these changes

+2 more reviewers

@refack refack refack approved these changes

@gibfahn gibfahn gibfahn approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

doc Issues and PRs related to the documentations. memory Issues and PRs related to the memory management or memory footprint. process Issues and PRs related to the process subsystem.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

10 participants

@profnandaa @refack @watilde @vsemozhetbyt @jasnell @lpinca @gireeshpunathil @gibfahn @MylesBorins @nodejs-github-bot