newrelic 12.4.0 → 12.5.0

package/NEWS.md

@@ -1,3 +1,22 @@
+### v12.5.0 (2024-09-12)
+
+#### Features
+
+* Added utilization info for ECS ([#2565](https://github.com/newrelic/node-newrelic/pull/2565)) ([6f92073](https://github.com/newrelic/node-newrelic/commit/6f92073a6c01124d8ab1b54d06c176a36fbc3441))
+
+#### Bug fixes
+
+* Ensured README displays for Azure site extension ([#2564](https://github.com/newrelic/node-newrelic/pull/2564)) ([a30aed5](https://github.com/newrelic/node-newrelic/commit/a30aed5cf31c0c89678618e51215063562331848))
+
+#### Documentation
+
+* Updated compatibility report ([#2562](https://github.com/newrelic/node-newrelic/pull/2562)) ([8f7aebe](https://github.com/newrelic/node-newrelic/commit/8f7aebe7e4274ce45cfe961537a09b34077b3aa0))
+
+#### Tests
+
+* Convert `metric` and `metrics-recorder` tests to `node:test` ([#2552](https://github.com/newrelic/node-newrelic/pull/2552)) ([7ae4af4](https://github.com/newrelic/node-newrelic/commit/7ae4af4c8adfabadd3c865bd2fdd0e8ba5317eef))
+* Updated `serverless` unit tests to `node:test` ([#2549](https://github.com/newrelic/node-newrelic/pull/2549)) ([619f23c](https://github.com/newrelic/node-newrelic/commit/619f23c938bf39c360a6da9a307c178986c70902))
+
 ### v12.4.0 (2024-09-11)
 
 #### Features

package/THIRD_PARTY_NOTICES.md

@@ -34,6 +34,7 @@ code, the source code can be found at [https://github.com/newrelic/node-newrelic
 * [@aws-sdk/client-s3](#aws-sdkclient-s3)
 * [@aws-sdk/s3-request-presigner](#aws-sdks3-request-presigner)
 * [@koa/router](#koarouter)
+* [@matteo.collina/tspl](#matteocollinatspl)
 * [@newrelic/eslint-config](#newreliceslint-config)
 * [@newrelic/newrelic-oss-cli](#newrelicnewrelic-oss-cli)
 * [@newrelic/test-utilities](#newrelictest-utilities)
@@ -69,7 +70,6 @@ code, the source code can be found at [https://github.com/newrelic/node-newrelic
 * [nock](#nock)
 * [proxy](#proxy)
 * [proxyquire](#proxyquire)
-* [rfdc](#rfdc)
 * [rimraf](#rimraf)
 * [self-cert](#self-cert)
 * [should](#should)
@@ -1076,7 +1076,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.637.0](https://github.com/aws/aws-sdk-js-v3/tree/v3.637.0)), distributed under the [Apache-2.0 License](https://github.com/aws/aws-sdk-js-v3/blob/v3.637.0/LICENSE):
+This product includes source derived from [@aws-sdk/client-s3](https://github.com/aws/aws-sdk-js-v3) ([v3.632.0](https://github.com/aws/aws-sdk-js-v3/tree/v3.632.0)), distributed under the [Apache-2.0 License](https://github.com/aws/aws-sdk-js-v3/blob/v3.632.0/LICENSE):
 
 ```
                                 Apache License
@@ -1285,7 +1285,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.637.0](https://github.com/aws/aws-sdk-js-v3/tree/v3.637.0)), distributed under the [Apache-2.0 License](https://github.com/aws/aws-sdk-js-v3/blob/v3.637.0/LICENSE):
+This product includes source derived from [@aws-sdk/s3-request-presigner](https://github.com/aws/aws-sdk-js-v3) ([v3.632.0](https://github.com/aws/aws-sdk-js-v3/tree/v3.632.0)), distributed under the [Apache-2.0 License](https://github.com/aws/aws-sdk-js-v3/blob/v3.632.0/LICENSE):
 
 ```
                                 Apache License
@@ -1521,6 +1521,35 @@ THE SOFTWARE.
 
 ```
 
+### @matteo.collina/tspl
+
+This product includes source derived from [@matteo.collina/tspl](https://github.com/mcollina/tspl) ([v0.1.1](https://github.com/mcollina/tspl/tree/v0.1.1)), distributed under the [MIT License](https://github.com/mcollina/tspl/blob/v0.1.1/LICENSE):
+
+```
+MIT License
+
+Copyright (c) 2023 Matteo Collina
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+```
+
 ### @newrelic/eslint-config
 
 This product includes source derived from [@newrelic/eslint-config](https://github.com/newrelic/eslint-config-newrelic) ([v0.3.0](https://github.com/newrelic/eslint-config-newrelic/tree/v0.3.0)), distributed under the [Apache-2.0 License](https://github.com/newrelic/eslint-config-newrelic/blob/v0.3.0/LICENSE):
@@ -2656,7 +2685,7 @@ SOFTWARE.
 
 ### async
 
-This product includes source derived from [async](https://github.com/caolan/async) ([v3.2.6](https://github.com/caolan/async/tree/v3.2.6)), distributed under the [MIT License](https://github.com/caolan/async/blob/v3.2.6/LICENSE):
+This product includes source derived from [async](https://github.com/caolan/async) ([v3.2.5](https://github.com/caolan/async/tree/v3.2.5)), distributed under the [MIT License](https://github.com/caolan/async/blob/v3.2.5/LICENSE):
 
 ```
 Copyright (c) 2010-2018 Caolan McMahon
@@ -2683,7 +2712,7 @@ THE SOFTWARE.
 
 ### aws-sdk
 
-This product includes source derived from [aws-sdk](https://github.com/aws/aws-sdk-js) ([v2.1687.0](https://github.com/aws/aws-sdk-js/tree/v2.1687.0)), distributed under the [Apache-2.0 License](https://github.com/aws/aws-sdk-js/blob/v2.1687.0/LICENSE.txt):
+This product includes source derived from [aws-sdk](https://github.com/aws/aws-sdk-js) ([v2.1677.0](https://github.com/aws/aws-sdk-js/tree/v2.1677.0)), distributed under the [Apache-2.0 License](https://github.com/aws/aws-sdk-js/blob/v2.1677.0/LICENSE.txt):
 
 ```
 
@@ -3978,29 +4007,6 @@ OTHER DEALINGS IN THE SOFTWARE.
 
 ```
 
-### rfdc
-
-This product includes source derived from [rfdc](https://github.com/davidmarkclements/rfdc) ([v1.4.1](https://github.com/davidmarkclements/rfdc/tree/v1.4.1)), distributed under the [MIT License](https://github.com/davidmarkclements/rfdc/blob/v1.4.1/LICENSE):
-
-```
-Copyright 2019 "David Mark Clements <david.mark.clements@gmail.com>"
-
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated 
-documentation files (the "Software"), to deal in the Software without restriction, including without limitation 
-the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and 
-to permit persons to whom the Software is furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all copies or substantial portions 
-of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED 
-TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL 
-THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF 
-CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS 
-IN THE SOFTWARE.
-
-```
-
 ### rimraf
 
 This product includes source derived from [rimraf](https://github.com/isaacs/rimraf) ([v2.7.1](https://github.com/isaacs/rimraf/tree/v2.7.1)), distributed under the [ISC License](https://github.com/isaacs/rimraf/blob/v2.7.1/LICENSE):

package/lib/metrics/names.js

@@ -204,11 +204,12 @@ const HAPI = {
 
 const UTILIZATION = {
   AWS_ERROR: SUPPORTABILITY.UTILIZATION + '/aws/error',
-  PCF_ERROR: SUPPORTABILITY.UTILIZATION + '/pcf/error',
   AZURE_ERROR: SUPPORTABILITY.UTILIZATION + '/azure/error',
-  GCP_ERROR: SUPPORTABILITY.UTILIZATION + '/gcp/error',
+  BOOT_ID_ERROR: SUPPORTABILITY.UTILIZATION + '/boot_id/error',
   DOCKER_ERROR: SUPPORTABILITY.UTILIZATION + '/docker/error',
-  BOOT_ID_ERROR: SUPPORTABILITY.UTILIZATION + '/boot_id/error'
+  ECS_CONTAINER_ERROR: SUPPORTABILITY.UTILIZATION + '/ecs/container_id/error',
+  GCP_ERROR: SUPPORTABILITY.UTILIZATION + '/gcp/error',
+  PCF_ERROR: SUPPORTABILITY.UTILIZATION + '/pcf/error'
 }
 
 const CUSTOM_EVENTS = {

package/lib/utilization/docker-info.js

@@ -6,7 +6,6 @@
 'use strict'
 
 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')
@@ -17,12 +16,17 @@ 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() {
+module.exports = {
+  clearVendorCache: clearDockerVendorCache,
+  getBootId,
+  getVendorInfo: fetchDockerVendorInfo
+}
+
+function clearDockerVendorCache() {
   vendorInfo = null
 }
 
-module.exports.getBootId = function getBootId(agent, callback, logger = log) {
+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)
@@ -37,76 +41,8 @@ module.exports.getBootId = function getBootId(agent, callback, logger = log) {
     }
 
     logger.debug('Container boot id is not available in cgroups info')
-
-    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)
-    }
-
-    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)
-      }
-    })
-  })
-
-  req.on('error', () => {
-    logger.debug('Failed to query ECS endpoint, omitting boot info')
-    recordBootIdError(agent)
     callback(null, null)
   })
-
-  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
 }
 
 /**

package/lib/utilization/ecs-info.js

@@ -0,0 +1,112 @@
+/*
+ * Copyright 2024 New Relic Corporation. All rights reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+'use strict'
+
+const http = require('node:http')
+const NAMES = require('../metrics/names')
+
+module.exports = function fetchEcsInfo(
+  agent,
+  callback,
+  {
+    logger = require('../logger').child({ component: 'ecs-info' }),
+    getEcsContainerId = _getEcsContainerId,
+    hasAwsContainerApi = _hasAwsContainerApi,
+    recordIdError = _recordIdError
+  } = {}
+) {
+  // Per spec, we do not have a `detect_ecs` key. Since ECS is a service of AWS,
+  // we rely on the `detect_aws` setting.
+  if (!agent.config.utilization || !agent.config.utilization.detect_aws) {
+    return setImmediate(callback, null)
+  }
+
+  if (hasAwsContainerApi() === false) {
+    logger.debug('ECS API not available, omitting ECS container id info')
+    recordIdError(agent)
+    return callback(null, null)
+  }
+
+  getEcsContainerId({
+    agent,
+    logger,
+    recordIdError,
+    callback: (error, dockerId) => {
+      if (error) {
+        return callback(error, null)
+      }
+      if (dockerId === null) {
+        // Some error happened where we could not find the id. Skipping.
+        return callback(null, null)
+      }
+      return callback(null, { ecsDockerId: dockerId })
+    }
+  })
+}
+
+/**
+ * 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.
+ * @param {function} params.recordIdError Function to record error metric.
+ */
+function _getEcsContainerId({ agent, callback, logger, recordIdError }) {
+  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')
+          recordIdError(agent)
+          return callback(null, null)
+        }
+        callback(null, data.DockerId)
+      } catch (error) {
+        logger.debug('Failed to process ECS API response, omitting boot info: ' + error.message)
+        recordIdError(agent)
+        callback(null, null)
+      }
+    })
+  })
+
+  req.on('error', () => {
+    logger.debug('Failed to query ECS endpoint, omitting boot info')
+    recordIdError(agent)
+    callback(null, null)
+  })
+
+  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
+}
+
+function _recordIdError(agent) {
+  agent.metrics.getOrCreateMetric(NAMES.UTILIZATION.ECS_CONTAINER_ERROR).incrementCallCount()
+}

package/lib/utilization/index.js

@@ -9,11 +9,12 @@ const logger = require('../logger').child({ component: 'utilization' })
 
 const VENDOR_METHODS = {
   aws: require('./aws-info'),
-  pcf: require('./pcf-info'),
   azure: require('./azure-info'),
-  gcp: require('./gcp-info'),
   docker: require('./docker-info').getVendorInfo,
-  kubernetes: require('./kubernetes-info')
+  ecs: require('./ecs-info'),
+  gcp: require('./gcp-info'),
+  kubernetes: require('./kubernetes-info'),
+  pcf: require('./pcf-info')
 }
 const VENDOR_NAMES = Object.keys(VENDOR_METHODS)
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "newrelic",
-  "version": "12.4.0",
+  "version": "12.5.0",
   "author": "New Relic Node.js agent team <nodejs@newrelic.com>",
   "license": "Apache-2.0",
   "contributors": [
@@ -219,6 +219,7 @@
     "@aws-sdk/client-s3": "^3.556.0",
     "@aws-sdk/s3-request-presigner": "^3.556.0",
     "@koa/router": "^12.0.1",
+    "@matteo.collina/tspl": "^0.1.1",
     "@newrelic/eslint-config": "^0.3.0",
     "@newrelic/newrelic-oss-cli": "^0.1.2",
     "@newrelic/test-utilities": "^9.1.0",
@@ -254,7 +255,6 @@
     "nock": "11.8.0",
     "proxy": "^2.1.1",
     "proxyquire": "^1.8.0",
-    "rfdc": "^1.3.1",
     "rimraf": "^2.6.3",
     "self-cert": "^2.0.0",
     "should": "*",