@instana/shared-metrics 5.0.0 → 5.0.1

package/src/dependencies.js

@@ -8,16 +8,17 @@
 const path = require('path');
 const { util, uninstrumentedFs: fs } = require('@instana/core');
 
-let logger = require('@instana/core').logger.getLogger('metrics');
-
 const CountDownLatch = require('./util/CountDownLatch');
 const { DependencyDistanceCalculator, MAX_DEPTH } = require('./util/DependencyDistanceCalculator');
 
+/** @type {import('@instana/core/src/core').GenericLogger} */
+let logger;
+
 /**
- * @param {import('@instana/core/src/core').GenericLogger} _logger
+ * @param {import('@instana/core/src/config').InstanaConfig} config
  */
-exports.setLogger = function setLogger(_logger) {
-  logger = _logger;
+exports.init = function init(config) {
+  logger = config.logger;
 };
 
 /** @type {number} */
@@ -26,6 +27,8 @@ exports.MAX_DEPENDENCIES = 750;
 /** @type {string} */
 exports.payloadPrefix = 'dependencies';
 
+const MAX_DEPTH_NODE_MODULES = 2;
+
 /** @type {Object.<string, string>} */
 const preliminaryPayload = {};
 
@@ -44,7 +47,7 @@ exports.activate = function activate() {
   const started = Date.now();
   util.applicationUnderMonitoring.getMainPackageJsonPathStartingAtMainModule((err, mainPackageJsonPath) => {
     if (err) {
-      return logger.warn('Failed to determine main package.json. Reason: %s %s ', err.message, err.stack);
+      return logger.warn(`Failed to determine main package.json. Reason: ${err?.message}, ${err?.stack}`);
     } else if (!mainPackageJsonPath && attempts < exports.MAX_ATTEMPTS) {
       logger.debug(`Main package.json could not be found at ${mainPackageJsonPath}. Will try again later.`);
       setTimeout(exports.activate, DELAY).unref();
@@ -55,7 +58,7 @@ exports.activate = function activate() {
       );
       util.applicationUnderMonitoring.findNodeModulesFolder((errNodeModules, nodeModulesFolder) => {
         if (errNodeModules) {
-          return logger.warn('Failed to determine node_modules folder. Reason: %s %s ', err.message, err.stack);
+          return logger.warn(`Failed to determine node_modules folder. Reason: ${err?.message}, ${err?.stack}`);
         } else if (!nodeModulesFolder) {
           return logger.warn(
             'Neither the package.json file nor the node_modules folder could be found. Stopping dependency analysis.'
@@ -86,7 +89,13 @@ exports.activate = function activate() {
  * @param {string} packageJsonPath
  */
 function addAllDependencies(dependencyDir, started, packageJsonPath) {
-  addDependenciesFromDir(dependencyDir, () => {
+  addDependenciesFromDir(dependencyDir, 0, () => {
+    // TODO: This check happens AFTER we have already collected the dependencies.
+    //       This is quiet useless for a large dependency tree, because we consume resources to collect
+    //       all the dependencies (fs.stats, fs.readFile etc), but then discard most of them here.
+    //       This is only critical for a very large number of defined dependencies in package.json (vertical).
+    // NOTE: There is an extra protection in the `addDependenciesFromDir` fn to
+    //       limit the depth of traversing node_modules.
     if (Object.keys(preliminaryPayload).length <= exports.MAX_DEPENDENCIES) {
       // @ts-ignore: Cannot redeclare exported variable 'currentPayload'
       exports.currentPayload = preliminaryPayload;
@@ -113,10 +122,14 @@ function addAllDependencies(dependencyDir, started, packageJsonPath) {
  * @param {string} dependencyDir
  * @param {() => void} callback
  */
-function addDependenciesFromDir(dependencyDir, callback) {
+function addDependenciesFromDir(dependencyDir, currentDepth = 0, callback) {
+  if (currentDepth >= MAX_DEPTH_NODE_MODULES) {
+    return callback();
+  }
+
   fs.readdir(dependencyDir, (readDirErr, dependencies) => {
     if (readDirErr || !dependencies) {
-      logger.warn('Cannot analyse dependencies due to %s', readDirErr.message);
+      logger.warn(`Cannot analyse dependencies due to ${readDirErr?.message}`);
       callback();
       return;
     }
@@ -139,18 +152,20 @@ function addDependenciesFromDir(dependencyDir, callback) {
 
     filteredDependendencies.forEach(dependency => {
       if (dependency.indexOf('@') === 0) {
-        addDependenciesFromDir(path.join(dependencyDir, dependency), () => {
+        // NOTE: We do not increase currentDepth because scoped packages are just a folder containing more packages.
+        addDependenciesFromDir(path.join(dependencyDir, dependency), currentDepth, () => {
           countDownLatch.countDown();
         });
       } else {
         const fullDirPath = path.join(dependencyDir, dependency);
+
         // Only check directories. For example, yarn adds a .yarn-integrity file to /node_modules/ which we need to
         // exclude, otherwise we get a confusing "Failed to identify version of .yarn-integrity dependency due to:
         // ENOTDIR: not a directory, open '.../node_modules/.yarn-integrity/package.json'." in the logs.
         fs.stat(fullDirPath, (statErr, stats) => {
           if (statErr) {
             countDownLatch.countDown();
-            logger.warn('Cannot analyse dependency %s due to %s', fullDirPath, statErr.message);
+            logger.warn(`Cannot analyse dependency ${fullDirPath} due to ${statErr?.message}`);
             return;
           }
           if (!stats.isDirectory()) {
@@ -158,7 +173,7 @@ function addDependenciesFromDir(dependencyDir, callback) {
             return;
           }
 
-          addDependency(dependency, fullDirPath, countDownLatch);
+          addDependency(dependency, fullDirPath, countDownLatch, currentDepth);
         });
       }
     });
@@ -172,9 +187,11 @@ function addDependenciesFromDir(dependencyDir, callback) {
  * @param {string} dependency
  * @param {string} dependencyDirPath
  * @param {import('./util/CountDownLatch')} countDownLatch
+ * @param {number} currentDepth
  */
-function addDependency(dependency, dependencyDirPath, countDownLatch) {
+function addDependency(dependency, dependencyDirPath, countDownLatch, currentDepth) {
   const packageJsonPath = path.join(dependencyDirPath, 'package.json');
+
   fs.readFile(packageJsonPath, { encoding: 'utf8' }, (err, contents) => {
     if (err && err.code === 'ENOENT') {
       // This directory does not contain a package json. This happens for example for node_modules/.cache etc.
@@ -185,10 +202,8 @@ function addDependency(dependency, dependencyDirPath, countDownLatch) {
     } else if (err) {
       countDownLatch.countDown();
       logger.info(
-        'Failed to identify version of %s dependency due to: %s. This means that you will not be ' +
-          'able to see details about this dependency within Instana.',
-        dependency,
-        err.message
+        `Failed to identify version of ${dependency} dependency due to: ${err?.message}. ` +
+          'This means that you will not be able to see details about this dependency within Instana.'
       );
       return;
     }
@@ -199,21 +214,23 @@ function addDependency(dependency, dependencyDirPath, countDownLatch) {
         preliminaryPayload[parsedPackageJson.name] = parsedPackageJson.version;
       }
     } catch (parseErr) {
+      // TODO: countDownLatch.countDown(); needs to be called here too?
+      // countDownLatch.countDown();
       return logger.info(
-        'Failed to identify version of %s dependency due to: %s. This means that you will not be ' +
-          'able to see details about this dependency within Instana.',
-        dependency,
-        parseErr.message
+        `Failed to identify version of ${dependency} dependency due to: ${parseErr?.message}.
+          This means that you will not be able to see details about this dependency within Instana.`
       );
     }
 
+    // NOTE: The dependency metric collector does not respect if the node_modules are dev dependencies or production
+    //       dependencies. It collects all dependencies that are installed in the node_modules folder.
     const potentialNestedNodeModulesFolder = path.join(dependencyDirPath, 'node_modules');
     fs.stat(potentialNestedNodeModulesFolder, (statErr, stats) => {
       if (statErr || !stats.isDirectory()) {
         countDownLatch.countDown();
         return;
       }
-      addDependenciesFromDir(potentialNestedNodeModulesFolder, () => {
+      addDependenciesFromDir(potentialNestedNodeModulesFolder, currentDepth + 1, () => {
         countDownLatch.countDown();
       });
     });

package/src/description.js

@@ -7,13 +7,14 @@
 
 const { applicationUnderMonitoring } = require('@instana/core').util;
 
-let logger = require('@instana/core').logger.getLogger('metrics');
+/** @type {import('@instana/core/src/core').GenericLogger} */
+let logger;
 
 /**
- * @param {import('@instana/core/src/core').GenericLogger} _logger
+ * @param {import('@instana/core/src/config').InstanaConfig} config
  */
-exports.setLogger = _logger => {
-  logger = _logger;
+exports.init = function init(config) {
+  logger = config.logger;
 };
 
 exports.payloadPrefix = 'description';
@@ -24,19 +25,14 @@ const MAX_ATTEMPTS = 20;
 const DELAY = 1000;
 let attempts = 0;
 
-/**
- * @param {import('@instana/core/src/util/normalizeConfig').InstanaConfig} config
- */
-exports.activate = function activate(config) {
+exports.activate = function activate() {
   attempts++;
-  applicationUnderMonitoring.getMainPackageJsonStartingAtMainModule(config, (err, packageJson) => {
+
+  applicationUnderMonitoring.getMainPackageJsonStartingAtMainModule((err, packageJson) => {
     if (err) {
-      return logger.warn('Failed to determine main package json. Reason: ', err.message, err.stack);
+      return logger.warn(`Failed to determine main package json. Reason: ${err?.message} ${err?.stack}`);
     } else if (!packageJson && attempts < MAX_ATTEMPTS) {
-      setTimeout(() => {
-        exports.activate(config);
-      }, DELAY).unref();
-
+      setTimeout(exports.activate, DELAY).unref();
       return;
     } else if (!packageJson) {
       // final attempt failed, ignore silently

package/src/directDependencies.js

@@ -7,13 +7,14 @@
 
 const { util, uninstrumentedFs: fs } = require('@instana/core');
 
-let logger = require('@instana/core').logger.getLogger('metrics');
+/** @type {import('@instana/core/src/core').GenericLogger} */
+let logger;
 
 /**
- * @param {import('@instana/core/src/core').GenericLogger} _logger
+ * @param {import('@instana/core/src/config').InstanaConfig} config
  */
-exports.setLogger = function setLogger(_logger) {
-  logger = _logger;
+exports.init = function init(config) {
+  logger = config.logger;
 };
 
 exports.payloadPrefix = 'directDependencies';
@@ -38,9 +39,8 @@ exports.activate = function activate() {
   util.applicationUnderMonitoring.getMainPackageJsonPathStartingAtMainModule((err, packageJsonPath) => {
     if (err) {
       return logger.info(
-        'Failed to determine main package.json for analysis of direct dependencies. Reason: %s %s ',
-        err.message,
-        err.stack
+        `Failed to determine main package.json for analysis of direct dependencies.
+        Reason: ${err?.message} ${err?.stack}`
       );
     } else if (!packageJsonPath && attempts < MAX_ATTEMPTS) {
       setTimeout(exports.activate, DELAY).unref();
@@ -63,7 +63,7 @@ function addDirectDependenciesFromMainPackageJson(packageJsonPath) {
   const started = Date.now();
   fs.readFile(packageJsonPath, { encoding: 'utf8' }, (err, contents) => {
     if (err) {
-      return logger.debug('Failed to analyze direct dependencies dependency due to: %s.', err.message);
+      return logger.debug(`Failed to analyze direct dependencies dependency due to: ${err?.message}`);
     }
 
     try {
@@ -75,7 +75,7 @@ function addDirectDependenciesFromMainPackageJson(packageJsonPath) {
       logger.debug(`Collection of direct dependencies took ${Date.now() - started} ms.`);
     } catch (subErr) {
       logger.debug(`Collection of direct dependencies took ${Date.now() - started} ms.`);
-      return logger.debug('Failed to parse package.json %s dependency due to: %s', packageJsonPath, subErr.message);
+      return logger.debug(`Failed to parse package.json ${packageJsonPath} dependency due to: ${subErr?.message}`);
     }
   });
 }

package/src/gc.js

@@ -6,8 +6,8 @@
 'use strict';
 
 const path = require('path');
-
 const slidingWindow = require('@instana/core').util.slidingWindow;
+const nativeModuleRetry = require('./util/nativeModuleRetry');
 
 const windowOpts = { duration: 1000 };
 const minorGcWindow = slidingWindow.create(windowOpts);
@@ -21,6 +21,29 @@ let gcStats;
 let activateHasBeenCalled = false;
 let hasBeenActivated = false;
 
+const statsHandler = (/** @type {*} */ stats) => {
+  // gcstats exposes start and end in nanoseconds
+  const pause = (stats.end - stats.start) / 1000000;
+  gcPauseWindow.addPoint(pause);
+  const type = stats.gctype;
+  if (type === 1) {
+    minorGcWindow.addPoint(1);
+  } else if (type === 2) {
+    majorGcWindow.addPoint(1);
+  } else if (type === 4) {
+    incrementalMarkingsWindow.addPoint(1);
+  } else if (type === 8) {
+    processWeakCallbacksWindow.addPoint(1);
+  } else if (type === 15) {
+    minorGcWindow.addPoint(1);
+    majorGcWindow.addPoint(1);
+    incrementalMarkingsWindow.addPoint(1);
+    processWeakCallbacksWindow.addPoint(1);
+  }
+
+  exports.currentPayload.usedHeapSizeAfterGc = stats.after.usedHeapSize;
+};
+
 exports.payloadPrefix = 'gc';
 
 /** @type {{
@@ -41,65 +64,52 @@ exports.currentPayload = {
   statsSupported: false
 };
 
+exports.init = function init() {
+  const nativeModuleLoader = nativeModuleRetry.loadNativeAddOn({
+    nativeModuleName: 'gcstats.js',
+    moduleRoot: path.join(__dirname, '..'),
+    message:
+      'Could not load gcstats.js. Garbage collection information will not be available for this ' +
+      'application. ' +
+      "However, general tracing functionality remains unaffected. Enable debug logs with 'INSTANA_DEBUG=true' " +
+      'for more details about the error. For more information on native add-ons, visit: ' +
+      'https://www.ibm.com/docs/en/instana-observability/current?topic=nodejs-collector-installation#native-add-ons'
+  });
+
+  nativeModuleLoader.once('loaded', gcStats_ => {
+    gcStats = gcStats_;
+    exports.currentPayload.statsSupported = true;
+    // CASE: If the environment does not support native addons, `gc-stats` may fail to initialize properly,
+    //       and `on` could be undefined.
+    if (activateHasBeenCalled && gcStats && typeof gcStats.on === 'function') {
+      actuallyActivate();
+    }
+  });
+
+  nativeModuleLoader.once('failed', () => {
+    exports.currentPayload.statsSupported = false;
+  });
+};
+
 exports.activate = function activate() {
   activateHasBeenCalled = true;
-  if (gcStats) {
+  // CASE: If the environment does not support native addons, `gc-stats` may fail to initialize properly,
+  //       and `on` could be undefined.
+  if (gcStats && typeof gcStats.on === 'function') {
     actuallyActivate();
   }
 };
 
-const nativeModuleLoader = require('./util/nativeModuleRetry')({
-  nativeModuleName: 'gcstats.js',
-  moduleRoot: path.join(__dirname, '..'),
-  message:
-    'Could not load gcstats.js. You will not be able to see GC information in Instana for this application. This ' +
-    'typically occurs when native addons could not be built during module installation (npm install/yarn) or when ' +
-    'npm install --no-optional or yarn --ignore-optional have been used to install dependencies. See the ' +
-    'instructions to learn more about the requirements of the collector: ' +
-    'https://www.ibm.com/docs/de/obi/current?topic=nodejs-collector-installation#native-add-ons'
-});
-
 /** @type {NodeJS.Timeout} */
 let senseIntervalHandle;
 
-nativeModuleLoader.once('loaded', gcStats_ => {
-  gcStats = gcStats_;
-  exports.currentPayload.statsSupported = true;
-  if (activateHasBeenCalled) {
-    actuallyActivate();
-  }
-});
-
-nativeModuleLoader.once('failed', () => {
-  exports.currentPayload.statsSupported = false;
-});
-
 function actuallyActivate() {
   if (hasBeenActivated) {
     return;
   }
   hasBeenActivated = true;
-  gcStats.on('stats', (/** @type {*} */ stats) => {
-    // gcstats exposes start and end in nanoseconds
-    const pause = (stats.end - stats.start) / 1000000;
-    gcPauseWindow.addPoint(pause);
-    const type = stats.gctype;
-    if (type === 1) {
-      minorGcWindow.addPoint(1);
-    } else if (type === 2) {
-      majorGcWindow.addPoint(1);
-    } else if (type === 4) {
-      incrementalMarkingsWindow.addPoint(1);
-    } else if (type === 8) {
-      processWeakCallbacksWindow.addPoint(1);
-    } else if (type === 15) {
-      minorGcWindow.addPoint(1);
-      majorGcWindow.addPoint(1);
-      incrementalMarkingsWindow.addPoint(1);
-      processWeakCallbacksWindow.addPoint(1);
-    }
-    exports.currentPayload.usedHeapSizeAfterGc = stats.after.usedHeapSize;
-  });
+
+  gcStats.on('stats', statsHandler);
   startSensing();
 }
 
@@ -120,4 +130,8 @@ exports.deactivate = function deactivate() {
   }
   activateHasBeenCalled = false;
   hasBeenActivated = false;
+
+  if (gcStats && typeof gcStats.removeListener === 'function') {
+    gcStats.removeListener('stats', statsHandler);
+  }
 };

package/src/healthchecks.js

@@ -7,13 +7,14 @@
 
 const { hook } = require('@instana/core').util;
 
-let logger = require('@instana/core').logger.getLogger('metrics');
+/** @type {import('@instana/core/src/core').GenericLogger} */
+let logger;
 
 /**
- * @param {import('@instana/core/src/core').GenericLogger} _logger
+ * @param {import('@instana/core/src/config').InstanaConfig} config
  */
-exports.setLogger = function setLogger(_logger) {
-  logger = _logger;
+exports.init = function init(config) {
+  logger = config.logger;
 };
 
 /** @type {number} */
@@ -38,7 +39,7 @@ hook.onModuleLoad(
 );
 
 /**
- * @param {import('@instana/core/src/util/normalizeConfig').InstanaConfig} config
+ * @param {import('@instana/core/src/config').InstanaConfig} config
  */
 exports.activate = function activate(config) {
   timeBetweenHealthcheckCalls = config.metrics.timeBetweenHealthcheckCalls;
@@ -79,7 +80,7 @@ function gatherHealthcheckResults() {
     .catch(function onHealthcheckResultFailure(/** @type {*} */ err) {
       // @ts-ignore
       exports.currentPayload = {};
-      logger.warn('Unexpected error while getting healthcheck results', err);
+      logger.warn(`Unexpected error while getting healthcheck results. ${err?.message} ${err?.stack}`);
       timeoutHandle = setTimeout(gatherHealthcheckResults, timeBetweenHealthcheckCalls);
       timeoutHandle.unref();
     });

package/src/index.js

@@ -5,39 +5,66 @@
 
 'use strict';
 
+const activeHandles = require('./activeHandles');
+const activeRequests = require('./activeRequests');
+const args = require('./args');
+const dependencies = require('./dependencies');
+const directDependencies = require('./directDependencies');
+const description = require('./description');
+const execArgs = require('./execArgs');
+const gc = require('./gc');
+const healthchecks = require('./healthchecks');
+const heapSpaces = require('./heapSpaces');
+const http = require('./http');
+const keywords = require('./keywords');
+const libuv = require('./libuv');
+const memory = require('./memory');
+const name = require('./name');
+const version = require('./version');
+const util = require('./util');
+
 /** @type {Array.<import('@instana/core/src/metrics').InstanaMetricsModule>} */
 const allMetrics = [
-  require('./activeHandles'),
-  require('./activeRequests'),
-  require('./args'),
-  require('./dependencies'),
-  require('./directDependencies'),
-  require('./description'),
-  require('./execArgs'),
-  require('./gc'),
-  require('./healthchecks'),
-  require('./heapSpaces'),
-  require('./http'),
-  require('./keywords'),
-  require('./libuv'),
-  require('./memory'),
-  require('./name'),
-  require('./version')
+  activeHandles,
+  activeRequests,
+  args,
+  dependencies,
+  directDependencies,
+  description,
+  execArgs,
+  gc,
+  healthchecks,
+  heapSpaces,
+  http,
+  keywords,
+  libuv,
+  memory,
+  name,
+  version
 ];
 
-const util = require('./util');
-
 /**
- * @param {import('@instana/core/src/core').GenericLogger} logger
+ * @param {import('@instana/core/src/config').InstanaConfig} config
  */
-const setLogger = function (logger) {
-  util.setLogger(logger);
+const init = function (config) {
+  util.init(config);
+  dependencies.init(config);
+  description.init(config);
+  directDependencies.init(config);
+  healthchecks.init(config);
+  keywords.init(config);
+  name.init(config);
+  version.init(config);
+  name.init(config);
+  gc.init();
+  libuv.init();
 };
 
 /**
  * @typedef {Object} InstanaSharedMetrics
  * @property {Array.<import('@instana/core/src/metrics').InstanaMetricsModule>} allMetrics
  * @property {import('./util')} util
+ * @property {(config: import('@instana/core/src/config').InstanaConfig) => void} init
  * @property {(logger: import('@instana/core/src/core').GenericLogger) => void} setLogger
  */
 
@@ -45,5 +72,7 @@ const setLogger = function (logger) {
 module.exports = {
   allMetrics,
   util,
-  setLogger
+  init,
+  // TODO: Remove in next major release
+  setLogger: () => {}
 };

package/src/keywords.js

@@ -7,12 +7,14 @@
 
 const { applicationUnderMonitoring } = require('@instana/core').util;
 
-let logger = require('@instana/core').logger.getLogger('metrics');
+/** @type {import('@instana/core/src/core').GenericLogger} */
+let logger;
+
 /**
- * @param {import('@instana/core/src/core').GenericLogger} _logger
+ * @param {import('@instana/core/src/config').InstanaConfig} config
  */
-exports.setLogger = function setLogger(_logger) {
-  logger = _logger;
+exports.init = function init(config) {
+  logger = config.logger;
 };
 
 exports.payloadPrefix = 'keywords';
@@ -24,18 +26,14 @@ const MAX_ATTEMPTS = 20;
 const DELAY = 1000;
 let attempts = 0;
 
-/**
- * @param {import('@instana/core/src/util/normalizeConfig').InstanaConfig} config
- */
-exports.activate = function activate(config) {
+exports.activate = function activate() {
   attempts++;
-  applicationUnderMonitoring.getMainPackageJsonStartingAtMainModule(config, (err, packageJson) => {
+
+  applicationUnderMonitoring.getMainPackageJsonStartingAtMainModule((err, packageJson) => {
     if (err) {
-      return logger.warn('Failed to determine main package json. Reason: ', err.message, err.stack);
+      return logger.warn(`Failed to determine main package json. Reason: ${err?.message} ${err?.stack}`);
     } else if (!packageJson && attempts < MAX_ATTEMPTS) {
-      setTimeout(() => {
-        exports.activate(config);
-      }, DELAY).unref();
+      setTimeout(exports.activate, DELAY).unref();
 
       return;
     } else if (!packageJson) {

package/src/libuv.js

@@ -6,7 +6,7 @@
 'use strict';
 
 const path = require('path');
-
+const nativeModuleRetry = require('./util/nativeModuleRetry');
 const lag = require('event-loop-lag')(1000);
 
 /** @type {*} */
@@ -14,24 +14,26 @@ let eventLoopStats;
 
 exports.payloadPrefix = 'libuv';
 
-const nativeModuleLoader = require('./util/nativeModuleRetry')({
-  nativeModuleName: 'event-loop-stats',
-  moduleRoot: path.join(__dirname, '..'),
-  message:
-    'Could not load event-loop-stats. You will only see limited event loop information in Instana for this ' +
-    'application. This typically occurs when native addons could not be built during module installation ' +
-    '(npm install/yarn) or when npm install --no-optional or yarn --ignore-optional have been used to install ' +
-    'dependencies. See the instructions to learn more about the requirements of the collector: ' +
-    'https://www.ibm.com/docs/de/obi/current?topic=nodejs-collector-installation#native-add-ons'
-});
-
-nativeModuleLoader.once('loaded', eventLoopStats_ => {
-  eventLoopStats = eventLoopStats_;
-});
-
-nativeModuleLoader.once('failed', () => {
-  exports.currentPayload.statsSupported = false;
-});
+exports.init = function init() {
+  const nativeModuleLoader = nativeModuleRetry.loadNativeAddOn({
+    nativeModuleName: 'event-loop-stats',
+    moduleRoot: path.join(__dirname, '..'),
+    message:
+      'Could not load event-loop-stats. Event loop information will not be available for this ' +
+      'application. ' +
+      "However, general tracing functionality remains unaffected. Enable debug logs with 'INSTANA_DEBUG=true' " +
+      'for more details about the error. For more information on native add-ons, visit: ' +
+      'https://www.ibm.com/docs/en/instana-observability/current?topic=nodejs-collector-installation#native-add-ons'
+  });
+
+  nativeModuleLoader.once('loaded', eventLoopStats_ => {
+    eventLoopStats = eventLoopStats_;
+  });
+
+  nativeModuleLoader.once('failed', () => {
+    exports.currentPayload.statsSupported = false;
+  });
+};
 
 Object.defineProperty(exports, 'currentPayload', {
   get: function () {
@@ -42,7 +44,9 @@ Object.defineProperty(exports, 'currentPayload', {
 });
 
 function sense() {
-  if (eventLoopStats) {
+  // CASE: If the c++ module does not support the env, it might export `sense` as undefined.
+  //       See https://github.com/bripkens/event-loop-stats/blob/v1.4.1/src/eventLoopStats.js#L1-L2
+  if (eventLoopStats && eventLoopStats.sense) {
     const stats = eventLoopStats.sense();
     stats.statsSupported = true;
     return stats;