update tests for metrics

jsumners-nr · jsumners-nr · commit edbaf161b643 · 2026-01-09T12:35:54.000-05:00
diff --git a/lib/shimmer.js b/lib/shimmer.js
@@ -306,7 +306,7 @@ const shimmer = (module.exports = {
   registerHooks(agent) {
     // add the packages from the subscriber based instrumentation
     // this is only added to add tracking metrics
-    pkgsToHook.push(...Object.keys(subscriptions), ...trackingPkgs)
+    Array.prototype.push.apply(pkgsToHook, trackingPkgs)
     this._ritm = new Hook(pkgsToHook, function onHook(exports, name, basedir) {
       return _postLoad(agent, exports, name, basedir)
     })
diff --git a/test/lib/custom-assertions/assert-pkg-tracking-metrics.js b/test/lib/custom-assertions/assert-pkg-tracking-metrics.js
@@ -4,9 +4,18 @@
  */
 
 'use strict'
-const NAMES = require('#agentlib/metrics/names.js')
-const assertMetrics = require('./assert-metrics')
+
 const semver = require('semver')
+const assertMetrics = require('./assert-metrics')
+
+const {
+  FEATURES: {
+    INSTRUMENTATION: {
+      SUBSCRIBER_USED,
+      ON_REQUIRE
+    }
+  }
+} = require('#agentlib/metrics/names.js')
 
 /**
  * assertion to verify tracking metrics for a given
@@ -16,19 +25,29 @@ const semver = require('semver')
  * @param {string} params.pkg name of package
  * @param {string} params.version version of package
  * @param {Agent} params.agent agent instance
+ * @param {boolean} params.subscriberType When true, the metrics are expected
+ * to have been generated from a subscriber based instrumentation. Otherwise,
+ * the metrics are expected to be generated from a shimmer based
+ * instrumentation.
  * @param {object} [deps] Injected dependencies.
  * @param {object} [deps.assert] Assertion library to use.
  */
 module.exports = function assertPackageMetrics(
-  { pkg, version, agent },
+  { pkg, version, agent, subscriberType = false },
   { assert = require('node:assert') } = {}
 ) {
-  const metrics = [
-    [{ name: `${NAMES.FEATURES.INSTRUMENTATION.ON_REQUIRE}/${pkg}` }]
-  ]
+  const metrics = []
+  const prefix = subscriberType === true
+    ? `${SUBSCRIBER_USED}/${pkg}`
+    : `${ON_REQUIRE}/${pkg}`
 
+  metrics.push([{ name: prefix }])
   if (version) {
-    metrics.push([{ name: `${NAMES.FEATURES.INSTRUMENTATION.ON_REQUIRE}/${pkg}/Version/${semver.major(version)}` }])
+    const major = semver.major(version)
+    const suffix = subscriberType === true
+      ? `/${major}`
+      : `/Version/${major}`
+    metrics.push([{ name: `${prefix}${suffix}` }])
   }
 
   assertMetrics(agent.metrics, metrics, false, false, { assert })
diff --git a/test/versioned/amqplib/callback.test.js b/test/versioned/amqplib/callback.test.js
@@ -62,7 +62,7 @@ test('amqplib callback instrumentation', async function (t) {
 
   await t.test('should log tracking metrics', function(t) {
     const { agent } = t.nr
-    assertPackageMetrics({ agent, pkg: 'amqplib', version })
+    assertPackageMetrics({ agent, pkg: 'amqplib', version, subscriberType: true })
   })
 
   await t.test('connect in a transaction', function (t, end) {
diff --git a/test/versioned/amqplib/promises.test.js b/test/versioned/amqplib/promises.test.js
@@ -55,7 +55,7 @@ test('amqplib promise instrumentation', async function (t) {
 
   await t.test('should log tracking metrics', function(t) {
     const { agent } = t.nr
-    assertPackageMetrics({ agent, pkg: 'amqplib', version })
+    assertPackageMetrics({ agent, pkg: 'amqplib', version, subscriberType: true })
   })
 
   await t.test('connect in a transaction', async function (t) {
diff --git a/test/versioned/bunyan/bunyan.test.js b/test/versioned/bunyan/bunyan.test.js
@@ -51,9 +51,10 @@ test('logging enabled/disabled', async (t) => {
 
   await t.test('should log tracking metrics', function(t) {
     setup(t.nr, { application_logging: { enabled: true } })
-    const { agent } = t.nr
+    const { agent, bunyan } = t.nr
     const { version } = require('bunyan/package.json')
-    assertPackageMetrics({ agent, pkg: 'bunyan', version })
+    bunyan.createLogger({ name: 'test-logger' })
+    assertPackageMetrics({ agent, pkg: 'bunyan', version, subscriberType: true })
   })
 
   await t.test('logging enabled', (t) => {
diff --git a/test/versioned/elastic/elasticsearch.test.js b/test/versioned/elastic/elasticsearch.test.js
@@ -407,7 +407,7 @@ test('Elasticsearch instrumentation', async (t) => {
       expected['Datastore/instance/ElasticSearch/' + HOST_ID] = 5
       checkMetrics(unscoped, expected)
       const pkgName = '@elastic/elasticsearch'
-      assertPackageMetrics({ agent, pkg: pkgName, version: pkgVersion })
+      assertPackageMetrics({ agent, pkg: pkgName, version: pkgVersion, subscriberType: true })
     })
   })
 
diff --git a/test/versioned/express/app-use.test.js b/test/versioned/express/app-use.test.js
@@ -39,7 +39,6 @@ test('app should be at top of stack when mounted', async function (t) {
 
   const express = require('express')
   const { version } = require('express/package.json')
-  assertPackageMetrics({ agent, pkg: 'express', version })
   const main = express()
   const app = express()
   const app2 = express()
@@ -67,6 +66,7 @@ test('app should be at top of stack when mounted', async function (t) {
   // store finished transactions
   const finishedTransactions = {}
   agent.on('transactionFinished', function (tx) {
+    assertPackageMetrics({ agent, pkg: 'express', version, subscriberType: true })
     finishedTransactions[tx.id] = tx
   })
 
diff --git a/test/versioned/google-genai/chat-completions.test.js b/test/versioned/google-genai/chat-completions.test.js
@@ -53,9 +53,21 @@ test.afterEach((ctx) => {
   removeModules('@google/genai')
 })
 
-test('should log tracking metrics', function(t) {
-  const { agent } = t.nr
-  assertPackageMetrics({ agent, pkg: '@google/genai', version: pkgVersion })
+test('should log tracking metrics', function(t, end) {
+  t.plan(5)
+  const { agent, client } = t.nr
+  helper.runInTransaction(agent, async () => {
+    const model = 'gemini-2.0-flash'
+    await client.models.generateContent({
+      model,
+      contents: 'You are a mathematician.'
+    })
+    assertPackageMetrics(
+      { agent, pkg: '@google/genai', version: pkgVersion, subscriberType: true },
+      { assert: t.assert }
+    )
+    end()
+  })
 })
 
 test('should create span on successful models generateContent', (t, end) => {
diff --git a/test/versioned/ioredis/ioredis.test.js b/test/versioned/ioredis/ioredis.test.js
@@ -63,7 +63,7 @@ test('ioredis instrumentation', async (t) => {
       expected['Datastore/instance/Redis/' + HOST_ID] = 2
 
       assertMetrics(tx.metrics, expected, false, false, { assert: plan })
-      assertPackageMetrics({ agent, pkg: 'ioredis', version: pkgVersion })
+      assertPackageMetrics({ agent, pkg: 'ioredis', version: pkgVersion, subscriberType: true })
     })
 
     helper.runInTransaction(agent, async (transaction) => {
diff --git a/test/versioned/iovalkey/iovalkey.test.js b/test/versioned/iovalkey/iovalkey.test.js
@@ -63,7 +63,12 @@ test('iovalkey instrumentation', async (t) => {
       expected['Datastore/instance/Valkey/' + HOST_ID] = 2
 
       assertMetrics(tx.metrics, expected, false, false, { assert: plan })
-      assertPackageMetrics({ agent, pkg: 'iovalkey', version: pkgVersion })
+      assertPackageMetrics({
+        agent,
+        pkg: 'iovalkey',
+        version: pkgVersion,
+        subscriberType: true
+      })
     })
 
     helper.runInTransaction(agent, async (transaction) => {
diff --git a/test/versioned/mcp-sdk/client-stdio.test.js b/test/versioned/mcp-sdk/client-stdio.test.js
@@ -7,6 +7,7 @@
 
 const test = require('node:test')
 const assert = require('node:assert')
+const path = require('node:path')
 
 const { removeModules } = require('../../lib/cache-buster')
 const helper = require('../../lib/agent_helper')
@@ -27,7 +28,7 @@ test.beforeEach(async (ctx) => {
   const { StdioClientTransport } = require('@modelcontextprotocol/sdk/client/stdio.js')
   ctx.nr.transport = new StdioClientTransport({
     command: 'node',
-    args: ['stdio-server.js']
+    args: [path.join(__dirname, 'stdio-server.js')]
   })
   ctx.nr.client = new Client(
     {
@@ -45,10 +46,21 @@ test.afterEach(async (ctx) => {
   removeModules(['@modelcontextprotocol/sdk/client/index.js', '@modelcontextprotocol/sdk/client/stdio.js'])
 })
 
-test('should log tracking metrics', function(t) {
-  const { agent } = t.nr
+test('should log tracking metrics', function(t, end) {
+  t.plan(5)
+  const { agent, client } = t.nr
   const pkgVersion = helper.readPackageVersion(__dirname, '@modelcontextprotocol/sdk')
-  assertPackageMetrics({ agent, pkg: '@modelcontextprotocol/sdk', version: pkgVersion })
+  helper.runInTransaction(agent, async () => {
+    await client.callTool({
+      name: 'echo',
+      arguments: { message: 'example message' }
+    })
+    assertPackageMetrics(
+      { agent, pkg: '@modelcontextprotocol/sdk', version: pkgVersion, subscriberType: true },
+      { assert: t.assert }
+    )
+    end()
+  })
 })
 
 test('should create span for callTool', async (t) => {
diff --git a/test/versioned/mcp-sdk/client-streaming.test.js b/test/versioned/mcp-sdk/client-streaming.test.js
@@ -57,7 +57,12 @@ test.afterEach(async (ctx) => {
 test('should log package tracking metrics', (t) => {
   const { agent } = t.nr
   const version = helper.readPackageVersion(__dirname, '@modelcontextprotocol/sdk')
-  assertPackageMetrics({ agent, pkg: '@modelcontextprotocol/sdk', version })
+  assertPackageMetrics({
+    agent,
+    pkg: '@modelcontextprotocol/sdk',
+    version,
+    subscriberType: true
+  })
 })
 
 test('should create span for callTool', (t, end) => {
diff --git a/test/versioned/mysql/basic.js b/test/versioned/mysql/basic.js
@@ -55,7 +55,7 @@ module.exports = function ({ lib, factory, poolFactory, constants, version }) {
 
     await t.test('should log tracking metrics', function(t) {
       const { agent } = t.nr
-      assertPackageMetrics({ agent, pkg: lib, version })
+      assertPackageMetrics({ agent, pkg: lib, version, subscriberType: true })
     })
 
     await t.test('basic transaction', function testTransaction(t, end) {
diff --git a/test/versioned/nestjs/nest.test.js b/test/versioned/nestjs/nest.test.js
@@ -14,12 +14,14 @@ const { initNestApp, deleteNestApp } = require('./setup')
 const { assertPackageMetrics } = require('../../lib/custom-assertions')
 
 test('Nest.js', async (t) => {
-  const port = 8972 // chosen by rand(), guaranteed to be random
-  const baseUrl = `http://localhost:${port}`
   await initNestApp()
   const agent = helper.instrumentMockedAgent()
   const { bootstrap } = require('./test-app/dist/main.js')
-  const app = await bootstrap(port)
+  const app = await bootstrap(0)
+  const address = app.httpServer.address()
+  const baseUrl = address.family === 'IPv6'
+    ? `http://[${address.address}]:${address.port}`
+    : `http://${address.address}:${address.port}`
 
   t.after(async () => {
     app.close()
@@ -28,7 +30,7 @@ test('Nest.js', async (t) => {
     await deleteNestApp()
   })
 
-  await t.test('should log tracking metrics', function() {
+  await t.test('should log tracking metrics', async function() {
     // eslint-disable-next-line sonarjs/no-internal-api-use
     const { version } = require('./test-app/node_modules/@nestjs/core/package.json')
     assertPackageMetrics({ agent, pkg: '@nestjs/core', version })
diff --git a/test/versioned/nestjs/setup.js b/test/versioned/nestjs/setup.js
@@ -23,7 +23,10 @@ async function initNestApp() {
     await deleteNestApp()
   }
   // skip install of deps because we will install them later to force peer dep failures on nest 10.x
-  await exec('npx nest new --package-manager npm --skip-git --skip-install test-app')
+  await exec(
+    'npx nest new --package-manager npm --skip-git --skip-install test-app',
+    { cwd: __dirname }
+  )
   // on versions of nest 10.x peer dep issues exist, ignore them and force install
   await exec('npm install --prefix test-app --force', { cwd: __dirname })
   // We patch the default Nest app with some of our own functions.
diff --git a/test/versioned/opensearch/opensearch.test.js b/test/versioned/opensearch/opensearch.test.js
@@ -351,7 +351,12 @@ test('opensearch instrumentation', async (t) => {
       }
       expected['Datastore/instance/OpenSearch/' + HOST_ID] = 5
       checkMetrics(unscoped, expected)
-      assertPackageMetrics({ agent, pkg: '@opensearch-project/opensearch', version: pkgVersion })
+      assertPackageMetrics({
+        agent,
+        pkg: '@opensearch-project/opensearch',
+        version: pkgVersion,
+        subscriberType: true
+      })
     })
   })
 
diff --git a/test/versioned/pg/pg.common.js b/test/versioned/pg/pg.common.js
@@ -237,7 +237,7 @@ module.exports = function runTests(name, clientFactory) {
     await t.test('should log tracking metrics', function(t) {
       const { agent } = t.nr
       const version = helper.readPackageVersion(__dirname, 'pg')
-      assertPackageMetrics({ agent, pkg: 'pg', version })
+      assertPackageMetrics({ agent, pkg: 'pg', version, subscriberType: true })
     })
 
     await t.test('simple query with prepared statement', (t, end) => {
diff --git a/test/versioned/pino/pino.test.js b/test/versioned/pino/pino.test.js
@@ -89,7 +89,7 @@ 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`)
-  assertPackageMetrics({ agent, pkg: 'pino', version: pinoVersion })
+  assertPackageMetrics({ agent, pkg: 'pino', version: pinoVersion, subscriberType: true })
 })
 
 test('local_decorating', (t, end) => {
diff --git a/test/versioned/undici/requests.test.js b/test/versioned/undici/requests.test.js
@@ -51,9 +51,17 @@ test('should not fail if request not in a transaction', async (t) => {
   assert.equal(statusCode, 200)
 })
 
-test('should create tracking metrics', (t) => {
-  const { agent, pkgVersion } = t.nr
-  assertPackageMetrics({ agent, pkg: 'undici', version: pkgVersion })
+test('should create tracking metrics', (t, end) => {
+  t.plan(5)
+  const { agent, pkgVersion, undici, REQUEST_URL } = t.nr
+  helper.runInTransaction(agent, async () => {
+    await undici.request(REQUEST_URL)
+    assertPackageMetrics(
+      { agent, pkg: 'undici', version: pkgVersion, subscriberType: true },
+      { assert: t.assert }
+    )
+    end()
+  })
 })
 
 test('should properly name segments', async (t) => {
