@instana/shared-metrics 5.0.0 → 5.0.1

package/src/name.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 = function setLogger(_logger) {
-  logger = _logger;
+exports.init = function init(config) {
+  logger = config.logger;
 };
 
 exports.payloadPrefix = 'name';
@@ -24,22 +25,15 @@ exports.MAX_ATTEMPTS = 60;
 exports.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 < exports.MAX_ATTEMPTS) {
       logger.debug('Main package.json could not be found. Will try again later.');
-
-      setTimeout(() => {
-        exports.activate(config);
-      }, exports.DELAY).unref();
-
+      setTimeout(exports.activate, exports.DELAY).unref();
       return;
     } else if (!packageJson) {
       if (require.main) {

package/src/util/DependencyDistanceCalculator.js

@@ -6,18 +6,19 @@
 'use strict';
 
 const assert = require('assert');
-const { logger: Logger, uninstrumentedFs: fs } = require('@instana/core');
+const { uninstrumentedFs: fs } = require('@instana/core');
 const path = require('path');
 
 const CountDownLatch = require('./CountDownLatch');
 
-let logger = 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
  */
-const setLogger = function (_logger) {
-  logger = _logger;
+const init = config => {
+  logger = config.logger;
 };
 
 class DependencyDistanceCalculator {
@@ -73,10 +74,8 @@ class DependencyDistanceCalculator {
       fs.readFile(packageJsonPath, { encoding: 'utf8' }, (err, contents) => {
         if (err) {
           logger.debug(
-            'Failed to calculate transitive distances for some dependencies, could not read package.json file at ' +
-              '%s: %s.',
-            packageJsonPath,
-            err.message
+            `Failed to calculate transitive distances for some dependencies, could not read package.json file at
+              ${packageJsonPath}: ${err?.message}.`
           );
 
           // If we cannot parse the package.json or if it does not exist, we need to decrement by 3 immediately because
@@ -90,10 +89,8 @@ class DependencyDistanceCalculator {
           parsedPackageJson = JSON.parse(contents);
         } catch (parseErr) {
           logger.debug(
-            'Failed to calculate transitive distances for some dependencies, could not parse package.json file at ' +
-              '%s: %s',
-            packageJsonPath,
-            parseErr.message
+            `Failed to calculate transitive distances for some dependencies, could not parse package.json file at
+              ${packageJsonPath}: ${parseErr?.message}.`
           );
           this.globalCountDownLatchAllPackages.countDown(3);
           return;
@@ -109,9 +106,8 @@ class DependencyDistanceCalculator {
       // This catch-block is for synchronous errors from fs.readFile, which can also happen in addition to the callback
       // being called with an error.
       logger.debug(
-        'Failed to calculate transitive distances for some dependencies, synchronous error from fs.readFile for %s:',
-        packageJsonPath,
-        fsReadFileErr
+        `Failed to calculate transitive distances for some dependencies, synchronous error from fs.readFile for
+          ${packageJsonPath}: ${fsReadFileErr?.message}`
       );
       this.globalCountDownLatchAllPackages.countDown(3);
     }
@@ -179,7 +175,7 @@ class DependencyDistanceCalculator {
       mainModulePath = require.resolve(dependency);
     } catch (requireResolveErr) {
       // ignore
-      logger.debug(
+      logger.trace(
         `Ignoring failure to resolve the path to dependency ${dependency} for dependency distance calculation.`
       );
     }
@@ -188,7 +184,7 @@ class DependencyDistanceCalculator {
       // Could not find the package.json for this dependency so we cannot analyze it further, which means we are done
       // with it.
       localCountDownLatchForThisNode.countDown();
-      logger.debug(`No main module path for dependency ${dependency}.`);
+      logger.trace(`Ignoring ${dependency} for dependency distance calculation, could not find main module path.`);
       return;
     }
 
@@ -197,8 +193,7 @@ class DependencyDistanceCalculator {
         localCountDownLatchForThisNode.countDown();
         logger.debug(
           `Ignoring failure to find the package.json file for dependency ${dependency} for dependency distance ` +
-            'calculation.',
-          err
+            `calculation. ${err?.message} ${err?.stack}`
         );
         return;
       }
@@ -275,8 +270,8 @@ function searchInParentDir(dir, onParentDir, callback) {
 }
 
 module.exports = {
+  init,
   DependencyDistanceCalculator,
   MAX_DEPTH: 15,
-  __moduleRefExportedForTest: module,
-  setLogger
+  __moduleRefExportedForTest: module
 };

package/src/util/index.js

@@ -6,14 +6,18 @@
 'use strict';
 
 const nativeModuleRetry = require('./nativeModuleRetry');
-const { setLogger: setLoggerForDependencyDistanceCalculator } = require('./DependencyDistanceCalculator');
+const dependencyDistanceCalculator = require('./DependencyDistanceCalculator');
+
+/**
+ * @param {import('@instana/core/src/config').InstanaConfig} config
+ */
+const init = config => {
+  nativeModuleRetry.init(config);
+  dependencyDistanceCalculator.init(config);
+};
+
 module.exports = {
+  init,
   nativeModuleRetry,
-  /**
-   * @param {import('@instana/core/src/core').GenericLogger} logger
-   */
-  setLogger: function setLogger(logger) {
-    nativeModuleRetry.setLogger(logger);
-    setLoggerForDependencyDistanceCalculator(logger);
-  }
+  dependencyDistanceCalculator
 };

package/src/util/nativeModuleRetry.js

@@ -5,15 +5,23 @@
 
 'use strict';
 
-const { logger: Logger, uninstrumentedFs: fs } = require('@instana/core');
-let logger = Logger.getLogger('shared-metrics/native-module-retry');
-
+const { uninstrumentedFs: fs } = require('@instana/core');
 const EventEmitter = require('events');
 const os = require('os');
 const tar = require('tar');
 const path = require('path');
 const detectLibc = require('detect-libc');
 
+/** @type {import('@instana/core/src/core').GenericLogger} */
+let logger;
+
+/**
+ * @param {import('@instana/core/src/config').InstanaConfig} config
+ */
+exports.init = function init(config) {
+  logger = config.logger;
+};
+
 /**
  * @typedef {Object} InstanaSharedMetricsOptions
  * @property {string} [nativeModuleName]
@@ -115,7 +123,9 @@ function attemptRequire(opts, loaderEmitter, mechanism) {
     logger.debug(`Attempt to load native add-on ${opts.nativeModuleName} ${mechanism} has been successful.`);
     return true;
   } catch (e) {
-    logger.debug(`Attempt to load native add-on ${opts.nativeModuleName} ${mechanism} has failed.`, e);
+    logger.debug(
+      `Attempt to load native add-on ${opts.nativeModuleName} ${mechanism} has failed. ${e?.message} ${e?.stack}`
+    );
     return false;
   }
 }
@@ -167,7 +177,10 @@ function copyPrecompiled(opts, loaderEmitter, callback) {
       callback(false);
       return;
     } else if (statsErr) {
-      logger.warn(`Looking for a precompiled version for ${opts.nativeModuleName} ${label} failed.`, statsErr);
+      logger.warn(
+        `Looking for a precompiled version for ${opts.nativeModuleName} ${label} failed.
+        ${statsErr?.message} ${statsErr?.stack}`
+      );
       callback(false);
       return;
     }
@@ -206,12 +219,24 @@ function copyPrecompiled(opts, loaderEmitter, callback) {
             callback(true);
           })
           .catch(error => {
-            logger.warn(`Copying the precompiled build for ${opts.nativeModuleName} ${label} failed.`, error);
+            // The log triggered when the Instana Node.js collector fails to load a precompiled native module.
+            // The collector first attempts to load the module directly; if that fails, it extracts a precompiled
+            // version from the instrumentation image, which is currently compiled only for Node.js v21.
+            // If the application runs a different Node.js version and the filesystem is read-only, extraction may fail,
+            // preventing collection of certain telemetry data (garbage collection and event loop stats).
+            // TODO: Fix the issue tracked under INSTA-6673. Ensure prebuilt binaries are available for the
+            // corresponding Node.js version.
+            logger.debug(
+              `Failed to load precompiled build for ${opts.nativeModuleName} ${label}. ` +
+                'Precompiled binary extraction has failed, possibly due to a read-only filesystem or an unknown' +
+                `system operation error for the Node.js ${process.version}. ${error?.message} ${error?.stack}`
+            );
             callback(false);
           });
       })
       .catch(tarErr => {
-        logger.warn(`Unpacking the precompiled build for ${opts.nativeModuleName} ${label} failed.`, tarErr);
+        logger.warn(`Unpacking the precompiled build for ${opts.nativeModuleName} ${label} failed.
+          ${tarErr?.message} ${tarErr?.stack}`);
         callback(false);
       });
   });
@@ -245,7 +270,9 @@ function findNativeModulePath(opts) {
     opts.nativeModuleParentPath = path.join(opts.nativeModulePath, '..');
     return true;
   } catch (e) {
-    logger.debug(`Could not find location for ${opts.nativeModuleName}. Will create a path for it.`, e);
+    logger.debug(
+      `Could not find location for ${opts.nativeModuleName}. Will create a path for it. ${e?.message} ${e?.stack}`
+    );
     return createNativeModulePath(opts);
   }
 }
@@ -278,14 +305,6 @@ function createNativeModulePath(opts) {
   return true;
 }
 
-loadNativeAddOn.setLogger = setLogger;
 loadNativeAddOn.selfNodeModulesPath = '';
 
-/**
- * @param {import('@instana/core/src/core').GenericLogger} _logger
- */
-function setLogger(_logger) {
-  logger = _logger;
-}
-
-module.exports = loadNativeAddOn;
+exports.loadNativeAddOn = loadNativeAddOn;

package/src/version.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 = 'version';
@@ -23,18 +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) {