feat(otel-node): add node runtime metrics

packages/opentelemetry-node/lib/elastic-node-sdk.js

@@ -123,9 +123,9 @@
                     exportIntervalMillis: metricsInterval,
                     exportTimeoutMillis: metricsTimeout,
                 });
-            defaultConfig.views = [
-                // Add views for `host-metrics` to avoid excess of data being sent to the server
-                ...HOST_METRICS_VIEWS,
+            defaultConfig.views = [	
+                // Add views for `host-metrics` to avoid excess of data being sent to the server	
+                ...HOST_METRICS_VIEWS,	
             ];
         }
 
@@ -160,9 +160,9 @@
         );
         super.start();
 
-        if (!this._metricsDisabled) {
-            // TODO: make this configurable, user might collect host metrics with a separate utility
-            enableHostMetrics();
+        if (!this._metricsDisabled) {	
+            // TODO: make this configurable, user might collect host metrics with a separate utility	
+            enableHostMetrics();	
         }
     }
 }

packages/opentelemetry-node/lib/instrumentations.js

@@ -50,6 +50,7 @@
  *  "@opentelemetry/instrumentation-redis-4": import('@opentelemetry/instrumentation-redis-4').RedisInstrumentationConfig | InstrumentationFactory,
  *  "@opentelemetry/instrumentation-restify": import('@opentelemetry/instrumentation-restify').RestifyInstrumentationConfig | InstrumentationFactory,
  *  "@opentelemetry/instrumentation-router": import('@opentelemetry/instrumentation').InstrumentationConfig | InstrumentationFactory,
+ *  "@opentelemetry/instrumentation-runtime-node": import('@opentelemetry/instrumentation-runtime-node').RuntimeNodeInstrumentationConfig | InstrumentationFactory,
  *  "@opentelemetry/instrumentation-socket.io": import('@opentelemetry/instrumentation-socket.io').SocketIoInstrumentationConfig | InstrumentationFactory,
  *  "@opentelemetry/instrumentation-tedious": import('@opentelemetry/instrumentation-tedious').TediousInstrumentationConfig | InstrumentationFactory,
  *  "@opentelemetry/instrumentation-undici": import('@opentelemetry/instrumentation-undici').UndiciInstrumentationConfig | InstrumentationFactory,
@@ -84,6 +85,7 @@
 const {RedisInstrumentation: RedisFourInstrumentation} = require('@opentelemetry/instrumentation-redis-4');
 const {RestifyInstrumentation} = require('@opentelemetry/instrumentation-restify');
 const {RouterInstrumentation} = require('@opentelemetry/instrumentation-router');
+const {RuntimeNodeInstrumentation} = require('@opentelemetry/instrumentation-runtime-node');
 const {SocketIoInstrumentation} = require('@opentelemetry/instrumentation-socket.io');
 const {TediousInstrumentation} = require('@opentelemetry/instrumentation-tedious');
 const {UndiciInstrumentation} = require('@opentelemetry/instrumentation-undici');
@@ -126,6 +128,7 @@
     '@opentelemetry/instrumentation-redis-4': (cfg) => new RedisFourInstrumentation(cfg),
     '@opentelemetry/instrumentation-restify': (cfg) => new RestifyInstrumentation(cfg),
     '@opentelemetry/instrumentation-router': (cfg) => new RouterInstrumentation(cfg),
+    '@opentelemetry/instrumentation-runtime-node': (cfg) => new RuntimeNodeInstrumentation(cfg),
     '@opentelemetry/instrumentation-socket.io': (cfg) => new SocketIoInstrumentation(cfg),
     '@opentelemetry/instrumentation-tedious': (cfg) => new TediousInstrumentation(cfg),
     '@opentelemetry/instrumentation-undici': (cfg) => new UndiciInstrumentation(cfg),
@@ -232,6 +235,13 @@
             return;
         }
 
+        // Skip if metrics are disabled by env var
+        const isMetricsDisabled =
+            process.env.ELASTIC_OTEL_METRICS_DISABLED === 'true';
+        if (isMetricsDisabled && name === '@opentelemetry/instrumentation-runtime-node') {
+            return;
+        }
+
         const isFactory = typeof opts[name] === 'function';
         const isObject = typeof opts[name] === 'object';
         const instrFactory = isFactory ? opts[name] : INSTRUMENTATIONS[name];

packages/opentelemetry-node/lib/metrics/host.js

@@ -36,24 +36,16 @@
 // Ref (metrics in Kibana): https://github.com/elastic/kibana/pull/174700
 /** @type {metrics.View[]} */
 const HOST_METRICS_VIEWS = [
-    // drop `system.network.*` (not in Kibana)
+    // TODO: As for now we're going to drop all system metrics
+    // - most of them are not in the classic agent
+    // - `system.cpu` and `system.memory` are recommended to use the collector
     new View({
-        instrumentName: 'system.network.*',
-        aggregation: Aggregation.Drop(),
-    }),
-    // drop `system.cpu.time` (not in Kibana)
-    new View({
-        instrumentName: 'system.cpu.time',
-        aggregation: Aggregation.Drop(),
-    }),
-    // drop `process.*` (not in Kibana)
-    new View({
-        instrumentName: 'process.*',
+        instrumentName: 'system.*',
         aggregation: Aggregation.Drop(),
     }),
 ];
 
 module.exports = {
     HOST_METRICS_VIEWS,
     enableHostMetrics,
-};
+};

packages/opentelemetry-node/package.json

@@ -98,6 +98,7 @@
     "@opentelemetry/instrumentation-redis-4": "^0.42.0",
     "@opentelemetry/instrumentation-restify": "^0.41.0",
     "@opentelemetry/instrumentation-router": "^0.40.0",
+    "@opentelemetry/instrumentation-runtime-node": "file:../../../../otel/opentelemetry-js-contrib/plugins/node/instrumentation-runtime-node",
     "@opentelemetry/instrumentation-socket.io": "^0.42.0",
     "@opentelemetry/instrumentation-tedious": "^0.14.0",
     "@opentelemetry/instrumentation-undici": "^0.6.0",

packages/opentelemetry-node/test/host-metrics.test.js

@@ -114,4 +114,4 @@
 test('host metrics', (suite) => {
     runTestFixtures(suite, testFixtures);
     suite.end();
-});
+});