worker: add worker.getMemoryUsage() API #60778
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
nodejs-github-bot
added
c++
Codecov Report❌ Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #60778 +/- ##
==========================================
- Coverage 88.57% 88.54% -0.04%
==========================================
Files 703 703
Lines 208256 208347 +91
Branches 40158 40174 +16
==========================================
+ Hits 184469 184486 +17
- Misses 15824 15851 +27
- Partials 7963 8010 +47
🚀 New features to boost your workflow:
|
addaleax
reviewed
Nov 19, 2025
| Number::New(isolate, heap_stats.external_memory()), | ||
| Number::New(isolate, allocator == nullptr | ||
| ? 0 | ||
| : allocator->total_mem_usage()), |
Member
There was a problem hiding this comment.
There's no guarantee that allocator is still alive at this point
addaleax
reviewed
Nov 19, 2025
| <!-- YAML | ||
| added: | ||
| changes: | ||
| - version: v25.2.0 |
Member
There was a problem hiding this comment.
Suggested change
| - version: v25.2.0 | |
| - version: REPLACEME |
addaleax
reviewed
Nov 19, 2025
| `SharedArrayBuffer` instances within the worker. | ||
| The returned `Promise` rejects with [`ERR_WORKER_NOT_RUNNING`][] if called after | ||
| the worker has stopped. |
Member
There was a problem hiding this comment.
This should explain the relationship to worker.getHeapStatistics() and how it differs from that
Flarna
reviewed
Nov 19, 2025
| Returns an object mirroring [`process.memoryUsage()`][] but scoped to the | ||
| worker's isolate: | ||
| * `rss` {integer} Resident Set Size. This value represents the RSS reported by |
Member
There was a problem hiding this comment.
Isn't RSS a per process thing?
Therefore RSS value should be the same on all workers so quite pointless to read it from a different thread.
Flarna
reviewed
Nov 19, 2025
| added: | ||
| changes: | ||
| - version: v25.2.0 | ||
| pr-url: https://github.com/nodejs/node/pull/REPLACEME |
Member
There was a problem hiding this comment.
Suggested change
| pr-url: https://github.com/nodejs/node/pull/REPLACEME | |
| pr-url: https://github.com/nodejs/node/pull/60778 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
worker.getMemoryUsage()so worker threads can report RSS, heap usage, external memory, and ArrayBuffer statistics.WorkerMemoryUsageTakerplus the per-isolate templates/bindings to expose this data.test/parallel/test-worker-get-memory-usage.js) and document the API indoc/api/worker_threads.md.Testing
python3 tools/test.py parallel/test-worker-get-memory-usageninja -C out/Debug node