newrelic 13.2.1 → 13.3.1

package/lib/otel/setup-signal.js

@@ -0,0 +1,37 @@
+/*
+ * Copyright 2025 New Relic Corporation. All rights reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+'use strict'
+
+const defaultLogger = require('#agentlib/logger.js').child({ component: 'opentelemetry-bridge' })
+
+/**
+ * SetupSignal is an interface to standardize how we bootstrap OpenTelemetry
+ * observability signals within the OTEL bridge. Subclasses are expected to
+ * implement their setup in the constructor, and to provide a `.teardown`
+ * method that properly cleans up any created resources (i.e. unblocks the
+ * parent singleton managed by the OTEL packages from being garbage collected).
+ */
+class SetupSignal {
+  agent
+  logger
+
+  coreApi = require('@opentelemetry/api')
+
+  constructor({ agent, logger = defaultLogger } = {}) {
+    if (Object.prototype.toString.call(agent) !== '[object Agent]') {
+      throw Error('must provide an instance of the New Relic agent')
+    }
+
+    this.agent = agent
+    this.logger = logger
+  }
+
+  teardown() {
+    this.logger.warn('teardown method is not implemented')
+  }
+}
+
+module.exports = SetupSignal

package/lib/otel/setup.js

@@ -6,18 +6,17 @@
 'use strict'
 
 const opentelemetry = require('@opentelemetry/api')
-const logsApi = require('@opentelemetry/api-logs')
-const { BasicTracerProvider } = require('@opentelemetry/sdk-trace-base')
 
-const NrSpanProcessor = require('./span-processor')
-const NrSampler = require('./sampler')
+const SetupLogs = require('./logs/index.js')
+const SetupMetrics = require('./metrics/index.js')
+const SetupTraces = require('./traces/index.js')
 const ContextManager = require('./context-manager')
 const TracePropagator = require('./trace-propagator')
 const defaultLogger = require('../logger').child({ component: 'opentelemetry-bridge' })
 const createOtelLogger = require('./logger')
 const interceptSpanKey = require('./span-key-interceptor')
