To help you get started, we've collected the most common ways that pprof is being used within popular public projects.

googleapis / cloud-profiler-nodejs / ts / src / index.ts View on Github

if (!nodeVersionOkay(process.version)) {
    throw new Error(
      `Could not start profiler: node version ${process.version}` +
        ` does not satisfies "${pjson.engines.node}"` +
        '\nSee https://github.com/GoogleCloudPlatform/cloud-profiler-nodejs#prerequisites' +
        ' for details.'
    );
  }

  let profilerConfig: ProfilerConfig = initConfigLocal(config);

  // Start the heap profiler if profiler config does not indicate heap profiling
  // is disabled. This must be done before any asynchronous calls are made so
  // all memory allocations made after start() is called can be captured.
  if (!profilerConfig.disableHeap) {
    heapProfiler.start(
      profilerConfig.heapIntervalBytes,
      profilerConfig.heapMaxStackDepth
    );
  }
  profilerConfig = await initConfigMetadata(profilerConfig);
  return new Profiler(profilerConfig);
}

View more ways to use pprof

pprof support for Node.js

pprof support for Node.js.

Prerequisites

1. Your application will need to be using Node.js 14 or greater. This package is tested against current versions of Node.js: 14, 16, 18, and 20.

2. The pprof module has a native component that is used to collect profiles with v8's CPU and Heap profilers. You may need to install additional dependencies to build this module.

   • For Linux: pprof has prebuilt binaries available for Linux and Alpine Linux for Node 14 and 16. No additional dependencies are required.
   • For other environments: when using @google-cloud/profiler on environments that pprof does not have prebuilt binaries for, the module node-gyp will be used to build binaries. See node-gyp's documentation for information on dependencies required to build binaries with node-gyp.

3. The pprof CLI can be used to view profiles collected with this module. Instructions for installing the pprof CLI can be found here.

Basic Set-up

Install pprof with npm or add to your package.json.

# Install through npm while saving to the local 'package.json'
npm install --save pprof

Using the Profiler

Collect a Wall Time Profile

In code:

1. Update code to collect and save a profile:

   const profile = await pprof.time.profile({
     durationMillis: 10000,    // time in milliseconds for which to 
                               // collect profile.
   });
   const buf = await pprof.encode(profile);
   fs.writeFile('wall.pb.gz', buf, (err) => {
     if (err) throw err;
   });
   

2. View the profile with command line pprof:

   pprof -http=: wall.pb.gz
   

Requiring from the command line

1. Start program from the command line:

   node --require pprof app.js
   

2. A wall time profile for the job will be saved in pprof-profile-${process.pid}.pb.gz. View the profile with command line pprof:

   pprof -http=: pprof-profile-${process.pid}.pb.gz
   

Collect a Heap Profile

1. Enable heap profiling at the start of the application:

   // The average number of bytes between samples.
   const intervalBytes = 512 * 1024;
   
   // The maximum stack depth for samples collected.
   const stackDepth = 64;
   
   heap.start(intervalBytes, stackDepth); 
   

2. Collect heap profiles:

   • Collecting and saving a profile in profile.proto format:

     const profile = await pprof.heap.profile();
     const buf = await pprof.encode(profile);
     fs.writeFile('heap.pb.gz', buf, (err) => {
       if (err) throw err;
     })
     

   • View the profile with command line pprof.

     pprof -http=: heap.pb.gz
     

   • Collecting a heap profile with V8 allocation profile format:

       const profile = await pprof.heap.v8Profile();