Socket
Socket
Sign inDemoInstall

@clinic/heap-profiler

Package Overview
Dependencies
245
Maintainers
4
Versions
7
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

@clinic/heap-profiler

Programmable interface to Clinic.js Heap Profiler


Version published
Maintainers
4
Weekly downloads
19,745
decreased by-31.04%

Weekly downloads

Readme

Source

Clinic.js Heap Profiler

npm version Stability Stable Github Actions build status Downloads Code style

Programmable interface to Clinic.js Heap Profiler. Learn more about Clinic.js: https://clinicjs.org/

screenshot

Issues

To open an issue, please use the main repository with the heapprofiler label.

Installation

npm i -S @clinic/heap-profiler

Supported node versions

  • Node.js 16 and above

Example

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
  })
})

Documentation

const ClinicHeapProfiler = require('@clinic/heap-profiler')
const heapProfiler = new ClinicHeapProfiler()

new ClinicHeapProfiler([settings])

  • settings <Object>
    • detectPort <boolean> Default: false
    • collectOnFailure <boolean> If set to true, the collected data will be returned even if the process exits with non-zero code. Default: false
    • debug <boolean> If set to true, the generated html will not be minified. Default: false
    • dest <String> Destination for the collected data Default: .clinic
    • name <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.

Examples

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.

License

MIT

FAQs

Last updated on 27 Jun 2023

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.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc