newrelic 11.1.0 → 11.2.1

package/NEWS.md

@@ -1,21 +1,53 @@
-### v11.1.0 (2023-09-07)
-
-#### Features
-
-* Added instrumentation for fetch. ([#1776](https://github.com/newrelic/node-newrelic/pull/1776)) ([980b4dc](https://github.com/newrelic/node-newrelic/commit/980b4dc31d085cafc45961a157f76cb73768741a))
-* Removed undici feature flag. This will now instrument undici by default. ([#1772](https://github.com/newrelic/node-newrelic/pull/1772)) ([683b254](https://github.com/newrelic/node-newrelic/commit/683b254c1c4686527a37e628f80eed9fcc03cb37))
-* Updated undici instrumentation to create segment on request create instead of after connection and opening socket to more accurately record time it takes to make an undici request. ([#1770](https://github.com/newrelic/node-newrelic/pull/1770)) ([3f494f8](https://github.com/newrelic/node-newrelic/commit/3f494f8ad8dd1350fbe034e9c4a582a40228bc45))
-
-#### Performance Improvements
-
-* **Trace:** optimise getTotalTimeDurationInMillis function to push to an array instead of concat arrays. ([#1774](https://github.com/newrelic/node-newrelic/pull/1774)) ([6ecde97](https://github.com/newrelic/node-newrelic/commit/6ecde97a5efeef4d816b2e82ba762f2130914658))
-    * Thanks @infinity-naveen for your contribution 🎉 
-
-#### Miscellaneous Chores
-
-* Updated Next.js plugin versioned tests to use main now that require-in-the-middle fixes have been merged. ([#1768](https://github.com/newrelic/node-newrelic/pull/1768)) ([6a72d1f](https://github.com/newrelic/node-newrelic/commit/6a72d1fb452ea2655c35d7cd008fa78935821ab8))
-* Upgraded `@newrelic/test-utilities` and removed unused shimmer.patchModule and shimmer.unpatchModule ([#1769](https://github.com/newrelic/node-newrelic/pull/1769)) ([96620ef](https://github.com/newrelic/node-newrelic/commit/96620efa725f0f548b683825cb3cefff270fb252))
-
+### v11.2.1 (2023-10-12)
+
+#### Bug fixes
+
+* Updated initialization to return the api on start up to the security agent properly ([#1807](https://github.com/newrelic/node-newrelic/pull/1807)) ([99e5792](https://github.com/newrelic/node-newrelic/commit/99e5792024263a61751b73976ed707ed51815388))
+
+### v11.2.0 (2023-10-11)
+
+#### Features
+
+* Added instrumentation for ElasticSearch ([#1785](https://github.com/newrelic/node-newrelic/pull/1785)) ([a748b84](https://github.com/newrelic/node-newrelic/commit/a748b84c6a706ed0cea2e07c9fae8807a82dbc95))
+
+#### Bug Fixes
+
+* Updated agent to create a stub api when running in a worker thread to avoid Next.js early return errors ([#1800](https://github.com/newrelic/node-newrelic/pull/1800)) ([636e8f0](https://github.com/newrelic/node-newrelic/commit/636e8f068a2ec2f989e28f6646f844b951ee636d))
+* Updated shimmer to allow registering instrumentation for different versions of the same module ([#1799](https://github.com/newrelic/node-newrelic/pull/1799)) ([30f0b16](https://github.com/newrelic/node-newrelic/commit/30f0b16e13e9621c86481c5d5409a799dbbb8d57))
+
+#### Miscellaneous Chores
+
+* **deps:** Updated @newrelic/security-agent to v0.3.0 ([#1786](https://github.com/newrelic/node-newrelic/pull/1786)) ([9ca78ae](https://github.com/newrelic/node-newrelic/commit/9ca78aede72ddecd3eb8271d349ad35cc4ce05f9))
+* Separated running versioned tests between local and external ([#1792](https://github.com/newrelic/node-newrelic/pull/1792)) ([6ffe2f6](https://github.com/newrelic/node-newrelic/commit/6ffe2f6e16c769c3fb8de767e9336992b1cca797))
+* **dev-deps** Updated get-func-name to fix CVE ([#1790](https://github.com/newrelic/node-newrelic/pull/1790)) ([f378c77](https://github.com/newrelic/node-newrelic/commit/f378c77eb09fcd3453850a1d177faea41422f637))
+
+#### Tests
+
+* Updated elasticsearch container to ignore highwatermark to function on a constrained environment ([#1803](https://github.com/newrelic/node-newrelic/pull/1803)) ([8380e9d](https://github.com/newrelic/node-newrelic/commit/8380e9d527f3ffc61d1f3e32199e81ed25837185))
+* Updated invalid json pino test as this was fixed in 8.15.1 of the pino library. ([#1782](https://github.com/newrelic/node-newrelic/pull/1782)) ([3e65fdc](https://github.com/newrelic/node-newrelic/commit/3e65fdcc68999e09d9ef3c341ff7c1159b65ab37))
+
+#### Continuous Integration
+
+* Added steps to zip up container logs on versioned test failure ([#1804](https://github.com/newrelic/node-newrelic/pull/1804)) ([0a54729](https://github.com/newrelic/node-newrelic/commit/0a54729f1d8187bb50508659716ec55349e9ee31))
+
+### v11.1.0 (2023-09-07)
+
+#### Features
+
+* Added instrumentation for fetch. ([#1776](https://github.com/newrelic/node-newrelic/pull/1776)) ([980b4dc](https://github.com/newrelic/node-newrelic/commit/980b4dc31d085cafc45961a157f76cb73768741a))
+* Removed undici feature flag. This will now instrument undici by default. ([#1772](https://github.com/newrelic/node-newrelic/pull/1772)) ([683b254](https://github.com/newrelic/node-newrelic/commit/683b254c1c4686527a37e628f80eed9fcc03cb37))
+* Updated undici instrumentation to create segment on request create instead of after connection and opening socket to more accurately record time it takes to make an undici request. ([#1770](https://github.com/newrelic/node-newrelic/pull/1770)) ([3f494f8](https://github.com/newrelic/node-newrelic/commit/3f494f8ad8dd1350fbe034e9c4a582a40228bc45))
+
+#### Performance Improvements
+
+* **Trace:** optimise getTotalTimeDurationInMillis function to push to an array instead of concat arrays. ([#1774](https://github.com/newrelic/node-newrelic/pull/1774)) ([6ecde97](https://github.com/newrelic/node-newrelic/commit/6ecde97a5efeef4d816b2e82ba762f2130914658))
+    * Thanks @infinity-naveen for your contribution 🎉 
+
+#### Miscellaneous Chores
+
+* Updated Next.js plugin versioned tests to use main now that require-in-the-middle fixes have been merged. ([#1768](https://github.com/newrelic/node-newrelic/pull/1768)) ([6a72d1f](https://github.com/newrelic/node-newrelic/commit/6a72d1fb452ea2655c35d7cd008fa78935821ab8))
+* Upgraded `@newrelic/test-utilities` and removed unused shimmer.patchModule and shimmer.unpatchModule ([#1769](https://github.com/newrelic/node-newrelic/pull/1769)) ([96620ef](https://github.com/newrelic/node-newrelic/commit/96620efa725f0f548b683825cb3cefff270fb252))
+
 ### v11.0.0 (2023-08-28)
 
 #### ⚠ BREAKING CHANGES

package/THIRD_PARTY_NOTICES.md

@@ -26,6 +26,7 @@ code, the source code can be found at [https://github.com/newrelic/node-newrelic
 * [import-in-the-middle](#import-in-the-middle)
 * [json-bigint](#json-bigint)
 * [json-stringify-safe](#json-stringify-safe)
+* [module-details-from-path](#module-details-from-path)
 * [readable-stream](#readable-stream)
 * [require-in-the-middle](#require-in-the-middle)
 * [semver](#semver)
@@ -91,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.8.14](https://github.com/grpc/grpc-node/tree/master/packages/grpc-js/tree/v1.8.14)), distributed under the [Apache-2.0 License](https://github.com/grpc/grpc-node/tree/master/packages/grpc-js/blob/v1.8.14/LICENSE):
+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):
 
 ```
                                  Apache License
@@ -300,7 +301,7 @@ This product includes source derived from [@grpc/grpc-js](https://github.com/grp
 
 ### @grpc/proto-loader
 
-This product includes source derived from [@grpc/proto-loader](https://github.com/grpc/grpc-node) ([v0.7.7](https://github.com/grpc/grpc-node/tree/v0.7.7)), distributed under the [Apache-2.0 License](https://github.com/grpc/grpc-node/blob/v0.7.7/LICENSE):
+This product includes source derived from [@grpc/proto-loader](https://github.com/grpc/grpc-node) ([v0.7.9](https://github.com/grpc/grpc-node/tree/v0.7.9)), distributed under the [Apache-2.0 License](https://github.com/grpc/grpc-node/blob/v0.7.9/LICENSE):
 
 ```
                                  Apache License
@@ -926,7 +927,7 @@ Apache License
 
 ### @newrelic/security-agent
 
-This product includes source derived from [@newrelic/security-agent](https://github.com/newrelic/csec-node-agent) ([v0.2.1](https://github.com/newrelic/csec-node-agent/tree/v0.2.1)), distributed under the [New Relic Pre-Release License](https://github.com/newrelic/csec-node-agent/blob/v0.2.1/LICENSE):
+This product includes source derived from [@newrelic/security-agent](https://github.com/newrelic/csec-node-agent) ([v0.3.0](https://github.com/newrelic/csec-node-agent/tree/v0.3.0)), distributed under the [New Relic Pre-Release License](https://github.com/newrelic/csec-node-agent/blob/v0.3.0/LICENSE):
 
 ```
 ## New Relic Pre-Release Software Notice
@@ -1246,7 +1247,7 @@ SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
 ### https-proxy-agent
 
-This product includes source derived from [https-proxy-agent](https://github.com/TooTallNate/proxy-agents) ([v7.0.1](https://github.com/TooTallNate/proxy-agents/tree/v7.0.1)), distributed under the [MIT License](https://github.com/TooTallNate/proxy-agents/blob/v7.0.1/README.md):
+This product includes source derived from [https-proxy-agent](https://github.com/TooTallNate/proxy-agents) ([v7.0.2](https://github.com/TooTallNate/proxy-agents/tree/v7.0.2)), distributed under the [MIT License](https://github.com/TooTallNate/proxy-agents/blob/v7.0.2/README.md):
 
 ```
 MIT License
@@ -1332,6 +1333,35 @@ IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 
 ```
 
+### module-details-from-path
+
+This product includes source derived from [module-details-from-path](https://github.com/watson/module-details-from-path) ([v1.0.3](https://github.com/watson/module-details-from-path/tree/v1.0.3)), distributed under the [MIT License](https://github.com/watson/module-details-from-path/blob/v1.0.3/LICENSE):
+
+```
+The MIT License (MIT)
+
+Copyright (c) 2016 Thomas Watson Steen
+
+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.
+
+```
+
 ### readable-stream
 
 This product includes source derived from [readable-stream](https://github.com/nodejs/readable-stream) ([v3.6.2](https://github.com/nodejs/readable-stream/tree/v3.6.2)), distributed under the [MIT License](https://github.com/nodejs/readable-stream/blob/v3.6.2/LICENSE):
@@ -2131,7 +2161,7 @@ THE SOFTWARE.
 
 ### @slack/bolt
 
-This product includes source derived from [@slack/bolt](https://github.com/slackapi/bolt) ([v3.13.1](https://github.com/slackapi/bolt/tree/v3.13.1)), distributed under the [MIT License](https://github.com/slackapi/bolt/blob/v3.13.1/LICENSE):
+This product includes source derived from [@slack/bolt](https://github.com/slackapi/bolt) ([v3.13.3](https://github.com/slackapi/bolt/tree/v3.13.3)), distributed under the [MIT License](https://github.com/slackapi/bolt/blob/v3.13.3/LICENSE):
 
 ```
 The MIT License (MIT)
@@ -2240,7 +2270,7 @@ ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 
 ### chai
 
-This product includes source derived from [chai](https://github.com/chaijs/chai) ([v4.3.7](https://github.com/chaijs/chai/tree/v4.3.7)), distributed under the [MIT License](https://github.com/chaijs/chai/blob/v4.3.7/LICENSE):
+This product includes source derived from [chai](https://github.com/chaijs/chai) ([v4.3.8](https://github.com/chaijs/chai/tree/v4.3.8)), distributed under the [MIT License](https://github.com/chaijs/chai/blob/v4.3.8/LICENSE):
 
 ```
 MIT License
@@ -2269,7 +2299,7 @@ SOFTWARE.
 
 ### clean-jsdoc-theme
 
-This product includes source derived from [clean-jsdoc-theme](https://github.com/ankitskvmdam/clean-jsdoc-theme) ([v4.2.7](https://github.com/ankitskvmdam/clean-jsdoc-theme/tree/v4.2.7)), distributed under the [MIT License](https://github.com/ankitskvmdam/clean-jsdoc-theme/blob/v4.2.7/LICENSE):
+This product includes source derived from [clean-jsdoc-theme](https://github.com/ankitskvmdam/clean-jsdoc-theme) ([v4.2.10](https://github.com/ankitskvmdam/clean-jsdoc-theme/tree/v4.2.10)), distributed under the [MIT License](https://github.com/ankitskvmdam/clean-jsdoc-theme/blob/v4.2.10/LICENSE):
 
 ```
 MIT License
@@ -2409,7 +2439,7 @@ SOFTWARE.
 
 ### eslint-config-prettier
 
-This product includes source derived from [eslint-config-prettier](https://github.com/prettier/eslint-config-prettier) ([v8.8.0](https://github.com/prettier/eslint-config-prettier/tree/v8.8.0)), distributed under the [MIT License](https://github.com/prettier/eslint-config-prettier/blob/v8.8.0/LICENSE):
+This product includes source derived from [eslint-config-prettier](https://github.com/prettier/eslint-config-prettier) ([v8.10.0](https://github.com/prettier/eslint-config-prettier/tree/v8.10.0)), distributed under the [MIT License](https://github.com/prettier/eslint-config-prettier/blob/v8.10.0/LICENSE):
 
 ```
 The MIT License (MIT)
@@ -2748,7 +2778,7 @@ Library.
 
 ### eslint
 
-This product includes source derived from [eslint](https://github.com/eslint/eslint) ([v8.40.0](https://github.com/eslint/eslint/tree/v8.40.0)), distributed under the [MIT License](https://github.com/eslint/eslint/blob/v8.40.0/LICENSE):
+This product includes source derived from [eslint](https://github.com/eslint/eslint) ([v8.48.0](https://github.com/eslint/eslint/tree/v8.48.0)), distributed under the [MIT License](https://github.com/eslint/eslint/blob/v8.48.0/LICENSE):
 
 ```
 Copyright OpenJS Foundation and other contributors, <www.openjsf.org>
@@ -3050,7 +3080,7 @@ SOFTWARE.
 
 ### lockfile-lint
 
-This product includes source derived from [lockfile-lint](https://github.com/lirantal/lockfile-lint) ([v4.10.1](https://github.com/lirantal/lockfile-lint/tree/v4.10.1)), distributed under the [Apache-2.0 License](https://github.com/lirantal/lockfile-lint/blob/v4.10.1/LICENSE):
+This product includes source derived from [lockfile-lint](https://github.com/lirantal/lockfile-lint) ([v4.12.1](https://github.com/lirantal/lockfile-lint/tree/v4.12.1)), distributed under the [Apache-2.0 License](https://github.com/lirantal/lockfile-lint/blob/v4.12.1/LICENSE):
 
 ```
 
@@ -9440,7 +9470,7 @@ THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
 ### tap
 
-This product includes source derived from [tap](https://github.com/tapjs/node-tap) ([v16.3.4](https://github.com/tapjs/node-tap/tree/v16.3.4)), distributed under the [ISC License](https://github.com/tapjs/node-tap/blob/v16.3.4/LICENSE):
+This product includes source derived from [tap](https://github.com/tapjs/node-tap) ([v16.3.8](https://github.com/tapjs/node-tap/tree/v16.3.8)), distributed under the [ISC License](https://github.com/tapjs/node-tap/blob/v16.3.8/LICENSE):
 
 ```
 The ISC License
@@ -9525,7 +9555,7 @@ 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.3.1](https://github.com/Contrast-Security-Inc/node-fn-inspect/tree/v3.3.1)), distributed under the [MIT License](https://github.com/Contrast-Security-Inc/node-fn-inspect/blob/v3.3.1/LICENSE):
+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):
 
 ```
 Copyright 2022 Contrast Security, Inc

package/api.js

@@ -29,6 +29,7 @@ const MODULE_TYPE = require('./lib/shim/constants').MODULE_TYPE
 const NAMES = require('./lib/metrics/names')
 const obfuscate = require('./lib/util/sql/obfuscate')
 const { DESTINATIONS } = require('./lib/config/attribute-filter')
+const parse = require('module-details-from-path')
 
 /*
  *
@@ -1495,8 +1496,9 @@ API.prototype.instrumentLoadedModule = function instrumentLoadedModule(moduleNam
 
   try {
     const resolvedName = require.resolve(moduleName)
+    const parsed = parse(resolvedName)
 
-    return shimmer.instrumentPostLoad(this.agent, module, moduleName, resolvedName)
+    return shimmer.instrumentPostLoad(this.agent, module, moduleName, parsed.basedir)
   } catch (error) {
     logger.error('instrumentLoadedModule encountered an error, module not instrumented: %s', error)
   }

package/index.js

@@ -20,28 +20,36 @@ const NAMES = require('./lib/metrics/names')
 const isESMSupported = psemver.satisfies('>=16.2.0')
 
 const pkgJSON = require('./package.json')
-if (!isMainThread) {
+if (isMainThread) {
+  logger.info(
+    'Using New Relic for Node.js. Agent version: %s; Node version: %s.',
+    pkgJSON.version,
+    process.version
+  )
+
+  if (require.cache.__NR_cache) {
+    logger.warn(
+      'Attempting to load a second copy of newrelic from %s, using cache instead',
+      __dirname
+    )
+    if (require.cache.__NR_cache.agent) {
+      require.cache.__NR_cache.agent.recordSupportability('Agent/DoubleLoad')
+    }
+    module.exports = require.cache.__NR_cache
+  } else {
+    initialize()
+  }
+} else {
   logger.warn('Using New Relic for Node.js in worker_threads is not supported. Not starting!')
-  return
+  initApi({ apiPath: './stub_api' })
 }
 
-logger.info(
-  'Using New Relic for Node.js. Agent version: %s; Node version: %s.',
-  pkgJSON.version,
-  process.version
-)
+function initApi({ agent, apiPath }) {
+  const API = require(apiPath)
 
-if (require.cache.__NR_cache) {
-  logger.warn(
-    'Attempting to load a second copy of newrelic from %s, using cache instead',
-    __dirname
-  )
-  if (require.cache.__NR_cache.agent) {
-    require.cache.__NR_cache.agent.recordSupportability('Agent/DoubleLoad')
-  }
-  module.exports = require.cache.__NR_cache
-} else {
-  initialize()
+  const api = new API(agent)
+  require.cache.__NR_cache = module.exports = api
+  return api
 }
 
 function initialize() {
@@ -103,15 +111,7 @@ function initialize() {
     /* eslint-enable no-console */
   }
 
-  let API = null
-  if (agent) {
-    API = require('./api')
-  } else {
-    API = require('./stub_api')
-  }
-
-  const api = new API(agent)
-  require.cache.__NR_cache = module.exports = 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/instrumentation/@elastic/elasticsearch.js

@@ -0,0 +1,144 @@
+/*
+ * Copyright 2023 New Relic Corporation. All rights reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+'use strict'
+const logger = require('../../logger').child({ component: 'ElasticSearch' })
+
+/**
+ * Instruments the `@elastic/elasticsearch` module. This function is
+ * passed to `onRequire` when instantiating instrumentation.
+ *
+ * @param {object} _agent New Relic agent
+ * @param {object} elastic resolved module
+ * @param {string} _moduleName string representation of require/import path
+ * @param {object} shim New Relic shim
+ * @returns {void}
+ */
+module.exports = function initialize(_agent, elastic, _moduleName, shim) {
+  shim.setDatastore(shim.ELASTICSEARCH)
+  shim.setParser(queryParser)
+
+  shim.recordQuery(elastic.Transport.prototype, 'request', function wrapQuery(shim, _, __, args) {
+    const ctx = this
+    return {
+      query: JSON.stringify(args?.[0]),
+      promise: true,
+      opaque: true,
+      inContext: function inContext() {
+        getConnection.call(ctx, shim)
+      }
+    }
+  })
+}
+
+/**
+ * Parses the parameters sent to elasticsearch for collection,
+ * method, and query
+ *
+ * @param {object} params Query object received by the datashim.
+ * Required properties: path {string}, method {string}.
+ * Optional properties: querystring {string}, body {object}, and
+ * bulkBody {object}
+ * @returns {object} consisting of collection {string}, operation {string},
+ * and query {string}
+ */
+function queryParser(params) {
+  params = JSON.parse(params)
+
+  const { collection, operation } = parsePath(params.path, params.method)
+
+  // the substance of the query may be in querystring or in body.
+  let queryParam = {}
+  if (typeof params.querystring === 'object' && Object.keys(params.querystring).length > 0) {
+    queryParam = params.querystring
+  }
+  // let body or bulkBody override querystring, as some requests have both
+  if (typeof params.body === 'object' && Object.keys(params.body).length > 0) {
+    queryParam = params.body
+  } else if (typeof params.bulkBody === 'object' && Object.keys(params.bulkBody).length > 0) {
+    queryParam = params.bulkBody
+  }
+
+  const query = JSON.stringify(queryParam)
+
+  return {
+    collection,
+    operation,
+    query
+  }
+}
+
+/**
+ * Convenience function for parsing the params.path sent to the queryParser
+ * for normalized collection and operation
+ *
+ * @param {string} pathString params.path supplied to the query parser
+ * @param {string} method http method called by @elastic/elasticsearch
+ * @returns {object} consisting of collection {string} and operation {string}
+ */
+function parsePath(pathString, method) {
+  let collection
+  let operation
+  const defaultCollection = 'any'
+  const actions = {
+    GET: 'get',
+    PUT: 'create',
+    POST: 'create',
+    DELETE: 'delete',
+    HEAD: 'exists'
+  }
+  const suffix = actions[method]
+
+  try {
+    const path = pathString.split('/')
+    if (method === 'PUT' && path.length === 2) {
+      collection = path?.[1] || defaultCollection
+      operation = `index.create`
+      return { collection, operation }
+    }
+    path.forEach((segment, idx) => {
+      const prev = idx - 1
+      let opname
+      if (segment === '_search') {
+        collection = path?.[prev] || defaultCollection
+        operation = `search`
+      } else if (segment[0] === '_') {
+        opname = segment.substring(1)
+        collection = path?.[prev] || defaultCollection
+        operation = `${opname}.${suffix}`
+      }
+    })
+    if (!operation && !collection) {
+      // likely creating an index--no underscore segments
+      collection = path?.[1] || defaultCollection
+      operation = `index.${suffix}`
+    }
+  } catch (e) {
+    logger.warn('Failed to parse path for operation and collection. Using defaults')
+    logger.warn(e)
+    collection = defaultCollection
+    operation = 'unknown'
+  }
+
+  return { collection, operation }
+}
+
+/**
+ * Convenience function for deriving connection information from
+ * elasticsearch
+ *
+ * @param {object} shim The New Relic datastore-shim
+ * @returns {Function} captureInstanceAttributes method of shim
+ */
+function getConnection(shim) {
+  const connectionPool = this.connectionPool.connections[0]
+  const host = connectionPool.url.host.split(':')
+  const port = connectionPool.url.port || host?.[1]
+  return shim.captureInstanceAttributes(host[0], port)
+}
+
+module.exports.queryParser = queryParser
+module.exports.parsePath = parsePath
+module.exports.getConnection = getConnection

package/lib/instrumentations.js

@@ -17,6 +17,7 @@ module.exports = function instrumentations() {
     'bluebird': { type: MODULE_TYPE.PROMISE },
     'bunyan': { type: MODULE_TYPE.GENERIC },
     'director': { type: MODULE_TYPE.WEB_FRAMEWORK },
+    '@elastic/elasticsearch': { type: MODULE_TYPE.DATASTORE },
     'express': { type: MODULE_TYPE.WEB_FRAMEWORK },
     'fastify': { type: MODULE_TYPE.WEB_FRAMEWORK },
     'generic-pool': { type: MODULE_TYPE.GENERIC },

package/lib/shim/datastore-shim.js

@@ -29,6 +29,7 @@ const util = require('util')
 const DATASTORE_NAMES = {
   CASSANDRA: 'Cassandra',
   DYNAMODB: 'DynamoDB',
+  ELASTICSEARCH: 'ElasticSearch',
   MEMCACHED: 'Memcache',
   MONGODB: 'MongoDB',
   MYSQL: 'MySQL',

package/lib/shimmer.js

@@ -10,7 +10,6 @@ const semver = require('semver')
 const fs = require('./util/unwrapped-core').fs
 const logger = require('./logger').child({ component: 'shimmer' })
 const INSTRUMENTATIONS = require('./instrumentations')()
-const properties = require('./util/properties')
 const shims = require('./shim')
 const { Hook } = require('require-in-the-middle')
 const IitmHook = require('import-in-the-middle')
@@ -92,7 +91,7 @@ const shimmer = (module.exports = {
    * Detects if the given function has already been wrapped.
    *
    * @param {Function} fn - The function to look for a wrapper on.
-   * @returns {bool} True if `fn` exists and has an attached original, else false.
+   * @returns {boolean} True if `fn` exists and has an attached original, else false.
    */
   isWrapped: function isWrapped(fn) {
     return !!(fn && fn[symbols.original])
@@ -183,7 +182,7 @@ const shimmer = (module.exports = {
    *                              helpful than you'd think.
    * @param {string}   property   The property to replace with the accessor.
    * @param {Function} options    Optional getter and setter to use for the accessor.
-   * @returns {object} The original value of the property.
+   * @returns {object|undefined} returns original function
    */
   wrapDeprecated: function wrapDeprecated(nodule, noduleName, property, options) {
     if (!property) {
@@ -396,6 +395,8 @@ const shimmer = (module.exports = {
       }
     }
 
+    opts[symbols.instrumented] = new Set()
+    opts[symbols.instrumentedErrored] = new Set()
     shimmer.registeredInstrumentations[opts.moduleName].push({ ...opts })
   },
 
@@ -418,8 +419,9 @@ const shimmer = (module.exports = {
    *
    * Use this to re-apply any applicable instrumentation.
    *
-   * @param agent
-   * @param modulePath
+   * @param {object} agent NR agent
+   * @param {string} modulePath path to module getting required
+   * @returns {object} exported module
    */
   reinstrument: function reinstrument(agent, modulePath) {
     return _postLoad(agent, require(modulePath), modulePath)
@@ -430,7 +432,8 @@ const shimmer = (module.exports = {
    * instrumentation.  These two things are usually, but not always,
    * the same.
    *
-   * @param moduleName
+   * @param {string} moduleName name of module getting instrumented
+   * @returns {string} name unless pg.js and then returns pg
    */
   getInstrumentationNameFromModuleName(moduleName) {
     // XXX When updating these special cases, also update `uninstrumented`.
@@ -447,12 +450,13 @@ const shimmer = (module.exports = {
    * only if every hook succeeded.
    *
    * @param {string} moduleName name of registered instrumentation
-   * @returns {boolean}
+   * @returns {boolean} if all instrumentation hooks ran for a given version
    */
   isInstrumented(moduleName) {
+    const pkgVersion = shimmer.getPackageVersion(moduleName)
     const instrumentations = shimmer.registeredInstrumentations[moduleName]
-    const didInstrument = instrumentations.filter(
-      (instrumentation) => instrumentation[symbols.instrumented]
+    const didInstrument = instrumentations.filter((instrumentation) =>
+      instrumentation[symbols.instrumented].has(pkgVersion)
     )
     return didInstrument.length === instrumentations.length
   },
@@ -463,6 +467,23 @@ const shimmer = (module.exports = {
     // previously it would just call instrumentation
     // and not check the result
     return returnModule ? result : shimmer.isInstrumented(moduleName)
+  },
+
+  /**
+   * Gets the version of a given package by parsing it from package.json
+   *
+   * @param {string} moduleName name of module
+   * @returns {string} version, defaults to Node.js version when it cannot parse
+   */
+  getPackageVersion(moduleName) {
+    try {
+      const { basedir } = shimmer.registeredInstrumentations[moduleName]
+      const pkg = require(path.resolve(basedir, 'package.json'))
+      return pkg.version
+    } catch (err) {
+      logger.debug('Failed to get version for `%s`, reason: %s', moduleName, err.message)
+      return process.version
+    }
   }
 })
 
@@ -486,23 +507,23 @@ function applyDebugState(shim, nodule, inEsm) {
  * initialization function that takes the agent and the module to be
  * instrumented.
  *
- * @param agent
- * @param nodule
- * @param moduleName
- * @param resolvedName
- * @param esmResolver
+ * @param {object} agent NR agent
+ * @param {object} nodule Class or module containing the function to wrap.
+ * @param {string} moduleName name of module
+ * @param {string} resolvedName fully qualified path to module
+ * @param {boolean} esmResolver indicates if it came from esm loader
+ * @returns {object|undefined} returns exported module unless already instrumented
  */
 function instrumentPostLoad(agent, nodule, moduleName, resolvedName, esmResolver) {
+  // default to Node.js version, this occurs for core libraries
+  const pkgVersion = resolvedName ? shimmer.getPackageVersion(moduleName) : process.version
   const instrumentations = shimmer.registeredInstrumentations[moduleName]
   instrumentations.forEach((instrumentation) => {
-    if (
-      properties.hasOwn(instrumentation, symbols.instrumented) ||
-      properties.hasOwn(instrumentation, symbols.instrumentedErrored)
-    ) {
-      logger.trace(
-        'Already instrumented or failed to instrument %s, skipping redundant instrumentation',
-        moduleName
-      )
+    const isInstrumented = instrumentation[symbols.instrumented].has(pkgVersion)
+    const failedInstrumentation = instrumentation[symbols.instrumentedErrored].has(pkgVersion)
+    if (isInstrumented || failedInstrumentation) {
+      const msg = isInstrumented ? 'Already instrumented' : 'Failed to instrument'
+      logger.trace(`${msg} ${moduleName}@${pkgVersion}, skipping registering instrumentation`)
       return
     }
 
@@ -530,38 +551,71 @@ function instrumentPostLoad(agent, nodule, moduleName, resolvedName, esmResolver
     // that occur directly above this.  No reason to attempt to load instrumentation
     // as it does not exist.
     if (instrumentation.type === MODULE_TYPE.TRACKING) {
-      instrumentation[symbols.instrumented] = true
+      instrumentation[symbols.instrumented].add(pkgVersion)
       return
     }
 
-    try {
-      if (instrumentation.onRequire(shim, resolvedNodule, moduleName) !== false) {
-        nodule = shim.getExport(nodule)
-        instrumentation[symbols.instrumented] = true
-      }
-    } catch (instrumentationError) {
-      instrumentation[symbols.instrumentedErrored] = true
-      if (instrumentation.onError) {
-        try {
-          instrumentation.onError(instrumentationError)
-        } catch (e) {
-          logger.warn(
-            e,
-            instrumentationError,
-            'Custom instrumentation for %s failed, then the onError handler threw an error',
-            moduleName
-          )
-        }
-      } else {
+    nodule = loadInstrumentation({
+      shim,
+      resolvedNodule,
+      pkgVersion,
+      moduleName,
+      nodule,
+      instrumentation
+    })
+  })
+
+  return nodule
+}
+
+/**
+ * Attempts to execute an onRequire hook for a given module.
+ * If it fails it will call an onError hook and log warnings accordingly
+ *
+ * @param {object} params wrapping object to function
+ * @param {*} params.shim The instance of the shim used to instrument the module.
+ * @param {object} params.nodule Class or module containing the function to wrap.
+ * @param {object} params.resolvedNodule returns xport of the default property
+ * @param {string} params.pkgVersion version of module
+ * @param {string} params.moduleName module name
+ * @param {object} params.instrumentation hooks for a give module
+ * @returns {object} updated xport module
+ */
+function loadInstrumentation({
+  shim,
+  resolvedNodule,
+  pkgVersion,
+  moduleName,
+  nodule,
+  instrumentation
+}) {
+  try {
+    if (instrumentation.onRequire(shim, resolvedNodule, moduleName) !== false) {
+      nodule = shim.getExport(nodule)
+      instrumentation[symbols.instrumented].add(pkgVersion)
+    }
+  } catch (instrumentationError) {
+    instrumentation[symbols.instrumentedErrored].add(pkgVersion)
+    if (instrumentation.onError) {
+      try {
+        instrumentation.onError(instrumentationError)
+      } catch (e) {
         logger.warn(
+          e,
           instrumentationError,
-          'Custom instrumentation for %s failed. Please report this to the ' +
-            'maintainers of the custom instrumentation.',
+          'Custom instrumentation for %s failed, then the onError handler threw an error',
           moduleName
         )
       }
+    } else {
+      logger.warn(
+        instrumentationError,
+        'Custom instrumentation for %s failed. Please report this to the ' +
+          'maintainers of the custom instrumentation.',
+        moduleName
+      )
     }
-  })
+  }
 
   return nodule
 }
@@ -589,10 +643,12 @@ function _postLoad(agent, nodule, name, resolvedName, esmResolver) {
   const hasPostLoadInstrumentation =
     registeredInstrumentation &&
     registeredInstrumentation.length &&
-    registeredInstrumentation.filter((instrumentation) => instrumentation.onRequire).length
+    registeredInstrumentation.filter((hook) => hook.onRequire).length
 
   // Check if this is a known instrumentation and then run it.
   if (hasPostLoadInstrumentation) {
+    // Add the basedir to the instrumentation to be used later to parse version from package.json
+    registeredInstrumentation.basedir = resolvedName
     logger.trace('Instrumenting %s with onRequire (module loaded) hook.', name)
     return instrumentPostLoad(agent, nodule, instrumentation, resolvedName, esmResolver)
   }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "newrelic",
-  "version": "11.1.0",
+  "version": "11.2.1",
   "author": "New Relic Node.js agent team <nodejs@newrelic.com>",
   "license": "Apache-2.0",
   "contributors": [
@@ -153,7 +153,7 @@
     "lint:lockfile": "lockfile-lint --path package-lock.json --type npm --allowed-hosts npm --validate-https --validate-integrity",
     "public-docs": "jsdoc -c ./jsdoc-conf.json --tutorials examples/shim api.js lib/shim/ lib/transaction/handle.js && cp examples/shim/*.png out/",
     "publish-docs": "./bin/publish-docs.sh",
-    "services": "./bin/docker-services.sh",
+    "services": "docker compose up -d --wait",
     "smoke": "npm run ssl && time tap test/smoke/**/**/*.tap.js --timeout=180 --no-coverage",
     "ssl": "./bin/ssl.sh",
     "sub-install": "node test/bin/install_sub_deps",
@@ -165,8 +165,12 @@
     "versioned-tests": "./bin/run-versioned-tests.sh",
     "update-changelog-version": "node ./bin/update-changelog-version",
     "checkout-external-versioned": "node ./test/versioned-external/checkout-external-tests.js",
+    "versioned:internal:major": "VERSIONED_MODE=--major npm run versioned:internal",
+    "versioned:internal": "npm run prepare-test && EXTERNAL_MODE=none time ./bin/run-versioned-tests.sh",
+    "versioned:external:major": "VERSIONED_MODE=--major npm run versioned:external",
+    "versioned:external": "npm run checkout-external-versioned && SKIP_C8=true EXTERNAL_MODE=only time ./bin/run-versioned-tests.sh",
     "versioned:major": "VERSIONED_MODE=--major npm run versioned",
-    "versioned": "npm run checkout-external-versioned && npm run prepare-test && NPM7=1 time ./bin/run-versioned-tests.sh",
+    "versioned": "npm run checkout-external-versioned && npm run prepare-test && time ./bin/run-versioned-tests.sh",
     "versioned:legacy-context": "NEW_RELIC_FEATURE_FLAG_LEGACY_CONTEXT_MANAGER=1 npm run versioned",
     "versioned:legacy_context:major": "NEW_RELIC_FEATURE_FLAG_LEGACY_CONTEXT_MANAGER=1 npm run versioned:major",
     "versioned:security": "NEW_RELIC_SECURITY_AGENT_ENABLED=true npm run versioned",
@@ -181,7 +185,7 @@
     "@grpc/proto-loader": "^0.7.5",
     "@newrelic/aws-sdk": "^7.0.0",
     "@newrelic/koa": "^8.0.0",
-    "@newrelic/security-agent": "0.2.1",
+    "@newrelic/security-agent": "0.3.0",
     "@newrelic/superagent": "^7.0.0",
     "@tyriar/fibonacci-heap": "^2.0.7",
     "concat-stream": "^2.0.0",
@@ -189,6 +193,7 @@
     "import-in-the-middle": "^1.4.2",
     "json-bigint": "^1.0.0",
     "json-stringify-safe": "^5.0.0",
+    "module-details-from-path": "^1.0.3",
     "readable-stream": "^3.6.1",
     "require-in-the-middle": "^7.2.0",
     "semver": "^7.5.2",