Merge pull request #10 from nearform/preloader-disabler

fix: Add a flag to disabled the preloader.
nearform · Nov 25, 2020 · be6a8cd · be6a8cd
2 parents 0b41ca8 + 7de6d02
commit be6a8cd
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -38,6 +38,8 @@ Then the tool will await on the next signal, to resume profiling/tracking/shooti
 
 The preloader uses the following environment variables to control its behavior:
 
+- `HEAP_PROFILER_PRELOADER_DISABLED`: If set to `true`, the preloader is not installed and you need to use the API to sample the process.
+
 - `HEAP_PROFILER_SNAPSHOT`: If set to `false`, it will not generate heap dump snapshots.
 
 - `HEAP_PROFILER_SNAPSHOT_DESTINATION`: The path where to store the snapshot. The default will be a `.heapsnapshot` in the current directory.

diff --git a/src/index.js b/src/index.js
@@ -5,7 +5,7 @@ const generateHeapSamplingProfile = require('./profile')
 
 module.exports = { generateHeapSnapshot, generateHeapSamplingProfile }
 
-if (require.main === undefined) {
+if (process.env.HEAP_PROFILER_PRELOADER_DISABLED !== 'true' && require.main === undefined) {
   let logger = console
 
   if (process.env.HEAP_PROFILER_LOGGING_DISABLED === 'true') {