@nearform/heap-profiler
Advanced tools
Readme
Heap dump and sample profiler generator for Node.
Just run:
npm install @nearform/heap-profiler
Once installed, the profiler can be used as a preloader that adds a listener to SIGUSR2 signal.
If you start your application like this:
node -r @nearform/heap-profiler index.js
Then you will be able to generate a heap profile and heap snapshot by sending the process a SIGUSR2 signal, like this:
kill -USR2 $PID
The preloader uses the following environment variables to control its behavior:
HEAP_PROFILER_SNAPSHOT: If set to false, it will not generate heap dump snapshots.
HEAP_PROFILER_SNAPSHOT_DESTINATION: The path where to store the snapshot. The default will be a .heapsnapshot in the current directory.
HEAP_PROFILER_PROFILE: If set to false, it will not generate heap sampling profile.
HEAP_PROFILER_PROFILE_DESTINATION: The path where to store the profile. The default will be a .heapprofile in the current directory.
HEAP_PROFILER_PROFILE_INTERVAL: Heap sampling profile interval, in bytes. Default is 32768 (32KB).
HEAP_PROFILER_PROFILE_DURAITON: Heap sampling profile in milliseconds. Default is 10000 (10 seconds).
All module functions can be used with promises and by providing a callback as last option.
The promise resolved value (or the callback argument) will be the generated file path.
The available functions are:
generateHeapSnapshot([options], [callback]): Generates a heap dump
destination: The path where to store the snapshot. The default will be a .heapsnapshot in the current directory.generateHeapSamplingProfile([options], [callback]): Generates a heap sampling profiler. The valid options are:
destination: The path where to store the profile. The default will be a .heapprofile in the current directory.interval: Sample interval, in bytes. Default is 32768 (32KB).duration: Sample duration, in milliseconds. Default is 10000 (10 seconds).Generating a heap dump snapshot is handled synchronously by Node and therefore will block your process completely.
Generating a heap sampling profile is instead asynchronous and lightweight. Our test showed that the performance decrease is around 10%.
See CONTRIBUTING.md
Copyright NearForm Ltd 2020. Licensed under the Apache-2.0 license.
FAQs
Heap dump, sample profiler and allocation timeline generator for Node.
We found that @nearform/heap-profiler demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 34 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
CISA launched a new project called Vulnrichment to enrich CVEs with details that help prioritize patching and mitigation efforts, as the NVD backlog of unenriched CVEs awaiting analysis surpasses 10,000.
Security News
Socket is joining forces with CISA and other industry leaders at the RSA Conference to sign the Secure by Design pledge, committing to uphold the highest security standards in our products.
Research
The Socket research team breaks down a sampling of malicious packages that download and execute files, among other suspicious behaviors, targeting the popular Discord platform.