newrelic 13.3.2 → 13.3.3

package/NEWS.md

@@ -1,3 +1,23 @@
+### v13.3.3 (2025-09-22)
+
+#### Features
+
+* Added support for tracing callback on subscribers ([#3371](https://github.com/newrelic/node-newrelic/pull/3371)) ([e6ad52e](https://github.com/newrelic/node-newrelic/commit/e6ad52e1f897ec757e90f9fc12f592e1c6eec2fe))
+
+#### Bug fixes
+
+* Updated `openai` instrumentation to properly return APIPromise to avoid crashing when using `completions.parse` or `responses.parse` ([#3382](https://github.com/newrelic/node-newrelic/pull/3382)) ([c7ccf26](https://github.com/newrelic/node-newrelic/commit/c7ccf260ffc9c788bde73b43231b716199724d09))
+
+#### Documentation
+
+* Updated compatibility report ([#3370](https://github.com/newrelic/node-newrelic/pull/3370)) ([754c2f0](https://github.com/newrelic/node-newrelic/commit/754c2f089339268fb73a3ff7765a630ea8982d0d))
+
+#### Miscellaneous chores
+
+* Removed unused `loader.mjs` ([#3376](https://github.com/newrelic/node-newrelic/pull/3376)) ([66a9fd5](https://github.com/newrelic/node-newrelic/commit/66a9fd543d1a7854b7405c7b5b884d8a71773b85))
+* Updated metrics for OTel Bridge enablement/disablement ([#3381](https://github.com/newrelic/node-newrelic/pull/3381)) ([b976c37](https://github.com/newrelic/node-newrelic/commit/b976c376fe187bda5bde1b8cd4b86a7de86fe4f9))
+* Updated supportability metric names for OTel Bridge enablement… ([#3383](https://github.com/newrelic/node-newrelic/pull/3383)) ([c7c1d6c](https://github.com/newrelic/node-newrelic/commit/c7c1d6c942c6b53fd944e2259b42d1e7e7be483a))
+
 ### v13.3.2 (2025-09-10)
 
 #### Bug fixes
@@ -7885,3 +7905,4 @@ Special thanks to Ryan Copley (@RyanCopley) for the contribution.
 
 
 
+

package/lib/otel/metrics/index.js

@@ -42,7 +42,7 @@ class SetupMetrics extends SetupSignal {
     const getMeter = provider.getMeter
     provider.getMeter = function nrGetMeter(...args) {
       agent.metrics
-        .getOrCreateMetric('Supportability/Nodejs/OpenTelemetryBridge/Metrics/getMeter')
+        .getOrCreateMetric('Supportability/Metrics/Nodejs/OpenTelemetryBridge/getMeter')
         .incrementCallCount()
 
       const meter = getMeter.apply(provider, args)
@@ -61,7 +61,7 @@ class SetupMetrics extends SetupSignal {
         // + createObservableUpDownCounter
         meter[method] = function nrWrappedMethod(...args) {
           agent.metrics
-            .getOrCreateMetric(`Supportability/Nodejs/OpenTelemetryBridge/Metrics/meter/${method}`)
+            .getOrCreateMetric(`Supportability/Metrics/Nodejs/OpenTelemetryBridge/meter/${method}`)
             .incrementCallCount()
           return originals[method].apply(meter, args)
         }
@@ -73,7 +73,7 @@ class SetupMetrics extends SetupSignal {
     this.coreApi.metrics.setGlobalMeterProvider(provider)
 
     agent.metrics
-      .getOrCreateMetric('Supportability/Nodejs/OpenTelemetryBridge/Metrics')
+      .getOrCreateMetric('Supportability/Metrics/Nodejs/OpenTelemetryBridge/enabled')
       .incrementCallCount()
 
     // We need access to `agent.config.entity_guid` in order to attach metrics

package/lib/otel/setup.js

@@ -41,6 +41,9 @@ function setupOtel(agent, logger = defaultLogger) {
     signals.push(signal)
   } else {
     logger.debug('`opentelemetry_bridge.traces` is not enabled, skipping')
+    agent.metrics
+      .getOrCreateMetric('Supportability/Tracing/Nodejs/OpenTelemetryBridge/disabled')
+      .incrementCallCount()
   }
 
   if (agent.config.opentelemetry_bridge.metrics.enabled === true) {
@@ -48,6 +51,9 @@ function setupOtel(agent, logger = defaultLogger) {
     signals.push(signal)
   } else {
     logger.debug('`opentelemetry_bridge.metrics` is not enabled, skipping')
+    agent.metrics
+      .getOrCreateMetric('Supportability/Metrics/Nodejs/OpenTelemetryBridge/disabled')
+      .incrementCallCount()
   }
 
   if (agent.config.opentelemetry_bridge.logs.enabled === true) {

package/lib/otel/traces/index.js

@@ -28,7 +28,7 @@ class SetupTraces extends SetupSignal {
     this.coreApi.trace.setGlobalTracerProvider(traceProvider)
 
     agent.metrics
-      .getOrCreateMetric('Supportability/Nodejs/OpenTelemetryBridge/Traces')
+      .getOrCreateMetric('Supportability/Tracing/Nodejs/OpenTelemetryBridge/enabled')
       .incrementCallCount()
   }
 

package/lib/subscribers/base.js

@@ -8,6 +8,12 @@
 const { tracingChannel } = require('node:diagnostics_channel')
 const semver = require('semver')
 const NAMES = require('../metrics/names')
+// Used for the `traceCallback` work.
+// This can be removed when we add true support into orchestrion
+const makeCall = (fn) => (...args) => fn.call(...args)
+const ArrayPrototypeAt = makeCall(Array.prototype.at)
+const ArrayPrototypeSplice = makeCall(Array.prototype.splice)
+// End temp work
 
 /**
  * The baseline parameters available to all subscribers.
@@ -15,9 +21,8 @@ const NAMES = require('../metrics/names')
  * @typedef {object} SubscriberParams
  * @property {object} agent A New Relic Node.js agent instance.
  * @property {object} logger An agent logger instance.
- * @property {string} packageName The npm installable name for the package
- * being instrumented. This is what a developer would provide to the `require`
- * function.
+ * @property {string} packageName The package name being instrumented.
+ * This is what a developer would provide to the `require` function.
  * @property {string} channelName A unique name for the diagnostics channel
  * that will be created and monitored.
  */
@@ -44,6 +49,7 @@ const NAMES = require('../metrics/names')
  * @property {string} id A unique identifier for the subscriber, combining the prefix, package name, and channel name.
  * @property {TracingChannel} channel The tracing channel instance this subscriber will be monitoring.
  * @property {AsyncLocalStorage} store The async local storage instance used for context management.
+ * @property {number} callback position of callback if it needs to be wrapped for instrumentation. -1 means last argument
  */
 class Subscriber {
   constructor({ agent, logger, packageName, channelName }) {
@@ -60,6 +66,7 @@ class Subscriber {
     this.id = `${this.prefix}${this.packageName}:${this.channelName}`
     this.channel = tracingChannel(this.id)
     this.store = agent.tracer._contextManager._asyncLocalStorage
+    this.callback = null
   }
 
   shouldCreateSegment(parent) {
@@ -68,6 +75,49 @@ class Subscriber {
     )
   }
 
+  /**
+   * Note: This is a temporary patch until we can get the correct implementation
+   * of `tracingChannel.traceCallback` into orchestrion-js.
+   *
+   * This will wrap a callback at a given position and reassign the callback argument to the wrapped one
+   *
+   * @param {number} position index of the callback, you can specify -1 to be the last
+   * @param {object} context the event passed to the tracing channel hooks
+   */
+  traceCallback(position, context) {
+    this.logger.trace('Wrapping the callback at position %s', position)
+    const { asyncStart, asyncEnd, error } = this.channel
+    function wrappedCallback(err, res) {
+      // assigning a boolean to the context so we know that the
+      // `error`, `asyncStart`, and `asyncEnd` are coming from the wrapped callback
+      context.callback = true
+      if (err) {
+        context.error = err
+        error.publish(context)
+      } else {
+        context.result = res
+      }
+
+      // Using runStores here enables manual context failure recovery
+      asyncStart.runStores(context, () => {
+        try {
+          if (callback) {
+            return Reflect.apply(callback, this, arguments)
+          }
+        } finally {
+          asyncEnd.publish(context)
+        }
+      })
+    }
+
+    const callback = ArrayPrototypeAt(context.arguments, position)
+    if (typeof callback !== 'function') {
+      this.logger.trace('Callback is not present, not wrapping')
+    } else {
+      ArrayPrototypeSplice(context.arguments, position, 1, wrappedCallback)
+    }
+  }
+
   /**
    * Creates the `Supportability/Features/Instrumentation/OnRequire/<packageName>`
    * and `Supportability/Features/Instrumentation/OnRequire/<packageName>/Version/<majorVersion>`
@@ -123,12 +173,12 @@ class Subscriber {
       segment.opaque = this.opaque
       segment.shimId = this.packageName
       segment.start()
-      this.logger.trace('Created segment %s', name)
+      this.logger.trace('Created segment %s, returning new context', name)
       this.addAttributes(segment)
       const newCtx = ctx.enterSegment({ segment })
       return newCtx
     } else {
-      this.logger.trace('Failed to create segment for %s', name)
+      this.logger.trace('Failed to create segment for %s, returning existing context', name)
       return ctx
     }
   }
@@ -144,6 +194,7 @@ class Subscriber {
 
   /**
    * Checks if the subscriber is enabled based on the agent's configuration.
+   * @returns boolean if subscriber is enabled
    */
   get enabled() {
     return this.config.instrumentation[this.packageName].enabled === true
@@ -156,14 +207,27 @@ class Subscriber {
    */
   enable() {
     this.channel.start.bindStore(this.store, (data) => {
+      // only wrap the callback if a subscriber has a callback property defined
+      if (this.callback !== null) {
+        this.traceCallback(this.callback, data)
+      }
       this.trackInstrumentationUsage(data?.moduleVersion)
       const ctx = this.agent.tracer.getContext()
       if (this.requireActiveTx && !ctx?.transaction?.isActive()) {
-        this.logger.debug('Not recording event for %s, transaction is not active', this.package)
+        this.logger.trace('Not recording event for %s, transaction is not active', this.package)
         return ctx
       }
 
-      return this.handler(data, ctx)
+      const result = this.handler(data, ctx)
+      // we cannot rely on the context manager to obtain the active segment
+      // in the `asyncStart` and `asyncEnd` events. This is because other instrumented
+      // functions are being executed at times. so we assign the active segment on the data
+      // so it can be used later to properly touch the segment in `asyncStart` and `asyncEnd`
+      if (this.callback !== null) {
+        data.segment = result?.segment
+        this.logger.trace('Adding segment %s to event context', data?.segment?.name)
+      }
+      return result
     })
   }
 
@@ -174,13 +238,41 @@ class Subscriber {
     this.channel.start.unbindStore(this.store)
   }
 
+  /**
+   * This should only be used for callback based functions to touch the segment for the function
+   * that implements a callback.
+   * @param {object} data event passed to asyncStart hook
+   */
+  asyncStart(data) {
+    const ctx = this.agent.tracer.getContext()
+    if (data.callback !== true || this.internal === true || (this.requireActiveTx && !ctx?.transaction?.isActive())) {
+      this.logger.trace('Not touching parent in asyncStart for %s, transaction is not active? %s, segment is internal? %s, or no callback to bind', this.id, ctx?.transaction?.isActive(), this.internal)
+      return
+    }
+
+    this.logger.trace('touching segment %s, in asyncStart', data?.segment?.name)
+    data?.segment?.touch()
+  }
+
   /**
    * Common handler for when async events end.
    * It gets the context and touches the segment if it exists.
+   * @param {object} data event passed to asyncEnd hook
    */
-  asyncEnd() {
+  asyncEnd(data) {
     const ctx = this.agent.tracer.getContext()
-    ctx?.segment?.touch()
+    if (this.internal === true) {
+      this.logger.trace('asyncEnd occurring for %s internal event, not touching segment', this.id)
+      return
+    }
+
+    if (data?.callback === true) {
+      this.logger.trace('touching callback segment %s, in asyncEnd', data?.segment?.name)
+      data?.segment?.touch()
+    } else {
+      this.logger.trace('touching segment %s, in asyncEnd', ctx?.segment?.name)
+      ctx?.segment?.touch()
+    }
   }
 
   /*

package/lib/subscribers/openai/chat.js

@@ -23,6 +23,7 @@ const MIN_STREAM_VERSION = '4.12.2'
 class OpenAIChatCompletions extends OpenAISubscriber {
   constructor({ agent, logger, channelName = 'nr_completionsCreate' }) {
     super({ agent, logger, channelName })
+    this.events = ['asyncEnd', 'end']
   }
 
   handler(data, ctx) {
@@ -42,6 +43,32 @@ class OpenAIChatCompletions extends OpenAISubscriber {
     return newCtx
   }
 
+  /**
+   * Temporary fix as `tracePromise` wraps the promise in a native one.
+   * We are now wrapping `openai.chat.completions.parse` in a traceSync call
+   * and then wrapping the promise here so it returns the custom promise.
+   * OpenAI has a [custom promise](https://github.com/openai/openai-node/blob/master/src/core/api-promise.ts) that crashes applications using `openai.chat.completions.parse`
+   * see: https://github.com/newrelic/node-newrelic/issues/3379
+   * see: https://github.com/nodejs/node/issues/59936
+   * @param data
+   */
+  end(data) {
+    const promise = data?.result
+    if (!promise.then) {
+      return promise
+    }
+
+    return promise.then((result) => {
+      data.result = result
+      this.channel.asyncEnd.publish(data)
+      return result
+    }).catch((err) => {
+      data.error = err
+      this.channel.asyncEnd.publish(data)
+      return err
+    })
+  }
+
   asyncEnd(data) {
     const ctx = this.agent.tracer.getContext()
     if (!ctx?.segment || !ctx?.transaction) {

package/lib/subscribers/openai/config.js

@@ -16,7 +16,7 @@ module.exports = {
           functionQuery: {
             className: 'Completions',
             methodName: 'create',
-            kind: 'Async'
+            kind: 'Sync'
           }
         },
         {
@@ -25,7 +25,7 @@ module.exports = {
           functionQuery: {
             className: 'Completions',
             methodName: 'create',
-            kind: 'Async'
+            kind: 'Sync'
           }
         }
       ]
@@ -39,7 +39,7 @@ module.exports = {
           functionQuery: {
             className: 'Responses',
             methodName: 'create',
-            kind: 'Async'
+            kind: 'Sync'
           }
         }
       ]

package/package.json

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