node-oom-heapdump 2.1.0-progress.1 → 3.0.1-beta

package/.eslintrc.js

@@ -1,3 +1,3 @@
-module.exports = {
-    "extends": "google"
+module.exports = {
+    "extends": "google"
 };

package/.travis.yml

@@ -1,9 +1,13 @@
-language: node_js
-node_js:
-  - "7"
-  - "8"
-  - "9"
-  - "10"
-  - "11"
-  - "12"
-script: npm run dummy
+language: node_js
+node_js:
+  - "7"
+  - "8"
+  - "9"
+  - "10"
+  - "11"
+  - "12"
+  - "13"
+  - "14"
+  - "15"
+  - "16"
+script: npm run dummy

package/CHANGELOG.md

@@ -1,84 +1,107 @@
-20-07-2020  Paul Rütter
-- 2.0
-- Added prebuilt binaries again, in a new major version. To "solve" https://github.com/blueconic/node-oom-heapdump/issues/13.
-
-20-07-2020  Paul Rütter
-- 1.3.1
-- Revert prebuilt binaries, since it's a breaking change.
-
-24-06-2020 Stuart Miller / Paul Rütter
-- 1.3.0
-- Stuart Miller added support for having prebuilt binaries for all supported Node.js versions.
-
-16-10-2019 Paul Rütter
-- 1.2.0
-- Node 12 support.
-- Still some deprecated API's are used, which should be avoided.
-See https://github.com/joyeecheung/node/blob/v8-maybe-doc/CPP_STYLE_GUIDE.md#use-maybe-version-of-v8-apis
-- Adjusted test script a bit, by removing some flags which seem to complicate nodejs 12 support.
-
-02-09-2019 Paul Rütter
-- 1.2.0-beta.0
-- Updated dependencies (nan update is needed for nodejs 12)
-- Add nodejs 12 to travis
-- Add experimental node 12 support. Still some deprecated API's are used, which should be avoided.
-See https://github.com/joyeecheung/node/blob/v8-maybe-doc/CPP_STYLE_GUIDE.md#use-maybe-version-of-v8-apis
-
-02-01-2019 Paul Rütter
-- 1.1.4
-- Updated dependencies
-- Add travis file to trigger a build. Just run a dummy script which does nothing; the default "npm install" will check if the native module compiles.
-
-09-06-2018 Paul Rütter
-- 1.1.3 - Updated dependencies, to mitigate security issues.
-
-02-20-2018 Paul Rütter
-- 1.1.2 - Fixed heapdump generation on Unix machines.
-- Added option to use the "old" implementation (GCmonitoring), as the new implementatuion is more prone to run in with the OoM killer when in memory restricted environments (like Docker). The old implementation was less impacted by this, because the "threshold" parameter can be used to create the heapdump earlier.
-You can specify which OoM implementation to use, either: "NATIVE_HOOK" (default) or "GC_MONITORING" (old implementation).
-
-02-19-2018 Paul Rütter
-- 1.1.0 - Changed the way the "out of memory" heapdump is created, based on the work of 'trevnorris' (https://github.com/trevnorris/node-ofe/blob/master/ofe.cc). Using V8 engine isolate.SetOOMErrorHandler() to hook in on the out of memory event.
-- Updated readme and removed deprecated 'limit' and 'threshold' parameters.
-- Removed 'gc-stats' module, as we no longer need it with the native C++ add-on.
-
-02-13-2018 - Paul Rütter
-- 1.0.12 - Use 'require-main-filename' instead of require.main.filename, to resolve 'https://github.com/blueconic/node-oom-heapdump/issues/3'.
-- Upgrade dependencies
-
-11-21-2017 - Paul Rütter
-- 1.0.11 - Added port verification; when the module is loaded, the configured WebSocket port is verified. If the websocket responds with ECONNREFUSED, the process might have been started without the --inspect flag.
-
-11-17-2017 - Paul Rütter
-- 1.0.10 - Use gc-stats to calculate when to make a OoM heapdumo instead of process.memoryUsage() as this memory information (heapTotal) is growing over time, which is not expected.
-- Stringify gc-stats output, so it runs over only 1 line.
-
-06-10-2017 - Paul Rütter
-- 1.0.9 - Handle exit codes better and reject promise if so.
-
-05-10-2017 - Paul Rütter
-- 1.0.8 - Add CPU profile functionality.
-
-04-10-2017 - Paul Rütter
-- 1.0.7 - Add addTimestamp option.
-
-04-10-2017 - Paul Rütter
-- 1.0.6 - Add limit option.
-
-03-10-2017 - Paul Rütter
-- 1.0.5 - Change heap calculation.
-
-03-10-2017 - Paul Rütter
-- 1.0.4 - Add error handler in case the calling process is not running anymore. Also, block execution a while to allow heapdump to be created.
-
-01-10-2017 - Paul Rütter
-- 1.0.3 - Minor doc changes.
-
-01-10-2017 - Paul Rütter
-- 1.0.2 - Refactored code; split up API and implementation. Also added API for creating heapdumps on the fly. Documentation updated.
-
-29-09-2017 - Paul Rütter
-- 1.0.1 - minor changed
-
-29-09-2017 - Paul Rütter
-- 1.0.1 - initial version
+09-02-2022 Paul Rütter
+- 3.0.0
+- Updated dependencies to resolve https://github.com/blueconic/node-oom-heapdump/issues/19
+- Removed `gc-stats` as it was not used a lot anymore (breaking change) and contained security issues.
+- Removed creating heapdumps on out of memory, as this is superseeded by native node functionality.
+- Remove unused dependencies and native code.
+
+21-12-2020 Paul Rütter
+- 2.2.0
+- Updated ini
+
+12-10-2020 Paul Rütter
+- 2.1.0
+- Added Node 14 support
+
+12-10-2020  Paul Rütter
+- 2.0.2
+- Fix latest published version, was replaced with beta.
+
+02-08-2020  Paul Rütter
+- 2.0.1
+- Fixed prebuilt binaries path.
+
+20-07-2020  Paul Rütter
+- 2.0
+- Added prebuilt binaries again, in a new major version. To "solve" https://github.com/blueconic/node-oom-heapdump/issues/13.
+
+20-07-2020  Paul Rütter
+- 1.3.1
+- Revert prebuilt binaries, since it's a breaking change.
+
+24-06-2020 Stuart Miller / Paul Rütter
+- 1.3.0
+- Stuart Miller added support for having prebuilt binaries for all supported Node.js versions.
+
+16-10-2019 Paul Rütter
+- 1.2.0
+- Node 12 support.
+- Still some deprecated API's are used, which should be avoided.
+See https://github.com/joyeecheung/node/blob/v8-maybe-doc/CPP_STYLE_GUIDE.md#use-maybe-version-of-v8-apis
+- Adjusted test script a bit, by removing some flags which seem to complicate nodejs 12 support.
+
+02-09-2019 Paul Rütter
+- 1.2.0-beta.0
+- Updated dependencies (nan update is needed for nodejs 12)
+- Add nodejs 12 to travis
+- Add experimental node 12 support. Still some deprecated API's are used, which should be avoided.
+See https://github.com/joyeecheung/node/blob/v8-maybe-doc/CPP_STYLE_GUIDE.md#use-maybe-version-of-v8-apis
+
+02-01-2019 Paul Rütter
+- 1.1.4
+- Updated dependencies
+- Add travis file to trigger a build. Just run a dummy script which does nothing; the default "npm install" will check if the native module compiles.
+
+09-06-2018 Paul Rütter
+- 1.1.3 - Updated dependencies, to mitigate security issues.
+
+02-20-2018 Paul Rütter
+- 1.1.2 - Fixed heapdump generation on Unix machines.
+- Added option to use the "old" implementation (GCmonitoring), as the new implementatuion is more prone to run in with the OoM killer when in memory restricted environments (like Docker). The old implementation was less impacted by this, because the "threshold" parameter can be used to create the heapdump earlier.
+You can specify which OoM implementation to use, either: "NATIVE_HOOK" (default) or "GC_MONITORING" (old implementation).
+
+02-19-2018 Paul Rütter
+- 1.1.0 - Changed the way the "out of memory" heapdump is created, based on the work of 'trevnorris' (https://github.com/trevnorris/node-ofe/blob/master/ofe.cc). Using V8 engine isolate.SetOOMErrorHandler() to hook in on the out of memory event.
+- Updated readme and removed deprecated 'limit' and 'threshold' parameters.
+- Removed 'gc-stats' module, as we no longer need it with the native C++ add-on.
+
+02-13-2018 - Paul Rütter
+- 1.0.12 - Use 'require-main-filename' instead of require.main.filename, to resolve 'https://github.com/blueconic/node-oom-heapdump/issues/3'.
+- Upgrade dependencies
+
+11-21-2017 - Paul Rütter
+- 1.0.11 - Added port verification; when the module is loaded, the configured WebSocket port is verified. If the websocket responds with ECONNREFUSED, the process might have been started without the --inspect flag.
+
+11-17-2017 - Paul Rütter
+- 1.0.10 - Use gc-stats to calculate when to make a OoM heapdumo instead of process.memoryUsage() as this memory information (heapTotal) is growing over time, which is not expected.
+- Stringify gc-stats output, so it runs over only 1 line.
+
+06-10-2017 - Paul Rütter
+- 1.0.9 - Handle exit codes better and reject promise if so.
+
+05-10-2017 - Paul Rütter
+- 1.0.8 - Add CPU profile functionality.
+
+04-10-2017 - Paul Rütter
+- 1.0.7 - Add addTimestamp option.
+
+04-10-2017 - Paul Rütter
+- 1.0.6 - Add limit option.
+
+03-10-2017 - Paul Rütter
+- 1.0.5 - Change heap calculation.
+
+03-10-2017 - Paul Rütter
+- 1.0.4 - Add error handler in case the calling process is not running anymore. Also, block execution a while to allow heapdump to be created.
+
+01-10-2017 - Paul Rütter
+- 1.0.3 - Minor doc changes.
+
+01-10-2017 - Paul Rütter
+- 1.0.2 - Refactored code; split up API and implementation. Also added API for creating heapdumps on the fly. Documentation updated.
+
+29-09-2017 - Paul Rütter
+- 1.0.1 - minor changed
+
+29-09-2017 - Paul Rütter
+- 1.0.1 - initial version

package/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2017 BlueConic
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c) 2017 BlueConic
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,143 +1,129 @@
-[![TravisCI Build Status](https://travis-ci.org/blueconic/node-oom-heapdump.svg?branch=master)](https://travis-ci.org/blueconic/node-oom-heapdump)
-
-# node-oom-heapdump
-Node module which will create a V8 heap snapshot right before an "Out of Memory" error occurs.
-
-It can also create heapdumps and CPU profiles on request like 'v8-profiler', but does this off-process so it doesn't interfere with execution of the main process.
-
-Tested on Node.js 7.x, 8.x, 9.x, 10.x, 11.x and 12.x.
-No support for Node.js < 7.0 at the moment (although this can be fixed if needed).  
-
-Also comes with prebuilt binaries (hosted on Github releases), thanks to Stuart Miller (https://github.com/spmiller).
-
-# Why?
-When running nodejs processes in a low memory environment, every out of memory that occurs is interesting.
-To figure out why a process went out of memory, a heap snapshot (e.g. heapdump) can help a lot.
-This module creates a heap snapshot right before an out of memory error occurs (by leveraging 'SetOOMErrorHandler' of the V8 engine).
-It shows what the heap was filled with right before the out of memory error occured and can be opened with Chrome DevTools (Memory tab).
-
-There are several modules around which can create heapdumps (v8-profiler, node-heapdump), but these run in the same process as the one going out of memory. Often, creating heapdump won't work when the node process is already struggling.
-This module creates the heap snapshot from a separate process, which solves this issue.
-Also, these modules are not able to create a heapdump when an out of memory occurs.
-
-# What?
-Based on the work of 'trevnorris' (https://github.com/trevnorris/node-ofe/), this module uses 'isolate.SetOOMErrorHandler' (https://v8docs.nodesource.com/node-8.9/d5/dda/classv8_1_1_isolate.html#a08fd4087f39c33b4ac1c20ad953ce4e3) of the V8 engine, and then creates a heapdump when an actual Out of Memory occurs. To make this happen, a native C++ add-on is used. 
-Node-gyp is needed to compile this add-on.
-
-When creating a heapdump of CPU profile on request, the DevTools protocol is used to create these files (no native add-on).
-The --inspect node.js flag is needed to make this work (which is validated on startup).
-
-# Example
-Just run "npm test" to see it in action. It creates a heapdump named "my_heapdump.heapsnapshot" in the 'tests' directory of this module.
-
-# Usage
-
-```javascript
-npm install node-oom-heapdump
-```
-
-Just add the following snippet to your node process.
-
-```javascript
-let path = require('path');
-require('node-oom-heapdump')({
-    path: path.resolve(__dirname, 'my_heapdump')
-});
-```
-
-To make heapdumps and CPU profiles on request, your node process should at least be started with the "--inspect" (or --inspect=port) flag. When the module is loaded, the configured port is verified. If it doesn't respond correctly, a console warning will be shown.
-
-When running in a low memory environment, the following flags are advised:
-
-* --max_old_space_size=60 - this will limit your heapsize on 60MB
-* --optimize_for_size - keep memory as low as possible (GC more often than usual)
-* --always_compact - keep memory as low as possible (do compactions each GC)
-
-These might impact performance though.
-On Node.js 12.x the latter two flags seem to cause some stability issues (see https://github.com/nodejs/node/issues/27552#issuecomment-542695931). So, if you encounter issues on Node.js 12.x in combination with those flags, please refrain from using these.
-
-# Options
-* heapdumpOnOOM - boolean whether to create a heapdump when an out of memory occurs. Default true.
-* OOMImplementation - Either "NATIVE_HOOK" or "GC_MONITORING". 
-"NATIVE_HOOK" relies on the native v8 hook and makes sure that the heapdump is actually created when the OoM occurs. It's more impacted by the OoMKiller of Unix systems though, when being run in memory restricted environments like Docker. 
-"GC_MONITORING" is the old implementation, which relies on GC monitoring. It's less impacted by OoMKiller, because the 'threshold' parameter determines when to create the heapdump. Use this option when you run into the OoMKiller of the Unix OS. Default is "NATIVE_HOOK".
-* path - the path where the heapdump ends up when an out of memory error occurs. '.heapsnapshot' is automatically appended. Defaults to this modules' directory.
-* addTimestamp - add a timestamp to the out of memory heapdump filename, to make it unique. Default is false.
-* port - optionally, the alternative DevTools protocol port. Defaults to 9229. Should map on the port given to the --inspect arg.
-
-The following options are only relevant when OOMImplementation="GC_MONITORING".
-* limit - optionally, specify a limit to how many heapdumps will be created when being above the threshold. Default is 3.
-* threshold - integer between 0 and 100 (%) which determines when to make the heapdump. When the used heapSize exceeds the threshold, a heapdump is made. This value can be tuned depending on your configuration; if memory usage is very volatile, a lower value might make more sense. Default is 70.
-
-# API
-Besides creating heapdumps when an out of memory error occurs, there also is an API for creating heapdumps and CPU profiles on request. See below for the currently available API.
-
-Notice that you cannot create a heapdump while a CPU profile is being generated and vice versa; an Error will be thrown if this is the case.
-
-```javascript
-let nodeOomHeapdump = require("node-oom-heapdump")({
-  heapdumpOnOOM: false
-});
-
-/**
-  * Returns the path to the created heap snapshot in a promise, or rejects on error
-  * @param {String} snapshotPath - path of the snapshot
-  * @return {Promise} Promise containing the heap snapshot path on success or error on rejection
-  */
-nodeOomHeapdump.createHeapSnapshot("myheapsnapshotpath").then((snapshotPath) => {
-  // do something with heap snapshot
-
-  // and delete again from disk
-  nodeOomHeapdump.deleteHeapSnapshot(snapshotPath);
-}).catch((err) => {
-  // handle error
-});
-
-/**
-  * Deletes all previously created heapsnapshots from disk
-  */
-nodeOomHeapdump.deleteAllHeapSnapshots();
-
-/**
-  * Deletes a particular snapshot from disk
-  * @param {String} snapshotPath - path of the heap snapshot to delete
-  * @return {Promise}
-  */
-nodeOomHeapdump.deleteHeapSnapshot(snapshotPath);
-
-/**
-  * Returns the path to the created CPU profile in a promise, or rejects on error
-  * @param {String} cpuProfilePath - path of the CPU profile
-  * @param {number} duration - the duration of the CPU profile in ms (default: 30000ms)
-  * @return {Promise} the CPU profile path on success or error on rejection
-  */
-nodeOomHeapdump.createCpuProfile("mycpuprofilepath", 10000).then((cpuProfilePath) => {
-  // do something with CPU profile
-
-  // and delete again from disk
-  nodeOomHeapdump.deleteCpuProfile(cpuProfilePath);
-}).catch((err) => {
-  // handle error
-});
-
-/**
-  * Deletes all previously created CPU profiles from disk
-  */
-nodeOomHeapdump.deleteAllCpuProfiles();
-
-/**
-  * Deletes a particular CPU profile from disk
-  * @param {String} cpuProfilePath - path to the CPU profile to delete from disk
-  * @return {Promise}
-  */
-nodeOomHeapdump.deleteCpuProfile(cpuProfilePath);
-```
-
-# Known issues and limitations
-
-## Memory usage
-When creating a heapdump on request, it's notorious for using a lot of memory. This is caused by a bug in V8/DevTools protocol and is reported here (https://bugs.chromium.org/p/chromium/issues/detail?id=768355); the protocol has no backpressure mechanism, which causes the heapdump to be pushed faster than the DevTools client can handle, causing in-memory buffering.
-
-This is not a problem if your server/machine has memory to spare, but can cause issues in memory restricted environments like a Docker container. Once the process exceeds the container memory threshold, it will be killed by OoMKiller (if enabled). This leads to an empty heapsnapshot file (0 bytes).
-
-Please vote for that issue to be fixed!
+[![TravisCI Build Status](https://travis-ci.org/blueconic/node-oom-heapdump.svg?branch=master)](https://travis-ci.org/blueconic/node-oom-heapdump)
+
+# node-oom-heapdump
+Node module that can create heapdumps and CPU profiles on request like 'v8-profiler', but does this off-process so it doesn't interfere with execution of the main process.
+
+Tested on Node.js 7.x, 8.x, 9.x, 10.x, 11.x, 12.x, 13.x, 14.x and 16.x.
+No support for Node.js < 7.0 at the moment (although this can be fixed if needed).  
+
+Also comes with prebuilt binaries (hosted on Github releases), thanks to Stuart Miller (https://github.com/spmiller).
+
+## Node.js 14.18.x and higher
+https://github.com/nodejs/node/pull/33010 landed in Node.js 14.18.0, which makes this module no longer needed for heapdumps on out of memory.
+One can use the `--heapsnapshot-near-heap-limit` Node.js CLI option as an native alternative.
+See https://nodejs.org/dist/latest-v14.x/docs/api/cli.html#cli_heapsnapshot_near_heap_limit_max_count.
+
+For Node versions older than 14, use the `2.2.0` release, where this functionality is still present (not maintained anymore).
+For Node versions 14 and up, use `--heapsnapshot-near-heap-limit` for out-of-memory heapdumps. This functionality has been removed from `3.0.0`.
+
+One can still use the API of this module to create CPU profiles and heapdumps on request
+
+# Why?
+There are several modules around which can create heapdumps (v8-profiler, node-heapdump), although this module creates the heap snapshot from a separate process which performs better and doesn't affect the main event loop.
+
+# What?
+When creating a heapdump of CPU profile on request, the DevTools protocol is used to create these files (no native add-on needed).
+The --inspect node.js flag is needed to make this work (which is validated on startup).
+
+# Usage
+
+```javascript
+npm install node-oom-heapdump
+```
+
+Just add the following snippet to your node process.
+
+```javascript
+let path = require('path');
+require('node-oom-heapdump')({
+    path: path.resolve(__dirname, 'my_heapdump')
+});
+```
+
+To make heapdumps and CPU profiles on request, your node process should at least be started with the "--inspect" (or --inspect=port) flag. When the module is loaded, the configured port is verified. If it doesn't respond correctly, a console warning will be shown.
+
+When running in a low memory environment, the following flags are advised:
+
+* --max_old_space_size=60 - this will limit your heapsize on 60MB
+* --optimize_for_size - keep memory as low as possible (GC more often than usual)
+* --always_compact - keep memory as low as possible (do compactions each GC)
+
+These might impact performance though.
+On Node.js 12.x the latter two flags seem to cause some stability issues (see https://github.com/nodejs/node/issues/27552#issuecomment-542695931). So, if you encounter issues on Node.js 12.x in combination with those flags, please refrain from using these.
+
+# Options
+* addTimestamp - add a timestamp to the heapdump filename, to make it unique. Default is false.
+* port - optionally, the alternative DevTools protocol port. Defaults to 9229. Should map on the port given to the --inspect arg.
+
+# API
+The API for creating heapdumps and CPU profiles on request. See below for the currently available API.
+
+Notice that you cannot create a heapdump while a CPU profile is being generated and vice versa; an Error will be thrown if this is the case.
+
+```javascript
+let nodeOomHeapdump = require("node-oom-heapdump")({
+  heapdumpOnOOM: false
+});
+
+/**
+  * Returns the path to the created heap snapshot in a promise, or rejects on error
+  * @param {String} snapshotPath - path of the snapshot
+  * @return {Promise} Promise containing the heap snapshot path on success or error on rejection
+  */
+nodeOomHeapdump.createHeapSnapshot("myheapsnapshotpath").then((snapshotPath) => {
+  // do something with heap snapshot
+
+  // and delete again from disk
+  nodeOomHeapdump.deleteHeapSnapshot(snapshotPath);
+}).catch((err) => {
+  // handle error
+});
+
+/**
+  * Deletes all previously created heapsnapshots from disk
+  */
+nodeOomHeapdump.deleteAllHeapSnapshots();
+
+/**
+  * Deletes a particular snapshot from disk
+  * @param {String} snapshotPath - path of the heap snapshot to delete
+  * @return {Promise}
+  */
+nodeOomHeapdump.deleteHeapSnapshot(snapshotPath);
+
+/**
+  * Returns the path to the created CPU profile in a promise, or rejects on error
+  * @param {String} cpuProfilePath - path of the CPU profile
+  * @param {number} duration - the duration of the CPU profile in ms (default: 30000ms)
+  * @return {Promise} the CPU profile path on success or error on rejection
+  */
+nodeOomHeapdump.createCpuProfile("mycpuprofilepath", 10000).then((cpuProfilePath) => {
+  // do something with CPU profile
+
+  // and delete again from disk
+  nodeOomHeapdump.deleteCpuProfile(cpuProfilePath);
+}).catch((err) => {
+  // handle error
+});
+
+/**
+  * Deletes all previously created CPU profiles from disk
+  */
+nodeOomHeapdump.deleteAllCpuProfiles();
+
+/**
+  * Deletes a particular CPU profile from disk
+  * @param {String} cpuProfilePath - path to the CPU profile to delete from disk
+  * @return {Promise}
+  */
+nodeOomHeapdump.deleteCpuProfile(cpuProfilePath);
+```
+
+# Known issues and limitations
+
+## Memory usage
+When creating a heapdump on request, it's notorious for using a lot of memory. This is caused by a bug in V8/DevTools protocol and is reported here (https://bugs.chromium.org/p/chromium/issues/detail?id=768355); the protocol has no backpressure mechanism, which causes the heapdump to be pushed faster than the DevTools client can handle, causing in-memory buffering.
+
+This is not a problem if your server/machine has memory to spare, but can cause issues in memory restricted environments like a Docker container. Once the process exceeds the container memory threshold, it will be killed by OoMKiller (if enabled). This leads to an empty heapsnapshot file (0 bytes).
+
+Please vote for that issue to be fixed!

package/build/binding.sln

@@ -0,0 +1,19 @@
+Microsoft Visual Studio Solution File, Format Version 12.00
+# Visual Studio 2015
+Project("{8BC9CEB8-8B4A-11D0-8D11-00A0C91BC942}") = "node_oom_heapdump_native", "node_oom_heapdump_native.vcxproj", "{B44BD8E7-8AB3-68F6-9D96-154D16CEC9C0}"
+EndProject
+Global
+	GlobalSection(SolutionConfigurationPlatforms) = preSolution
+		Debug|x64 = Debug|x64
+		Release|x64 = Release|x64
+	EndGlobalSection
+	GlobalSection(ProjectConfigurationPlatforms) = postSolution
+		{B44BD8E7-8AB3-68F6-9D96-154D16CEC9C0}.Debug|x64.ActiveCfg = Debug|x64
+		{B44BD8E7-8AB3-68F6-9D96-154D16CEC9C0}.Debug|x64.Build.0 = Debug|x64
+		{B44BD8E7-8AB3-68F6-9D96-154D16CEC9C0}.Release|x64.ActiveCfg = Release|x64
+		{B44BD8E7-8AB3-68F6-9D96-154D16CEC9C0}.Release|x64.Build.0 = Release|x64
+	EndGlobalSection
+	GlobalSection(SolutionProperties) = preSolution
+		HideSolutionNode = FALSE
+	EndGlobalSection
+EndGlobal