newrelic 11.6.0 → 11.7.0

package/NEWS.md

@@ -1,3 +1,50 @@
+### v11.7.0 (2023-12-14)
+
+#### Features
+
+* Added deserialized X-NewRelic-Synthetics-Info header to transaction and transaction trace intrinsic attributes ([#1912](https://github.com/newrelic/node-newrelic/pull/1912)) ([7ed64bd](https://github.com/newrelic/node-newrelic/commit/7ed64bd1410d7eed6c4dbf153e0a67754e7bcdef))
+    * The attributes in transactions are: `nr.syntheticsType`, `nr.syntheticsInitiator`, and `nr.synthetics<attributeKey(s)>` 
+    * The attributes in transaction traces are: `synthetics_type`, `synthetics_initiator`, and `synthetics_<attribute_key(s)>` 
+    * It will also include the `X-NewRelic-Synthetics-Info` header in outgoing http requests
+* Added instrumentation for Restify async handlers ([#1910](https://github.com/newrelic/node-newrelic/pull/1910)) ([1a3f87f](https://github.com/newrelic/node-newrelic/commit/1a3f87ff10dea1c25b35c349550338f327446cb1))
+
+#### Bug fixes
+
+* Update import-in-the-middle to fix ESM on Node 18.19.0 ([#1906](https://github.com/newrelic/node-newrelic/pull/1906)) ([e9c3748](https://github.com/newrelic/node-newrelic/commit/e9c37487a606d986d3568c11a014f6397f4f379e))
+
+#### Code refactoring
+
+* change dynamic import to work with bundlers ([#1905](https://github.com/newrelic/node-newrelic/pull/1905)) ([ee81429](https://github.com/newrelic/node-newrelic/commit/ee81429f5c34491392ed79026e6f716c76e2d735))
+
+#### Miscellaneous chores
+
+* Add AWS Bedrock feature flag ([#1913](https://github.com/newrelic/node-newrelic/pull/1913)) ([91019b0](https://github.com/newrelic/node-newrelic/commit/91019b0a45dcf8399cd8eadbe4e111e72ceab512))
+
+#### Continuous integration
+
+* removed step in post release process to update an internal system with the latest agent version ([#1909](https://github.com/newrelic/node-newrelic/pull/1909)) ([2080b1f](https://github.com/newrelic/node-newrelic/commit/2080b1fe03e65a4c6aaa073e8e338835c708680d))
+
+### v11.6.1 (2023-12-07)
+
+#### Bug fixes
+
+* **deps:** Updated @newrelic/aws-sdk to 7.0.3 ([#1902](https://github.com/newrelic/node-newrelic/pull/1902)) ([bf22ae5](https://github.com/newrelic/node-newrelic/commit/bf22ae502ee74d5071dc5578cc77c38039e68778))
+* Updated shimmer to handle instrumenting named and default exports of CommonJS modules in ESM ([#1894](https://github.com/newrelic/node-newrelic/pull/1894)) ([9f7979c](https://github.com/newrelic/node-newrelic/commit/9f7979cd41dcb3735e553cbd4837ad455836e3ff))
+
+#### Code refactoring
+
+* Fixed cognitive complexity violations of openai instrumentation by moving functions outside of the parent function scope ([#1895](https://github.com/newrelic/node-newrelic/pull/1895)) ([31dc717](https://github.com/newrelic/node-newrelic/commit/31dc71797c4798793b1bba8ca15733482ba3e7d6))
+* Updated span names of openai actions to allow AI O11y team to locate relevant spans ([#1896](https://github.com/newrelic/node-newrelic/pull/1896)) ([b7a644d](https://github.com/newrelic/node-newrelic/commit/b7a644d1ef56bf88171fb74868ae78d24745dd19))
+
+#### Miscellaneous chores
+
+* Improve OpenAI mock server streams ([#1890](https://github.com/newrelic/node-newrelic/pull/1890)) ([d12bfe4](https://github.com/newrelic/node-newrelic/commit/d12bfe45f2c8d01277a1f8186844f0dd3598cbd7))
+
+#### Tests
+
+* Fix winston-esm versioned tests ([#1898](https://github.com/newrelic/node-newrelic/pull/1898)) ([6e02e57](https://github.com/newrelic/node-newrelic/commit/6e02e57a2b4ed8351e39e5fb8d47e2702bcafde0))
+* pin undici versioned to <6.0.0 on Node 16 ([#1900](https://github.com/newrelic/node-newrelic/pull/1900)) ([9973b24](https://github.com/newrelic/node-newrelic/commit/9973b24067211f5fcc06adae79e02df8f599d735))
+
 ### v11.6.0 (2023-11-29)
 
 #### Features

package/THIRD_PARTY_NOTICES.md

@@ -510,7 +510,7 @@ This product includes source derived from [@grpc/proto-loader](https://github.co
 
 ### @newrelic/aws-sdk
 
-This product includes source derived from [@newrelic/aws-sdk](https://github.com/newrelic/node-newrelic-aws-sdk) ([v7.0.2](https://github.com/newrelic/node-newrelic-aws-sdk/tree/v7.0.2)), distributed under the [Apache-2.0 License](https://github.com/newrelic/node-newrelic-aws-sdk/blob/v7.0.2/LICENSE):
+This product includes source derived from [@newrelic/aws-sdk](https://github.com/newrelic/node-newrelic-aws-sdk) ([v7.0.3](https://github.com/newrelic/node-newrelic-aws-sdk/tree/v7.0.3)), distributed under the [Apache-2.0 License](https://github.com/newrelic/node-newrelic-aws-sdk/blob/v7.0.3/LICENSE):
 
 ```
                                  Apache License

package/index.js

@@ -40,7 +40,7 @@ if (require.cache.__NR_cache) {
 }
 
 function initApi({ agent, apiPath }) {
-  const API = require(apiPath)
+  const API = require(`./${apiPath}`)
 
   const api = new API(agent)
   require.cache.__NR_cache = module.exports = api
@@ -115,7 +115,7 @@ function initialize() {
     /* eslint-enable no-console */
   }
 
-  const api = agent ? initApi({ agent, apiPath: './api' }) : initApi({ apiPath: './stub_api' })
+  const api = agent ? initApi({ agent, apiPath: 'api' }) : initApi({ apiPath: 'stub_api' })
 
   // If we loaded an agent, record a startup time for the agent.
   // NOTE: Metrics are recorded in seconds, so divide the value by 1000.

package/lib/agent.js

@@ -36,9 +36,9 @@ const {
   addRequiredCATAttributes,
   maybeAddExtraCATAttributes,
   maybeAddParentAttributes,
-  maybeAddQueueAttributes,
-  maybeAddSyntheticAttributes
+  maybeAddQueueAttributes
 } = require('./util/attributes')
+const synthetics = require('./synthetics')
 
 // Map of valid states to whether or not data collection is valid
 const STATES = {
@@ -747,7 +747,7 @@ function _addIntrinsicAttrsFromTransaction(transaction) {
   maybeAddQueueAttributes(transaction, intrinsicAttributes)
   maybeAddExternalAttributes(transaction, intrinsicAttributes)
   maybeAddDatabaseAttributes(transaction, intrinsicAttributes)
-  maybeAddSyntheticAttributes(transaction, intrinsicAttributes)
+  synthetics.assignTransactionAttrs(transaction, intrinsicAttributes)
 
   if (this.config.distributed_tracing.enabled) {
     transaction.addDistributedTraceIntrinsics(intrinsicAttributes)

package/lib/errors/index.js

@@ -13,9 +13,9 @@ const errorHelper = require('../errors/helper')
 const {
   maybeAddQueueAttributes,
   maybeAddExternalAttributes,
-  maybeAddDatabaseAttributes,
-  maybeAddSyntheticAttributes
+  maybeAddDatabaseAttributes
 } = require('../util/attributes')
+const synthetics = require('../synthetics')
 const Transaction = require('../transaction')
 const ERROR_EXPECTED_PATH = 'error.expected'
 
@@ -230,7 +230,7 @@ function _getErrorEventIntrinsicAttrs(transaction, errorClass, message, expected
     maybeAddQueueAttributes(transaction, attributes)
     maybeAddExternalAttributes(transaction, attributes)
     maybeAddDatabaseAttributes(transaction, attributes)
-    maybeAddSyntheticAttributes(transaction, attributes)
+    synthetics.assignTransactionAttrs(transaction, attributes)
 
     if (transaction.agent.config.distributed_tracing.enabled) {
       transaction.addDistributedTraceIntrinsics(attributes)

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,
+  aws_bedrock_instrumentation: false
 }
 
 // flags that are no longer used for released features

package/lib/header-attributes.js

@@ -60,6 +60,7 @@ const HEADER_ATTR_NAMES = {
   'x-newrelic-app-data': 'xNewrelicAppData',
   'x-newrelic-id': 'xNewrelicId',
   'x-newrelic-synthetics': 'xNewrelicSynthetics',
+  'x-newrelic-synthetics-info': 'xNewrelicSyntheticsInfo',
   'x-newrelic-transaction': 'xNewrelicTransaction',
   'x-powered-by': 'xPoweredBy',
   'x-queue-start': 'xQueueStart',

package/lib/instrumentation/core/http-outbound.js

@@ -14,6 +14,7 @@ const url = require('url')
 const copy = require('../../util/copy')
 const symbols = require('../../symbols')
 const http = require('http')
+const synthetics = require('../../synthetics')
 
 const NAMES = require('../../metrics/names')
 
@@ -21,8 +22,6 @@ const DEFAULT_HOST = 'localhost'
 const DEFAULT_HTTP_PORT = 80
 const DEFAULT_SSL_PORT = 443
 
-const NEWRELIC_SYNTHETICS_HEADER = 'x-newrelic-synthetics'
-
 /**
  * Determines the default port to 80 if protocol is undefined or http:
  * Otherwise it assigns it as 443
@@ -139,10 +138,7 @@ function instrumentRequest(agent, opts, makeRequest, hostname, segment) {
   const transaction = segment.transaction
   const outboundHeaders = Object.create(null)
 
-  if (agent.config.encoding_key && transaction.syntheticsHeader) {
-    outboundHeaders[NEWRELIC_SYNTHETICS_HEADER] = transaction.syntheticsHeader
-  }
-
+  synthetics.assignHeadersToOutgoingRequest(agent.config, transaction, outboundHeaders)
   maybeAddDtCatHeaders(agent, transaction, outboundHeaders, opts?.headers)
   opts.headers = assignOutgoingHeaders(opts.headers, outboundHeaders)
 

package/lib/instrumentation/core/http.js

@@ -10,26 +10,19 @@
 const shimmer = require('../../shimmer')
 const logger = require('../../logger').child({ component: 'http' })
 const recordWeb = require('../../metrics/recorders/http')
-const hashes = require('../../util/hashes')
 const cat = require('../../util/cat')
 const instrumentOutbound = require('./http-outbound')
 const url = require('url')
 const urltils = require('../../util/urltils')
 const headerAttributes = require('../../header-attributes')
 const headerProcessing = require('../../header-processing')
+const synthetics = require('../../synthetics')
 
 const NAMES = require('../../metrics/names')
 const DESTS = require('../../config/attribute-filter').DESTINATIONS
 
 const symbols = require('../../symbols')
 
-/*
- *
- * CONSTANTS
- *
- */
-const NEWRELIC_SYNTHETICS_HEADER = 'x-newrelic-synthetics'
-
 // For incoming requests this instrumentation functions by wrapping
 // `http.createServer` and `http.Server#addListener`. The former merely sets the
 // agent dispatcher to 'http' and the latter wraps any event handlers bound to
@@ -119,16 +112,7 @@ function wrapEmitWithTransaction(agent, emit, isHTTPS) {
       transaction.queueTime = Date.now() - queueTimeStamp
     }
 
-    const synthHeader = request.headers[NEWRELIC_SYNTHETICS_HEADER]
-
-    if (synthHeader && agent.config.trusted_account_ids && agent.config.encoding_key) {
-      handleSyntheticsHeader(
-        synthHeader,
-        agent.config.encoding_key,
-        agent.config.trusted_account_ids,
-        transaction
-      )
-    }
+    synthetics.assignHeadersToTransaction(agent.config, transaction, request.headers)
 
     if (agent.config.distributed_tracing.enabled) {
       // Node http headers are automatically lowercase
@@ -278,9 +262,8 @@ function wrapWriteHead(agent, writeHead) {
       logger.trace('No transaction - not adding response CAT headers')
       return writeHead.apply(this, arguments)
     }
-    if (transaction.syntheticsHeader) {
-      this.setHeader(NEWRELIC_SYNTHETICS_HEADER, transaction.syntheticsHeader)
-    }
+
+    synthetics.assignHeadersToResponse(this, transaction)
 
     if (!transaction.incomingCatId) {
       logger.trace('No incoming CAT ID - not adding response CAT headers')
@@ -487,104 +470,3 @@ module.exports = function initialize(agent, http, moduleName) {
     }
   )
 }
-
-/**
- * Take the X-NewRelic-Synthetics header and apply any appropriate data to the
- * transaction for later use. This is the gate keeper for attributes being
- * added onto the transaction object for synthetics.
- *
- * @param {string} header - The raw X-NewRelic-Synthetics header
- * @param {string} encKey - Encoding key handed down from the server
- * @param {Array.<number>} trustedIds - Array of accounts to trust the header from.
- * @param {object} transaction - Where the synthetics data is attached to.
- */
-function handleSyntheticsHeader(header, encKey, trustedIds, transaction) {
-  const synthData = parseSyntheticsHeader(header, encKey, trustedIds)
-  if (!synthData) {
-    return
-  }
-
-  transaction.syntheticsData = synthData
-  transaction.syntheticsHeader = header
-}
-
-/**
- * Parse out and verify the the pieces of the X-NewRelic-Synthetics header.
- *
- * @param {string} header - The raw X-NewRelic-Synthetics header
- * @param {string} encKey - Encoding key handed down from the server
- * @param {Array.<number>} trustedIds - Array of accounts to trust the header from.
- * @returns {object | null} - On successful parse and verification an object of
- *                            synthetics data is returned, otherwise null is
- *                            returned.
- */
-function parseSyntheticsHeader(header, encKey, trustedIds) {
-  // Eagerly declare this object because we know what it should look like and
-  // can use that for header verification.
-  const parsedData = {
-    version: null,
-    accountId: null,
-    resourceId: null,
-    jobId: null,
-    monitorId: null
-  }
-  let synthData = null
-  try {
-    synthData = JSON.parse(hashes.deobfuscateNameUsingKey(header, encKey))
-  } catch (e) {
-    logger.trace(e, 'Got unparsable synthetics header: %s', header)
-    return
-  }
-
-  if (!Array.isArray(synthData)) {
-    logger.trace('Synthetics data is not an array: %s (%s)', synthData, typeof synthData)
-    return
-  }
-
-  if (synthData.length < Object.keys(parsedData).length) {
-    logger.trace(
-      'Synthetics header length is %s, expected at least %s',
-      synthData.length,
-      Object.keys(parsedData).length
-    )
-  }
-
-  parsedData.version = synthData[0]
-  if (parsedData.version !== 1) {
-    logger.trace('Synthetics header version is not 1, got: %s (%s)', parsedData.version, synthData)
-    return
-  }
-
-  parsedData.accountId = synthData[1]
-  if (parsedData.accountId) {
-    if (trustedIds.indexOf(parsedData.accountId) === -1) {
-      logger.trace(
-        'Synthetics header account ID is not in trusted account IDs: %s (%s)',
-        parsedData.accountId,
-        trustedIds
-      )
-      return
-    }
-  } else {
-    logger.trace('Synthetics header account ID missing.')
-    return
-  }
-
-  parsedData.resourceId = synthData[2]
-  if (!parsedData.resourceId) {
-    logger.trace('Synthetics resource ID is missing.')
-    return
-  }
-
-  parsedData.jobId = synthData[3]
-  if (!parsedData.jobId) {
-    logger.trace('Synthetics job ID is missing.')
-  }
-
-  parsedData.monitorId = synthData[4]
-  if (!parsedData.monitorId) {
-    logger.trace('Synthetics monitor ID is missing.')
-  }
-
-  return parsedData
-}