newrelic 11.20.0 → 11.22.0

package/NEWS.md

@@ -1,3 +1,48 @@
+### v11.22.0 (2024-06-28)
+
+#### Features
+
+* Added support for Node 22([#2305](https://github.com/newrelic/node-newrelic/pull/2305)) ([0bf8908](https://github.com/newrelic/node-newrelic/commit/0bf89081a59fe598b22613257f519c171149c454))
+* Added AIM support for Meta Llama3 models in AWS Bedrock ([#2306](https://github.com/newrelic/node-newrelic/pull/2306)) ([ff2e509](https://github.com/newrelic/node-newrelic/commit/ff2e509913c2169c274387db461edffeee896834))
+
+#### Documentation
+
+* Updated compatibility report ([#2309](https://github.com/newrelic/node-newrelic/pull/2309)) ([7bf77c6](https://github.com/newrelic/node-newrelic/commit/7bf77c6b41d8313c6837293f42901c6e13954af4))
+
+#### Miscellaneous chores
+
+* Added [@amychisholm03](https://github.com/amychisholm03) to list of contributors 🎉 ([#2310](https://github.com/newrelic/node-newrelic/pull/2310)) ([8a890f1](https://github.com/newrelic/node-newrelic/commit/8a890f1d8879715be3b15bdc58f95c764c112646))
+* Forced re-creation of API docs on gh-pages ([#2307](https://github.com/newrelic/node-newrelic/pull/2307)) ([917110a](https://github.com/newrelic/node-newrelic/commit/917110a189bc77823f114b1bfb338788fa2b6043))
+
+#### Tests
+
+* Updated undici versioned tests to assert an error is present and not the actual message ([#2299](https://github.com/newrelic/node-newrelic/pull/2299)) ([4e38ed4](https://github.com/newrelic/node-newrelic/commit/4e38ed494f2706d4c6b3f89474efb7365e766903))
+
+#### Continuous integration
+
+* Added Node 22 to CI ([#2164](https://github.com/newrelic/node-newrelic/pull/2164)) ([4b12d9e](https://github.com/newrelic/node-newrelic/commit/4b12d9e7d89d8367fdb895b24e2818ff85d67592))
+* Added Node 22 to smoke tests and nightly versioned test runs ([#2316](https://github.com/newrelic/node-newrelic/pull/2316)) ([af00666](https://github.com/newrelic/node-newrelic/commit/af00666d3b1a3458c40bd6f0e3dca6ac2e477335))
+* Moved the docs PR job to before api docs publish ([#2300](https://github.com/newrelic/node-newrelic/pull/2300)) ([2e7252e](https://github.com/newrelic/node-newrelic/commit/2e7252ef3281046c3c85722ccede582e5aefa1a9))
+
+### v11.21.0 (2024-06-25)
+
+#### Features
+
+* Added support for getting container ids from ECS metadata API ([#2292](https://github.com/newrelic/node-newrelic/pull/2292)) ([dbca830](https://github.com/newrelic/node-newrelic/commit/dbca830deb6c9420427b60df4875ba71939508c4))
+
+#### Bug fixes
+
+* Handled assigning headers in LambdaProxyWebRequest when there are no headers present ([#2293](https://github.com/newrelic/node-newrelic/pull/2293)) ([e4d22f3](https://github.com/newrelic/node-newrelic/commit/e4d22f38b70cee061b345d6dbc94a2783a164b76))
+
+#### Documentation
+
+* Updated compatibility report ([#2290](https://github.com/newrelic/node-newrelic/pull/2290)) ([b5fc893](https://github.com/newrelic/node-newrelic/commit/b5fc8932ed5a0372f8be3f0e53c6d9fa0cf12855))
+
+#### Tests
+
+* Fixed log error stack message truncating and failing equality test ([#2294](https://github.com/newrelic/node-newrelic/pull/2294)) ([8e06f0f](https://github.com/newrelic/node-newrelic/commit/8e06f0f77762922e7862446bdf85a32eef3f9096))
+* Updated shimmer method in benchmark tests ([#2281](https://github.com/newrelic/node-newrelic/pull/2281)) ([1528d68](https://github.com/newrelic/node-newrelic/commit/1528d685c7fd8e9af23ea91bd66124b82dcdb523))
+
 ### v11.20.0 (2024-06-24)
 
 #### Features

package/THIRD_PARTY_NOTICES.md

@@ -674,7 +674,7 @@ SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
 ### import-in-the-middle
 
-This product includes source derived from [import-in-the-middle](https://github.com/DataDog/import-in-the-middle) ([v1.7.4](https://github.com/DataDog/import-in-the-middle/tree/v1.7.4)), distributed under the [Apache-2.0 License](https://github.com/DataDog/import-in-the-middle/blob/v1.7.4/LICENSE):
+This product includes source derived from [import-in-the-middle](https://github.com/DataDog/import-in-the-middle) ([v1.8.0](https://github.com/DataDog/import-in-the-middle/tree/v1.8.0)), distributed under the [Apache-2.0 License](https://github.com/DataDog/import-in-the-middle/blob/v1.8.0/LICENSE):
 
 ```
 Copyright 2021 Datadog, Inc.
@@ -886,7 +886,7 @@ SOFTWARE.
 
 ### @aws-sdk/client-s3
 
-This product includes source derived from [@aws-sdk/client-s3](https://github.com/aws/aws-sdk-js-v3) ([v3.587.0](https://github.com/aws/aws-sdk-js-v3/tree/v3.587.0)), distributed under the [Apache-2.0 License](https://github.com/aws/aws-sdk-js-v3/blob/v3.587.0/LICENSE):
+This product includes source derived from [@aws-sdk/client-s3](https://github.com/aws/aws-sdk-js-v3) ([v3.592.0](https://github.com/aws/aws-sdk-js-v3/tree/v3.592.0)), distributed under the [Apache-2.0 License](https://github.com/aws/aws-sdk-js-v3/blob/v3.592.0/LICENSE):
 
 ```
                                 Apache License
@@ -1095,7 +1095,7 @@ This product includes source derived from [@aws-sdk/client-s3](https://github.co
 
 ### @aws-sdk/s3-request-presigner
 
-This product includes source derived from [@aws-sdk/s3-request-presigner](https://github.com/aws/aws-sdk-js-v3) ([v3.587.0](https://github.com/aws/aws-sdk-js-v3/tree/v3.587.0)), distributed under the [Apache-2.0 License](https://github.com/aws/aws-sdk-js-v3/blob/v3.587.0/LICENSE):
+This product includes source derived from [@aws-sdk/s3-request-presigner](https://github.com/aws/aws-sdk-js-v3) ([v3.592.0](https://github.com/aws/aws-sdk-js-v3/tree/v3.592.0)), distributed under the [Apache-2.0 License](https://github.com/aws/aws-sdk-js-v3/blob/v3.592.0/LICENSE):
 
 ```
                                 Apache License
@@ -1750,7 +1750,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.5.0](https://github.com/newrelic/node-test-utilities/tree/v8.5.0)), distributed under the [Apache-2.0 License](https://github.com/newrelic/node-test-utilities/blob/v8.5.0/LICENSE):
+This product includes source derived from [@newrelic/test-utilities](https://github.com/newrelic/node-test-utilities) ([v8.6.0](https://github.com/newrelic/node-test-utilities/tree/v8.6.0)), distributed under the [Apache-2.0 License](https://github.com/newrelic/node-test-utilities/blob/v8.6.0/LICENSE):
 
 ```
                                  Apache License
@@ -2493,7 +2493,7 @@ THE SOFTWARE.
 
 ### aws-sdk
 
-This product includes source derived from [aws-sdk](https://github.com/aws/aws-sdk-js) ([v2.1631.0](https://github.com/aws/aws-sdk-js/tree/v2.1631.0)), distributed under the [Apache-2.0 License](https://github.com/aws/aws-sdk-js/blob/v2.1631.0/LICENSE.txt):
+This product includes source derived from [aws-sdk](https://github.com/aws/aws-sdk-js) ([v2.1636.0](https://github.com/aws/aws-sdk-js/tree/v2.1636.0)), distributed under the [Apache-2.0 License](https://github.com/aws/aws-sdk-js/blob/v2.1636.0/LICENSE.txt):
 
 ```
 
@@ -2892,7 +2892,7 @@ THE SOFTWARE.
 
 ### eslint-plugin-jsdoc
 
-This product includes source derived from [eslint-plugin-jsdoc](https://github.com/gajus/eslint-plugin-jsdoc) ([v48.2.7](https://github.com/gajus/eslint-plugin-jsdoc/tree/v48.2.7)), distributed under the [BSD-3-Clause License](https://github.com/gajus/eslint-plugin-jsdoc/blob/v48.2.7/LICENSE):
+This product includes source derived from [eslint-plugin-jsdoc](https://github.com/gajus/eslint-plugin-jsdoc) ([v48.2.8](https://github.com/gajus/eslint-plugin-jsdoc/tree/v48.2.8)), distributed under the [BSD-3-Clause License](https://github.com/gajus/eslint-plugin-jsdoc/blob/v48.2.8/LICENSE):
 
 ```
 Copyright (c) 2018, Gajus Kuizinas (http://gajus.com/)
@@ -3941,7 +3941,7 @@ CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
 ### @contrast/fn-inspect
 
-This product includes source derived from [@contrast/fn-inspect](https://github.com/Contrast-Security-Inc/node-fn-inspect) ([v3.4.0](https://github.com/Contrast-Security-Inc/node-fn-inspect/tree/v3.4.0)), distributed under the [MIT License](https://github.com/Contrast-Security-Inc/node-fn-inspect/blob/v3.4.0/LICENSE):
+This product includes source derived from [@contrast/fn-inspect](https://github.com/Contrast-Security-Inc/node-fn-inspect) ([v4.2.0](https://github.com/Contrast-Security-Inc/node-fn-inspect/tree/v4.2.0)), distributed under the [MIT License](https://github.com/Contrast-Security-Inc/node-fn-inspect/blob/v4.2.0/LICENSE):
 
 ```
 Copyright 2022 Contrast Security, Inc

package/index.js

@@ -63,8 +63,8 @@ function initialize() {
       throw new Error(message)
     }
 
-    // TODO: Update this check when Node v22 support is added
-    if (psemver.satisfies('>=21.0.0')) {
+    // TODO: Update this check when Node v24 support is added
+    if (psemver.satisfies('>=23.0.0')) {
       logger.warn(
         'New Relic for Node.js %s has not been tested on Node.js %s. Please ' +
           'update the agent or downgrade your version of Node.js',

package/lib/llm-events/aws-bedrock/bedrock-command.js

@@ -37,7 +37,7 @@ class BedrockCommand {
       result = this.#body.max_tokens_to_sample
     } else if (this.isClaude3() === true || this.isCohere() === true) {
       result = this.#body.max_tokens
-    } else if (this.isLlama2() === true) {
+    } else if (this.isLlama() === true) {
       result = this.#body.max_gen_length
     } else if (this.isTitan() === true) {
       result = this.#body.textGenerationConfig?.maxTokenCount
@@ -80,7 +80,7 @@ class BedrockCommand {
       this.isClaude() === true ||
       this.isAi21() === true ||
       this.isCohere() === true ||
-      this.isLlama2() === true
+      this.isLlama() === true
     ) {
       result = this.#body.prompt
     } else if (this.isClaude3() === true) {
@@ -104,7 +104,7 @@ class BedrockCommand {
       this.isClaude3() === true ||
       this.isAi21() === true ||
       this.isCohere() === true ||
-      this.isLlama2() === true
+      this.isLlama() === true
     ) {
       result = this.#body.temperature
     }
@@ -131,8 +131,8 @@ class BedrockCommand {
     return this.#modelId.startsWith('cohere.embed')
   }
 
-  isLlama2() {
-    return this.#modelId.startsWith('meta.llama2')
+  isLlama() {
+    return this.#modelId.startsWith('meta.llama')
   }
 
   isTitan() {

package/lib/llm-events/aws-bedrock/bedrock-response.js

@@ -70,7 +70,7 @@ class BedrockResponse {
     } else if (cmd.isCohere() === true) {
       this.#completions = body.generations?.map((g) => g.text) ?? []
       this.#id = body.id
-    } else if (cmd.isLlama2() === true) {
+    } else if (cmd.isLlama() === true) {
       body.generation && this.#completions.push(body.generation)
     } else if (cmd.isTitan() === true) {
       this.#completions = body.results?.map((r) => r.outputText) ?? []
@@ -107,7 +107,7 @@ class BedrockResponse {
       result = this.#parsedBody.stop_reason
     } else if (cmd.isCohere() === true) {
       result = this.#parsedBody.generations?.find((r) => r.finish_reason !== null)?.finish_reason
-    } else if (cmd.isLlama2() === true) {
+    } else if (cmd.isLlama() === true) {
       result = this.#parsedBody.stop_reason
     } else if (cmd.isTitan() === true) {
       result = this.#parsedBody.results?.find((r) => r.completionReason !== null)?.completionReason

package/lib/llm-events/aws-bedrock/stream-handler.js

@@ -114,9 +114,9 @@ class StreamHandler {
     } else if (bedrockCommand.isCohereEmbed() === true) {
       this.stopReasonKey = 'nr_none'
       this.generator = handleCohereEmbed
-    } else if (bedrockCommand.isLlama2() === true) {
+    } else if (bedrockCommand.isLlama() === true) {
       this.stopReasonKey = 'stop_reason'
-      this.generator = handleLlama2
+      this.generator = handleLlama
     } else if (bedrockCommand.isTitan() === true) {
       this.stopReasonKey = 'completionReason'
       this.generator = handleTitan
@@ -271,7 +271,7 @@ async function* handleCohereEmbed() {
   }
 }
 
-async function* handleLlama2() {
+async function* handleLlama() {
   let currentBody = {}
   let generation = ''
 

package/lib/serverless/api-gateway.js

@@ -80,7 +80,7 @@ function normalizeHeaders(event, lowerCaseKey = false) {
   const headers = event.multiValueHeaders ?? event.headers
 
   if (!headers) {
-    return
+    return {}
   }
 
   return Object.fromEntries(

package/lib/utilization/docker-info.js

@@ -5,52 +5,152 @@
 
 'use strict'
 
-const logger = require('../logger').child({ component: 'docker-info' })
+const fs = require('node:fs')
+const http = require('node:http')
+const log = require('../logger').child({ component: 'docker-info' })
 const common = require('./common')
 const NAMES = require('../metrics/names')
 const os = require('os')
 let vendorInfo = null
+
 const CGROUPS_V1_PATH = '/proc/self/cgroup'
 const CGROUPS_V2_PATH = '/proc/self/mountinfo'
+const BOOT_ID_PROC_FILE = '/proc/sys/kernel/random/boot_id'
 
 module.exports.getVendorInfo = fetchDockerVendorInfo
 module.exports.clearVendorCache = function clearDockerVendorCache() {
   vendorInfo = null
 }
 
-module.exports.getBootId = function getBootId(agent, callback) {
+module.exports.getBootId = function getBootId(agent, callback, logger = log) {
   if (!/linux/i.test(os.platform())) {
     logger.debug('Platform is not a flavor of linux, omitting boot info')
     return setImmediate(callback, null, null)
   }
 
-  common.readProc('/proc/sys/kernel/random/boot_id', function readProcBootId(err, data) {
-    if (!data) {
-      bootIdError()
-      return callback(null, null)
+  fs.access(BOOT_ID_PROC_FILE, fs.constants.F_OK, (err) => {
+    if (err == null) {
+      // The boot id proc file exists, so use it to get the container id.
+      return common.readProc(BOOT_ID_PROC_FILE, (_, data, cbAgent = agent) => {
+        readProcBootId({ data, agent: cbAgent, callback })
+      })
     }
 
-    data = data.trim()
-    const asciiData = Buffer.from(data, 'ascii').toString()
+    logger.debug('Container boot id is not available in cgroups info')
 
-    if (data !== asciiData) {
-      bootIdError()
+    if (hasAwsContainerApi() === false) {
+      // We don't seem to have a recognized location for getting the container
+      // identifier.
+      logger.debug('Container is not in a recognized ECS container, omitting boot info')
+      recordBootIdError(agent)
       return callback(null, null)
     }
 
-    if (data.length !== 36) {
-      bootIdError()
-      if (data.length > 128) {
-        data = data.substring(0, 128)
+    getEcsContainerId({ agent, callback, logger })
+  })
+}
+
+/**
+ * Queries the AWS ECS metadata API to get the boot id.
+ *
+ * @param {object} params Function parameters.
+ * @param {object} params.agent Newrelic agent instance.
+ * @param {Function} params.callback Typical error first callback. The second
+ * parameter is the boot id as a string.
+ * @param {object} [params.logger] Internal logger instance.
+ */
+function getEcsContainerId({ agent, callback, logger }) {
+  const ecsApiUrl =
+    process.env.ECS_CONTAINER_METADATA_URI_V4 || process.env.ECS_CONTAINER_METADATA_URI
+  const req = http.request(ecsApiUrl, (res) => {
+    let body = Buffer.alloc(0)
+    res.on('data', (chunk) => {
+      body = Buffer.concat([body, chunk])
+    })
+    res.on('end', () => {
+      try {
+        const json = body.toString('utf8')
+        const data = JSON.parse(json)
+        if (data.DockerId == null) {
+          logger.debug('Failed to find DockerId in response, omitting boot info')
+          recordBootIdError(agent)
+          return callback(null, null)
+        }
+        callback(null, data.DockerId)
+      } catch (error) {
+        logger.debug('Failed to process ECS API response, omitting boot info: ' + error.message)
+        recordBootIdError(agent)
+        callback(null, null)
       }
-    }
+    })
+  })
 
-    return callback(null, data)
+  req.on('error', () => {
+    logger.debug('Failed to query ECS endpoint, omitting boot info')
+    recordBootIdError(agent)
+    callback(null, null)
   })
 
-  function bootIdError() {
-    agent.metrics.getOrCreateMetric(NAMES.UTILIZATION.BOOT_ID_ERROR).incrementCallCount()
+  req.end()
+}
+
+/**
+ * Inspects the running environment to determine if the AWS ECS metadata API
+ * is available.
+ *
+ * @see https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ec2-metadata.html
+ *
+ * @returns {boolean}
+ */
+function hasAwsContainerApi() {
+  if (process.env.ECS_CONTAINER_METADATA_URI_V4 != null) {
+    return true
   }
+  return process.env.ECS_CONTAINER_METADATA_URI != null
+}
+
+/**
+ * Increments a supportability metric to indicate that there was an error
+ * while trying to read the boot id from the system.
+ *
+ * @param {object} agent Newrelic agent instance.
+ */
+function recordBootIdError(agent) {
+  agent.metrics.getOrCreateMetric(NAMES.UTILIZATION.BOOT_ID_ERROR).incrementCallCount()
+}
+
+/**
+ * Utility function to parse a Docker boot id from a cgroup proc file.
+ *
+ * @param {Buffer} data The information from the proc file.
+ * @param {object} agent Newrelic agent instance.
+ * @param {Function} callback Typical error first callback. Second parameter
+ * is the boot id as a string.
+ *
+ * @returns {*}
+ */
+function readProcBootId({ data, agent, callback }) {
+  if (!data) {
+    recordBootIdError(agent)
+    return callback(null, null)
+  }
+
+  data = data.trim()
+  const asciiData = Buffer.from(data, 'ascii').toString()
+
+  if (data !== asciiData) {
+    recordBootIdError(agent)
+    return callback(null, null)
+  }
+
+  if (data.length !== 36) {
+    recordBootIdError(agent)
+    if (data.length > 128) {
+      data = data.substring(0, 128)
+    }
+  }
+
+  return callback(null, data)
 }
 
 /**
@@ -58,8 +158,9 @@ module.exports.getBootId = function getBootId(agent, callback) {
  *
  * @param {object} agent NR instance
  * @param {Function} callback function to call when done
+ * @param {object} [logger] internal logger instance
  */
-function fetchDockerVendorInfo(agent, callback) {
+function fetchDockerVendorInfo(agent, callback, logger = log) {
   if (!agent.config.utilization || !agent.config.utilization.detect_docker) {
     return callback(null, null)
   }
@@ -93,8 +194,9 @@ function fetchDockerVendorInfo(agent, callback) {
  *
  * @param {string} data file contents
  * @param {Function} callback function to call when done
+ * @param {object} [logger] internal logger instance
  */
-function parseCGroupsV2(data, callback) {
+function parseCGroupsV2(data, callback, logger = log) {
   const containerLine = new RegExp('/docker/containers/([0-9a-f]{64})/')
   const line = containerLine.exec(data)
   if (line) {
@@ -110,8 +212,9 @@ function parseCGroupsV2(data, callback) {
  * e.g. - `4:cpu:/docker/f37a7e4d17017e7bf774656b19ca4360c6cdc4951c86700a464101d0d9ce97ee`
  *
  * @param {Function} callback function to call when done
+ * @param {object} [logger] internal logger instance
  */
-function findCGroupsV1(callback) {
+function findCGroupsV1(callback, logger = log) {
   common.readProc(CGROUPS_V1_PATH, function getCGroup(err, data) {
     if (!data) {
       logger.debug(`${CGROUPS_V1_PATH} not found, exiting parsing containerId.`)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "newrelic",
-  "version": "11.20.0",
+  "version": "11.22.0",
   "author": "New Relic Node.js agent team <nodejs@newrelic.com>",
   "license": "Apache-2.0",
   "contributors": [
@@ -133,6 +133,11 @@
       "name": "Svetlana Brennan",
       "email": "sbrennan@newrelic.com",
       "web": "https://newrelic.com"
+    },
+    {
+      "name": "Amy Chisholm",
+      "email": "achisholm@newrelic.com",
+      "web": "https://newrelic.com"
     }
   ],
   "description": "New Relic agent",
@@ -208,7 +213,7 @@
     "winston-transport": "^4.5.0"
   },
   "optionalDependencies": {
-    "@contrast/fn-inspect": "^3.3.0",
+    "@contrast/fn-inspect": "^4.2.0",
     "@newrelic/native-metrics": "^10.0.0",
     "@prisma/prisma-fmt-wasm": "^4.17.0-16.27eb2449f178cd9fe1a4b892d732cc4795f75085"
   },