newrelic 11.3.0 → 11.4.0

package/NEWS.md

@@ -1,3 +1,18 @@
+### v11.4.0 (2023-10-25)
+
+#### Features
+
+* Added support for parsing container ids from docker versions using cgroups v2. ([#1830](https://github.com/newrelic/node-newrelic/pull/1830)) ([9892901](https://github.com/newrelic/node-newrelic/commit/98929013da3e62e2223f94531b8d6f59eecfc35b))
+
+#### Miscellaneous chores
+
+* [Snyk] Upgraded @grpc/grpc-js from 1.9.2 to 1.9.4. ([#1823](https://github.com/newrelic/node-newrelic/pull/1823)) ([81f9450](https://github.com/newrelic/node-newrelic/commit/81f945033376e4d33651d1e42afc30aea19dbdeb))
+* **deps:** Updated aws-sdk, koa, superagent ([#1831](https://github.com/newrelic/node-newrelic/pull/1831)) ([8b4e963](https://github.com/newrelic/node-newrelic/commit/8b4e963e84d34e4727b9fda3aa630ef119aa3905))
+
+#### Tests
+
+* Increased timeout for integration tests to avoid random failures. ([#1827](https://github.com/newrelic/node-newrelic/pull/1827)) ([5202048](https://github.com/newrelic/node-newrelic/commit/52020485191868f479092ae4860019acf105b3eb))
+
 ### v11.3.0 (2023-10-23)
 
 #### Features

package/THIRD_PARTY_NOTICES.md

@@ -92,7 +92,7 @@ code, the source code can be found at [https://github.com/newrelic/node-newrelic
 
 ### @grpc/grpc-js
 
-This product includes source derived from [@grpc/grpc-js](https://github.com/grpc/grpc-node/tree/master/packages/grpc-js) ([v1.9.2](https://github.com/grpc/grpc-node/tree/master/packages/grpc-js/tree/v1.9.2)), distributed under the [Apache-2.0 License](https://github.com/grpc/grpc-node/tree/master/packages/grpc-js/blob/v1.9.2/LICENSE):
+This product includes source derived from [@grpc/grpc-js](https://github.com/grpc/grpc-node/tree/master/packages/grpc-js) ([v1.9.4](https://github.com/grpc/grpc-node/tree/master/packages/grpc-js/tree/v1.9.4)), distributed under the [Apache-2.0 License](https://github.com/grpc/grpc-node/tree/master/packages/grpc-js/blob/v1.9.4/LICENSE):
 
 ```
                                  Apache License
@@ -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.0](https://github.com/newrelic/node-newrelic-aws-sdk/tree/v7.0.0)), distributed under the [Apache-2.0 License](https://github.com/newrelic/node-newrelic-aws-sdk/blob/v7.0.0/LICENSE):
+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):
 
 ```
                                  Apache License
@@ -718,7 +718,7 @@ This product includes source derived from [@newrelic/aws-sdk](https://github.com
 
 ### @newrelic/koa
 
-This product includes source derived from [@newrelic/koa](https://github.com/newrelic/node-newrelic-koa) ([v8.0.0](https://github.com/newrelic/node-newrelic-koa/tree/v8.0.0)), distributed under the [Apache-2.0 License](https://github.com/newrelic/node-newrelic-koa/blob/v8.0.0/LICENSE):
+This product includes source derived from [@newrelic/koa](https://github.com/newrelic/node-newrelic-koa) ([v8.0.1](https://github.com/newrelic/node-newrelic-koa/tree/v8.0.1)), distributed under the [Apache-2.0 License](https://github.com/newrelic/node-newrelic-koa/blob/v8.0.1/LICENSE):
 
 ```
 Apache License
@@ -978,7 +978,7 @@ This license terminates when the Pre-Release Software stops being provided by Ne
 
 ### @newrelic/superagent
 
-This product includes source derived from [@newrelic/superagent](https://github.com/newrelic/node-newrelic-superagent) ([v7.0.0](https://github.com/newrelic/node-newrelic-superagent/tree/v7.0.0)), distributed under the [Apache-2.0 License](https://github.com/newrelic/node-newrelic-superagent/blob/v7.0.0/LICENSE):
+This product includes source derived from [@newrelic/superagent](https://github.com/newrelic/node-newrelic-superagent) ([v7.0.1](https://github.com/newrelic/node-newrelic-superagent/tree/v7.0.1)), distributed under the [Apache-2.0 License](https://github.com/newrelic/node-newrelic-superagent/blob/v7.0.1/LICENSE):
 
 ```
                                  Apache License

package/lib/utilization/docker-info.js

@@ -10,6 +10,8 @@ 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'
 
 module.exports.getVendorInfo = fetchDockerVendorInfo
 module.exports.clearVendorCache = function clearDockerVendorCache() {
@@ -51,6 +53,12 @@ module.exports.getBootId = function getBootId(agent, callback) {
   }
 }
 
+/**
+ * Attempt to extract container id from either cgroups v1 or v2 file
+ *
+ * @param {object} agent NR instance
+ * @param {Function} callback function to call when done
+ */
 function fetchDockerVendorInfo(agent, callback) {
   if (!agent.config.utilization || !agent.config.utilization.detect_docker) {
     return callback(null, null)
@@ -62,16 +70,56 @@ function fetchDockerVendorInfo(agent, callback) {
 
   if (!os.platform().match(/linux/i)) {
     logger.debug('Platform is not a flavor of linux, omitting docker info')
-    return callback(null)
+    return callback(null, null)
   }
 
-  common.readProc('/proc/self/cgroup', function getCGroup(err, data) {
+  // try v2 path first and if null try parsing v1 path
+  common.readProc(CGROUPS_V2_PATH, function getV2CGroup(err, data) {
+    if (data === null) {
+      logger.debug(
+        `${CGROUPS_V2_PATH} not found, trying to parse container id from ${CGROUPS_V1_PATH}`
+      )
+      findCGroupsV1(callback)
+      return
+    }
+
+    parseCGroupsV2(data, callback)
+  })
+}
+
+/**
+ * Try extracting container id from a /proc/self/mountinfo
+ * e.g. - `528 519 254:1 /docker/containers/84cf3472a20d1bfb4b50e48b6ff50d96dfcd812652d76dd907951e6f98997bce/resolv.conf`
+ *
+ * @param {string} data file contents
+ * @param {Function} callback function to call when done
+ */
+function parseCGroupsV2(data, callback) {
+  const containerLine = new RegExp('/docker/containers/([0-9a-f]{64})/')
+  const line = containerLine.exec(data)
+  if (line) {
+    callback(null, { id: line[1] })
+  } else {
+    logger.debug(`Found ${CGROUPS_V2_PATH} but failed to parse Docker container id.`)
+    callback(null, null)
+  }
+}
+
+/**
+ * Read /proc/self/cgroup and try to extract the container id from a cpu line
+ * e.g. - `4:cpu:/docker/f37a7e4d17017e7bf774656b19ca4360c6cdc4951c86700a464101d0d9ce97ee`
+ *
+ * @param {Function} callback function to call when done
+ */
+function findCGroupsV1(callback) {
+  common.readProc(CGROUPS_V1_PATH, function getCGroup(err, data) {
     if (!data) {
+      logger.debug(`${CGROUPS_V1_PATH} not found, exiting parsing containerId.`)
       return callback(null)
     }
 
     let id = null
-    findCGroups(data, 'cpu', function forEachCpuGroup(cpuGroup) {
+    parseCGroupsV1(data, 'cpu', function forEachCpuGroup(cpuGroup) {
       const match = /(?:^|[^0-9a-f])([0-9a-f]{64})(?:[^0-9a-f]|$)/.exec(cpuGroup)
       if (match) {
         id = match[1]
@@ -91,7 +139,14 @@ function fetchDockerVendorInfo(agent, callback) {
   })
 }
 
-function findCGroups(info, cgroup, eachCb) {
+/**
+ * Iterate line by line to extract the container id from the cpu stanza
+ *
+ * @param {string} info contents of file
+ * @param {string} cgroup value is cpu
+ * @param {Function} eachCb funtion to test if the container id exists
+ */
+function parseCGroupsV1(info, cgroup, eachCb) {
   const target = new RegExp('^\\d+:[^:]*?\\b' + cgroup + '\\b[^:]*:')
   const lines = info.split('\n')
   for (let i = 0; i < lines.length; ++i) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "newrelic",
-  "version": "11.3.0",
+  "version": "11.4.0",
   "author": "New Relic Node.js agent team <nodejs@newrelic.com>",
   "license": "Apache-2.0",
   "contributors": [
@@ -146,7 +146,7 @@
     "bench": "node ./bin/run-bench.js",
     "docker-env": "./bin/docker-env-vars.sh",
     "docs": "npm ci && jsdoc -c ./jsdoc-conf.json --private -r .",
-    "integration": "npm run prepare-test && npm run sub-install && time c8 -o ./coverage/integration tap --test-regex='(\\/|^test\\/integration\\/.*\\.tap\\.js)$' --timeout=300 --no-coverage --reporter classic",
+    "integration": "npm run prepare-test && npm run sub-install && time c8 -o ./coverage/integration tap --test-regex='(\\/|^test\\/integration\\/.*\\.tap\\.js)$' --timeout=600 --no-coverage --reporter classic",
     "prepare-test": "npm run ssl && npm run docker-env",
     "lint": "eslint ./*.{js,mjs} lib test bin examples",
     "lint:fix": "eslint --fix, ./*.{js,mjs} lib test bin examples",
@@ -181,12 +181,12 @@
     "newrelic-naming-rules": "./bin/test-naming-rules.js"
   },
   "dependencies": {
-    "@grpc/grpc-js": "^1.8.10",
+    "@grpc/grpc-js": "^1.9.4",
     "@grpc/proto-loader": "^0.7.5",
-    "@newrelic/aws-sdk": "^7.0.0",
-    "@newrelic/koa": "^8.0.0",
+    "@newrelic/aws-sdk": "^7.0.2",
+    "@newrelic/koa": "^8.0.1",
     "@newrelic/security-agent": "0.3.0",
-    "@newrelic/superagent": "^7.0.0",
+    "@newrelic/superagent": "^7.0.1",
     "@tyriar/fibonacci-heap": "^2.0.7",
     "concat-stream": "^2.0.0",
     "https-proxy-agent": "^7.0.1",