newrelic 12.1.0 → 12.1.1

package/NEWS.md

@@ -1,3 +1,23 @@
+### v12.1.1 (2024-08-15)
+
+#### Bug fixes
+
+* Updated `amqplib` instrumentation to properly parse host/port from connect ([#2461](https://github.com/newrelic/node-newrelic/pull/2461)) ([91636a8](https://github.com/newrelic/node-newrelic/commit/91636a8e9702ba4ad1bf9b3941432ea65a3920fe))
+* Updated `redis` instrumentation to parse host/port when a url is not provided ([#2463](https://github.com/newrelic/node-newrelic/pull/2463)) ([2b67623](https://github.com/newrelic/node-newrelic/commit/2b67623afef5fb132105c7f5b1d72e23b6d56dc1))
+* Updated the `kafkajs` node metrics to remove `/Named` from the name ([#2458](https://github.com/newrelic/node-newrelic/pull/2458)) ([37ce113](https://github.com/newrelic/node-newrelic/commit/37ce1137a91c2efa85541cf6ec252a759e5f48ea))
+
+#### Code refactoring
+
+* Updated pino instrumentation to separate the wrapping of asJson into its own function ([#2464](https://github.com/newrelic/node-newrelic/pull/2464)) ([81fdde1](https://github.com/newrelic/node-newrelic/commit/81fdde1e35b5643ff141db1309ca58d7f6176cd5))
+
+#### Documentation
+
+* Updated compatibility report ([#2460](https://github.com/newrelic/node-newrelic/pull/2460)) ([a4570e9](https://github.com/newrelic/node-newrelic/commit/a4570e93298d10f4464570b75867634b95a61e89))
+
+#### Miscellaneous chores
+
+* Removed limit on superagent versioned testing ([#2456](https://github.com/newrelic/node-newrelic/pull/2456)) ([b4b6a6b](https://github.com/newrelic/node-newrelic/commit/b4b6a6b2eca8bd47d17f8b265344b4596c8226b3))
+
 ### v12.1.0 (2024-08-12)
 
 #### Bug fixes

package/lib/instrumentation/@node-redis/client.js

@@ -104,8 +104,9 @@ function getRedisParams(clientOpts) {
   }
 
   return new DatastoreParameters({
-    host: clientOpts?.socket?.host || 'localhost',
-    port_path_or_id: clientOpts?.socket?.path || clientOpts?.socket?.port || '6379',
+    host: clientOpts?.host || clientOpts?.socket?.host || 'localhost',
+    port_path_or_id:
+      clientOpts?.port || clientOpts?.socket?.path || clientOpts?.socket?.port || '6379',
     database_name: clientOpts?.database || 0
   })
 }

package/lib/instrumentation/amqplib/amqplib.js

@@ -9,10 +9,10 @@ const {
   OperationSpec,
   params: { DatastoreParameters }
 } = require('../../shim/specs')
-const url = require('url')
 const wrapModel = require('./channel-model')
-const { setCallback } = require('./utils')
+const { setCallback, parseConnectionArgs } = require('./utils')
 const wrapChannel = require('./channel')
+const { amqpConnection } = require('../../symbols')
 
 module.exports.instrumentPromiseAPI = instrumentChannelAPI
 module.exports.instrumentCallbackAPI = instrumentCallbackAPI
@@ -73,31 +73,52 @@ function instrumentAMQP(shim, amqp, promiseMode) {
 /**
  *
  * Instruments the connect method
+ * We have to both wrap and record because
+ * we need the host/port for all subsequent calls on the model/channel
+ * but record only completes in an active transaction
  *
  * @param {Shim} shim instance of shim
  * @param {object} amqp amqplib object
  * @param {boolean} promiseMode is this promise based?
  */
 function wrapConnect(shim, amqp, promiseMode) {
-  shim.record(amqp, 'connect', function recordConnect(shim, connect, name, args) {
-    let [connArgs] = args
-    const params = new DatastoreParameters()
+  shim.wrap(amqp, 'connect', function wrapConnect(shim, connect) {
+    return function wrappedConnect() {
+      const args = shim.argsToArray.apply(shim, arguments)
+      const [connArgs] = args
+      const params = parseConnectionArgs({ shim, connArgs })
+      const cb = args[args.length - 1]
+      if (!promiseMode) {
+        args[args.length - 1] = function wrappedCallback() {
+          const cbArgs = shim.argsToArray.apply(shim, arguments)
+          const [, c] = cbArgs
+          c.connection[amqpConnection] = params
+          return cb.apply(this, cbArgs)
+        }
+      }
 
-    if (shim.isString(connArgs)) {
-      connArgs = url.parse(connArgs)
-      params.host = connArgs.hostname
-      if (connArgs.port) {
-        params.port = connArgs.port
+      const result = connect.apply(this, args)
+      if (promiseMode) {
+        return result.then((c) => {
+          c.connection[amqpConnection] = params
+          return c
+        })
       }
+      return result
     }
+  })
 
+  shim.record(amqp, 'connect', function recordConnect(shim, connect, name, args) {
+    const [connArgs] = args
+    const params = parseConnectionArgs({ shim, connArgs })
     return new OperationSpec({
       name: 'amqplib.connect',
       callback: setCallback(shim, promiseMode),
       promise: promiseMode,
-      parameters: params,
-      stream: null,
-      recorder: null
+      parameters: new DatastoreParameters({
+        host: params.host,
+        port_path_or_id: params.port
+      })
     })
   })
 }

package/lib/instrumentation/amqplib/channel-model.js

@@ -5,6 +5,7 @@
 
 'use strict'
 const { MessageSpec, MessageSubscribeSpec, RecorderSpec } = require('../../shim/specs')
+const { amqpConnection } = require('../../symbols')
 const CHANNEL_METHODS = [
   'close',
   'open',
@@ -22,13 +23,7 @@ const CHANNEL_METHODS = [
   'prefetch',
   'recover'
 ]
-const {
-  describeMessage,
-  setCallback,
-  parseConnect,
-  getParametersFromMessage,
-  TEMP_RE
-} = require('./utils')
+const { describeMessage, setCallback, getParametersFromMessage, TEMP_RE } = require('./utils')
 
 /**
  *
@@ -89,7 +84,7 @@ function recordPurge({ shim, proto, promiseMode }) {
 
 function recordGet({ shim, proto, promiseMode }) {
   shim.recordConsume(proto, 'get', function wrapGet() {
-    const { host, port } = parseConnect(this?.connection?.stream)
+    const { host, port } = this?.connection?.[amqpConnection] || {}
     return new MessageSpec({
       destinationName: shim.FIRST,
       callback: setCallback(shim, promiseMode),
@@ -115,7 +110,7 @@ function recordGet({ shim, proto, promiseMode }) {
 
 function recordConsume({ shim, proto, promiseMode }) {
   shim.recordSubscribedConsume(proto, 'consume', function consume() {
-    const { host, port } = parseConnect(this?.connection?.stream)
+    const { host, port } = this?.connection?.[amqpConnection] || {}
     return new MessageSubscribeSpec({
       name: 'amqplib.Channel#consume',
       queue: shim.FIRST,

package/lib/instrumentation/amqplib/channel.js

@@ -5,7 +5,8 @@
 
 'use strict'
 const { MessageSpec } = require('../../shim/specs')
-const { parseConnect, getParameters, TEMP_RE } = require('./utils')
+const { amqpConnection } = require('../../symbols')
+const { getParameters, TEMP_RE } = require('./utils')
 
 /**
  *
@@ -47,24 +48,26 @@ module.exports = function wrapChannel(shim) {
     }
   })
 
-  shim.recordProduce(proto, 'sendMessage', function recordSendMessage(shim, fn, n, args) {
-    const fields = args[0]
-    if (!fields) {
-      return null
-    }
-    const isDefault = fields.exchange === ''
-    let exchange = 'Default'
-    if (!isDefault) {
-      exchange = TEMP_RE.test(fields.exchange) ? null : fields.exchange
-    }
-    const { host, port } = parseConnect(this?.connection?.stream)
+  shim.recordProduce(proto, 'sendMessage', recordSendMessage)
+}
+
+function recordSendMessage(shim, fn, n, args) {
+  const fields = args[0]
+  if (!fields) {
+    return null
+  }
+  const isDefault = fields.exchange === ''
+  let exchange = 'Default'
+  if (!isDefault) {
+    exchange = TEMP_RE.test(fields.exchange) ? null : fields.exchange
+  }
+  const { host, port } = this?.connection?.[amqpConnection] || {}
 
-    return new MessageSpec({
-      destinationName: exchange,
-      destinationType: shim.EXCHANGE,
-      routingKey: fields.routingKey,
-      headers: fields.headers,
-      parameters: getParameters({ parameters: Object.create(null), fields, host, port })
-    })
+  return new MessageSpec({
+    destinationName: exchange,
+    destinationType: shim.EXCHANGE,
+    routingKey: fields.routingKey,
+    headers: fields.headers,
+    parameters: getParameters({ parameters: Object.create(null), fields, host, port })
   })
 }

package/lib/instrumentation/amqplib/utils.js

@@ -8,7 +8,6 @@ const {
   MessageSpec,
   params: { QueueMessageParameters }
 } = require('../../shim/specs')
-const { amqpConnection } = require('../../symbols')
 const TEMP_RE = /^amq\./
 
 /**
@@ -100,25 +99,6 @@ function getParametersFromMessage({ message, host, port }) {
   return parameters
 }
 
-/**
- * Extracts the host/port from the amqp socket connection.
- * Stores on connection as symbol to only parse once.
- *
- * @param {Socket} socket amqp connection
- * @returns {object} {host, port } of connection
- */
-function parseConnect(socket) {
-  if (socket[amqpConnection]) {
-    return socket[amqpConnection]
-  }
-  const host = ['127.0.0.1', '::1', '[::1]'].includes(socket?.remoteAddress)
-    ? 'localhost'
-    : socket?.remoteAddress
-  const port = socket?.remotePort
-  socket[amqpConnection] = { host, port }
-  return { host, port }
-}
-
 /**
  * Helper to set the appropriate value of the callback property
  * in the spec. If it's a promise set to null otherwise set it to `shim.LAST`
@@ -131,11 +111,33 @@ function setCallback(shim, promiseMode) {
   return promiseMode ? null : shim.LAST
 }
 
+/**
+ * Parses the connection args to return host/port
+ *
+ * @param {string|object} connArgs connection arguments
+ * @returns {object} {host, port }
+ */
+function parseConnectionArgs({ shim, connArgs }) {
+  const params = {}
+  if (shim.isString(connArgs)) {
+    connArgs = new URL(connArgs)
+    params.host = connArgs.hostname
+    if (connArgs.port) {
+      params.port = parseInt(connArgs.port, 10)
+    }
+  } else {
+    params.port = connArgs.port || (connArgs.protocol === 'amqp' ? 5672 : 5671)
+    params.host = connArgs.hostname
+  }
+
+  return params
+}
+
 module.exports = {
   describeMessage,
   getParameters,
   getParametersFromMessage,
-  parseConnect,
+  parseConnectionArgs,
   setCallback,
   TEMP_RE
 }

package/lib/instrumentation/kafkajs/record-linking-metrics.js

@@ -11,7 +11,7 @@ function recordLinkingMetrics({ agent, brokers, topic, producer = true }) {
   const kind = producer === true ? 'Produce' : 'Consume'
   for (const broker of brokers) {
     agent.metrics
-      .getOrCreateMetric(`MessageBroker/Kafka/Nodes/${broker}/${kind}/Named/${topic}`)
+      .getOrCreateMetric(`MessageBroker/Kafka/Nodes/${broker}/${kind}/${topic}`)
       .incrementCallCount()
   }
 }

package/lib/instrumentation/pino/pino.js

@@ -15,7 +15,6 @@ const {
 } = require('../../util/application-logging')
 const semver = require('semver')
 
-// eslint-disable-next-line sonarjs/cognitive-complexity
 module.exports = function instrument(shim, tools) {
   const pinoVersion = shim.pkgVersion
 
@@ -35,7 +34,20 @@ module.exports = function instrument(shim, tools) {
   const metrics = agent.metrics
   createModuleUsageMetric('pino', metrics)
 
+  wrapAsJson({ shim, tools })
+}
+
+/**
+ * Wraps `asJson` to properly decorate and forward logs
+ *
+ * @param {object} params to function
+ * @param {Shim} params.shim instance of shim
+ * @param {object} params.tools exported `pino/lib/tools`
+ */
+function wrapAsJson({ shim, tools }) {
   const symbols = shim.require('./lib/symbols')
+  const { agent } = shim
+  const { config, metrics } = agent
 
   shim.wrap(tools, 'asJson', function wrapJson(shim, asJson) {
     /**
@@ -98,16 +110,14 @@ module.exports = function instrument(shim, tools) {
  * reformats error and assigns NR context data
  * to log line
  *
- * @param logLine.logLine
- * @param {object} logLine log line
- * @param {object} metadata NR context data
- * @param {string} chindings serialized string of all common log line data
- * @param logLine.args
- * @param logLine.agent
- * @param logLine.chindings
- * @param logLine.msg
- * @param logLine.level
- * @param logLine.logger
+ * @param {object} params to function
+ * @param {object} params.logLine log line
+ * @param {string} params.msg message of log line
+ * @param {object} params.agent instance of agent
+ * @param {string} params.chindings serialized string of all common log line data
+ * @param {string} params.level log level
+ * @param {object} params.logger instance of agent logger
+ * @returns {function} wrapped log formatter function
  */
 function reformatLogLine({ logLine, msg, agent, chindings = '', level, logger }) {
   const metadata = agent.getLinkingMetadata()

package/package.json

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