-const bootstrapMetrics = require('./metrics/bootstrap-metrics')
-const bootstrapLogs = require('./logs/bootstrap-logs')
+
+const signals = []
 
 function setupOtel(agent, logger = defaultLogger) {
   if (agent.config.opentelemetry_bridge.enabled !== true) {
@@ -38,19 +37,22 @@ function setupOtel(agent, logger = defaultLogger) {
   opentelemetry.propagation.setGlobalPropagator(new TracePropagator(agent))
 
   if (agent.config.opentelemetry_bridge.traces.enabled === true) {
-    bootstrapTraces(agent)
+    const signal = new SetupTraces({ agent })
+    signals.push(signal)
   } else {
     logger.debug('`opentelemetry_bridge.traces` is not enabled, skipping')
   }
 
   if (agent.config.opentelemetry_bridge.metrics.enabled === true) {
-    bootstrapMetrics(agent)
+    const signal = new SetupMetrics({ agent })
+    signals.push(signal)
   } else {
     logger.debug('`opentelemetry_bridge.metrics` is not enabled, skipping')
   }
 
   if (agent.config.opentelemetry_bridge.logs.enabled === true) {
-    bootstrapLogs({ agent })
+    const signal = new SetupLogs({ agent })
+    signals.push(signal)
   } else {
     logger.debug('`opentelemetry_bridge.logs` is not enabled, skipping')
   }
@@ -60,30 +62,18 @@ function setupOtel(agent, logger = defaultLogger) {
     .incrementCallCount()
 }
 
-function bootstrapTraces(agent) {
-  opentelemetry.trace.setGlobalTracerProvider(new BasicTracerProvider({
-    sampler: new NrSampler(),
-    spanProcessors: [new NrSpanProcessor(agent)],
-    generalLimits: {
-      attributeValueLengthLimit: 4095
-    }
-  }))
-
-  agent.metrics
-    .getOrCreateMetric('Supportability/Nodejs/OpenTelemetryBridge/Traces')
-    .incrementCallCount()
-}
-
 function teardownOtel(agent) {
   if (agent?.config?.opentelemetry_bridge?.enabled !== true) {
     return
   }
 
-  opentelemetry.trace.disable()
+  for (const signal of signals) {
+    signal.teardown()
+  }
+
   opentelemetry.context.disable()
   opentelemetry.propagation.disable()
   opentelemetry.diag.disable()
-  logsApi.logs.disable()
 }
 
 module.exports = {

package/lib/otel/{attr-reconciler.js → traces/attr-reconciler.js}

@@ -5,8 +5,8 @@
 
 'use strict'
 
-const urltils = require('../util/urltils')
-const constants = require('./constants')
+const urltils = require('#agentlib/util/urltils.js')
+const constants = require('./constants.js')
 
 const hostKeys = [
   constants.ATTR_NET_HOST_NAME,

package/lib/otel/{exception-mapping.js → traces/exception-mapping.js}

@@ -4,7 +4,7 @@
  */
 
 'use strict'
-const constants = require('./constants')
+const constants = require('./constants.js')
 const attrMappings = {
   msg: {
     attrs: [constants.EXCEPTION_MESSAGE, constants.EXCEPTION_TYPE]

package/lib/otel/traces/index.js

@@ -0,0 +1,40 @@
+/*
+ * Copyright 2025 New Relic Corporation. All rights reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+'use strict'
+
+const { BasicTracerProvider } = require('@opentelemetry/sdk-trace-base')
+
+const defaultLogger = require('../../logger').child({ component: 'opentelemetry-traces' })
+const SetupSignal = require('../setup-signal.js')
+const NrSampler = require('./sampler.js')
+const NrSpanProcessor = require('./span-processor.js')
+
+class SetupTraces extends SetupSignal {
+  constructor({ agent, logger = defaultLogger } = {}) {
+    super({ agent, logger })
+
+    const sampler = new NrSampler()
+    const spanProcessor = new NrSpanProcessor(agent)
+    const traceProvider = new BasicTracerProvider({
+      sampler,
+      spanProcessors: [spanProcessor],
+      generalLimits: {
+        attributeValueLengthLimit: 4_095
+      }
+    })
+    this.coreApi.trace.setGlobalTracerProvider(traceProvider)
+
+    agent.metrics
+      .getOrCreateMetric('Supportability/Nodejs/OpenTelemetryBridge/Traces')
+      .incrementCallCount()
+  }
+
+  teardown() {
+    this.coreApi.trace.disable()
+  }
+}
+
+module.exports = SetupTraces

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

@@ -6,7 +6,7 @@
 'use strict'
 
 const { SpanKind } = require('@opentelemetry/api')
-const srcJson = require('./transformation-rules')
+const srcJson = require('./transformation-rules.json')
 
 /**
  * Mapping rules are stored, and provided to the agent, as JSON. We call these

package/lib/otel/{segment-synthesis.js → traces/segment-synthesis.js}

@@ -4,8 +4,9 @@
  */
 
 'use strict'
-const { RulesEngine } = require('./rules')
-const defaultLogger = require('../logger').child({ component: 'segment-synthesizer' })
+
+const defaultLogger = require('#agentlib/logger.js').child({ component: 'segment-synthesizer' })
+const { RulesEngine } = require('./rules.js')
 const {
   createConsumerSegment,
   createDbSegment,
@@ -13,7 +14,7 @@ const {
   createInternalSegment,
   createProducerSegment,
   createServerSegment
-} = require('./segments')
+} = require('./segments/index.js')
 
 class SegmentSynthesizer {
   constructor(agent, { logger = defaultLogger } = {}) {
@@ -43,7 +44,7 @@ class SegmentSynthesizer {
       }
 
       case 'external': {
-        return createHttpExternalSegment(this.agent, otelSpan, rule)
+        return createHttpExternalSegment(this.agent, otelSpan, rule, this.logger)
       }
 
       case 'internal': {

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

@@ -7,10 +7,10 @@
 
 module.exports = createConsumerSegment
 
-const Transaction = require('../../transaction/')
-const recorder = require('../../metrics/recorders/message-transaction')
-const { propagateTraceContext } = require('./utils')
-const createInternalSegment = require('./internal')
+const Transaction = require('#agentlib/transaction/index.js')
+const recorder = require('#agentlib/metrics/recorders/message-transaction.js')
+const { propagateTraceContext } = require('./utils.js')
+const createInternalSegment = require('./internal.js')
 
 function createConsumerSegment(agent, otelSpan, rule) {
   const activeTx = agent.tracer.getTransaction()

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/api-gateway.js

@@ -62,7 +62,7 @@ function normalizeQueryStringParameters(event) {
     !event.multiValueQueryStringParameters ||
     Object.keys(event.multiValueQueryStringParameters).length === 0
   ) {
-    return event.queryStringParameters
+    return event.queryStringParameters ?? {}
   }
   return Object.fromEntries(
     Object.entries(event.multiValueQueryStringParameters).map(([param, value]) => {

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

@@ -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