process: add _getActiveHandles documentation - #37261
Conversation
Sorry, something went wrong.
Documenting activeHandles documentation in the process API which can be used by the developers to make functions/modules to track the health of their node process.
mscdex
left a comment
There was a problem hiding this comment.
I think we should instead strive to either remove the "private" underscore prefix or come up with an alternative public API that achieves the same goal. We should not make a habit of documenting private properties/methods, no matter how useful they might seem.
Sorry, something went wrong.
| The return value includes fractions of a second. Use `Math.floor()` to get whole | ||
| seconds. | ||
|
|
||
| ## `process._getActiveHandles()` |
There was a problem hiding this comment.
| ## `process._getActiveHandles()` | |
| ## `process.getActiveHandles()` |
Sorry, something went wrong.
|
|
||
| * Returns: {Array} | ||
|
|
||
| The `process.getActiveHandles` method returns the list of handles that are |
There was a problem hiding this comment.
| The `process.getActiveHandles` method returns the list of handles that are | |
| The `process.getActiveHandles()` method returns the list of handles that are |
Sorry, something went wrong.
| currently opened up by the process. These can be open file descriptors, | ||
| conenction, resources that are actively being held by the process. |
There was a problem hiding this comment.
| currently opened up by the process. These can be open file descriptors, | |
| conenction, resources that are actively being held by the process. | |
| currently acquired by the process. These can be open file descriptors, | |
| connections, and resources. |
Sorry, something went wrong.
|
This issue/PR was marked as stalled, it will be automatically closed in 30 days. If it should remain open, please leave a comment explaining why it should remain open. |
Sorry, something went wrong.
|
btw, that public property already exists in Node.js, see #40813, and it is already documented (https://nodejs.org/api/process.html#processgetactiveresourcesinfo) |
Sorry, something went wrong.
|
This issue/PR was marked as stalled, it will be automatically closed in 30 days. If it should remain open, please leave a comment explaining why it should remain open. |
Sorry, something went wrong.
Documenting activeHandles documentation in the process API which can be
used by the developers to make functions/modules to track the health of
their node process.
Though i am aware of the reason that why it is not documented yet, even though being very
much helpful for instrumentation of process stats. I might be lacking some
information around the context but wanted to float this PR so that iteration can
be done on this PR and developers are aware of this awesome function.