newrelic 11.10.2 → 11.10.3

package/NEWS.md

@@ -1,3 +1,27 @@
+### v11.10.3 (2024-02-07)
+
+#### Features
+
+* Added feature flag for LangChain instrumentation ([#1990](https://github.com/newrelic/node-newrelic/pull/1990)) ([ab04e7a](https://github.com/newrelic/node-newrelic/commit/ab04e7a80b3aa7d669786d469ba256d009a195e6))
+* Added message entities for LangChain ([#1983](https://github.com/newrelic/node-newrelic/pull/1983)) ([6b44a3a](https://github.com/newrelic/node-newrelic/commit/6b44a3ab84690acce71ade9364cb3634b7d42614))
+* Added vectorsearch entities ([#1992](https://github.com/newrelic/node-newrelic/pull/1992)) ([ef74b2e](https://github.com/newrelic/node-newrelic/commit/ef74b2e4426c625e43cadcb4a84e4c389ae06577))
+
+#### Bug fixes
+
+* Updated grpc-js instrumentation to properly track errors and end transactions ([#2001](https://github.com/newrelic/node-newrelic/pull/2001)) ([fda1346](https://github.com/newrelic/node-newrelic/commit/fda134623522e9fde9dccb7606d4a2da89adf511))
+
+#### Documentation
+
+* Removed documentation around aws_bedrock_instrumentation as feature flag has been removed ([#1991](https://github.com/newrelic/node-newrelic/pull/1991)) ([f414564](https://github.com/newrelic/node-newrelic/commit/f414564738ab3ad8df207f96a857f27309d01f0b))
+
+#### Miscellaneous chores
+
+* Fixed third party notices and package-lock as they were out of sync. ([#1999](https://github.com/newrelic/node-newrelic/pull/1999)) ([a89def8](https://github.com/newrelic/node-newrelic/commit/a89def89f5cd7fec29c6466e15740f0f157da9b5))
+
+#### Tests
+
+* Updated prisma versioned test range to skip 5.9.0 as it was broken ([#1993](https://github.com/newrelic/node-newrelic/pull/1993)) ([d885286](https://github.com/newrelic/node-newrelic/commit/d8852867282dc79ea495cac8c414485ee91e7cd1))
+
 ### v11.10.2 (2024-01-31)
 
 #### Bug fixes

package/THIRD_PARTY_NOTICES.md

@@ -86,7 +86,7 @@ code, the source code can be found at [https://github.com/newrelic/node-newrelic
 
 ### @grpc/grpc-js
 
-This product includes source derived from [@grpc/grpc-js](https://github.com/grpc/grpc-node/tree/master/packages/grpc-js) ([v1.9.14](https://github.com/grpc/grpc-node/tree/master/packages/grpc-js/tree/v1.9.14)), distributed under the [Apache-2.0 License](https://github.com/grpc/grpc-node/tree/master/packages/grpc-js/blob/v1.9.14/LICENSE):
+This product includes source derived from [@grpc/grpc-js](https://github.com/grpc/grpc-node/tree/master/packages/grpc-js) ([v1.10.0](https://github.com/grpc/grpc-node/tree/master/packages/grpc-js/tree/v1.10.0)), distributed under the [Apache-2.0 License](https://github.com/grpc/grpc-node/tree/master/packages/grpc-js/blob/v1.10.0/LICENSE):
 
 ```
                                  Apache License
@@ -1443,7 +1443,7 @@ SOFTWARE.
 
 ### semver
 
-This product includes source derived from [semver](https://github.com/npm/node-semver) ([v7.5.4](https://github.com/npm/node-semver/tree/v7.5.4)), distributed under the [ISC License](https://github.com/npm/node-semver/blob/v7.5.4/LICENSE):
+This product includes source derived from [semver](https://github.com/npm/node-semver) ([v7.6.0](https://github.com/npm/node-semver/tree/v7.6.0)), distributed under the [ISC License](https://github.com/npm/node-semver/blob/v7.6.0/LICENSE):
 
 ```
 The ISC License
@@ -1466,7 +1466,7 @@ IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 
 ### winston-transport
 
-This product includes source derived from [winston-transport](https://github.com/winstonjs/winston-transport) ([v4.6.0](https://github.com/winstonjs/winston-transport/tree/v4.6.0)), distributed under the [MIT License](https://github.com/winstonjs/winston-transport/blob/v4.6.0/LICENSE):
+This product includes source derived from [winston-transport](https://github.com/winstonjs/winston-transport) ([v4.7.0](https://github.com/winstonjs/winston-transport/tree/v4.7.0)), distributed under the [MIT License](https://github.com/winstonjs/winston-transport/blob/v4.7.0/LICENSE):
 
 ```
 The MIT License (MIT)
@@ -1916,7 +1916,7 @@ This product includes source derived from [@newrelic/newrelic-oss-cli](https://g
 
 ### @newrelic/test-utilities
 
-This product includes source derived from [@newrelic/test-utilities](https://github.com/newrelic/node-test-utilities) ([v8.1.0](https://github.com/newrelic/node-test-utilities/tree/v8.1.0)), distributed under the [Apache-2.0 License](https://github.com/newrelic/node-test-utilities/blob/v8.1.0/LICENSE):
+This product includes source derived from [@newrelic/test-utilities](https://github.com/newrelic/node-test-utilities) ([v8.2.0](https://github.com/newrelic/node-test-utilities/tree/v8.2.0)), distributed under the [Apache-2.0 License](https://github.com/newrelic/node-test-utilities/blob/v8.2.0/LICENSE):
 
 ```
                                  Apache License

package/lib/feature_flags.js

@@ -12,7 +12,8 @@ exports.prerelease = {
   reverse_naming_rules: false,
   undici_async_tracking: true,
   unresolved_promise_cleanup: true,
-  legacy_context_manager: false
+  legacy_context_manager: false,
+  langchain_instrumentation: false
 }
 
 // flags that are no longer used for released features

package/lib/instrumentation/grpc-js/grpc.js

@@ -153,7 +153,11 @@ function wrapRegister(shim, original) {
     function instrumentedHandler(stream) {
       const { transaction, segment } = createTransaction()
       acceptDTHeaders(stream, transaction)
-      instrumentEventListeners(stream, transaction)
+      if (semver.gte(shim.pkgVersion, '1.10.0')) {
+        instrumentInterceptors(stream, transaction)
+      } else {
+        instrumentEventListeners(stream, transaction)
+      }
       return shim.applySegment(handler, segment, true, this, arguments)
     }
 
@@ -194,9 +198,48 @@ function wrapRegister(shim, original) {
       transaction.acceptDistributedTraceHeaders('HTTP', headers)
     }
 
+    /**
+     * Wraps the onCallEnd to add the response.status to trace, log an error,
+     * and end transaction.
+     *
+     * @param {object} stream the http2 server stream
+     * @param {object} transaction active transaction
+     */
+    function instrumentInterceptors(stream, transaction) {
+      const agent = shim.agent
+      const config = agent.config
+      if (!shim.isWrapped(stream.call.callEventTracker, 'onCallEnd')) {
+        shim.wrap(stream.call.callEventTracker, 'onCallEnd', function onCallEnd(shim, orig) {
+          return function wrappedOnCallEnd() {
+            const args = shim.argsToArray.apply(shim, arguments)
+            const [{ code: statusCode }] = args
+            transaction.trace.attributes.addAttribute(DESTINATION, 'response.status', statusCode)
+            if (shouldTrackError(statusCode, config)) {
+              const status = constants.Status[statusCode]
+              const error = new Error(`gRPC status code ${statusCode}: ${status}`)
+              agent.errors.add(transaction, error)
+            }
+            transaction.end()
+            return orig.apply(this, arguments)
+          }
+        })
+      }
+    }
+
+    /**
+     * Registers event listeners for callEnd and streamEnd to add the response.status to trace, log an error,
+     * and end transaction.
+     *
+     * Note: two listeners are registered as callEnd is emitted before streamEnd. Unlike the instrumentInterceptors
+     * case above where onCallEnd is called last.
+     *
+     * @param {object} stream the http2 server stream
+     * @param {object} transaction active transaction
+     */
     function instrumentEventListeners(stream, transaction) {
       const agent = shim.agent
       const config = agent.config
+
       stream.call.once('callEnd', (statusCode) => {
         transaction.trace.attributes.addAttribute(DESTINATION, 'response.status', statusCode)
         if (shouldTrackError(statusCode, config)) {

package/lib/llm-events/event.js

@@ -0,0 +1,18 @@
+/*
+ * Copyright 2024 New Relic Corporation. All rights reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+'use strict'
+
+const { DESTINATIONS } = require('../config/attribute-filter')
+
+class BaseLlmEvent {
+  conversationId(agent) {
+    const transaction = agent.tracer.getTransaction()
+    const attrs = transaction?.trace?.custom.get(DESTINATIONS.TRANS_SCOPE)
+    return attrs?.['llm.conversation_id']
+  }
+}
+
+module.exports = BaseLlmEvent

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

@@ -0,0 +1,52 @@
+/*
+ * Copyright 2024 New Relic Corporation. All rights reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+'use strict'
+
+const LangChainEvent = require('./event')
+const { makeId } = require('../../util/hashes')
+
+/**
+ * @typedef {object} LangChainCompletionMessageParams
+ * @augments LangChainEventParams
+ * @property {string} content The text of the response received from LangChain.
+ * @property {string} role The role of the message, e.g. "human."
+ * @property {number} [sequence=0] The order of the message in the response.
+ * @property {string} [completionId] An identifier for the message.
+ */
+/**
+ * @type {LangChainCompletionMessageParams}
+ */
+const defaultParams = {
+  content: '',
+  role: undefined,
+  sequence: 0,
+  completionId: makeId(36)
+}
+
+class LangChainCompletionMesssage extends LangChainEvent {
+  content
+  role
+  sequence
+  completion_id
+
+  constructor(params = defaultParams) {
+    params = Object.assign({}, defaultParams, params)
+    super(params)
+
+    if (params.runId) {
+      this.id = `${params.runId}-${params.sequence}`
+    } else {
+      this.id = `${this.id}-${params.sequence}`
+    }
+
+    this.content = params.content
+    this.role = params.role
+    this.sequence = params.sequence
+    this.completion_id = params.completionId
+  }
+}
+
+module.exports = LangChainCompletionMesssage

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

@@ -0,0 +1,56 @@
+/*
+ * Copyright 2024 New Relic Corporation. All rights reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+'use strict'
+
+const LangChainEvent = require('./event')
+
+/**
+ * @typedef {object} LangChainCompletionSummaryParams
+ * @augments LangChainEventParams
+ * @property {string[]|string} [tags] A set of tags applied to the LangChain
+ * event. If provided as a simple string, it should be a comma separated value
+ * string.
+ * @property {object[]} messages The set of messages that were returned as the
+ * LangChain result.
+ */
+/**
+ * @type {LangChainCompletionSummaryParams}
+ */
+const defaultParams = {
+  tags: [],
+  messages: []
+}
+
+class LangChainCompletionSummary extends LangChainEvent {
+  duration;
+  ['response.number_of_messages'] = 0
+
+  #tags
+
+  constructor(params = defaultParams) {
+    params = Object.assign({}, defaultParams, params)
+    super(params)
+    const { segment } = params
+
+    this.tags = params.tags
+    this.duration = segment?.getDurationInMillis()
+    this['response.number_of_messages'] = params.messages?.length
+  }
+
+  get tags() {
+    return this.#tags
+  }
+
+  set tags(value) {
+    if (Array.isArray(value)) {
+      this.#tags = value.join(',')
+    } else if (typeof value === 'string') {
+      this.#tags = value
+    }
+  }
+}
+
+module.exports = LangChainCompletionSummary

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

@@ -0,0 +1,83 @@
+/*
+ * Copyright 2024 New Relic Corporation. All rights reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+'use strict'
+
+const BaseEvent = require('../event')
+const { makeId } = require('../../util/hashes')
+const { isSimpleObject } = require('../../util/objects')
+
+/**
+ * @typedef {object} LangChainEventParams
+ * @property {object} agent A New Relic agent instance.
+ * @property {object} segment A New Relic segment instance.
+ * @property {string} runId The identifier LangChain has assigned to the "run."
+ * @property {Object<string, string>} metadata The metadata, if any, associated with the
+ * LangChain run.
+ * @property {boolean|undefined} [virtual=true] Indicates that this event is a
+ * LangChain specific event (`true`). LangChain is not itself an LLM, but an
+ * interface to many LLMs. Any LLMs LangChain interacts with that we have
+ * instrumented will have their own traces that are not "virtual."
+ */
+/**
+ * @type {LangChainEventParams}
+ */
+const defaultParams = {
+  agent: {},
+  segment: {
+    transaction: {}
+  },
+  runId: '',
+  metadata: {},
+  virtual: undefined
+}
+
+/**
+ * Baseline object representing an event in a LangChain conversation.
+ */
+class LangChainEvent extends BaseEvent {
+  id = makeId(36)
+  appName
+  conversation_id
+  span_id
+  request_id
+  transaction_id
+  trace_id
+  ingest_source = 'Node'
+  vendor = 'langchain'
+  virtual_llm = true
+
+  constructor(params = defaultParams) {
+    params = Object.assign({}, defaultParams, params)
+    super(params)
+    const { agent, segment } = params
+
+    this.appName = agent.config.applications()[0]
+    this.conversation_id = this.conversationId(agent)
+    this.span_id = segment?.id
+    this.request_id = params.runId
+    this.transaction_id = segment?.transaction?.id
+    this.trace_id = segment?.transaction?.traceId
+    this.metadata = params.metadata
+
+    if (params.virtual !== undefined) {
+      if (params.virtual !== true && params.virtual !== false) {
+        throw Error('params.virtual must be a primitive boolean')
+      }
+      this.virtual_llm = params.virtual
+    }
+  }
+
+  set metadata(value) {
+    if (isSimpleObject(value) === false) {
+      return
+    }
+    for (const [key, val] of Object.entries(value)) {
+      this[`metadata.${key}`] = val
+    }
+  }
+}
+
+module.exports = LangChainEvent

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

@@ -0,0 +1,14 @@
+/*
+ * Copyright 2024 New Relic Corporation. All rights reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+'use strict'
+
+module.exports = {
+  LangChainEvent: require('./event'),
+  LangChainCompletionMessage: require('./chat-completion-message'),
+  LangChainCompletionSummary: require('./chat-completion-summary'),
+  LangChainVectorSearch: require('./vector-search'),
+  LangChainVectorSearchResult: require('./vector-search-result')
+}

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

@@ -0,0 +1,37 @@
+/*
+ * Copyright 2024 New Relic Corporation. All rights reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+'use strict'
+
+const LangChainEvent = require('./event')
+const crypto = require('crypto')
+
+/**
+ * @typedef {object} LangChainVectorSearchResultParams
+ * @augments LangChainEventParams
+ * @property {string} pageContent The stringified contents of the pageContent attribute on each returned search result document.
+ * @property {number} [sequence=0] The index of the document in the search result documents list.
+ */
+/**
+ * @type {LangChainVectorSearchResultParams}
+ */
+const defaultParams = {
+  pageContent: '',
+  sequence: 0
+}
+
+class LangChainVectorSearchResult extends LangChainEvent {
+  search_id = crypto.randomUUID()
+
+  constructor(params) {
+    params = Object.assign({}, defaultParams, params)
+    super(params)
+
+    this.page_content = params.pageContent
+    this.sequence = params.sequence
+  }
+}
+
+module.exports = LangChainVectorSearchResult

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

@@ -0,0 +1,40 @@
+/*
+ * Copyright 2024 New Relic Corporation. All rights reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+'use strict'
+
+const LangChainEvent = require('./event')
+
+/**
+ * @typedef {object} LangChainVectorSearchParams
+ * @augments LangChainEventParams
+ * @property {string} query First parameter of similaritySearch method.
+ * @property {number} k Second parameter of similaritySearch method.
+ * @property {object} documents The set of documents returned in a response.
+ */
+/**
+ * @type {LangChainVectorSearchParams}
+ */
+const defaultParams = {
+  documents: []
+}
+
+class LangChainVectorSearch extends LangChainEvent {
+  duration;
+  ['response.number_of_documents'] = 0
+
+  constructor(params) {
+    params = Object.assign({}, defaultParams, params)
+    super(params)
+    const { segment } = params
+
+    this.duration = segment?.getDurationInMillis()
+    this['request.query'] = params.query
+    this['request.k'] = params.k
+    this['response.number_of_documents'] = params.documents?.length
+  }
+}
+
+module.exports = LangChainVectorSearch

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

@@ -4,11 +4,14 @@
  */
 
 'use strict'
+
+const BaseEvent = require('../event')
 const { makeId } = require('../../util/hashes')
-const { DESTINATIONS } = require('../../../lib/config/attribute-filter')
 
-module.exports = class LlmEvent {
+module.exports = class LlmEvent extends BaseEvent {
   constructor({ agent, segment, request, response, responseAttrs = false }) {
+    super()
+
     this.id = makeId(36)
     this.appName = agent.config.applications()[0]
     this.request_id = response?.headers?.['x-request-id']
@@ -47,10 +50,4 @@ module.exports = class LlmEvent {
     this['response.headers.ratelimitRemainingRequests'] =
       response?.headers?.['x-ratelimit-remaining-requests']
   }
-
-  conversationId(agent) {
-    const transaction = agent.tracer.getTransaction()
-    const attrs = transaction?.trace?.custom.get(DESTINATIONS.TRANS_SCOPE)
-    return attrs?.['llm.conversation_id']
-  }
 }

package/package.json

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