newrelic 13.4.0 → 13.6.0

package/NEWS.md

@@ -1,3 +1,72 @@
+### v13.6.0 (2025-10-27)
+
+#### Features
+
+* Added instrumentation for http2 client methods ([#3284](https://github.com/newrelic/node-newrelic/pull/3284)) ([bda7aea](https://github.com/newrelic/node-newrelic/commit/bda7aeaac16ce9f54bd28de72aa7465be96cd157))
+
+#### Bug fixes
+
+* Updated `ioredis` instrumentation to handle breakage of errors when using `.pipeline`. ([#3457](https://github.com/newrelic/node-newrelic/pull/3457)) ([49f4d93](https://github.com/newrelic/node-newrelic/commit/49f4d93a59045f35406dfdbd3248dca0652727d6))
+* Updated `openai` `instrumentStream` function to handle empty chunk when `include_usage` is set ([#3427](https://github.com/newrelic/node-newrelic/pull/3427)) ([f804940](https://github.com/newrelic/node-newrelic/commit/f8049405003f0811450f75468e0bddfb1f05ec2b))
+
+#### Code refactoring
+
+* Update `express` instrumentation to subscribe to events emitted ([#3424](https://github.com/newrelic/node-newrelic/pull/3424)) ([bbf3d01](https://github.com/newrelic/node-newrelic/commit/bbf3d010bc402953e53cae5200af6bfb55a6446d))
+* Updated instances in instrumentation of `Array.forEach` for a more performant for...of or for index loop ([#3463](https://github.com/newrelic/node-newrelic/pull/3463)) ([99484ce](https://github.com/newrelic/node-newrelic/commit/99484ce0e7a963fbbc3cbc22f4956ce19e5eecc2))
+* Updated instances of `Array.forEach` for a more performant for...of or for index loop ([#3440](https://github.com/newrelic/node-newrelic/pull/3440)) ([48c37bf](https://github.com/newrelic/node-newrelic/commit/48c37bf7f85291553666d4512ca995b6a5b136a2))
+* Updated token calculation for `aws-bedrock` LLM Events ([#3445](https://github.com/newrelic/node-newrelic/pull/3445)) ([9450181](https://github.com/newrelic/node-newrelic/commit/945018171da713487a0b5b674e68bdbb211e655e))
+* Updated token calculation for `google-genai` LLM Events ([#3431](https://github.com/newrelic/node-newrelic/pull/3431)) ([41d32be](https://github.com/newrelic/node-newrelic/commit/41d32befe1d9c3201b62253a5de76c918d98a025))
+* Updated token calculation for `openai` LLM Events ([#3430](https://github.com/newrelic/node-newrelic/pull/3430)) ([b8678cc](https://github.com/newrelic/node-newrelic/commit/b8678cc92bb986eae7efec4b516f66406307e841))
+
+#### Documentation
+
+* Updated compatibility report ([#3459](https://github.com/newrelic/node-newrelic/pull/3459)) ([f253b97](https://github.com/newrelic/node-newrelic/commit/f253b97c039caa9e9110055d93e0c32e2d6911a8))
+
+#### Miscellaneous chores
+
+* Update release workflows ([#3444](https://github.com/newrelic/node-newrelic/pull/3444)) ([d1ec158](https://github.com/newrelic/node-newrelic/commit/d1ec158f46d034160b665f8b0785c020ba39b820))
+
+#### Tests
+
+* Added a `randomString` helper to agent_helper and use it in ioredis to avoid flappy tests, also updated local instances of random strings in kafka, elasticsearch and opensearch tests ([#3462](https://github.com/newrelic/node-newrelic/pull/3462)) ([4deb6d8](https://github.com/newrelic/node-newrelic/commit/4deb6d80d9daa7fd9d4c077a5cc52f358ed44e61))
+* Fixed conflict between ioredis and ioredis-esm by running `flushdb` instead of `flushall` to avoid index getting removed mid test ([#3464](https://github.com/newrelic/node-newrelic/pull/3464)) ([5e3f0a8](https://github.com/newrelic/node-newrelic/commit/5e3f0a81bfcf8bc8cf04559f29d3a76c1262bcc7))
+* Fixed express async error test to purposely misspell a method to emit a crash ([#3435](https://github.com/newrelic/node-newrelic/pull/3435)) ([ff9f064](https://github.com/newrelic/node-newrelic/commit/ff9f0646c4fc23e367c1e190eb8091423c690103))
+* Moved aws-sdk-v3 common.js requirement of semver ([#3461](https://github.com/newrelic/node-newrelic/pull/3461)) ([6a380ef](https://github.com/newrelic/node-newrelic/commit/6a380ef580268be131417587a2dda5adf3545e68))
+* Pinned Next.js tests to <16.0.0 ([#3446](https://github.com/newrelic/node-newrelic/pull/3446)) ([10787a1](https://github.com/newrelic/node-newrelic/commit/10787a1f4e325b7321173ee5b2fab0809af5e8d1))
+* Updated minimum tested version of `@langchain/core` to 1.0.0 ([#3437](https://github.com/newrelic/node-newrelic/pull/3437)) ([b61f67a](https://github.com/newrelic/node-newrelic/commit/b61f67a4c6d59f0b2a49e0de93a6d38e56d214fd))
+
+### v13.5.0 (2025-10-14)
+
+#### Code refactoring
+
+* Updated `fastify` instrumentation to subscribe to events emitted ([#3407](https://github.com/newrelic/node-newrelic/pull/3407)) ([51e361e](https://github.com/newrelic/node-newrelic/commit/51e361ed736fa1235eeb16f1c5ec833a1b56a0bf))
+* Updated `pg` and `pg-native` instrumentation to subscribe to events emitted ([#3397](https://github.com/newrelic/node-newrelic/pull/3397)) ([04af258](https://github.com/newrelic/node-newrelic/commit/04af2580a554ecabedab447d5edc5cec836d7f40))
+
+* Updated `config.instrumentation.timers.enabled` to false to disable `timers.setTimeout` and `timers.setInterval` by default. ([#3414](https://github.com/newrelic/node-newrelic/pull/3414)) ([b925d3d](https://github.com/newrelic/node-newrelic/commit/b925d3d178886e6d4bbd0f2eaa6f51b6fddd7878))
+    * To re-enable, set `config.instrumentation.timers.enabled` to `true` in config or set `NEW_RELIC_INSTRUMENTATION_TIMERS_ENABLED=true` 
+
+#### Documentation
+
+* Updated compatibility report ([#3413](https://github.com/newrelic/node-newrelic/pull/3413)) ([fef98dd](https://github.com/newrelic/node-newrelic/commit/fef98ddffddf60b32f162ea87dee2a3a0bdf8048))
+
+#### Miscellaneous chores
+
+* Added a new diagnostics base class and migrated undici to use new class ([#3408](https://github.com/newrelic/node-newrelic/pull/3408)) ([8047bf1](https://github.com/newrelic/node-newrelic/commit/8047bf165ae5105bb612c1a834d574078d52724d))
+* Created directory for samplers ([#3419](https://github.com/newrelic/node-newrelic/pull/3419)) ([dd2d3df](https://github.com/newrelic/node-newrelic/commit/dd2d3dfe1bb2582de51e07a1cce6077df84f7108))
+
+#### Styles
+
+* Require `check-types` and `require-returns-type` jsdoc ([#3400](https://github.com/newrelic/node-newrelic/pull/3400)) ([e4cd687](https://github.com/newrelic/node-newrelic/commit/e4cd687c59aeaba6b627403bcb29b4b6576fe4d9))
+* Require jsdoc `check*`, `implements-on-classes`, and some `no-undefined-types` ([#3404](https://github.com/newrelic/node-newrelic/pull/3404)) ([4fa645b](https://github.com/newrelic/node-newrelic/commit/4fa645b91900ff0acbd24b8f50c6fffcd07f3b82))
+* Require jsdoc `require-returns-check` and `require-property-*` ([#3403](https://github.com/newrelic/node-newrelic/pull/3403)) ([1008073](https://github.com/newrelic/node-newrelic/commit/100807342b9c9283f43042024f15bb575de219ee))
+
+#### Tests
+
+* Added helper to get version of package when package.json not exported, and updated tests that need it ([#3411](https://github.com/newrelic/node-newrelic/pull/3411)) ([5ae02c7](https://github.com/newrelic/node-newrelic/commit/5ae02c7411cd7ae0a45203b025559c5442a7171e))
+* Fixed fastify segment tree assertion when security agent is enabled ([#3422](https://github.com/newrelic/node-newrelic/pull/3422)) ([b2cf6ed](https://github.com/newrelic/node-newrelic/commit/b2cf6ed5d8debae23d0bb31e9a72b325464fadc2))
+* Refactored mcp tests to listen on new port for every streaming test, removed unncessary shutdown of process ([#3420](https://github.com/newrelic/node-newrelic/pull/3420)) ([17db813](https://github.com/newrelic/node-newrelic/commit/17db8133e8e13c970362330885dccf4870942aea))
+* Updated an openai assertion with setTimeout disabled ([#3421](https://github.com/newrelic/node-newrelic/pull/3421)) ([ceec8f9](https://github.com/newrelic/node-newrelic/commit/ceec8f9ef2ac95285dcc1619ef2ee8e187252beb))
+
 ### v13.4.0 (2025-09-29)
 
 #### Code refactoring
@@ -7928,3 +7997,6 @@ Special thanks to Ryan Copley (@RyanCopley) for the contribution.
 
 
 
+
+
+

package/api.js

@@ -1813,16 +1813,16 @@ API.prototype.setUserID = function setUserID(id) {
  */
 function _filterAttributes(attributes, name) {
   const filteredAttributes = Object.create(null)
-  Object.keys(attributes).forEach((attributeKey) => {
+  for (const attributeKey of Object.keys(attributes)) {
     if (!isValidType(attributes[attributeKey])) {
       logger.info(
         `Omitting attribute ${attributeKey} from ${name} call, type must ` +
           'be boolean, number, or string'
       )
-      return
+      continue
     }
     filteredAttributes[attributeKey] = attributes[attributeKey]
-  })
+  }
   return filteredAttributes
 }
 
@@ -1937,7 +1937,7 @@ API.prototype.ignoreApdex = function ignoreApdex() {
  *      { role: 'user', content: 'Tell me about Node.js.'}
  *    ]})
  * })
- * @param {Object} context LLM custom attributes context
+ * @param {object} context LLM custom attributes context
  * @param {Function} callback The function to execute in context.
  */
 API.prototype.withLlmCustomAttributes = function withLlmCustomAttributes(context, callback) {

package/lib/agent.js

@@ -5,7 +5,7 @@
 
 'use strict'
 
-const AdaptiveSampler = require('./adaptive-sampler')
+const AdaptiveSampler = require('./samplers/adaptive-sampler')
 const CollectorAPI = require('./collector/api')
 const ServerlessCollector = require('./collector/serverless')
 const DESTINATIONS = require('./config/attribute-filter').DESTINATIONS
@@ -169,7 +169,7 @@ const DEFAULT_HARVEST_INTERVAL_MS = 60000
  * available. Don't try to recover here, because without configuration the
  * agent can't be brought up to a useful state.
  *
- * @param {object} config Agent configuration object
+ * @param {Config} config Agent configuration object
  */
 function Agent(config) {
   EventEmitter.call(this)
@@ -444,7 +444,7 @@ Agent.prototype._scheduleHarvests = function _scheduleHarvests(shouldImmediately
 
   const agent = this
 
-  // For data collection that streams immediately, dont delay capture/sending until
+  // For data collection that streams immediately, don't delay capture/sending until
   // the harvest of everything else has completed.
   agent.startStreaming()
 
@@ -564,7 +564,7 @@ Agent.prototype._resetCustomEvents = function resetCustomEvents() {
  * @fires Agent#harvestFinished
  */
 Agent.prototype.harvestSync = function harvestSync() {
-  logger.trace('Peparing to harvest.')
+  logger.trace('Preparing to harvest.')
 
   if (!this.collector.isConnected()) {
     throw new Error('Sync harvest not connected/enabled!')

package/lib/aggregators/event-aggregator.js

@@ -85,8 +85,6 @@ class EventAggregator extends Aggregator {
 
   /**
    * Resets the contents of the aggregator and all counters.
-   *
-   * @returns {PriorityQueue} The old collection of aggregated events.
    */
   clearEvents() {
     // ???: might be more efficient to clear here and come up with an efficient way to

package/lib/aggregators/log-aggregator.js

@@ -81,9 +81,9 @@ class LogAggregator extends EventAggregator {
   }
 
   addBatch(logs, priority) {
-    logs.forEach((logLine) => {
+    for (const logLine of logs) {
       super.add(logLine, priority)
-    })
+    }
   }
 
   reconfigure(config) {

package/lib/attributes.js

@@ -176,8 +176,8 @@ class Attributes {
  * Creates a filter function for the given scope.
  *
  * @param {string} scope - The scope of the filter to make.
- * @returns {Function} A function that performs attribute filtering for the given
- *  scope.
+ * @returns {Function|undefined} A function that performs attribute filtering for the given
+ *  scope, or undefined if the scope is not recognized.
  */
 function makeFilter(scope) {
   const { attributeFilter } = Config.getInstance()

package/lib/collector/api.js

@@ -63,15 +63,15 @@ const AGENT_RUN_BEHAVIOR = CollectorResponse.AGENT_RUN_BEHAVIOR
 function dumpErrors(errors, name) {
   let index = 1
 
-  errors.forEach(function forEachError(error) {
+  for (const error of errors) {
     logger.trace(error, 'Error %s during %s:', index++, name)
 
     if (error.laterErrors) {
-      error.laterErrors.forEach(function forEachLaterError(laterError) {
+      for (const laterError of error.laterErrors) {
         logger.trace(laterError, 'Error %s during %s:', index++, name)
-      })
+      }
     }
-  })
+  }
 }
 
 /**
@@ -153,7 +153,7 @@ CollectorAPI.prototype._updateEndpoints = function _updateEndpoints(endpoint) {
 /**
  * Connect to the data collector.
  *
- * @param {function} callback A typical error first callback to be invoked
+ * @param {Function} callback A typical error first callback to be invoked
  * upon successful or unsuccessful connection. The second parameter will be
  * an instance of {@link CollectorResponse}.
  *
@@ -421,9 +421,9 @@ CollectorAPI.prototype._onConnect = function _onConnect(callback, error, res) {
 
   // Log "Reporting to..." message from connect response.
   if (config.messages) {
-    config.messages.forEach((element) => {
+    for (const element of config.messages) {
       logger.info(element.message)
-    })
+    }
   }
 
   // Store request headers for future collector requests if they're present

package/lib/collector/http-agents.js

@@ -19,7 +19,7 @@ let agentProxyWithKeepAlive = null
 /**
  * Returns an HTTP agent with keep-alive enabled
  *
- * @param {Object} config configuration for HTTP agent
+ * @param {object} config configuration for HTTP agent
  */
 exports.keepAliveAgent = function keepAliveAgent(config) {
   config = config ? config : {}
@@ -45,7 +45,7 @@ exports.keepAliveAgent = function keepAliveAgent(config) {
  * to the proxy server as to how its connection is made
  * with New Relic's servers.
  *
- * @param {Object} config configuration for proxy agent
+ * @param {object} config configuration for proxy agent
  */
 exports.proxyAgent = function proxyAgent(config) {
   if (agentProxyWithKeepAlive !== null) {

package/lib/collector/remote-method.js

@@ -260,7 +260,7 @@ RemoteMethod.prototype._safeRequest = function _safeRequest(options) {
     level = 'info'
   }
 
-  // check if trace is enabled or audit log(aka info in this case) before attemping
+  // check if trace is enabled or audit log(aka info in this case) before attempting
   // to get the body length or parse the path with redacted key
   if (logger.traceEnabled() || level === 'info') {
     const logBody = Buffer.isBuffer(options.body) ? 'Buffer ' + options.body.length : options.body

package/lib/collector/serverless.js

@@ -110,7 +110,7 @@ class ServerlessCollector {
    * Constructs, serializes, and prints the final consolidated payload to stdout.
    *
    * @param {Function} cb The callback to invoke when finished.
-   * @returns {boolean} indicating if callback was defined and successfully executed
+   * @returns {boolean|undefined} indicating if callback was defined and successfully executed
    */
   flushPayload(cb) {
     if (!this.enabled) {

package/lib/config/attribute-filter.js

@@ -70,12 +70,12 @@ function AttributeFilter(config) {
   this._rules.global = Object.create(null)
 
   // And all the destination rules.
-  DESTINATION_DETAILS.forEach(function forEachDestination(dest) {
+  for (const dest of DESTINATION_DETAILS) {
     config.on(dest.name + '.attributes.enabled', updater)
     config.on(dest.name + '.attributes.include', updater)
     config.on(dest.name + '.attributes.exclude', updater)
     this._rules[dest.name] = Object.create(null)
-  }, this)
+  }
 
   // Now pull in all the rules.
   this.update()
@@ -184,10 +184,10 @@ AttributeFilter.prototype.update = function update() {
   this._cachedCount = 0
 
   // And all the destination rules.
-  DESTINATION_DETAILS.forEach(function forEachDestination(dest) {
+  for (const dest of DESTINATION_DETAILS) {
     const name = dest.name
     if (!this.config[name].attributes.enabled) {
-      return
+      continue
     }
 
     this._enabledDestinations |= dest.id
@@ -196,7 +196,7 @@ AttributeFilter.prototype.update = function update() {
     )
     this._rules[name].exclude = _importRules(this.config[name].attributes.exclude)
     this._cache[name] = Object.create(null)
-  }, this)
+  }
 }
 
 /**
@@ -291,13 +291,13 @@ function _importRules(rules) {
   }
   const exactRules = []
   const wildcardRules = []
-  rules.forEach(function separateRules(rule) {
+  for (const rule of rules) {
     if (rule[rule.length - 1] === '*') {
       wildcardRules.push(rule)
     } else {
       exactRules.push(rule)
     }
-  })
+  }
 
   if (exactRules.length) {
     out.exact = new RegExp('^' + _convertRulesToRegex(exactRules) + '$')

package/lib/config/build-instrumentation-config.js

@@ -12,18 +12,28 @@ const corePkgs = Object.keys(coreLibraries)
 const subscriptions = require('../subscriber-configs')
 const subscribers = Object.keys(subscriptions)
 pkgNames.push(...subscribers)
-// Manually adding undici as it is registered separately in shimmer
-corePkgs.push('undici')
 // Manually adding domain as it is registered separately in shimmer
 corePkgs.push('domain')
 pkgNames.push(...corePkgs)
 
+// Packages are normally enabled without any extra
+// configuration. This list is a set of packages that
+// we want to be disabled without any extra configuration.
+// Typically, this is because the instrumentation no longer
+// provides useful data. Users can still enable them if they
+// are interested in the instrumentation they provide.
+const disabledPkgs = ['timers']
+
 /**
  * Builds the stanza for config.instrumentation.*
  * It defaults every library to true and assigns a boolean
  * formatter for the environment variable conversion of the values
  */
 module.exports = pkgNames.reduce((config, pkg) => {
-  config[pkg] = { enabled: { formatter: boolean, default: true } }
+  let defaultValue = true
+  if (disabledPkgs.includes(pkg)) {
+    defaultValue = false
+  }
+  config[pkg] = { enabled: { formatter: boolean, default: defaultValue } }
   return config
 }, {})

package/lib/config/default.js

@@ -323,7 +323,7 @@ defaultConfig.definition = () => {
        */
       diagnostics: {
         formatter: boolean,
-        deafult: false
+        default: false
       }
     },
     audit_log: {
@@ -1145,7 +1145,7 @@ defaultConfig.definition = () => {
       /**
        * Controls whether the agent will generate spans for in-process actions.
        * When disabled, this will only create spans for entry and exit spans.
-       * entry spans - initial actions for web servers and messsage queue consumption.
+       * entry spans - initial actions for web servers and message queue consumption.
        * exit spans - all outgoing calls to external services(external and database calls)
        */
       in_process_spans: {
@@ -1156,16 +1156,27 @@ defaultConfig.definition = () => {
       },
 
       sampler: {
-      /**
-       * When set to `always_on`, the sampled flag in the `traceparent` header
-       * being set to "true" will result in the local transaction being sampled
-       * with a priority value of "2". When set to `always_off`, the local
-       * transaction will never be sampled. At the default setting, the sampling
-       * decision will be determined according to the normal algorithm.
-       *
-       * This setting takes precedence over the `remote_parent_not_sampled`
-       * setting.
-       */
+        /**
+         * The sampling target for adaptive sampling is controlled via this attribute when configuring the default/adaptive sampler.
+         * The default sampling target is 10 transactions/min when it is not specified but **MUST** be within the range of [1, 120] (inclusive).
+         * Upon agent connect, the connect response **MUST** provide the value of `sampling_target` based on this configuration setting's value.
+         * The `sampling_target` value from the connect response **SHOULD** be used as the sampling target value for adaptive sampling in the agent.
+         */
+        adaptive_sampling_target: {
+          formatter: int,
+          default: 10
+        },
+
+        /**
+         * When set to `always_on`, the sampled flag in the `traceparent` header
+         * being set to "true" will result in the local transaction being sampled
+         * with a priority value of "2". When set to `always_off`, the local
+         * transaction will never be sampled. At the default setting, the sampling
+         * decision will be determined according to the normal algorithm.
+         *
+         * This setting takes precedence over the `remote_parent_not_sampled`
+         * setting.
+         */
         remote_parent_sampled: {
           formatter: allowList.bind(null, ['always_on', 'always_off', 'default']),
           default: 'default'
@@ -1388,7 +1399,7 @@ defaultConfig.definition = () => {
     /**
      * Obfuscates URL parameters
      * for outgoing and incoming requests
-     * for distrubuted tracing attributes - both transaction and span attributes
+     * for distributed tracing attributes - both transaction and span attributes
      * for transaction trace transaction details
      */
     url_obfuscation: {
@@ -1418,7 +1429,7 @@ defaultConfig.definition = () => {
 
         /**
          * A string containing a replacement value for URL parameters
-         * can contain refferences to capture groups in the pattern
+         * can contain references to capture groups in the pattern
          */
         replacement: {
           default: ''
@@ -1488,7 +1499,7 @@ defaultConfig.definition = () => {
       },
 
       /**
-       * Unique test identifier when runnning IAST with CI/CD
+       * Unique test identifier when running IAST with CI/CD
        */
       iast_test_identifier: '',
 

package/lib/config/formatters.js

@@ -67,7 +67,7 @@ formatters.boolean = function boolean(setting) {
  *
  * @param {string} val config setting
  * @param {logger} logger agent logger instance
- * @returns {object}
+ * @returns {object|undefined} the parsed value, or undefined if an error occurred
  */
 formatters.object = function object(val, logger) {
   try {
@@ -83,7 +83,7 @@ formatters.object = function object(val, logger) {
  *
  * @param {string} val config setting
  * @param {logger} logger agent logger instance
- * @returns {Array}
+ * @returns {Array|undefined} The parsed array of objects, or undefined if an error occurred
  */
 formatters.objectList = function objectList(val, logger) {
   try {
@@ -111,7 +111,7 @@ formatters.allowList = function allowList(list, val) {
  *
  * @param {string} val valid regex
  * @param {logger} logger agent logger instance
- * @returns {RegExp} regex
+ * @returns {RegExp|undefined} regex, or undefined if an error occurred
  */
 formatters.regex = function regex(val, logger) {
   try {

package/lib/config/hsm.js

@@ -71,7 +71,7 @@ const REDACT_BEFORE_SEND = new Set([
   'certificates' // should be public but in case user mistake and also these are huge
 ])
 
-// process.domain needs to be stripped befeore sending
+// process.domain needs to be stripped before sending
 const REMOVE_BEFORE_SEND = new Set(['domain'])
 
 exports.HIGH_SECURITY_SETTINGS = HIGH_SECURITY_SETTINGS