prometheus / prometheus/client_js
process_heap_bytes
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 3.5k
- Forks
- 429
- Avg merge
- 3d 3h
- Merged PRs (30d)
- 22
Description
Hello @SimenB,
in https://github.com/siimon/prom-client/blob/master/lib/metrics/osMemoryHeapLinux.js prom-client exports metrics - process_heap_bytes.
This value collected from VmData value of /proc/self/status file.
VmData - is a data segment size, not the size of process heap. From one side - it does not include large objects heap because large objects allocated through mmap sys call, on the other side it does include statically allocated data structures (global data).
So its looks like "process_heap_bytes" is a misleading name for the metric. We should call it "process_data_segment_size" or something like that.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with lib/metrics/osMemoryHeapLinux.js and inspect how process_heap_bytes is collected from /proc/self/status. Decide on a name that accurately reflects VmData's data-segment meaning, then update the exported metric so its name is no longer misleading and verify the module remains consistent.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript, node.js
- Domain
- observability
- Issue type
- Bug
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100