Skip to content
Production friendly Node.js module that provides access to the V8 sampling heap profiler
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci build!: drop support for Node 6 (#37) Apr 26, 2019
bindings feat: ability to configure sampling interval and stack depth. (#17) Apr 24, 2018
doc doc: add screenshot, tweak README (#7) Nov 30, 2017
src chore(deps): upgrade to gts@1 (#38) Apr 30, 2019
test chore(deps): upgrade to gts@1 (#38) Apr 30, 2019
testing build: run in correct directory Dec 11, 2018
.gitignore chore: update circle config (#28) Dec 6, 2018
CONTRIBUTING.md initial version Oct 4, 2017
LICENSE
README.md doc: remove experimental from docs (#35) Apr 23, 2019
binding.gyp fix(build): ability to build with latest XCode on Mojave (#21) Sep 20, 2018
package-lock.json chore(deps): upgrade to gts@1 (#38) Apr 30, 2019
package.json chore(deps): upgrade to gts@1 (#38) Apr 30, 2019
tsconfig.json refactor,feat: switch to TypeScript, add get (#4) Nov 28, 2017

README.md

Sampling Heap Profiler

style badge CircleCI

This module adds supports for the Sampling Heap Profiler in V8. This works by taking a random sample of objects, as they are allocated, to keep a statistical sample of what is live in the heap at any given time. This also keeps track of the stack that allocated a given sampled object. This means that you know not only what is live, but what code path allocated it. This is motivated by, and functions similarly to, the heap profiler built into tcmalloc.

  • This is supposed to be lightweight enough for in-production use on servers.
  • The generated snapshots can be saved offline, and be opened in DevTools later.

app.get seems to be leaking

Usage

const heapProfile = require('heap-profile');

heapProfile.start();

// Write a snapshot to disk every hour
setInterval(() => {
  heapProfile.write((err, filename) => {
    console.log(`heapProfile.write. err: ${err} filename: ${filename}`);
  });
}, 60 * 60 * 1000).unref();

heapProfile.start()

Starts sampling. You probably want to call this as close to the program startup as possible.

heapProfile.get(translate?: boolean)

Returns the profile composed of a tree of nodes (V8 format). When the optional parameter translate is true, the returned profile is in DevTools format.

heapProfile.write()

This function is overloaded with the following variants:

function write(): Promise<string>;
function write(path: string): Promise<string>;
function write(cb: Callback): void;
function write(path: string, cb: Callback): void;

interface Callback { (err: Error|null, path?: string): void; }

Writes the current heap sample to the path specified. If the path parameter is omitted, a file with the pattern heap-profile-${Date.now()}.heapprofile will be written to the current working directory.

The callback returns error if profiling was not active at the time of call. Otherwise the output file path is returned via the callback or the promise.

stop()

Stops sampling and discard the current set of tracked sampled objects. You can call start again to start sampling again, but any objects allocated before start is called cannot be sampled, which means that the profile will not be representative of the state of the heap.

The sampling overhead is low enough that you probably don't need to use stop.

You can’t perform that action at this time.