newrelic 13.6.2 → 13.6.4

package/lib/subscribers/mysql/config.js

@@ -0,0 +1,73 @@
+/*
+ * Copyright 2025 New Relic Corporation. All rights reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+const connectionQuery = {
+  path: './mysql/connection-query.js',
+  instrumentations: [
+    {
+      channelName: 'nr_connectionQuery',
+      module: { name: 'mysql', versionRange: '>=2.16.0', filePath: 'lib/Connection.js' },
+      functionQuery: {
+        moduleName: 'Connection',
+        expressionName: 'query',
+        kind: 'Sync'
+      }
+    }
+  ]
+}
+
+const poolQuery = {
+  path: './mysql/pool-query.js',
+  instrumentations: [
+    {
+      channelName: 'nr_poolQuery',
+      module: { name: 'mysql', versionRange: '>=2.16.0', filePath: 'lib/Pool.js' },
+      functionQuery: {
+        moduleName: 'Pool',
+        expressionName: 'query',
+        kind: 'Sync'
+      }
+    }
+  ]
+}
+
+const poolNamespaceQuery = {
+  path: './mysql/pool-namespace-query.js',
+  instrumentations: [
+    {
+      channelName: 'nr_poolNamespaceQuery',
+      module: { name: 'mysql', versionRange: '>=2.16.0', filePath: 'lib/PoolNamespace.js' },
+      functionQuery: {
+        moduleName: 'PoolNamespace',
+        expressionName: 'query',
+        kind: 'Sync'
+      }
+    }
+  ]
+}
+
+const poolGetConnection = {
+  path: './mysql/pool-get-connection.js',
+  instrumentations: [
+    {
+      channelName: 'nr_poolGetConnection',
+      module: { name: 'mysql', versionRange: '>=2.16.0', filePath: 'lib/Pool.js' },
+      functionQuery: {
+        moduleName: 'Pool',
+        expressionName: 'getConnection',
+        kind: 'Sync'
+      }
+    }
+  ]
+}
+
+module.exports = {
+  mysql: [
+    connectionQuery,
+    poolQuery,
+    poolNamespaceQuery,
+    poolGetConnection,
+  ]
+}

package/lib/subscribers/mysql/connection-query.js

@@ -0,0 +1,56 @@
+/*
+ * Copyright 2025 New Relic Corporation. All rights reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+const DbQuerySubscriber = require('../db-query')
+const { MYSQL } = require('#agentlib/metrics/names.js')
+const { extractQuery, getInstanceParameters } = require('./helper.js')
+const symbols = require('../../symbols')
+const { EventEmitter } = require('node:events')
+
+/**
+ * Subscribes to `mysql`'s `Connection#query` events and creates the
+ * coordinating Datastore query segment.
+ *
+ * Also provides a base for other `Connection#query` subscribers.
+ */
+class MySQLConnectionQuerySubscriber extends DbQuerySubscriber {
+  constructor({ agent, logger, channelName = 'nr_connectionQuery', packageName = 'mysql' }) {
+    super({ agent, logger, channelName, packageName, system: MYSQL.PREFIX })
+    this.events = ['asyncStart', 'asyncEnd', 'end']
+    this.operation = 'query'
+    this.callback = -1
+    this.propagateContext = true
+  }
+
+  handler(data, ctx) {
+    const Connection = data?.self
+    // Setting this symbol is necessary because we
+    // may need to track the databaseName across multiple
+    // consecutive queries; see `getInstanceParameters`.
+    Connection[symbols.storeDatabase] = true
+
+    // Set database attributes
+    this.queryString = extractQuery(data?.arguments)
+    this.parameters = getInstanceParameters(this.logger, Connection, this.queryString)
+    this.parameters.product = this.system
+
+    // Call DbQuerySubscriber.handler to make the segment
+    return super.handler(data, ctx)
+  }
+
+  end(data) {
+    const ctx = this.agent.tracer.getContext()
+    if (ctx?.transaction?.isActive() !== true) {
+      return
+    }
+
+    if (data?.result instanceof EventEmitter) {
+      const ctx = this.agent.tracer.getContext()
+      this.wrapEventEmitter({ args: data, index: 'result', ctx })
+    }
+  }
+}
+
+module.exports = MySQLConnectionQuerySubscriber

package/lib/subscribers/mysql/helper.js

