newrelic 11.11.0 → 11.12.0

package/NEWS.md

@@ -1,3 +1,17 @@
+### v11.12.0 (2024-03-04)
+
+#### Features
+
+* Added instrumentation for `chain.stream` for langchain js. ([#2052](https://github.com/newrelic/node-newrelic/pull/2052)) ([03abfce](https://github.com/newrelic/node-newrelic/commit/03abfce666d3c48abd0994c44817bb5cbe8655a9))
+
+#### Miscellaneous chores
+
+* Added @azure/openai and @langchain/community/llms/bedrock as tracking packages so we can measure usage with angler ([#2053](https://github.com/newrelic/node-newrelic/pull/2053)) ([4830ea3](https://github.com/newrelic/node-newrelic/commit/4830ea3285726f8cc8fb60820c4cf2d3790e5250))
+
+#### Tests
+
+* Updated aws-sdk branch to main as the necessary code was merged. ([#2051](https://github.com/newrelic/node-newrelic/pull/2051)) ([1e52a5c](https://github.com/newrelic/node-newrelic/commit/1e52a5cd7a8acc8970dbdc6b1bf774c06aa6f5fb))
+
 ### v11.11.0 (2024-02-27)
 
 #### Features

package/lib/config/default.js

@@ -1359,6 +1359,19 @@ defaultConfig.definition = () => ({
       formatter: boolean,
       default: false
     },
+
+    /**
+     * When enabled, the content of LLM messages will be included in the
+     * recorded spans (i.e. delivered to the New Relic collector). This is
+     * enabled by default.
+     */
+    record_content: {
+      enabled: {
+        formatter: boolean,
+        default: true
+      }
+    },
+
     /**
      * Toggles the capturing of Llm events when using streaming
      * based methods in AIM supported libraries(i.e.- openai, AWS bedrock, langchain)
@@ -1390,8 +1403,8 @@ defaultConfig.config = () => {
  *
  * @param {object} definition configuration definition for a given leaf node
  * @param {object} config object that is used to construct the agent config
- * @param {Array} [paths=[]] an array to capture the leaf node keys to properly assign defaults for nested objects
- * @param {int} [objectKeys=1] amount of keys in a given leaf node
+ * @param {Array} [paths] an array to capture the leaf node keys to properly assign defaults for nested objects
+ * @param {int} [objectKeys] amount of keys in a given leaf node
  */
 function buildConfig(definition, config, paths = [], objectKeys = 1) {
   let keysSeen = 0
@@ -1429,7 +1442,7 @@ function buildConfig(definition, config, paths = [], objectKeys = 1) {
  * @param {object} params.config object that is used to construct the agent config
  * @param {string} params.key name of the configuration option
  * @param {string} params.value value the configuration option
- * @param {Array} [params.paths=[]] an array to capture the leaf node keys to properly assign defaults for nested objects
+ * @param {Array} [params.paths] an array to capture the leaf node keys to properly assign defaults for nested objects
  */
 function assignConfigValue({ config, key, value, paths }) {
   if (paths.length) {

package/lib/instrumentation/langchain/runnable.js

@@ -6,9 +6,8 @@
 'use strict'
 
 const common = require('./common')
-const {
-  AI: { LANGCHAIN }
-} = require('../../metrics/names')
+const { AI } = require('../../metrics/names')
+const { LANGCHAIN } = AI
 const {
   LangChainCompletionMessage,
   LangChainCompletionSummary
@@ -28,10 +27,33 @@ module.exports = function initialize(shim, langchain) {
     return
   }
 
+  instrumentInvokeChain({ langchain, shim })
+
+  if (agent.config.ai_monitoring.streaming.enabled) {
+    instrumentStream({ langchain, shim })
+  } else {
+    shim.logger.warn(
+      '`ai_monitoring.streaming.enabled` is set to `false`, stream will not be instrumented.'
+    )
+    agent.metrics.getOrCreateMetric(AI.STREAMING_DISABLED).incrementCallCount()
+    agent.metrics
+      .getOrCreateMetric(`${LANGCHAIN.TRACKING_PREFIX}/${pkgVersion}`)
+      .incrementCallCount()
+  }
+}
+
+/**
+ * Instruments and records span and relevant LLM events for `chain.invoke`
+ *
+ * @param {object} params function params
+ * @param {object} params.langchain `@langchain/core/runnables/base` export
+ * @param {Shim} params.shim instace of shim
+ */
+function instrumentInvokeChain({ langchain, shim }) {
   shim.record(
     langchain.RunnableSequence.prototype,
     'invoke',
-    function wrapCall(shim, invoke, fnName, args) {
+    function wrapCall(shim, _invoke, fnName, args) {
       const [request, params] = args
       const metadata = params?.metadata ?? {}
       const tags = params?.tags ?? []
@@ -41,53 +63,183 @@ module.exports = function initialize(shim, langchain) {
         promise: true,
         // eslint-disable-next-line max-params
         after(_shim, _fn, _name, err, output, segment) {
-          segment.end()
-          const completionSummary = new LangChainCompletionSummary({
-            agent,
-            messages: [{ output }],
-            metadata,
-            tags,
+          recordChatCompletionEvents({
             segment,
-            error: err != null,
-            runId: segment[langchainRunId]
-          })
-
-          common.recordEvent({
-            agent,
-            type: 'LlmChatCompletionSummary',
-            pkgVersion,
-            msg: completionSummary
-          })
-
-          // output can be BaseMessage with a content property https://js.langchain.com/docs/modules/model_io/concepts#messages
-          // or an output parser https://js.langchain.com/docs/modules/model_io/concepts#output-parsers
-          recordCompletions({
+            messages: [output],
             events: [request, output],
-            completionSummary,
-            agent,
-            segment,
+            metadata,
+            tags,
+            err,
             shim
           })
+        }
+      })
+    }
+  )
+}
+
+/**
+ * Instruments and records span and relevant LLM events for `chain.stream`
+ *
+ * @param {object} params function params
+ * @param {object} params.langchain `@langchain/core/runnables/base` export
+ * @param {Shim} params.shim instace of shim
+ */
+function instrumentStream({ langchain, shim }) {
+  shim.record(
+    langchain.RunnableSequence.prototype,
+    'stream',
+    function wrapStream(shim, _stream, fnName, args) {
+      const [request, params] = args
+      const metadata = params?.metadata ?? {}
+      const tags = params?.tags ?? []
 
-          if (err) {
-            agent.errors.add(
-              segment.transaction,
+      return new RecorderSpec({
+        name: `${LANGCHAIN.CHAIN}/${fnName}`,
+        promise: true,
+        // eslint-disable-next-line max-params
+        after(_shim, _fn, _name, err, output, segment) {
+          // Input error occurred which means a stream was not created.
+          // Skip instrumenting streaming and create Llm Events from
+          // the data we have
+          if (output?.next) {
+            wrapNextHandler({ shim, output, segment, request, metadata, tags })
+          } else {
+            recordChatCompletionEvents({
+              segment,
+              messages: [],
+              events: [request],
+              metadata,
+              tags,
               err,
-              new LlmErrorMessage({
-                response: {},
-                cause: err,
-                summary: completionSummary
-              })
-            )
+              shim
+            })
           }
-
-          segment.transaction.trace.attributes.addAttribute(DESTINATIONS.TRANS_EVENT, 'llm', true)
         }
       })
     }
   )
 }
 
+/**
+ * Wraps the next method on the IterableReadableStream. It will also record the Llm
+ * events when the stream is done processing.
+ *
+ * @param {object} params function params
+ * @param {Shim} params.shim shim instance
+ * @param {TraceSegment} params.segment active segment
+ * @param {function} params.output IterableReadableStream
+ * @param {string} params.request the prompt message
+ * @param {object} params.metadata metadata for the call
+ * @param {Array} params.tags tags for the call
+ */
+function wrapNextHandler({ shim, output, segment, request, metadata, tags }) {
+  shim.wrap(output, 'next', function wrapIterator(shim, orig) {
+    let content = ''
+    return async function wrappedIterator() {
+      try {
+        const result = await orig.apply(this, arguments)
+        // only create Llm events when stream iteration is done
+        if (result?.done) {
+          recordChatCompletionEvents({
+            segment,
+            messages: [content],
+            events: [request, content],
+            metadata,
+            tags,
+            shim
+          })
+        } else {
+          content += result.value
+        }
+        return result
+      } catch (error) {
+        recordChatCompletionEvents({
+          segment,
+          messages: [content],
+          events: [request, content],
+          metadata,
+          tags,
+          err: error,
+          shim
+        })
+        throw error
+      } finally {
+        // update segment duration on every stream iteration to extend
+        // the timer
+        segment.touch()
+      }
+    }
+  })
+}
+
+/**
+ * Ends active segment, creates LlmChatCompletionSummary, and LlmChatCompletionMessage(s), and handles errors if they exists
+ *
+ * @param {object} params function params
+ * @param {TraceSegment} params.segment active segment
+ * @param {Array} params.messages response messages
+ * @param {Array} params.events prompt and response messages
+ * @param {object} params.metadata metadata for the call
+ * @param {Array} params.tags tags for the call
+ * @param {Error} params.err error object from call
+ * @param {Shim} params.shim shim instance
+ */
+function recordChatCompletionEvents({ segment, messages, events, metadata, tags, err, shim }) {
+  const { pkgVersion, agent } = shim
+  segment.end()
+  const completionSummary = new LangChainCompletionSummary({
+    agent,
+    messages,
+    metadata,
+    tags,
+    segment,
+    error: err != null,
+    runId: segment[langchainRunId]
+  })
+
+  common.recordEvent({
+    agent,
+    type: 'LlmChatCompletionSummary',
+    pkgVersion,
+    msg: completionSummary
+  })
+
+  // output can be BaseMessage with a content property https://js.langchain.com/docs/modules/model_io/concepts#messages
+  // or an output parser https://js.langchain.com/docs/modules/model_io/concepts#output-parsers
+  recordCompletions({
+    events,
+    completionSummary,
+    agent,
+    segment,
+    shim
+  })
+
+  if (err) {
+    agent.errors.add(
+      segment.transaction,
+      err,
+      new LlmErrorMessage({
+        response: {},
+        cause: err,
+        summary: completionSummary
+      })
+    )
+  }
+
+  segment.transaction.trace.attributes.addAttribute(DESTINATIONS.TRANS_EVENT, 'llm', true)
+}
+
+/**
+ * Records the LlmChatCompletionMessage(s)
+ *
+ * @param {object} params function params
+ * @param {Array} params.events prompt and response messages
+ * @param {LangChainCompletionSummary} params.completionSummary LlmChatCompletionSummary event
+ * @param {Agent} params.agent instance of agent
+ * @param {TraceSegment} params.segment active segment
+ * @param {Shim} params.shim shim instance
+ */
 function recordCompletions({ events, completionSummary, agent, segment, shim }) {
   for (let i = 0; i < events.length; i += 1) {
     let msg = events[i]

package/lib/instrumentations.js

@@ -55,6 +55,8 @@ module.exports = function instrumentations() {
     'loglevel': { type: MODULE_TYPE.TRACKING },
     'npmlog': { type: MODULE_TYPE.TRACKING },
     'fancy-log': { type: MODULE_TYPE.TRACKING },
-    'knex': { type: MODULE_TYPE.TRACKING }
+    'knex': { type: MODULE_TYPE.TRACKING },
+    '@azure/openai': { type: MODULE_TYPE.TRACKING },
+    '@langchain/community/llms/bedrock': { type: MODULE_TYPE.TRACKING }
   }
 }

package/lib/llm-events/langchain/chat-completion-message.js

@@ -36,6 +36,7 @@ class LangChainCompletionMessage extends LangChainEvent {
   constructor(params = defaultParams) {
     params = Object.assign({}, defaultParams, params)
     super(params)
+    const { agent } = params
 
     if (params.runId) {
       this.id = `${params.runId}-${params.sequence}`
@@ -43,10 +44,13 @@ class LangChainCompletionMessage extends LangChainEvent {
       this.id = `${this.id}-${params.sequence}`
     }
 
-    this.content = params.content
     this.sequence = params.sequence
     this.completion_id = params.completionId
     this.is_response = params.isResponse ?? false
+
+    if (agent.config.ai_monitoring.record_content.enabled === true) {
+      this.content = params.content
+    }
   }
 }
 

package/lib/llm-events/langchain/event.js

@@ -51,7 +51,6 @@ class LangChainEvent extends BaseEvent {
   ingest_source = 'Node'
   vendor = 'langchain'
   virtual_llm = true
-  error = false
 
   constructor(params = defaultParams) {
     params = Object.assign({}, defaultParams, params)
@@ -66,7 +65,7 @@ class LangChainEvent extends BaseEvent {
     this.langchainMeta = params.metadata
     this.metadata = agent
     this.tags = Array.isArray(params.tags) ? params.tags.join(',') : params.tags
-    this.error = params.error ?? false
+    this.error = params.error ?? null
 
     if (params.virtual !== undefined) {
       if (params.virtual !== true && params.virtual !== false) {

package/lib/llm-events/langchain/tool.js

@@ -9,8 +9,8 @@ const LangChainEvent = require('./event')
 class LangChainTool extends LangChainEvent {
   constructor(params) {
     super(params)
-    this.input = params.input
-    this.output = params.output
+    const { agent } = params
+
     this.name = params.name
     this.description = params.description
     this.duration = params?.segment?.getDurationInMillis()
@@ -18,6 +18,11 @@ class LangChainTool extends LangChainEvent {
     delete this.request_id
     delete this.virtual_llm
     delete this.conversation_id
+
+    if (agent.config.ai_monitoring.record_content.enabled === true) {
+      this.input = params.input
+      this.output = params.output
+    }
   }
 }
 

package/lib/llm-events/langchain/vector-search-result.js

@@ -28,9 +28,13 @@ class LangChainVectorSearchResult extends LangChainEvent {
   constructor(params) {
     params = Object.assign({}, defaultParams, params)
     super(params)
+    const { agent } = params
 
-    this.page_content = params.pageContent
     this.sequence = params.sequence
+
+    if (agent.config.ai_monitoring.record_content.enabled === true) {
+      this.page_content = params.pageContent
+    }
   }
 }
 

package/lib/llm-events/langchain/vector-search.js

@@ -28,12 +28,15 @@ class LangChainVectorSearch extends LangChainEvent {
   constructor(params) {
     params = Object.assign({}, defaultParams, params)
     super(params)
-    const { segment } = params
+    const { agent, segment } = params
 
     this.duration = segment?.getDurationInMillis()
-    this['request.query'] = params.query
     this['request.k'] = params.k
     this['response.number_of_documents'] = params.documents?.length
+
+    if (agent.config.ai_monitoring.record_content.enabled === true) {
+      this['request.query'] = params.query
+    }
   }
 }
 

package/lib/llm-events/openai/chat-completion-message.js

@@ -10,10 +10,13 @@ module.exports = class LlmChatCompletionMessage extends LlmEvent {
   constructor({ agent, segment, request = {}, response = {}, index = 0, message, completionId }) {
     super({ agent, segment, request, response })
     this.id = `${response.id}-${index}`
-    this.content = message?.content
     this.role = message?.role
     this.sequence = index
     this.completion_id = completionId
-    this.is_response = response?.choices?.[0]?.message?.content === this.content
+    this.is_response = response?.choices?.[0]?.message?.content === message?.content
+
+    if (agent.config.ai_monitoring.record_content.enabled === true) {
+      this.content = message?.content
+    }
   }
 }

package/lib/llm-events/openai/embedding.js

@@ -10,6 +10,9 @@ module.exports = class LlmEmbedding extends LlmEvent {
   constructor({ agent, segment, request = {}, response = {}, withError = false }) {
     super({ agent, segment, request, response, responseAttrs: true })
     this.error = withError
-    this.input = request.input?.toString()
+
+    if (agent.config.ai_monitoring.record_content.enabled === true) {
+      this.input = request.input?.toString()
+    }
   }
 }

package/package.json

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