oyyd / node-linux-perf

node-linux-perf

Library to replace V8's --perf-basic-prof flag, with the ability to toggle creation of Linux perf map files during runtime.

It's recommended to run Node.js with the --interpreted-frames-native-stack flag enabled, otherwise Linux perf will not be able to translate the name of many JavaScript functions.

Build Status

Version	Status
Node.js v10.x
Node.js v12.x
nodejs/node@master
nodejs/node-v8@canary

Installation

$ npm install linux-perf

Usage

const linuxPerf = require('linux-perf');

// Generated a /tmp/perf-PID.map file and updates it when necessary
linuxPerf.start();

// **YOUR CODE HERE**

// Stops writing to /tmp/perf-PID.map
linuxPerf.stop();

API

start(): bool

Generates a /tmp/perf-PID.map file and updates it when necessary (for example, when new functions are declared). If a /tmp/perf-PID.map file already exists, its content will be erased, and a new file will be generated.

Return: true if the file was generated successfully, false otherwise.

stop(): bool

Stops writing to /tmp/perf-PID.map. The content written on the file is preserved.

Return: true if it was able to stop writting to the file, false otherwise.