Security News
New Proposed CISA Mandate Would Require Critical Infrastructure to Report Ransom Payments Within 24 Hours
CISA has proposed a set of new rules that would require critical infrastructure to report cyber incidents and ransom payments.
node-clinic-heap-profiler
Advanced tools
Programmable interface to Clinic.js Heap Profiler
Weekly downloads
Readme
Programmable interface to Clinic.js Heap Profiler. Learn more about Clinic.js: https://clinicjs.org/
const ClinicHeapProfiler = require('@nearform/clinic-heap-profiler')
const heapProfiler = new ClinicHeapProfiler()
heapProfiler.collect(['node', './path-to-script.js'], function (err, filepath) {
if (err) throw err
heapProfiler.visualize(filepath, filepath + '.html', function (err) {
if (err) throw err
})
})
const ClinicHeapProfiler = require('@nearform/clinic-heap-profiler')
const heapProfiler = new ClinicHeapProfiler()
<Object>
<boolean>
Default: false<boolean>
If set to true, the collected data will be returned even if the process exits with non-zero code.
Default: false<boolean>
If set to true, the generated html will not be minified.
Default: false<String>
The file where the collected data is stored.
Default: ./.clinic/<process.pid>.clinic-heapprofile
heapProfiler.collect(args, callback)
Starts a process by using @nearform/heap-profiler.
The process sampling is started as soon as the process starts. The filepath with collected data will be the value in the callback.
stdout
, stderr
, and stdin
will be relayed to the calling process.
The sampling is stopped and data collected right before the process exits.
If you want to collect data earlier, you can send the process a SIGINT
or, if detectPort
is true
, you can call heapProfiler.stopViaIPC()
.
heapProfiler.visualize(dataFilename, outputFilename, callback)
Will consume the datafile specified by dataFilename
, this datafile will be
produced by the sampler using heapProfiler.collect
.
heapProfiler.visualize
will then output a standalone HTML file to outputFilename
.
When completed the callback
will be called with no extra arguments, except a
possible error.
heapProfiler.stopViaIPC()
When the profiler is started with detectPort=true
, the profiler establish a TCP based IPC communication.
This method can therefore be called to collect the data at any time.
If no TCP channel is opened or available, the method will perform no operation so it is safe to call at all times.
See the examples
folder. All example should be run from the repository main folder:
node examples/redis-web-service
Each index.js
will contain any specific setup step required by the example, if any.
FAQs
Programmable interface to Clinic.js Heap Profiler
The npm package node-clinic-heap-profiler receives a total of 113 weekly downloads. As such, node-clinic-heap-profiler popularity was classified as not popular.
We found that node-clinic-heap-profiler demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer 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 has proposed a set of new rules that would require critical infrastructure to report cyber incidents and ransom payments.
Security News
Redis is no longer OSS, breaking its explicit commitment to remain under the BSD 3-Clause License forever. This has angered contributors who are now working to fork the software.
Product
Socket AI now enables 'AI detected potential malware' alerts by default, ensuring users benefit from AI-powered state-of-the-art malware detection without needing to opt-in.