newrelic 11.20.0 → 11.21.0

package/NEWS.md

@@ -1,3 +1,22 @@
+### 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/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.21.0",
   "author": "New Relic Node.js agent team <nodejs@newrelic.com>",
   "license": "Apache-2.0",
   "contributors": [