gp

gc-profiler

Allows you to profile when the garbage collector runs, and how long it takes.

Showing:

Popularity

Downloads/wk

4K

GitHub Stars

188

Maintenance

Last Commit

2mos ago

Contributors

4

Package

Dependencies

1

License

MIT

Type Definitions

Tree-Shakeable

No?

Categories

Readme

node-gc-profiler

A cross-platform (tested on Linux, Windows, and OSX) profiler for the v8 garbage collector running inside Node.js. It will emit an event after every GC cycle providing you information about the duration and type of cycle.

npm install gc-profiler

Example:

var profiler = require('gc-profiler');
profiler.on('gc', function (info) {
  console.log(info);
});

The info object contains the following properties:

PropertyTypeDescription
dateDateThe approximate start time of the GC cycle. This uses the c++ time library internally, which only has one-second resolution.
durationnumberThe duration of the GC cycle in milliseconds.
typestringEither Scavenge or MarkSweepCompact depending on the type of GC cycle.
forcedbooleanTrue for a forced cycle.
flagsnumberThe raw GCCallbackFlags provided from v8.

The profiler.GCCallbackFlags enumeration is provided to help decode the flags property.

profiler.GCCallbackFlags = {
  kNoGCCallbackFlags: 0,
  kGCCallbackFlagCompacted: 1 << 0, // this flag is never set in v8 versions >= 3.6.5
  kGCCallbackFlagConstructRetainedObjectInfos: 1 << 1,
  kGCCallbackFlagForced: 1 << 2
};

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100
No reviews found
Be the first to rate

Alternatives

No alternatives found

Tutorials

No tutorials found
Add a tutorial