Security News
tea.xyz Spam Plagues npm and RubyGems Package Registries
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
@clinic/heap-profiler
Advanced tools
Readme
Programmable interface to Clinic.js Heap Profiler. Learn more about Clinic.js: https://clinicjs.org/
To open an issue, please use the main repository with the heapprofiler
label.
npm i -S @clinic/heap-profiler
const ClinicHeapProfiler = require('@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('@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>
Destination for the collected data
Default: .clinic
<String>
File name for the collected data
Default: <process.pid>.clinic-heapprofiler
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 @clinic/heap-profiler receives a total of 16,095 weekly downloads. As such, @clinic/heap-profiler popularity was classified as popular.
We found that @clinic/heap-profiler demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 4 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
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
Security News
As cyber threats become more autonomous, AI-powered defenses are crucial for businesses to stay ahead of attackers who can exploit software vulnerabilities at scale.
Security News
UnitedHealth Group disclosed that the ransomware attack on Change Healthcare compromised protected health information for millions in the U.S., with estimated costs to the company expected to reach $1 billion.