@instana/shared-metrics 4.7.0 → 4.9.0

package/CHANGELOG.md

@@ -3,6 +3,18 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [4.9.0](https://github.com/instana/nodejs/compare/v4.8.0...v4.9.0) (2025-03-20)
+
+### Bug Fixes
+
+- improved log for precompiled binary loading failure ([#1642](https://github.com/instana/nodejs/issues/1642)) ([f0c38d5](https://github.com/instana/nodejs/commit/f0c38d539be65c3e90fb2ecd05d5f46d982a5337))
+
+# [4.8.0](https://github.com/instana/nodejs/compare/v4.7.0...v4.8.0) (2025-03-19)
+
+### Bug Fixes
+
+- resolved TypeError gcStats.on is not a function ([#1633](https://github.com/instana/nodejs/issues/1633)) ([2bfcd92](https://github.com/instana/nodejs/commit/2bfcd92f4bc57b7fb163283d6f2792c06816389b))
+
 # [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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@instana/shared-metrics",
-  "version": "4.7.0",
+  "version": "4.9.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.7.0",
+    "@instana/core": "4.9.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": "224c0b1b302e34dd98d2388c3892be602142fb35"
+  "gitHead": "19d1f6ff80895afb493f3cfa4c965efd11ee3e01"
 }

package/src/gc.js

@@ -46,17 +46,19 @@ exports.init = function init() {
     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: ' +
+      '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;
-    if (activateHasBeenCalled) {
+    // 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();
     }
   });
@@ -68,7 +70,9 @@ exports.init = function init() {
 
 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();
   }
 };

package/src/libuv.js

@@ -19,10 +19,10 @@ exports.init = function init() {
     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: ' +
+      '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'
   });
 

package/src/util/nativeModuleRetry.js

@@ -219,9 +219,17 @@ function copyPrecompiled(opts, loaderEmitter, callback) {
             callback(true);
           })
           .catch(error => {
-            logger.warn(
-              `Copying the precompiled build for ${opts.nativeModuleName} ${label} failed. 
-              ${error?.message} ${error?.stack}`
+            // 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);
           });