newrelic 13.2.1 → 13.3.0

package/lib/subscribers/elasticsearch/config.js

@@ -2,6 +2,7 @@
  * Copyright 2025 New Relic Corporation. All rights reserved.
  * SPDX-License-Identifier: Apache-2.0
  */
+'use strict'
 
 module.exports = {
   '@elastic/elasticsearch': [{

package/lib/subscribers/mcp-sdk/client-request.js

@@ -0,0 +1,66 @@
+/*
+ * Copyright 2025 New Relic Corporation. All rights reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+'use strict'
+
+const Subscriber = require('../base')
+const { MCP } = require('../../metrics/names')
+
+class McpClientRequestSubscriber extends Subscriber {
+  constructor({ agent, logger }) {
+    super({ agent, logger, packageName: '@modelcontextprotocol/sdk', channelName: 'nr_request' })
+    this.events = ['asyncEnd']
+  }
+
+  get enabled() {
+    return super.enabled && this.config.ai_monitoring.enabled === true
+  }
+
+  /**
+   * Determine the MCP function to record based on the incoming request.
+   * @param {*} args0 - The arguments passed to the request.
+   * @returns {Object} - An object containing the MCP prefix, function name, and primitive name.
+   */
+  determineFunction(args0) {
+    const methodName = args0?.method
+    let mcpPrefix
+    let functionName
+    let primitiveName
+
+    if (methodName === 'tools/call') {
+      mcpPrefix = MCP.TOOL
+      functionName = 'callTool'
+      primitiveName = args0?.params?.name ?? 'tool'
+    } else if (methodName === 'prompts/get') {
+      mcpPrefix = MCP.PROMPT
+      functionName = 'getPrompt'
+      primitiveName = args0?.params?.name ?? 'prompt'
+    } else if (methodName === 'resources/read') {
+      mcpPrefix = MCP.RESOURCE
+      functionName = 'readResource'
+      const uri = args0?.params?.uri
+      primitiveName = typeof uri === 'string' ? uri.split('://')[0] : 'resource'
+    } else {
+      this.logger.debug(`@modelcontextprotocol/sdk: Will not create '${methodName}' segment.`)
+    }
+    return { mcpPrefix, functionName, primitiveName }
+  }
+
+  handler(data, ctx) {
+    const { mcpPrefix, functionName, primitiveName } = this.determineFunction(data?.arguments?.[0])
+    if (!mcpPrefix || !functionName || !primitiveName) {
+      // If it is not a function we care about, don't instrument at all
+      return
+    }
+
+    const segmentName = `${mcpPrefix}/${functionName}/${primitiveName}`
+    return this.createSegment({
+      name: segmentName,
+      ctx
+    })
+  }
+}
+
+module.exports = McpClientRequestSubscriber

package/lib/subscribers/mcp-sdk/config.js

@@ -3,96 +3,32 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-const mcpClientToolConfig = {
-  path: './mcp-sdk/client-tool',
+const mcpClientRequestConfig = {
+  path: './mcp-sdk/client-request',
   instrumentations: [
     {
-      channelName: 'nr_callTool',
+      channelName: 'nr_request',
       module: {
         name: '@modelcontextprotocol/sdk',
         versionRange: '>=1.13.0',
-        filePath: 'dist/cjs/client/index.js'
+        filePath: 'dist/cjs/shared/protocol.js'
       },
       functionQuery: {
-        className: 'Client',
-        methodName: 'callTool', // must be methodName, not functionName
+        className: 'Protocol',
+        methodName: 'request',
         kind: 'Async'
       }
     },
     {
-      channelName: 'nr_callTool',
+      channelName: 'nr_request',
       module: {
         name: '@modelcontextprotocol/sdk',
         versionRange: '>=1.13.0',
-        filePath: 'dist/esm/client/index.js'
+        filePath: 'dist/esm/shared/protocol.js'
       },
       functionQuery: {
-        className: 'Client',
-        methodName: 'callTool',
-        kind: 'Async'
-      }
-    },
-  ]
-}
-
-const mcpClientResourceConfig = {
-  path: './mcp-sdk/client-resource',
-  instrumentations: [
-    {
-      channelName: 'nr_readResource',
-      module: {
-        name: '@modelcontextprotocol/sdk',
-        versionRange: '>=1.13.0',
-        filePath: 'dist/cjs/client/index.js'
-      },
-      functionQuery: {
-        className: 'Client',
-        methodName: 'readResource',
-        kind: 'Async'
-      }
-    },
-    {
-      channelName: 'nr_readResource',
-      module: {
-        name: '@modelcontextprotocol/sdk',
-        versionRange: '>=1.13.0',
-        filePath: 'dist/esm/client/index.js'
-      },
-      functionQuery: {
-        className: 'Client',
-        methodName: 'readResource',
-        kind: 'Async'
-      }
-    },
-  ]
-}
-
-const mcpClientPromptConfig = {
-  path: './mcp-sdk/client-prompt',
-  instrumentations: [
-    {
-      channelName: 'nr_getPrompt',
-      module: {
-        name: '@modelcontextprotocol/sdk',
-        versionRange: '>=1.13.0',
-        filePath: 'dist/cjs/client/index.js'
-      },
-      functionQuery: {
-        className: 'Client',
-        methodName: 'getPrompt',
-        kind: 'Async'
-      }
-    },
-    {
-      channelName: 'nr_getPrompt',
-      module: {
-        name: '@modelcontextprotocol/sdk',
-        versionRange: '>=1.13.0',
-        filePath: 'dist/esm/client/index.js'
-      },
-      functionQuery: {
-        className: 'Client',
-        methodName: 'getPrompt',
+        className: 'Protocol',
+        methodName: 'request',
         kind: 'Async'
       }
     },
@@ -100,5 +36,7 @@ const mcpClientPromptConfig = {
 }
 
 module.exports = {
-  '@modelcontextprotocol/sdk': [mcpClientToolConfig, mcpClientResourceConfig, mcpClientPromptConfig],
+  '@modelcontextprotocol/sdk': [
+    mcpClientRequestConfig
+  ]
 }

package/lib/subscribers/openai/base.js

@@ -0,0 +1,21 @@
+/*
+ * Copyright 2025 New Relic Corporation. All rights reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+'use strict'
+
+const Subscriber = require('../base')
+
+class OpenAISubscriber extends Subscriber {
+  constructor({ agent, logger, channelName }) {
+    super({ agent, logger, packageName: 'openai', channelName })
+    this.events = ['asyncEnd']
+  }
+
+  get enabled() {
+    return super.enabled && this.config.ai_monitoring?.enabled
+  }
+}
+
+module.exports = OpenAISubscriber

package/lib/subscribers/openai/chat-responses.js

@@ -0,0 +1,15 @@
+/*
+ * Copyright 2025 New Relic Corporation. All rights reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+'use strict'
+const OpenAIChatCompletions = require('./chat')
+
+class OpenAIResponses extends OpenAIChatCompletions {
+  constructor({ agent, logger }) {
+    super({ agent, logger, channelName: 'nr_responses' })
+  }
+}
+
+module.exports = OpenAIResponses

package/lib/subscribers/openai/chat.js

@@ -0,0 +1,85 @@
+/*
+ * Copyright 2025 New Relic Corporation. All rights reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+'use strict'
+/*
+ * Copyright 2025 New Relic Corporation. All rights reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+const OpenAISubscriber = require('./base')
+const { AI } = require('../../metrics/names')
+const { OPENAI } = AI
+const {
+  addLlmMeta,
+  recordChatCompletionMessages,
+  instrumentStream,
+} = require('./utils')
+const semver = require('semver')
+const MIN_STREAM_VERSION = '4.12.2'
+
+class OpenAIChatCompletions extends OpenAISubscriber {
+  constructor({ agent, logger, channelName = 'nr_completionsCreate' }) {
+    super({ agent, logger, channelName })
+  }
+
+  handler(data, ctx) {
+    const { arguments: args, moduleVersion } = data
+    const [request] = args
+    if (request.stream && semver.lt(moduleVersion, MIN_STREAM_VERSION)) {
+      this.logger.warn(`Instrumenting chat completion streams is only supported with openai version ${MIN_STREAM_VERSION}+.`)
+      return ctx
+    }
+
+    const segment = this.agent.tracer.createSegment({
+      name: OPENAI.COMPLETION,
+      parent: ctx.segment,
+      transaction: ctx.transaction
+    })
+    const newCtx = ctx.enterSegment({ segment })
+    return newCtx
+  }
+
+  asyncEnd(data) {
+    const ctx = this.agent.tracer.getContext()
+    if (!ctx?.segment || !ctx?.transaction) {
+      return
+    }
+    const { result: response, arguments: args, error: err } = data
+    const [request] = args
+
+    if (request.stream) {
+      instrumentStream({
+        agent: this.agent,
+        logger: this.logger,
+        request,
+        headers: ctx.extras?.headers,
+        response,
+        segment: ctx.segment,
+        transaction: ctx.transaction,
+        err
+      })
+    } else {
+      recordChatCompletionMessages({
+        agent: this.agent,
+        logger: this.logger,
+        segment: ctx.segment,
+        transaction: ctx.transaction,
+        request,
+        response,
+        headers: ctx.extras?.headers,
+        err
+      })
+    }
+
+    addLlmMeta({
+      agent: this.agent,
+      transaction: ctx.transaction,
+      version: data.moduleVersion,
+    })
+  }
+}
+
+module.exports = OpenAIChatCompletions

package/lib/subscribers/openai/client.js

@@ -0,0 +1,31 @@
+/*
+ * Copyright 2025 New Relic Corporation. All rights reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+'use strict'
+const OpenAISubscriber = require('./base')
+class OpenAIClientSubscriber extends OpenAISubscriber {
+  constructor({ agent, logger }) {
+    super({ agent, logger, channelName: 'nr_makeRequest' })
+  }
+
+  handler(data, ctx) {
+    const { self } = data
+    ctx.extras = { apiKey: self.apiKey }
+    return ctx
+  }
+
+  asyncEnd(data) {
+    const { result } = data
+    const ctx = this.agent.tracer.getContext()
+    if (ctx?.segment) {
+      const headers = result?.response?.headers
+        ? Object.fromEntries(result.response.headers)
+        : { ...result?.headers }
+      ctx.extras = { headers }
+    }
+  }
+}
+
+module.exports = OpenAIClientSubscriber

package/lib/subscribers/openai/config.js

@@ -0,0 +1,85 @@
+/*
+ * Copyright 2025 New Relic Corporation. All rights reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+'use strict'
+
+module.exports = {
+  openai: [
+    {
+      path: './openai/chat.js',
+      instrumentations: [
+        {
+          channelName: 'nr_completionsCreate',
+          module: { name: 'openai', versionRange: '>=4.0.0', filePath: 'resources/chat/completions.js' },
+          functionQuery: {
+            className: 'Completions',
+            methodName: 'create',
+            kind: 'Async'
+          }
+        },
+        {
+          channelName: 'nr_completionsCreate',
+          module: { name: 'openai', versionRange: '>=4.0.0', filePath: 'resources/chat/completions/completions.js' },
+          functionQuery: {
+            className: 'Completions',
+            methodName: 'create',
+            kind: 'Async'
+          }
+        }
+      ]
+    },
+    {
+      path: './openai/chat-responses.js',
+      instrumentations: [
+        {
+          channelName: 'nr_responses',
+          module: { name: 'openai', versionRange: '>=4.87.0', filePath: 'resources/responses/responses.js' },
+          functionQuery: {
+            className: 'Responses',
+            methodName: 'create',
+            kind: 'Async'
+          }
+        }
+      ]
+    },
+    {
+      path: './openai/client.js',
+      instrumentations: [
+        {
+          channelName: 'nr_makeRequest',
+          module: { name: 'openai', versionRange: '>=4.0.0', filePath: 'core.js' },
+          functionQuery: {
+            className: 'APIClient',
+            methodName: 'makeRequest',
+            kind: 'Async'
+          }
+        },
+        {
+          channelName: 'nr_makeRequest',
+          module: { name: 'openai', versionRange: '>=4.0.0', filePath: 'client.js' },
+          functionQuery: {
+            className: 'OpenAI',
+            methodName: 'makeRequest',
+            kind: 'Async'
+          }
+        }
+      ]
+    },
+    {
+      path: './openai/embeddings.js',
+      instrumentations: [
+        {
+          channelName: 'nr_embeddingsCreate',
+          module: { name: 'openai', versionRange: '>=4.0.0', filePath: 'resources/embeddings.js' },
+          functionQuery: {
+            className: 'Embeddings',
+            methodName: 'create',
+            kind: 'Async'
+          }
+        }
+      ]
+    }
+  ]
+}

package/lib/subscribers/openai/embeddings.js

@@ -0,0 +1,54 @@
+/*
+ * Copyright 2025 New Relic Corporation. All rights reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+'use strict'
+const OpenAISubscriber = require('./base')
+const { AI } = require('../../metrics/names')
+const { OPENAI } = AI
+const {
+  addLlmMeta,
+  recordEmbeddingMessage
+} = require('./utils')
+
+class OpenAIEmbeddings extends OpenAISubscriber {
+  constructor({ agent, logger }) {
+    super({ agent, logger, channelName: 'nr_embeddingsCreate' })
+  }
+
+  handler(data, ctx) {
+    const segment = this.agent.tracer.createSegment({
+      name: OPENAI.EMBEDDING,
+      parent: ctx.segment,
+      transaction: ctx.transaction
+    })
+    const newCtx = ctx.enterSegment({ segment })
+    return newCtx
+  }
+
+  asyncEnd(data) {
+    const ctx = this.agent.tracer.getContext()
+    if (!ctx?.segment || !ctx?.transaction) {
+      return
+    }
+    const { arguments: args, error: err } = data
+    const { result: response } = data
+    const [request] = args
+    const agent = this.agent
+    const { segment, transaction } = ctx
+    recordEmbeddingMessage({
+      agent,
+      logger: this.logger,
+      segment,
+      transaction,
+      request,
+      response,
+      headers: ctx.extras?.headers,
+      err
+    })
+    addLlmMeta({ agent, transaction, version: data.moduleVersion })
+  }
+}
+
+module.exports = OpenAIEmbeddings