@instana/shared-metrics 4.6.2 → 4.7.0

package/CHANGELOG.md

@@ -3,6 +3,16 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [4.7.0](https://github.com/instana/nodejs/compare/v4.6.3...v4.7.0) (2025-03-11)
+
+**Note:** Version bump only for package @instana/shared-metrics
+
+## [4.6.3](https://github.com/instana/nodejs/compare/v4.6.2...v4.6.3) (2025-03-05)
+
+### Bug Fixes
+
+- reduced noise for dependency calculation debug logs ([#1589](https://github.com/instana/nodejs/issues/1589)) ([1aeaa94](https://github.com/instana/nodejs/commit/1aeaa94ad1431b5f7807d0e3d93384b585c97d5d))
+
 ## [4.6.2](https://github.com/instana/nodejs/compare/v4.6.1...v4.6.2) (2025-02-24)
 
 ### Bug Fixes

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@instana/shared-metrics",
-  "version": "4.6.2",
+  "version": "4.7.0",
   "description": "Internal metrics plug-in package for Node.js monitoring with Instana",
   "author": {
     "name": "Bastian Krol",
@@ -59,7 +59,7 @@
   },
   "license": "MIT",
   "dependencies": {
-    "@instana/core": "4.6.2",
+    "@instana/core": "4.7.0",
     "detect-libc": "^2.0.2",
     "event-loop-lag": "^1.4.0",
     "semver": "^7.5.4",
@@ -74,5 +74,5 @@
     "event-loop-stats": "1.4.1",
     "gcstats.js": "1.0.0"
   },
-  "gitHead": "d70ba21a091202ed248f083d546052a63e861ddc"
+  "gitHead": "224c0b1b302e34dd98d2388c3892be602142fb35"
 }

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/util/normalizeConfig').InstanaConfig} config
  */
-exports.setLogger = function setLogger(_logger) {
-  logger = _logger;
+exports.init = function init(config) {
+  logger = config.logger;
 };
 
 /** @type {number} */

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/util/normalizeConfig').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}`);
     } 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/util/normalizeConfig').InstanaConfig} config
  */
-exports.setLogger = function setLogger(_logger) {
-  logger = _logger;
+exports.init = function init(config) {
+  logger = config.logger;
 };
 
 exports.payloadPrefix = 'directDependencies';

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);
@@ -41,6 +41,31 @@ 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. 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/en/instana-observability/current?topic=nodejs-collector-installation#native-add-ons'
+  });
+
+  nativeModuleLoader.once('loaded', gcStats_ => {
+    gcStats = gcStats_;
+    exports.currentPayload.statsSupported = true;
+    if (activateHasBeenCalled) {
+      actuallyActivate();
+    }
+  });
+
+  nativeModuleLoader.once('failed', () => {
+    exports.currentPayload.statsSupported = false;
+  });
+};
+
 exports.activate = function activate() {
   activateHasBeenCalled = true;
   if (gcStats) {
@@ -48,32 +73,9 @@ exports.activate = function activate() {
   }
 };
 
-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/en/instana-observability/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;

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/util/normalizeConfig').InstanaConfig} config
  */
-exports.setLogger = function setLogger(_logger) {
-  logger = _logger;
+exports.init = function init(config) {
+  logger = config.logger;
 };
 
 /** @type {number} */

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/util/normalizeConfig').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/util/normalizeConfig').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/util/normalizeConfig').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}`);
     } 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/en/instana-observability/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. 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/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 () {

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/util/normalizeConfig').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}`);
     } 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/util/normalizeConfig').InstanaConfig} config
  */
-const setLogger = function (_logger) {
-  logger = _logger;
+const init = config => {
+  logger = config.logger;
 };
 
 class DependencyDistanceCalculator {
@@ -174,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.`
       );
     }
@@ -183,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;
     }
 
@@ -269,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/util/normalizeConfig').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/util/normalizeConfig').InstanaConfig} config
+ */
+exports.init = function init(config) {
+  logger = config.logger;
+};
+
 /**
  * @typedef {Object} InstanaSharedMetricsOptions
  * @property {string} [nativeModuleName]
@@ -289,14 +297,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/util/normalizeConfig').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}`);
     } else if (!packageJson && attempts < MAX_ATTEMPTS) {
-      setTimeout(() => {
-        exports.activate(config);
-      }, DELAY).unref();
+      setTimeout(exports.activate, DELAY).unref();
 
       return;
     } else if (!packageJson) {