@@ -0,0 +1,102 @@
+/*
+ * Copyright 2025 New Relic Corporation. All rights reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+const properties = require('../../util/properties')
+const symbols = require('../../symbols')
+
+/**
+ * @typedef {object} DatastoreParameters
+ * @property {string} host
+ *  The host of the database server being interacted with. If provided, along
+ *  with `port_path_or_id`, then an instance metric will also be generated for
+ *  this database.
+ * @property {number|string} port_path_or_id
+ *  The port number or path to domain socket used to connect to the database
+ *  server.
+ * @property {string} database_name
+ *  The name of the database being queried or operated on.
+ * @property {string} collection
+ *  The name of the collection or table being queried or operated on.
+ */
+
+/**
+ * Extracts the query string from the function arguments.
+ * @param {object[]} args the original query arguments
+ * @returns {string} the extracted query string
+ */
+function extractQuery(args) {
+  let query = ''
+
+  // Figure out the query parameter.
+  if (args[0] && typeof args[0] === 'string') {
+    // query(sql [, values], callback)
+    query = args[0]
+  } else {
+    // query(opts [, values], callback)
+    query = args[0].sql
+  }
+
+  return query
+}
+
+/**
+ *
+ * @param {object} logger an instance of the New Relic agent logger
+ * @param {object} queryable a MySQL object that has a `query` function e.g. `Connection` or `Pool`
+ * @param {string} query the query string
+ * @returns {DatastoreParameters} the relevant datastore parameters
+ */
+function getInstanceParameters(logger, queryable, query) {
+  const parameters = {}
+  let conf = queryable.config
+  conf = conf?.connectionConfig || conf
+  const databaseName = queryable[symbols.databaseName] || null
+
+  // Look at config for parameters
+  if (conf) {
+    parameters.database_name = databaseName || conf.database
+
+    if (properties.hasOwn(conf, 'socketPath') && conf.socketPath) {
+      // In the unix domain socket case we force the host to be localhost
+      parameters.host = 'localhost'
+      parameters.port_path_or_id = conf.socketPath
+    } else {
+      parameters.host = conf.host
+      parameters.port_path_or_id = conf.port
+    }
+  } else {
+    logger.trace('No query config detected, not collecting db instance data')
+  }
+
+  storeDatabaseName(queryable, query)
+  return parameters
+}
+
+function extractDatabaseChangeFromUse(sql) {
+  // The character ranges for this were pulled from
+  // http://dev.mysql.com/doc/refman/5.7/en/identifiers.html
+
+  // The lint rule being suppressed here has been evaluated, and it has been
+  // determined that the regular expression is sufficient for our use case.
+  // eslint-disable-next-line sonarjs/slow-regex
+  const match = /^\s*use[^\w`]+([\w$\u0080-\uFFFF]+|`[^`]+`)[\s;]*$/i.exec(sql)
+  return (match && match[1]) || null
+}
+
+function storeDatabaseName(queryable, query) {
+  if (queryable[symbols.storeDatabase]) {
+    const databaseName = extractDatabaseChangeFromUse(query)
+    if (databaseName) {
+      queryable[symbols.databaseName] = databaseName
+    }
+  }
+}
+
+module.exports = {
+  extractQuery,
+  getInstanceParameters,
+  // exported for testing purposes
+  extractDatabaseChangeFromUse
+}

package/lib/subscribers/mysql/pool-get-connection.js

@@ -0,0 +1,20 @@
+/*
+ * Copyright 2025 New Relic Corporation. All rights reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+const PropagationSubscriber = require('../propagation')
+
+/**
+ * This subscriber is only required to propagate the context within
+ * `Pool#getConnection`.
+ *
+ * Will be deleted when MySQL Pool#query segments are removed (@see https://github.com/newrelic/node-newrelic/issues/3482).
+ */
+class MySQLPoolGetConnectionSubscriber extends PropagationSubscriber {
+  constructor({ agent, logger, packageName = 'mysql', channelName = 'nr_poolGetConnection' }) {
+    super({ agent, logger, packageName, channelName, callback: -1 })
+  }
+}
+
+module.exports = MySQLPoolGetConnectionSubscriber

package/lib/subscribers/mysql/pool-namespace-query.js

@@ -0,0 +1,19 @@
+/*
+ * Copyright 2025 New Relic Corporation. All rights reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+const MySQLPoolQuerySubscriber = require('./pool-query.js')
+
+/**
+ * Subscribes to the events produced by `mysql`'s `PoolNamespace#query`.
+ *
+ * Will be deleted when MySQL Pool#query segments are removed (@see https://github.com/newrelic/node-newrelic/issues/3482).
+ */
+class MySQLPoolNamespaceQuerySubscriber extends MySQLPoolQuerySubscriber {
+  constructor({ agent, logger, channelName = 'nr_poolNamespaceQuery', packageName = 'mysql' }) {
+    super({ agent, logger, channelName, packageName })
+  }
+}
+
+module.exports = MySQLPoolNamespaceQuerySubscriber

package/lib/subscribers/mysql/pool-query.js

@@ -0,0 +1,41 @@
+/*
+ * Copyright 2025 New Relic Corporation. All rights reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+const Subscriber = require('../base')
+const symbols = require('../../symbols')
+
+/**
+ * Subscribes to the events produced by `mysql`'s `Pool#query`
+ * and creates a special segment named 'MySQL Pool#query'.
+ *
+ * Also provides a base for other `Pool#query` subscribers.
+ *
+ * Will be deleted when MySQL Pool#query segments are removed (@see https://github.com/newrelic/node-newrelic/issues/3482).
+ */
+class MySQLPoolQuerySubscriber extends Subscriber {
+  constructor({ agent, logger, channelName = 'nr_poolQuery', packageName = 'mysql' }) {
+    super({ agent, logger, channelName, packageName })
+    this.events = ['asyncStart', 'asyncEnd']
+    this.callback = -1
+    this.propagateContext = true
+  }
+
+  handler(data, ctx) {
+    const Pool = data?.self
+    // Setting this symbol is necessary because we
+    // may need to track the databaseName across multiple
+    // consecutive queries; see `getInstanceParameters`.
+    Pool[symbols.storeDatabase] = true
+
+    // Create the segment, but don't supply a recorder
+    const name = 'MySQL Pool#query'
+    return this.createSegment({
+      name,
+      ctx
+    })
+  }
+}
+
+module.exports = MySQLPoolQuerySubscriber

package/lib/subscribers/mysql2/config.js

@@ -0,0 +1,127 @@
+/*
+ * Copyright 2025 New Relic Corporation. All rights reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+// MySQL2 subscriber configs
+const connectionQuery2 = {
+  path: './mysql2/connection-query.js',
+  instrumentations: [
+    {
+      channelName: 'nr_connectionQuery',
+      module: { name: 'mysql2', versionRange: '>=2.0.0 <3.11.5', filePath: 'lib/connection.js' },
+      functionQuery: {
+        className: 'Connection',
+        methodName: 'query',
+        kind: 'Sync'
+      }
+    },
+    {
+      channelName: 'nr_connectionQuery',
+      module: { name: 'mysql2', versionRange: '>=3.11.5', filePath: 'lib/base/connection.js' },
+      functionQuery: {
+        className: 'BaseConnection',
+        methodName: 'query',
+        kind: 'Sync'
+      }
+    }
+  ]
+}
+
+const poolQuery2 = {
+  path: './mysql2/pool-query.js',
+  instrumentations: [
+    {
+      channelName: 'nr_poolQuery',
+      module: { name: 'mysql2', versionRange: '>2.0.0 <3.11.5', filePath: 'lib/pool.js' },
+      functionQuery: {
+        className: 'Pool',
+        methodName: 'query',
+        kind: 'Sync'
+      }
+    },
+    {
+      channelName: 'nr_poolQuery',
+      module: { name: 'mysql2', versionRange: '>=3.11.5', filePath: 'lib/base/pool.js' },
+      functionQuery: {
+        className: 'BasePool',
+        methodName: 'query',
+        kind: 'Sync'
+      }
+    }
+  ]
+}
+
+const poolNamespaceQuery2 = {
+  path: './mysql2/pool-namespace-query.js',
+  instrumentations: [
+    {
+      channelName: 'nr_poolNamespaceQuery',
+      // The `PoolNamespace` class did not get moved into lib/base in mysql2@3.11.5.
+      module: { name: 'mysql2', versionRange: '>=3.0.0', filePath: 'lib/pool_cluster.js' },
+      functionQuery: {
+        className: 'PoolNamespace',
+        methodName: 'query',
+        kind: 'Sync'
+      }
+    }
+  ]
+}
+
+const poolGetConnection = {
+  path: './mysql2/pool-get-connection.js',
+  instrumentations: [
+    {
+      channelName: 'nr_poolGetConnection',
+      module: { name: 'mysql2', versionRange: '>2.0.0 <3.11.5', filePath: 'lib/pool.js' },
+      functionQuery: {
+        className: 'Pool',
+        methodName: 'getConnection',
+        kind: 'Sync'
+      }
+    },
+    {
+      channelName: 'nr_poolGetConnection',
+      module: { name: 'mysql2', versionRange: '>=3.11.5', filePath: 'lib/base/pool.js' },
+      functionQuery: {
+        className: 'BasePool',
+        methodName: 'getConnection',
+        kind: 'Sync'
+      }
+    }
+  ]
+}
+
+const connectionExecute = {
+  path: './mysql2/connection-execute.js',
+  instrumentations: [
+    {
+      channelName: 'nr_connectionExecute',
+      module: { name: 'mysql2', versionRange: '>=2.0.0 <3.11.5', filePath: 'lib/connection.js' },
+      functionQuery: {
+        className: 'Connection',
+        methodName: 'execute',
+        kind: 'Sync'
+      }
+    },
+    {
+      channelName: 'nr_connectionExecute',
+      module: { name: 'mysql2', versionRange: '>=3.11.5', filePath: 'lib/base/connection.js' },
+      functionQuery: {
+        className: 'BaseConnection',
+        methodName: 'execute',
+        kind: 'Sync'
+      }
+    }
+  ]
+}
+
+module.exports = {
+  mysql2: [
+    connectionQuery2,
+    poolQuery2,
+    poolNamespaceQuery2,
+    poolGetConnection,
+    connectionExecute,
+  ]
+}

package/lib/subscribers/mysql2/connection-execute.js

@@ -0,0 +1,18 @@
+/*
+ * Copyright 2025 New Relic Corporation. All rights reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+const MySQL2ConnectionQuerySubscriber = require('../mysql/connection-query')
+
+/**
+ * Subscribes to `mysql2`'s `Connection#execute` events.
+ */
+class MySQL2ConnectionExecuteSubscriber extends MySQL2ConnectionQuerySubscriber {
+  constructor({ agent, logger }) {
+    super({ agent, logger, channelName: 'nr_connectionExecute', packageName: 'mysql2' })
+    this.operation = 'execute'
+  }
+}
+
+module.exports = MySQL2ConnectionExecuteSubscriber

package/lib/subscribers/mysql2/connection-query.js

@@ -0,0 +1,17 @@
+/*
+ * Copyright 2025 New Relic Corporation. All rights reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+const MySQLConnectionQuerySubscriber = require('../mysql/connection-query')
+
+/**
+ * Subscribes to `mysql2`'s `Connection#query` events.
+ */
+class MySQL2ConnectionQuerySubscriber extends MySQLConnectionQuerySubscriber {
+  constructor({ agent, logger }) {
+    super({ agent, logger, packageName: 'mysql2' })
+  }
+}
+
+module.exports = MySQL2ConnectionQuerySubscriber

package/lib/subscribers/mysql2/pool-get-connection.js

@@ -0,0 +1,20 @@
+/*
+ * Copyright 2025 New Relic Corporation. All rights reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+const MySqlPoolGetConnectionSubscriber = require('../mysql/pool-get-connection')
+
+/**
+ * This subscriber is only required to propagate the context within
+ * `Pool#getConnection`.
+ *
+ * Will be deleted when MySQL Pool#query segments are removed (@see https://github.com/newrelic/node-newrelic/issues/3482).
+ */
+class MySQL2PoolGetConnectionSubscriber extends MySqlPoolGetConnectionSubscriber {
+  constructor({ agent, logger }) {
+    super({ agent, logger, packageName: 'mysql2' })
+  }
+}
+
+module.exports = MySQL2PoolGetConnectionSubscriber

package/lib/subscribers/mysql2/pool-namespace-query.js

@@ -0,0 +1,19 @@
+/*
+ * Copyright 2025 New Relic Corporation. All rights reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+const MySQLPoolNamespaceQuerySubscriber = require('../mysql/pool-namespace-query.js')
+
+/**
+ * Subscribes to the events produced by `mysql2`'s `PoolNamespace#query`.
+ *
+ * Will be deleted when MySQL Pool#query segments are removed (@see https://github.com/newrelic/node-newrelic/issues/3482).
+ */
+class MySQL2PoolNamespaceQuerySubscriber extends MySQLPoolNamespaceQuerySubscriber {
+  constructor({ agent, logger }) {
+    super({ agent, logger, packageName: 'mysql2' })
+  }
+}
+
+module.exports = MySQL2PoolNamespaceQuerySubscriber

package/lib/subscribers/mysql2/pool-query.js

@@ -0,0 +1,19 @@
+/*
+ * Copyright 2025 New Relic Corporation. All rights reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+const MySQLPoolQuerySubscriber = require('../mysql/pool-query.js')
+
+/**
+ * Subscribes to the events produced by `mysql2`'s `Pool#query`.
+ *
+ * Will be deleted when MySQL Pool#query segments are removed (@see https://github.com/newrelic/node-newrelic/issues/3482).
+ */
+class MySQL2PoolQuerySubscriber extends MySQLPoolQuerySubscriber {
+  constructor({ agent, logger }) {
+    super({ agent, logger, packageName: 'mysql2' })
+  }
+}
+
+module.exports = MySQL2PoolQuerySubscriber

package/lib/subscribers/openai/utils.js

@@ -252,6 +252,7 @@ function instrumentStream({ agent, headers, logger, request, response, segment,
   response.iterator = async function * wrappedIterator() {
     let content = ''
     let role = ''
+    let finishReason = ''
     let chunk
     try {
       const iterator = orig.apply(this, arguments)
@@ -261,6 +262,10 @@ function instrumentStream({ agent, headers, logger, request, response, segment,
           role = chunk.choices[0].delta.role
         }
 
+        if (chunk.choices?.[0]?.finish_reason) {
+          finishReason = chunk.choices[0].finish_reason
+        }
+
         content += chunk.choices?.[0]?.delta?.content ?? ''
         yield chunk
       }
@@ -268,8 +273,12 @@ function instrumentStream({ agent, headers, logger, request, response, segment,
       err = streamErr
       throw err
     } finally {
-      if (chunk?.choices && chunk?.choices?.length !== 0) {
-        chunk.choices[0].message = { role, content }
+      // when `chunk.choices` is an array that means the completions API is being used
+      // we must re-assign the finish reason, and construct a message object with role and content
+      // This is because if `include_usage` is enabled, the last chunk only contains usage info and no message deltas
+      if (Array.isArray(chunk?.choices)) {
+        chunk.choices = [{ finish_reason: finishReason, message: { role, content } }]
+      // This means it is the responses API and the entire message is in the response object
       } else if (chunk?.response) {
         chunk = chunk.response
       }

package/lib/subscribers/pg/query.js

@@ -57,7 +57,7 @@ class PgQuerySubscriber extends DbQuerySubscriber {
     // then wrap the arguments and bind the new context to the event emitter
     const newCtx = super.handler(data, ctx)
     if (data?.arguments[0] instanceof EventEmitter) {
-      this.wrapEventEmitter({ args: data.arguments, index: 0, name: 'emit', ctx: newCtx })
+      this.wrapEventEmitter({ args: data.arguments, index: 0, ctx: newCtx })
     }
     return newCtx
   }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "newrelic",
-  "version": "13.6.2",
+  "version": "13.6.4",
   "author": "New Relic Node.js agent team <nodejs@newrelic.com>",
   "license": "Apache-2.0",
   "contributors": [

package/lib/db/utils.js

@@ -1,19 +0,0 @@
-/*
- * Copyright 2020 New Relic Corporation. All rights reserved.
- * SPDX-License-Identifier: Apache-2.0
- */
-
-'use strict'
-
-module.exports.extractDatabaseChangeFromUse = extractDatabaseChangeFromUse
-
-function extractDatabaseChangeFromUse(sql) {
-  // The character ranges for this were pulled from
-  // http://dev.mysql.com/doc/refman/5.7/en/identifiers.html
-
-  // The lint rule being suppressed here has been evaluated, and it has been
-  // determined that the regular expression is sufficient for our use case.
-  // eslint-disable-next-line sonarjs/slow-regex
-  const match = /^\s*use[^\w`]+([\w$\u0080-\uFFFF]+|`[^`]+`)[\s;]*$/i.exec(sql)
-  return (match && match[1]) || null
-}