newrelic 13.2.0 → 13.3.0

package/lib/otel/{segments → traces/segments}/database.js

@@ -5,12 +5,12 @@
 
 'use strict'
 
-const parseSql = require('../../db/query-parsers/sql')
-const recordQueryMetrics = require('../../metrics/recorders/database')
-const recordOperationMetrics = require('../../metrics/recorders/database-operation')
-const ParsedStatement = require('../../db/parsed-statement')
-const metrics = require('../../metrics/names')
-const { transformTemplate } = require('../utils')
+const parseSql = require('#agentlib/db/query-parsers/sql.js')
+const recordQueryMetrics = require('#agentlib/metrics/recorders/database.js')
+const recordOperationMetrics = require('#agentlib/metrics/recorders/database-operation.js')
+const ParsedStatement = require('#agentlib/db/parsed-statement.js')
+const metrics = require('#agentlib/metrics/names.js')
+const { transformTemplate } = require('../utils.js')
 
 module.exports = function createDbSegment(agent, otelSpan, rule) {
   const context = agent.tracer.getContext()

package/lib/otel/{segments → traces/segments}/http-external.js

@@ -5,10 +5,10 @@
 
 'use strict'
 
-const recordExternal = require('../../metrics/recorders/http_external')
-const urltils = require('../../util/urltils')
-const { transformTemplate } = require('../utils')
-const { UNKNOWN } = require('../constants')
+const recordExternal = require('#agentlib/metrics/recorders/http_external.js')
+const urltils = require('#agentlib/util/urltils.js')
+const { transformTemplate } = require('../utils.js')
+const { UNKNOWN } = require('../constants.js')
 
 function assignHost(otelSpan, segmentTransformation) {
   let host = UNKNOWN
@@ -23,18 +23,21 @@ function assignHost(otelSpan, segmentTransformation) {
   return host
 }
 
-module.exports = function createHttpExternalSegment(agent, otelSpan, rule) {
+module.exports = function createHttpExternalSegment(agent, otelSpan, rule, logger) {
   const context = agent.tracer.getContext()
   const segmentTransformation = rule.segmentTransformation
 
   const host = assignHost(otelSpan, segmentTransformation)
   const url = otelSpan?.attributes[segmentTransformation?.url]
   const system = otelSpan?.attributes[segmentTransformation?.system] ?? 'http'
-  let parsedUrl
   let obfuscatedPath = `/${UNKNOWN}`
   if (url) {
-    parsedUrl = new URL(url)
-    obfuscatedPath = urltils.obfuscatePath(agent.config, parsedUrl.pathname)
+    try {
+      const parsedUrl = new URL(url)
+      obfuscatedPath = urltils.obfuscatePath(agent.config, parsedUrl.pathname)
+    } catch (err) {
+      logger.debug('Could not parse URL %s: %s', url, err.message)
+    }
   }
 
   const name = transformTemplate(segmentTransformation?.name?.template, { host, path: obfuscatedPath, ...otelSpan?.attributes })

package/lib/otel/traces/segments/index.js

@@ -0,0 +1,22 @@
+/*
+ * Copyright 2024 New Relic Corporation. All rights reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+'use strict'
+
+const createConsumerSegment = require('./consumer.js')
+const createDbSegment = require('./database.js')
+const createHttpExternalSegment = require('./http-external.js')
+const createProducerSegment = require('./producer.js')
+const createServerSegment = require('./server.js')
+const createInternalSegment = require('./internal.js')
+
+module.exports = {
+  createConsumerSegment,
+  createDbSegment,
+  createHttpExternalSegment,
+  createInternalSegment,
+  createProducerSegment,
+  createServerSegment
+}

package/lib/otel/{segments → traces/segments}/internal.js

@@ -4,7 +4,7 @@
  */
 
 'use strict'
-const genericRecorder = require('../../metrics/recorders/generic')
+const genericRecorder = require('#agentlib/metrics/recorders/generic.js')
 
 module.exports = function createInternalSegment(agent, otelSpan, rule) {
   const context = agent.tracer.getContext()

package/lib/otel/{segments → traces/segments}/producer.js

@@ -5,8 +5,8 @@
 
 'use strict'
 
-const genericRecorder = require('../../metrics/recorders/generic')
-const { transformTemplate } = require('../utils')
+const genericRecorder = require('#agentlib/metrics/recorders/generic.js')
+const { transformTemplate } = require('../utils.js')
 
 module.exports = function createProducerSegment(agent, otelSpan, rule) {
   const context = agent.tracer.getContext()

package/lib/otel/{segments → traces/segments}/server.js

@@ -5,10 +5,10 @@
 
 'use strict'
 
-const Transaction = require('../../transaction')
-const httpRecorder = require('../../metrics/recorders/http')
-const { propagateTraceContext } = require('./utils')
-const createInternalSegment = require('./internal')
+const Transaction = require('#agentlib/transaction/index.js')
+const httpRecorder = require('#agentlib/metrics/recorders/http.js')
+const { propagateTraceContext } = require('./utils.js')
+const createInternalSegment = require('./internal.js')
 
 module.exports = function createServerSegment(agent, otelSpan, rule) {
   const activeTx = agent.tracer.getTransaction()

package/lib/otel/{segments → traces/segments}/utils.js

@@ -5,7 +5,7 @@
 
 'use strict'
 
-const Traceparent = require('../../w3c/traceparent')
+const Traceparent = require('#agentlib/w3c/traceparent.js')
 
 /**
  * Accepts trace context payload if span has a parent. It will use the

package/lib/otel/{span-processor.js → traces/span-processor.js}

@@ -7,19 +7,18 @@
 
 const { hrTimeToMilliseconds } = require('@opentelemetry/core')
 const { SpanKind } = require('@opentelemetry/api')
-const urltils = require('../util/urltils')
+const urltils = require('#agentlib/util/urltils.js')
 
-const AttributeReconciler = require('./attr-reconciler')
-const SegmentSynthesizer = require('./segment-synthesis')
-const { otelSynthesis } = require('../symbols')
-const { DESTINATIONS } = require('../config/attribute-filter')
-const { assignToTarget, buildRuleMappings, extractAttributeValue, processRegex, transformTemplate } = require('./utils')
-const defaultLogger = require('../logger').child({ component: 'span-processor' })
+const AttributeReconciler = require('./attr-reconciler.js')
+const SegmentSynthesizer = require('./segment-synthesis.js')
+const { otelSynthesis } = require('#agentlib/symbols.js')
+const { assignToTarget, buildRuleMappings, extractAttributeValue, processRegex, transformTemplate } = require('./utils.js')
+const defaultLogger = require('#agentlib/logger.js').child({ component: 'span-processor' })
 
 const {
   SPAN_STATUS_CODE
 } = require('./constants')
-const exceptionAttr = require('./exception-mapping')
+const exceptionAttr = require('./exception-mapping.js')
 
 module.exports = class NrSpanProcessor {
   #reconciler
@@ -215,24 +214,19 @@ module.exports = class NrSpanProcessor {
 
     try {
       const requestUrl = new URL(httpUrl)
-      transaction.parsedUrl = requestUrl
       transaction.url = urltils.obfuscatePath(this.agent.config, requestUrl.pathname)
       transaction.applyUserNamingRules(requestUrl.pathname)
-    } catch {
+      // If `http.route` was not emitted on server span, name the transaction from the path
+      // to avoid transactions being named `*`
+      transaction.nameState.appendPathIfEmpty(requestUrl.pathname)
+    } catch (err) {
+      this.logger.debug('Could not parse URL from span for transaction URL: %s, err: %s', httpUrl, err.message)
       transaction.url = httpUrl
     }
 
-    transaction.trace.attributes.addAttribute(DESTINATIONS.TRANS_COMMON, 'request.uri', transaction.url)
-
-    // If `http.route` was not emitted on server span, name the transaction from the path
-    // to avoid transactions being named `*`
-    if (transaction.parsedUrl) {
-      transaction.nameState.appendPathIfEmpty(transaction.parsedUrl?.path)
-    }
-
     // Add the status code to transaction name
     if (transaction.statusCode) {
-      transaction.finalizeNameFromUri(transaction.parsedUrl, transaction.statusCode)
+      transaction.finalizeNameFromWeb(transaction.statusCode)
     }
   }
 }

package/lib/otel/{transformation-rules.json → traces/transformation-rules.json}

@@ -731,8 +731,9 @@
     ],
     "segment": {
       "host": "server.address",
+      "url": "url.full",
       "name": {
-        "template": "External/${server.address}${url.path}"
+        "template": "External/${host}${path}"
       } 
     }
   },
@@ -798,7 +799,7 @@
       "host": "net.peer.name",
       "url": "http.url",
       "name": {
-        "template": "External/${net.peer.name}${path}"
+        "template": "External/${host}${path}"
       } 
     }
   },

package/lib/otel/{utils.js → traces/utils.js}

@@ -4,7 +4,8 @@
  */
 
 'use strict'
-const { DESTINATIONS } = require('../config/attribute-filter')
+
+const { DESTINATIONS } = require('#agentlib/config/attribute-filter.js')
 
 /**
  * Transforms a template string by replacing placeholders with values from the data object.

package/lib/serverless/aws-lambda.js

@@ -6,13 +6,11 @@
 'use strict'
 
 const apiGateway = require('./api-gateway')
-const headerAttributes = require('../header-attributes')
 const get = require('../util/get')
 const logger = require('../logger').child({ component: 'aws-lambda' })
 const recordBackground = require('../metrics/recorders/other')
 const recordWeb = require('../metrics/recorders/http')
 const TransactionShim = require('../shim/transaction-shim')
-const urltils = require('../util/urltils')
 const specs = require('../shim/specs')
 
 // CONSTANTS
@@ -255,7 +253,7 @@ class AwsLambda {
 
       if (isApiGatewayLambdaProxy) {
         const webRequest = new apiGateway.LambdaProxyWebRequest(event)
-        setWebRequest(shim, transaction, webRequest)
+        setWebRequest(transaction, webRequest)
         resultProcessor = getApiGatewayLambdaProxyResultProcessor(transaction)
       }
       const cbIndex = args.length - 1
@@ -411,57 +409,21 @@ function getApiGatewayLambdaProxyResultProcessor(transaction) {
   return function processApiGatewayLambdaProxyResponse(response) {
     if (apiGateway.isValidLambdaProxyResponse(response)) {
       const webResponse = new apiGateway.LambdaProxyWebResponse(response)
-      setWebResponse(transaction, webResponse)
+      transaction.finalizeWeb({ end: false, statusCode: webResponse.statusCode, headers: webResponse.headers })
     } else {
       logger.debug('Did not contain a valid API Gateway Lambda Proxy response.')
     }
   }
 }
 
-function setWebRequest(shim, transaction, request) {
-  transaction.type = shim.WEB
-
-  const segment = transaction.baseSegment
-
-  transaction.url = urltils.scrub(request.url.path)
-  transaction.verb = request.method
-  transaction.trace.attributes.addAttribute(
-    ATTR_DEST.TRANS_COMMON,
-    'request.method',
-    request.method
-  )
-
-  segment.addSpanAttribute('request.method', request.method)
-
-  transaction.port = request.url.port
+function setWebRequest(transaction, request) {
+  // make a fake URL to scrub the path from a URL object
+  const absoluteUrl = `http://localhost${request.url.path}`
+  transaction.initializeWeb({ absoluteUrl, method: request.method, port: request.url.port, transport: request?.transportType?.toUpperCase(), headers: request.headers })
 
   // These are only query parameters, from lib/serverless/api-gateway.js
+  // Not handled in `transaction.initializeWeb` because the query params are not on the absoluteUrl
   transaction.addRequestParameters(request.url.requestParameters)
-
-  // URL is sent as an agent attribute with transaction events
-  transaction.trace.attributes.addAttribute(
-    ATTR_DEST.TRANS_EVENT | ATTR_DEST.ERROR_EVENT,
-    'request.uri',
-    request.url.path
-  )
-
-  segment.addSpanAttribute('request.uri', request.url.path)
-
-  headerAttributes.collectRequestHeaders(request.headers, transaction)
-
-  if (shim.agent.config.distributed_tracing.enabled) {
-    const lowercaseHeaders = lowercaseObjectKeys(request.headers)
-
-    const transportType = request.transportType && request.transportType.toUpperCase()
-    transaction.acceptDistributedTraceHeaders(transportType, lowercaseHeaders)
-  }
-}
-
-function lowercaseObjectKeys(original) {
-  return Object.keys(original).reduce((destination, key) => {
-    destination[key.toLowerCase()] = original[key]
-    return destination
-  }, {})
 }
 
 function endTransaction(transaction, enderIndex) {
@@ -490,27 +452,4 @@ function endTransaction(transaction, enderIndex) {
   }
 }
 
-function setWebResponse(transaction, response) {
-  transaction.statusCode = response.statusCode
-
-  const responseCode = String(response.statusCode)
-
-  if (/^\d+$/.test(responseCode)) {
-    transaction.trace.attributes.addAttribute(
-      ATTR_DEST.TRANS_COMMON,
-      'http.statusCode',
-      responseCode
-    )
-
-    // We are adding http.statusCode to base segment as
-    // we found in testing async invoked lambdas, the
-    // active segment is not available at this point.
-    const segment = transaction.baseSegment
-
-    segment.addSpanAttribute('http.statusCode', responseCode)
-  }
-
-  headerAttributes.collectResponseHeaders(response.headers, transaction)
-}
-
 module.exports = AwsLambda

package/lib/shim/webframework-shim/middleware.js

@@ -70,7 +70,7 @@ function copyParams({ spec, shim, fn, fnName, args, req }) {
     ? null
     : spec.params.call(this, shim, fn, fnName, args, req)
 
-  // Route parameters are handled here, query parameters are handled in lib/transaction/index.js#_markAsWeb as part of finalization
+  // Route parameters are handled here, query parameters are handled in lib/transaction/index.js#finalizeNameFromWeb as part of finalization
   return shim.prefixRouteParameters(params)
 }
 

package/lib/shimmer.js

@@ -25,7 +25,7 @@ const symbols = require('./symbols')
 const { unsubscribe } = require('./instrumentation/undici')
 const subscriptions = require('./subscriber-configs')
 const createSubscriberConfigs = require('./subscribers/create-config')
-const ModulePatch = require('./patch-module')
+const ModulePatch = require('@apm-js-collab/tracing-hooks')
 
 /**
  * Unwrapping is only likely to be used by test code, and is a fairly drastic
@@ -400,7 +400,7 @@ const shimmer = (module.exports = {
         if (subscriber.enabled === false) {
           logger.debug(
             'Skipping subscriber %s because it is disabled in the config',
-            subscriber.id
+            subscriber.packageName
           )
           continue
         }

package/lib/subscriber-configs.js

@@ -11,7 +11,8 @@ const subscribers = {
   ...require('./subscribers/elasticsearch/config'),
   ...require('./subscribers/ioredis/config'),
   ...require('./subscribers/mcp-sdk/config'),
-  ...require('./subscribers/pino/config'),
+  ...require('./subscribers/openai/config'),
+  ...require('./subscribers/pino/config')
 }
 
 module.exports = subscribers

package/lib/subscribers/base.js

@@ -6,6 +6,8 @@
 'use strict'
 // eslint-disable-next-line n/no-unsupported-features/node-builtins
 const { tracingChannel } = require('node:diagnostics_channel')
+const semver = require('semver')
+const NAMES = require('../metrics/names')
 
 /**
  * The baseline parameters available to all subscribers.
@@ -66,6 +68,33 @@ class Subscriber {
     )
   }
 
+  /**
+   * Creates the `Supportability/Features/Instrumentation/OnRequire/<packageName>`
+   * and `Supportability/Features/Instrumentation/OnRequire/<packageName>/Version/<majorVersion>`
+   * metrics to track the usage of an instrumented package.
+   * We only want to increment this once per package, so we check the call count
+   *
+   * @param {string} [version] - The version of the package being instrumented.
+   * @returns {void}
+   */
+  trackInstrumentationUsage(version) {
+    const prefix = NAMES.FEATURES.INSTRUMENTATION.ON_REQUIRE
+    const instrumentationMetric = `${prefix}/${this.packageName}`
+    const metric = this.agent.metrics.getOrCreateMetric(instrumentationMetric)
+    if (metric.callCount === 0) {
+      metric.incrementCallCount()
+    }
+
+    if (version) {
+      const majorVersion = semver.major(version)
+      const versionMetricName = `${instrumentationMetric}/Version/${majorVersion}`
+      const versionMetric = this.agent.metrics.getOrCreateMetric(versionMetricName)
+      if (versionMetric.callCount === 0) {
+        versionMetric.incrementCallCount()
+      }
+    }
+  }
+
   /**
    * Creates a segment with a name, parent, transaction and optional recorder.
    * If the segment is successfully created, it will be started and added to the context.
@@ -127,6 +156,7 @@ class Subscriber {
    */
   enable() {
     this.channel.start.bindStore(this.store, (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)

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