feat: Added ability to register Supportability/Features/Instrumentation/OnRequire/<pkg> metrics for subscriber based instrumentation (#3309)

Author: bizob2828

lib/instrumentations.js

@@ -58,6 +58,19 @@ module.exports = function instrumentations() {
     'fancy-log': { type: InstrumentationDescriptor.TYPE_TRACKING },
     knex: { type: InstrumentationDescriptor.TYPE_TRACKING },
     loglevel: { type: InstrumentationDescriptor.TYPE_TRACKING },
-    npmlog: { type: InstrumentationDescriptor.TYPE_TRACKING }
+    npmlog: { type: InstrumentationDescriptor.TYPE_TRACKING },
+
+    /**
+     * The modules below are listed here is a temporary solution to maintaining
+     * the Supportability/Features/onRequire/<module> metrics for libraries
+     * that have been migrated to use tracing chanel instrumentation.
+     * Once orchestrion can emit the package version, these can be removed.
+     * {@link https://github.com/newrelic/node-newrelic/issues/3308 Github Issue}
+     */
+    '@elastic/elasticsearch': { type: InstrumentationDescriptor.TYPE_TRACKING },
+    '@modelcontextprotocol/sdk/client/index.js': { type: InstrumentationDescriptor.TYPE_TRACKING },
+    '@opensearch-project/opensearch': { type: InstrumentationDescriptor.TYPE_TRACKING },
+    ioredis: { type: InstrumentationDescriptor.TYPE_TRACKING },
+    pino: { type: InstrumentationDescriptor.TYPE_TRACKING }
   }
 }

test/versioned/elastic/elasticsearch.test.js

@@ -418,6 +418,12 @@ test('Elasticsearch instrumentation', async (t) => {
       }
       expected['Datastore/instance/ElasticSearch/' + HOST_ID] = 5
       checkMetrics(unscoped, expected)
+      const agentMetrics = agent.metrics._metrics.unscoped
+      const expectedPkgMetrics = {
+        'Supportability/Features/Instrumentation/OnRequire/@elastic/elasticsearch': 1,
+        [`Supportability/Features/Instrumentation/OnRequire/@elastic/elasticsearch/Version/${semver.major(pkgVersion)}`]: 1,
+      }
+      checkMetrics(agentMetrics, expectedPkgMetrics)
     })
   })
 

test/versioned/ioredis/ioredis.test.js

@@ -13,13 +13,15 @@ const urltils = require('../../../lib/util/urltils')
 const { tspl } = require('@matteo.collina/tspl')
 const { assertMetrics } = require('../../lib/custom-assertions')
 const { removeModules } = require('../../lib/cache-buster')
+const semver = require('semver')
 
 // Indicates unique database in Redis. 0-15 supported.
 const DB_INDEX = 3
 
 test('ioredis instrumentation', async (t) => {
   t.beforeEach(async (ctx) => {
     const agent = helper.instrumentMockedAgent()
+    const { version: pkgVersion } = require('ioredis/package.json')
     const Redis = require('ioredis')
     const redisClient = new Redis(params.redis_port, params.redis_host)
     await redisClient.flushall()
@@ -31,6 +33,7 @@ test('ioredis instrumentation', async (t) => {
     await redisClient.select(DB_INDEX)
     ctx.nr = {
       agent,
+      pkgVersion,
       redisClient,
       HOST_ID,
       METRIC_HOST_NAME
@@ -45,7 +48,7 @@ test('ioredis instrumentation', async (t) => {
   })
 
   await t.test('creates expected metrics', async (t) => {
-    const { agent, redisClient, HOST_ID } = t.nr
+    const { agent, pkgVersion, redisClient, HOST_ID } = t.nr
     const plan = tspl(t, { plan: 6 })
     agent.on('transactionFinished', function (tx) {
       const expected = [
@@ -56,6 +59,12 @@ test('ioredis instrumentation', async (t) => {
       expected['Datastore/instance/Redis/' + HOST_ID] = 2
 
       assertMetrics(tx.metrics, expected, false, false, { assert: plan })
+      const expectedPkgMetrics = [
+        [{ name: 'Supportability/Features/Instrumentation/OnRequire/ioredis' }],
+        [{ name: `Supportability/Features/Instrumentation/OnRequire/ioredis/Version/${semver.major(pkgVersion)}` }]
+      ]
+
+      assertMetrics(agent.metrics, expectedPkgMetrics, false, false)
     })
 
     helper.runInTransaction(agent, async (transaction) => {

test/versioned/mcp-sdk/client.test.js

@@ -10,7 +10,10 @@ const assert = require('node:assert')
 
 const { removeModules } = require('../../lib/cache-buster')
 const helper = require('../../lib/agent_helper')
-const { assertSegments, assertSpanKind } = require('../../lib/custom-assertions')
+const { assertMetrics, assertSegments, assertSpanKind } = require('../../lib/custom-assertions')
+const semver = require('semver')
+const { readFile } = require('node:fs/promises')
+const path = require('node:path')
 
 const {
   MCP
@@ -26,6 +29,9 @@ test.beforeEach(async (ctx) => {
 
   const { Client } = require('@modelcontextprotocol/sdk/client/index.js')
   const { StdioClientTransport } = require('@modelcontextprotocol/sdk/client/stdio.js')
+  const pkg = await readFile(path.join(__dirname, '/node_modules/@modelcontextprotocol/sdk/package.json'))
+  const { version: pkgVersion } = JSON.parse(pkg.toString())
+  ctx.nr.pkgVersion = pkgVersion
 
   ctx.nr.transport = new StdioClientTransport({
     command: 'node',
@@ -72,7 +78,7 @@ test('should create span for callTool', async (t) => {
 })
 
 test('should create span for readResource', async (t) => {
-  const { agent, client } = t.nr
+  const { agent, client, pkgVersion } = t.nr
   await helper.runInTransaction(agent, async (tx) => {
     const resource = await client.readResource({
       uri: 'echo://hello-world',
@@ -90,6 +96,12 @@ test('should create span for readResource', async (t) => {
         { name, kind: 'internal' }
       ]
     })
+    const agentMetrics = agent.metrics
+    const expectedPkgMetrics = [
+      [{ name: 'Supportability/Features/Instrumentation/OnRequire/@modelcontextprotocol/sdk/client/index.js' }],
+      [{ name: `Supportability/Features/Instrumentation/OnRequire/@modelcontextprotocol/sdk/client/index.js/Version/${semver.major(pkgVersion)}` }]
+    ]
+    assertMetrics(agentMetrics, expectedPkgMetrics, false, false)
   })
 })
 

test/versioned/opensearch/opensearch.test.js

@@ -13,6 +13,7 @@ const crypto = require('crypto')
 const DB_INDEX = `test-${randomString()}`
 const DB_INDEX_2 = `test2-${randomString()}`
 const SEARCHTERM_1 = randomString()
+const semver = require('semver')
 
 function randomString() {
   return crypto.randomBytes(5).toString('hex')
@@ -47,10 +48,12 @@ test('opensearch instrumentation', async (t) => {
     const client = new Client({
       node: `http://${params.opensearch_host}:${params.opensearch_port}`
     })
+    const { version: pkgVersion } = require('@opensearch-project/opensearch/package.json')
 
     ctx.nr = {
       agent,
       client,
+      pkgVersion,
       METRIC_HOST_NAME,
       HOST_ID
     }
@@ -314,7 +317,7 @@ test('opensearch instrumentation', async (t) => {
   })
 
   await t.test('should create correct metrics', async function (t) {
-    const { agent, client, HOST_ID } = t.nr
+    const { agent, client, pkgVersion, HOST_ID } = t.nr
     const id = `key-${randomString()}`
     await helper.runInTransaction(agent, async function transactionInScope(transaction) {
       const documentProp = setRequestBody({
@@ -355,6 +358,12 @@ test('opensearch instrumentation', async (t) => {
       }
       expected['Datastore/instance/OpenSearch/' + HOST_ID] = 5
       checkMetrics(unscoped, expected)
+      const agentMetrics = agent.metrics._metrics.unscoped
+      const expectedPkgMetrics = {
+        'Supportability/Features/Instrumentation/OnRequire/@opensearch-project/opensearch': 1,
+        [`Supportability/Features/Instrumentation/OnRequire/@opensearch-project/opensearch/Version/${semver.major(pkgVersion)}`]: 1,
+      }
+      checkMetrics(agentMetrics, expectedPkgMetrics)
     })
   })
 

test/versioned/pino/pino.test.js

@@ -18,6 +18,7 @@ const { removeMatchedModules } = require('../../lib/cache-buster')
 const { LOGGING } = require('../../../lib/metrics/names')
 const { originalMsgAssertion } = require('./helpers')
 const { validateLogLine, validateCommonAttrs } = require('../../lib/logging-helper')
+const { assertMetrics } = require('../../lib/custom-assertions')
 
 const { version: pinoVersion } = require('pino/package')
 
@@ -88,6 +89,11 @@ test('logging enabled', (t) => {
   logger.info(message)
   metric = agent.metrics.getMetric(LOGGING.LIBS.PINO)
   assert.equal(metric.callCount, 1, `should create ${LOGGING.LIBS.PINO} metric`)
+  const expectedPkgMetrics = [
+    [{ name: 'Supportability/Features/Instrumentation/OnRequire/pino' }],
+    [{ name: `Supportability/Features/Instrumentation/OnRequire/pino/Version/${semver.major(pinoVersion)}` }]
+  ]
+  assertMetrics(agent.metrics, expectedPkgMetrics, false, false)
 })
 
 test('local_decorating', (t, end) => {