newrelic 9.8.1 → 9.10.0

package/NEWS.md

@@ -1,3 +1,38 @@
+### v9.10.0 (2023-02-09)
+
+* Exposed a method on [API](https://newrelic.github.io/node-newrelic/API.html#obfuscateSql) to obfuscate sql: `newrelic.obfuscateSql`.
+
+* Add support for [Multi Value Parameters](https://aws.amazon.com/blogs/compute/support-for-multi-value-parameters-in-amazon-api-gateway) from API Gateway and ALB events for Lambdas (Thank you @Engerim for your contribution 🙏🏻)
+
+### v9.9.0 (2023-02-06)
+* Added support for url obfuscation using regex (Thanks for your contribution @matewilk)
+  * For Distributed Tracing, this means that:
+     * Incoming and outgoing requests' `path` will be obfuscated
+     * Transaction's `request.url` attribute will be obfuscated
+     * Span's `http.uri` path will be obfuscated
+  * For transactions, this means that:
+    * Transaction trace details `url` will be obfuscated
+  * With the following example configuration, url obfuscation will turn `/api/v1/users/12345456/edit` to `/api/v1/users/**/edit`.
+    ```js
+    url_obfuscation: {
+      enabled: true,
+      regex: {
+        pattern: /(\/api\/v1\/users\/)([\d]+)(\/.*$)/,
+        flags: "i",
+        replacement: '$1**$3'
+      }
+    }
+    ```
+  * You can also use environment variables to configure url obfuscation:
+    ```yml
+    NEW_RELIC_URL_OBFUSCATION_ENABLED: "true",
+    NEW_RELIC_URL_OBFUSCATION_REGEX_PATTERN: '/(\/api\/v1\/users\/)([\d]+)(\/.*$)/',
+    NEW_RELIC_URL_OBFUSCATION_REGEX_FLAGS: 'i',
+    NEW_RELIC_URL_OBFUSCATION_REGEX_REPLACEMENT: '$1**$3'
+    ```
+
+* Add a new tracking type of instrumentation.  This will be responsible for logging `Supportability/Features/Instrumentation/OnResolved/<pkg>` and `Supportability/Features/Instrumentation/OnResolved/<pkg>/Version/<version>` metrics when packages are required.
+
 ### v9.8.1 (2023-01-25)
 
 * Changed GCP metadata parsing to use `json-bigint` to avoid loss of precision from numerical instance ID.

package/THIRD_PARTY_NOTICES.md

@@ -40,6 +40,7 @@ code, the source code can be found at [https://github.com/newrelic/node-newrelic
 * [async](#async)
 * [c8](#c8)
 * [chai](#chai)
+* [clean-jsdoc-theme](#clean-jsdoc-theme)
 * [commander](#commander)
 * [eslint-config-prettier](#eslint-config-prettier)
 * [eslint-plugin-disable](#eslint-plugin-disable)
@@ -57,7 +58,6 @@ code, the source code can be found at [https://github.com/newrelic/node-newrelic
 * [lint-staged](#lint-staged)
 * [lockfile-lint](#lockfile-lint)
 * [memcached](#memcached)
-* [minami](#minami)
 * [nock](#nock)
 * [prettier](#prettier)
 * [proxyquire](#proxyquire)
@@ -74,7 +74,6 @@ code, the source code can be found at [https://github.com/newrelic/node-newrelic
 **[optionalDependencies](#optionalDependencies)**
 
 * [@contrast/fn-inspect](#contrastfn-inspect)
-* [@newrelic/native-metrics](#newrelicnative-metrics)
 
 **[Additional Licenses](#additional-licenses)**
 
@@ -1367,7 +1366,7 @@ SOFTWARE.
 
 ### @newrelic/eslint-config
 
-This product includes source derived from [@newrelic/eslint-config](https://github.com/newrelic/eslint-config-newrelic) ([v0.2.0](https://github.com/newrelic/eslint-config-newrelic/tree/v0.2.0)), distributed under the [Apache-2.0 License](https://github.com/newrelic/eslint-config-newrelic/blob/v0.2.0/LICENSE):
+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):
 
 ```
                                  Apache License
@@ -2175,6 +2174,35 @@ SOFTWARE.
 
 ```
 
+### clean-jsdoc-theme
+
+This product includes source derived from [clean-jsdoc-theme](https://github.com/ankitskvmdam/clean-jsdoc-theme) ([v4.2.4](https://github.com/ankitskvmdam/clean-jsdoc-theme/tree/v4.2.4)), distributed under the [MIT License](https://github.com/ankitskvmdam/clean-jsdoc-theme/blob/v4.2.4/LICENSE):
+
+```
+MIT License
+
+Copyright (c) 2019-2022 Ankit Kumar (अंकित कुमार)
+
+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.
+
+```
+
 ### commander
 
 This product includes source derived from [commander](https://github.com/tj/commander.js) ([v7.2.0](https://github.com/tj/commander.js/tree/v7.2.0)), distributed under the [MIT License](https://github.com/tj/commander.js/blob/v7.2.0/LICENSE):
@@ -2373,7 +2401,7 @@ OTHER DEALINGS IN THE SOFTWARE.
 
 ### eslint-plugin-sonarjs
 
-This product includes source derived from [eslint-plugin-sonarjs](https://github.com/SonarSource/eslint-plugin-sonarjs) ([v0.15.0](https://github.com/SonarSource/eslint-plugin-sonarjs/tree/v0.15.0)), distributed under the [LGPL-3.0 License](https://github.com/SonarSource/eslint-plugin-sonarjs/blob/v0.15.0/LICENSE):
+This product includes source derived from [eslint-plugin-sonarjs](https://github.com/SonarSource/eslint-plugin-sonarjs) ([v0.18.0](https://github.com/SonarSource/eslint-plugin-sonarjs/tree/v0.18.0)), distributed under the [LGPL-3.0 License](https://github.com/SonarSource/eslint-plugin-sonarjs/blob/v0.18.0/LICENSE):
 
 ```
                    GNU LESSER GENERAL PUBLIC LICENSE
@@ -2680,7 +2708,7 @@ SOFTWARE.
 
 ### jsdoc
 
-This product includes source derived from [jsdoc](https://github.com/jsdoc/jsdoc) ([v3.6.11](https://github.com/jsdoc/jsdoc/tree/v3.6.11)), distributed under the [Apache-2.0 License](https://github.com/jsdoc/jsdoc/blob/v3.6.11/LICENSE.md):
+This product includes source derived from [jsdoc](https://github.com/jsdoc/jsdoc) ([v4.0.0](https://github.com/jsdoc/jsdoc/tree/v4.0.0)), distributed under the [Apache-2.0 License](https://github.com/jsdoc/jsdoc/blob/v4.0.0/LICENSE.md):
 
 ```
 # License
@@ -3041,75 +3069,6 @@ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 THE SOFTWARE.
 ```
 
-### minami
-
-This product includes source derived from [minami](https://github.com/Nijikokun/minami) ([v1.2.3](https://github.com/Nijikokun/minami/tree/v1.2.3)), distributed under the [Apache-2.0 License](https://github.com/Nijikokun/minami/blob/v1.2.3/LICENSE):
-
-```
-# License
-
-Minami is free software, licensed under the Apache License, Version 2.0 (the
-"License"). Commercial and non-commercial use are permitted in compliance with
-the License.
-
-Copyright (c) 2014-2015 Nijiko Yonskai <nijikokun@gmail.com> and the
-[contributors to Minami](https://github.com/Nijikokun/minami/graphs/contributors).
-All rights reserved.
-
-You may obtain a copy of the License at:
-http://www.apache.org/licenses/LICENSE-2.0
-
-In addition, a copy of the License is included with this distribution.
-
-As stated in Section 7, "Disclaimer of Warranty," of the License:
-
-> Licensor provides the Work (and each Contributor provides its Contributions)
-> on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
-> express or implied, including, without limitation, any warranties or
-> conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
-> PARTICULAR PURPOSE. You are solely responsible for determining the
-> appropriateness of using or redistributing the Work and assume any risks
-> associated with Your exercise of permissions under this License.
-
-The source code for JSDoc 3 is available at:
-https://github.com/Nijikokun/minami
-
-# Third-Party Software
-
-Minami includes or depends upon the following third-party software, either in
-whole or in part. Each third-party software package is provided under its own
-license.
-
-## JSDoc 3
-
-JSDoc 3 is free software, licensed under the Apache License, Version 2.0 (the
-"License"). Commercial and non-commercial use are permitted in compliance with
-the License.
-
-Copyright (c) 2011-2015 Michael Mathews <micmath@gmail.com> and the
-[contributors to JSDoc](https://github.com/jsdoc3/jsdoc/graphs/contributors).
-All rights reserved.
-
-You may obtain a copy of the License at:
-http://www.apache.org/licenses/LICENSE-2.0
-
-In addition, a copy of the License is included with this distribution.
-
-As stated in Section 7, "Disclaimer of Warranty," of the License:
-
-> Licensor provides the Work (and each Contributor provides its Contributions)
-> on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
-> express or implied, including, without limitation, any warranties or
-> conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
-> PARTICULAR PURPOSE. You are solely responsible for determining the
-> appropriateness of using or redistributing the Work and assume any risks
-> associated with Your exercise of permissions under this License.
-
-The source code for JSDoc 3 is available at:
-https://github.com/jsdoc3/jsdoc
-
-```
-
 ### nock
 
 This product includes source derived from [nock](https://github.com/nock/nock) ([v11.8.0](https://github.com/nock/nock/tree/v11.8.0)), distributed under the [MIT License](https://github.com/nock/nock/blob/v11.8.0/LICENSE):
@@ -9355,12 +9314,12 @@ 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.0](https://github.com/tapjs/node-tap/tree/v16.3.0)), distributed under the [ISC License](https://github.com/tapjs/node-tap/blob/v16.3.0/LICENSE):
+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):
 
 ```
 The ISC License
 
-Copyright (c) 2011-2022 Isaac Z. Schlueter and Contributors
+Copyright (c) 2011-2023 Isaac Z. Schlueter and Contributors
 
 Permission to use, copy, modify, and/or distribute this software for any
 purpose with or without fee is hereby granted, provided that the above
@@ -9493,215 +9452,6 @@ CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
 ```
 
-### @newrelic/native-metrics
-
-This product includes source derived from [@newrelic/native-metrics](https://github.com/newrelic/node-native-metrics) ([v9.0.0](https://github.com/newrelic/node-native-metrics/tree/v9.0.0)), distributed under the [Apache-2.0 License](https://github.com/newrelic/node-native-metrics/blob/v9.0.0/LICENSE):
-
-```
-                                 Apache License
-                           Version 2.0, January 2004
-                        http://www.apache.org/licenses/
-
-   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
-
-   1. Definitions.
-
-      "License" shall mean the terms and conditions for use, reproduction,
-      and distribution as defined by Sections 1 through 9 of this document.
-
-      "Licensor" shall mean the copyright owner or entity authorized by
-      the copyright owner that is granting the License.
-
-      "Legal Entity" shall mean the union of the acting entity and all
-      other entities that control, are controlled by, or are under common
-      control with that entity. For the purposes of this definition,
-      "control" means (i) the power, direct or indirect, to cause the
-      direction or management of such entity, whether by contract or
-      otherwise, or (ii) ownership of fifty percent (50%) or more of the
-      outstanding shares, or (iii) beneficial ownership of such entity.
-
-      "You" (or "Your") shall mean an individual or Legal Entity
-      exercising permissions granted by this License.
-
-      "Source" form shall mean the preferred form for making modifications,
-      including but not limited to software source code, documentation
-      source, and configuration files.
-
-      "Object" form shall mean any form resulting from mechanical
-      transformation or translation of a Source form, including but
-      not limited to compiled object code, generated documentation,
-      and conversions to other media types.
-
-      "Work" shall mean the work of authorship, whether in Source or
-      Object form, made available under the License, as indicated by a
-      copyright notice that is included in or attached to the work
-      (an example is provided in the Appendix below).
-
-      "Derivative Works" shall mean any work, whether in Source or Object
-      form, that is based on (or derived from) the Work and for which the
-      editorial revisions, annotations, elaborations, or other modifications
-      represent, as a whole, an original work of authorship. For the purposes
-      of this License, Derivative Works shall not include works that remain
-      separable from, or merely link (or bind by name) to the interfaces of,
-      the Work and Derivative Works thereof.
-
-      "Contribution" shall mean any work of authorship, including
-      the original version of the Work and any modifications or additions
-      to that Work or Derivative Works thereof, that is intentionally
-      submitted to Licensor for inclusion in the Work by the copyright owner
-      or by an individual or Legal Entity authorized to submit on behalf of
-      the copyright owner. For the purposes of this definition, "submitted"
-      means any form of electronic, verbal, or written communication sent
-      to the Licensor or its representatives, including but not limited to
-      communication on electronic mailing lists, source code control systems,
-      and issue tracking systems that are managed by, or on behalf of, the
-      Licensor for the purpose of discussing and improving the Work, but
-      excluding communication that is conspicuously marked or otherwise
-      designated in writing by the copyright owner as "Not a Contribution."
-
-      "Contributor" shall mean Licensor and any individual or Legal Entity
-      on behalf of whom a Contribution has been received by Licensor and
-      subsequently incorporated within the Work.
-
-   2. Grant of Copyright License. Subject to the terms and conditions of
-      this License, each Contributor hereby grants to You a perpetual,
-      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-      copyright license to reproduce, prepare Derivative Works of,
-      publicly display, publicly perform, sublicense, and distribute the
-      Work and such Derivative Works in Source or Object form.
-
-   3. Grant of Patent License. Subject to the terms and conditions of
-      this License, each Contributor hereby grants to You a perpetual,
-      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-      (except as stated in this section) patent license to make, have made,
-      use, offer to sell, sell, import, and otherwise transfer the Work,
-      where such license applies only to those patent claims licensable
-      by such Contributor that are necessarily infringed by their
-      Contribution(s) alone or by combination of their Contribution(s)
-      with the Work to which such Contribution(s) was submitted. If You
-      institute patent litigation against any entity (including a
-      cross-claim or counterclaim in a lawsuit) alleging that the Work
-      or a Contribution incorporated within the Work constitutes direct
-      or contributory patent infringement, then any patent licenses
-      granted to You under this License for that Work shall terminate
-      as of the date such litigation is filed.
-
-   4. Redistribution. You may reproduce and distribute copies of the
-      Work or Derivative Works thereof in any medium, with or without
-      modifications, and in Source or Object form, provided that You
-      meet the following conditions:
-
-      (a) You must give any other recipients of the Work or
-          Derivative Works a copy of this License; and
-
-      (b) You must cause any modified files to carry prominent notices
-          stating that You changed the files; and
-
-      (c) You must retain, in the Source form of any Derivative Works
-          that You distribute, all copyright, patent, trademark, and
-          attribution notices from the Source form of the Work,
-          excluding those notices that do not pertain to any part of
-          the Derivative Works; and
-
-      (d) If the Work includes a "NOTICE" text file as part of its
-          distribution, then any Derivative Works that You distribute must
-          include a readable copy of the attribution notices contained
-          within such NOTICE file, excluding those notices that do not
-          pertain to any part of the Derivative Works, in at least one
-          of the following places: within a NOTICE text file distributed
-          as part of the Derivative Works; within the Source form or
-          documentation, if provided along with the Derivative Works; or,
-          within a display generated by the Derivative Works, if and
-          wherever such third-party notices normally appear. The contents
-          of the NOTICE file are for informational purposes only and
-          do not modify the License. You may add Your own attribution
-          notices within Derivative Works that You distribute, alongside
-          or as an addendum to the NOTICE text from the Work, provided
-          that such additional attribution notices cannot be construed
-          as modifying the License.
-
-      You may add Your own copyright statement to Your modifications and
-      may provide additional or different license terms and conditions
-      for use, reproduction, or distribution of Your modifications, or
-      for any such Derivative Works as a whole, provided Your use,
-      reproduction, and distribution of the Work otherwise complies with
-      the conditions stated in this License.
-
-   5. Submission of Contributions. Unless You explicitly state otherwise,
-      any Contribution intentionally submitted for inclusion in the Work
-      by You to the Licensor shall be under the terms and conditions of
-      this License, without any additional terms or conditions.
-      Notwithstanding the above, nothing herein shall supersede or modify
-      the terms of any separate license agreement you may have executed
-      with Licensor regarding such Contributions.
-
-   6. Trademarks. This License does not grant permission to use the trade
-      names, trademarks, service marks, or product names of the Licensor,
-      except as required for reasonable and customary use in describing the
-      origin of the Work and reproducing the content of the NOTICE file.
-
-   7. Disclaimer of Warranty. Unless required by applicable law or
-      agreed to in writing, Licensor provides the Work (and each
-      Contributor provides its Contributions) on an "AS IS" BASIS,
-      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
-      implied, including, without limitation, any warranties or conditions
-      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
-      PARTICULAR PURPOSE. You are solely responsible for determining the
-      appropriateness of using or redistributing the Work and assume any
-      risks associated with Your exercise of permissions under this License.
-
-   8. Limitation of Liability. In no event and under no legal theory,
-      whether in tort (including negligence), contract, or otherwise,
-      unless required by applicable law (such as deliberate and grossly
-      negligent acts) or agreed to in writing, shall any Contributor be
-      liable to You for damages, including any direct, indirect, special,
-      incidental, or consequential damages of any character arising as a
-      result of this License or out of the use or inability to use the
-      Work (including but not limited to damages for loss of goodwill,
-      work stoppage, computer failure or malfunction, or any and all
-      other commercial damages or losses), even if such Contributor
-      has been advised of the possibility of such damages.
-
-   9. Accepting Warranty or Additional Liability. While redistributing
-      the Work or Derivative Works thereof, You may choose to offer,
-      and charge a fee for, acceptance of support, warranty, indemnity,
-      or other liability obligations and/or rights consistent with this
-      License. However, in accepting such obligations, You may act only
-      on Your own behalf and on Your sole responsibility, not on behalf
-      of any other Contributor, and only if You agree to indemnify,
-      defend, and hold each Contributor harmless for any liability
-      incurred by, or claims asserted against, such Contributor by reason
-      of your accepting any such warranty or additional liability.
-
-   END OF TERMS AND CONDITIONS
-
-   APPENDIX: How to apply the Apache License to your work.
-
-      To apply the Apache License to your work, attach the following
-      boilerplate notice, with the fields enclosed by brackets "[]"
-      replaced with your own identifying information. (Don't include
-      the brackets!)  The text should be enclosed in the appropriate
-      comment syntax for the file format. We also recommend that a
-      file or class name and description of purpose be included on the
-      same "printed page" as the copyright notice for easier
-      identification within third-party archives.
-
-   Copyright [yyyy] [name of copyright owner]
-
-   Licensed under the Apache License, Version 2.0 (the "License");
-   you may not use this file except in compliance with the License.
-   You may obtain a copy of the License at
-
-       http://www.apache.org/licenses/LICENSE-2.0
-
-   Unless required by applicable law or agreed to in writing, software
-   distributed under the License is distributed on an "AS IS" BASIS,
-   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-   See the License for the specific language governing permissions and
-   limitations under the License.
-
-```
-
 ## Additional Licenses
 
 ### Symantec

package/api.js

@@ -27,6 +27,7 @@ const {
 const ATTR_DEST = require('./lib/config/attribute-filter').DESTINATIONS
 const MODULE_TYPE = require('./lib/shim/constants').MODULE_TYPE
 const NAMES = require('./lib/metrics/names')
+const obfuscate = require('./lib/util/sql/obfuscate')
 
 /*
  *
@@ -646,7 +647,7 @@ function _generateRUMHeader(options = {}, metadata, loader) {
  * @param {object} config agent configuration settings
  * @param {Transaction} transaction the active transaction or null
  * @param {boolean} allowTransactionlessInjection whether or not to allow the Browser Agent to be injected when there is no active transaction
- * @returns {{ isValidConfig: boolean, failureIdx?: number, quietMode?: boolean }} object containing validation results
+ * @returns {{ isValidConfig: boolean, failureIdx: number, quietMode: boolean }} object containing validation results
  */
 function validateBrowserMonitoring(config, transaction, allowTransactionlessInjection) {
   /*
@@ -1669,6 +1670,20 @@ API.prototype.setLambdaHandler = function setLambdaHandler(handler) {
   return this.awsLambda.patchLambdaHandler(handler)
 }
 
+/**
+ * Obfuscates SQL for a given database engine.
+ *
+ * @param {string} sql sql statement
+ * @param {string} dialect engine of the sql (mysql, postgres, cassandra, oracle)
+ * @returns {string} sql that obfuscates raw values
+ */
+API.prototype.obfuscateSql = function obfuscateSql(sql, dialect) {
+  const metric = this.agent.metrics.getOrCreateMetric(NAMES.SUPPORTABILITY.API + '/obfuscateSql')
+  metric.incrementCallCount()
+
+  return obfuscate(sql, dialect)
+}
+
 /**
  * Function for removing invalid attribute key/value pairs from an object
  *

package/lib/collector/facts.js

@@ -9,12 +9,6 @@ const fetchSystemInfo = require('../system-info')
 const logger = require('../logger').child({ component: 'facts' })
 const os = require('os')
 const parseLabels = require('../util/label-parser')
-const NAMES = require('../metrics/names')
-
-// For now static and tentative list of which logging libraries we
-// want to track. Later might come up with a better way of populating
-// this list.
-const LOG_LIBRARIES = ['winston', 'bunyan', 'pino', 'loglevel', 'npmlog', 'fancy-log']
 
 module.exports = facts
 
@@ -38,8 +32,6 @@ async function facts(agent, callback) {
   systemInfo = systemInfo || Object.create(null)
   environment = environment || []
 
-  countSupportabilityForLogLibraries(environment, agent)
-
   const hostname = agent.config.getHostnameSafe()
   const results = {
     utilization: {
@@ -148,23 +140,3 @@ function getIdentifierOverride(appNames) {
     appNames.concat([]).sort().join(',')
   ].join(':')
 }
-
-/**
- * This function searches the computed environment for the presence of
- * some popular logging libraries. If present, it increments the
- * corresponding supportability metrics.
- *
- * @param {Array} environment the environment computed by
- * @param {object} agent the New Relic agent
- */
-function countSupportabilityForLogLibraries(environment, agent) {
-  const packages = environment.find((elt) => elt[0] === 'Packages')[1]
-  packages.forEach((pkg) => {
-    pkg = JSON.parse(pkg)[0]
-    if (LOG_LIBRARIES.includes(pkg)) {
-      agent.metrics
-        .getOrCreateMetric(`${NAMES.SUPPORTABILITY.NODEJS_DEPENDENCIES}/${pkg}`)
-        .incrementCallCount()
-    }
-  })
-}

package/lib/config/default.js

@@ -6,7 +6,7 @@
 'use strict'
 
 const defaultConfig = module.exports
-const { array, int, float, boolean, object, objectList, allowList } = require('./formatters')
+const { array, int, float, boolean, object, objectList, allowList, regex } = require('./formatters')
 
 /**
  * A function that returns the definition of the agent configuration
@@ -52,6 +52,13 @@ defaultConfig.definition = () => ({
    * You shouldn't need to change this.
    */
   host: '',
+  /**
+   * Endpoint to send OpenTelemetry spans to.
+   *
+   * This should be automatically deduced from your region and other
+   * settings, but if desired, you can override it.
+   */
+  otlp_endpoint: '',
   /**
    * The port on which the collector proxy will be listening.
    *
@@ -1208,6 +1215,47 @@ defaultConfig.definition = () => ({
       formatter: boolean,
       default: false
     }
+  },
+
+  /**
+   * Obfuscates URL parameters
+   * for outgoing and incoming requests
+   * for distrubuted tracing attributes - both transaction and span attributes
+   * for transaction trace transaction details
+   */
+  url_obfuscation: {
+    /**
+     * Toggles whether to obfuscate URL parameters
+     */
+    enabled: {
+      formatter: boolean,
+      default: false
+    },
+
+    regex: {
+      /**
+       * A regular expression to match URL parameters to obfuscate
+       */
+      pattern: {
+        formatter: regex,
+        default: null
+      },
+
+      /**
+       * A string containing RegEx flags to use when matching URL parameters
+       */
+      flags: {
+        default: ''
+      },
+
+      /**
+       * A string containing a replacement value for URL parameters
+       * can contain refferences to capture groups in the pattern
+       */
+      replacement: {
+        default: ''
+      }
+    }
   }
 })
 

package/lib/config/formatters.js

@@ -106,3 +106,19 @@ formatters.objectList = function objectList(val, logger) {
 formatters.allowList = function allowList(list, val) {
   return list.includes(val) ? val : list[0]
 }
+
+/**
+ * Parse a config setting as a regex
+ *
+ * @param {string} val valid regex
+ * @param {logger} logger agent logger instance
+ * @returns {RegExp} regex
+ */
+formatters.regex = function regex(val, logger) {
+  try {
+    return new RegExp(val)
+  } catch (error) {
+    logger.error(`New Relic configurator could not validate regex: ${val}`)
+    logger.error(error.stack)
+  }
+}

package/lib/config/index.js

@@ -993,7 +993,7 @@ Config.prototype._fromPassed = function _fromPassed(external, internal, arbitrar
       return
     }
 
-    if (typeof node === 'object' && !Array.isArray(node)) {
+    if (typeof node === 'object' && !Array.isArray(node) && !(node instanceof RegExp)) {
       // is top level and can have arbitrary keys
       const allowArbitrary = internal === this || HAS_ARBITRARY_KEYS.has(key)
       this._fromPassed(node, internal[key], allowArbitrary)
@@ -1095,7 +1095,13 @@ Config.prototype._fromEnvironment = function _fromEnvironment(
       setFromEnv({ config, key, envVar, paths })
     } else if (type === 'object') {
       if (value.hasOwnProperty('env')) {
-        setFromEnv({ config, key, envVar: value.env, paths, formatter: value.formatter })
+        setFromEnv({
+          config,
+          key,
+          envVar: value.env,
+          paths,
+          formatter: value.formatter
+        })
       } else if (value.hasOwnProperty('default')) {
         const envVar = deriveEnvVar(key, paths)
         setFromEnv({ config, key, envVar, formatter: value.formatter, paths })
@@ -1298,14 +1304,21 @@ Config.prototype._canonicalize = function _canonicalize() {
   const level = this.logging.level
   this.logging.level = logAliases[level] || level
 
+  const region = parseKey(this.license_key)
   if (this.host === '') {
-    const region = parseKey(this.license_key)
     if (region) {
-      this.host = 'collector.' + region + '.nr-data.net'
+      this.host = `collector.${region}.nr-data.net`
     } else {
       this.host = 'collector.newrelic.com'
     }
   }
+  if (this.otlp_endpoint === '') {
+    if (region) {
+      this.otlp_endpoint = `otlp.${region}.nr-data.net`
+    } else {
+      this.otlp_endpoint = 'otlp.nr-data.net'
+    }
+  }
 
   if (this.license_key) {
     this.license_key = this.license_key.trim()

package/lib/instrumentation/core/http-outbound.js

@@ -215,6 +215,7 @@ function applySegment(opts, makeRequest, hostname, segment) {
   segment.start()
   const request = makeRequest(opts)
   const parsed = urltils.scrubAndParseParameters(request.path)
+  parsed.path = urltils.obfuscatePath(segment.transaction.agent.config, parsed.path)
   const proto = parsed.protocol || opts.protocol || 'http:'
   segment.name += parsed.path
   request[symbols.segment] = segment

package/lib/instrumentation/core/http.js

@@ -86,7 +86,7 @@ function wrapEmitWithTransaction(agent, emit, isHTTPS) {
 
     // the error tracer needs a URL for tracing, even though naming overwrites
     transaction.parsedUrl = url.parse(request.url, true)
-    transaction.url = transaction.parsedUrl.pathname
+    transaction.url = urltils.obfuscatePath(agent.config, transaction.parsedUrl.path)
     transaction.verb = request.method
 
     // URL is sent as an agent attribute with transaction events

package/lib/instrumentations.js

@@ -38,6 +38,21 @@ module.exports = function instrumentations() {
     'undici': { type: MODULE_TYPE.TRANSACTION },
     '@hapi/vision': { type: MODULE_TYPE.WEB_FRAMEWORK },
     'when': { module: './instrumentation/when' },
-    'winston': { type: MODULE_TYPE.GENERIC }
+    'winston': { type: MODULE_TYPE.GENERIC },
+    /**
+     * The modules below are listed here purely to take
+     * advantage of the Supportability/Features/onRequire/<module>
+     * metrics for libraries we want to track for some reason or another.
+     * The big uses cases are:
+     *  Logging libraries we want to instrument in the future
+     *  Libraries that have OpenTelemetry instrumentation we want to register
+     *  or have already registered.
+     */
+    'loglevel': { type: MODULE_TYPE.TRACKING },
+    'npmlog': { type: MODULE_TYPE.TRACKING },
+    'fancy-log': { type: MODULE_TYPE.TRACKING },
+    '@prisma/client': { type: MODULE_TYPE.TRACKING },
+    '@nestjs/core': { type: MODULE_TYPE.TRACKING },
+    'knex': { type: MODULE_TYPE.TRACKING }
   }
 }

package/lib/metrics/names.js

@@ -23,7 +23,6 @@ const SUPPORTABILITY = {
   TRANSACTION_API: 'Supportability/API/Transaction',
   UTILIZATION: 'Supportability/utilization',
   DEPENDENCIES: 'Supportability/InstalledDependencies',
-  NODEJS_DEPENDENCIES: 'Supportability/InstalledDependencies/Nodejs',
   NODEJS: 'Supportability/Nodejs',
   REGISTRATION: 'Supportability/Registration',
   EVENT_HARVEST: 'Supportability/EventHarvest',

package/lib/serverless/api-gateway.js

@@ -7,19 +7,21 @@
 
 /**
  * This class captures data needed to construct a web transaction from
- * a API Gateway Lambda proxy request. This is to be used with the setWebRequest
+ * an API Gateway Lambda proxy request. This is to be used with the setWebRequest
  * method.
  */
 class LambdaProxyWebRequest {
   constructor(event) {
-    this.headers = event.headers
+    const lowerCaseHeaders = normalizeHeaders(event, true)
+
+    this.headers = normalizeHeaders(event)
     this.url = {
       path: event.path,
-      port: event.headers['X-Forwarded-Port'],
-      requestParameters: event.queryStringParameters
+      port: lowerCaseHeaders['x-forwarded-port'],
+      requestParameters: normalizeQueryStringParameters(event)
     }
     this.method = event.httpMethod
-    this.transportType = event.headers['X-Forwarded-Proto']
+    this.transportType = lowerCaseHeaders['x-forwarded-proto']
   }
 }
 
@@ -30,11 +32,53 @@ class LambdaProxyWebRequest {
  */
 class LambdaProxyWebResponse {
   constructor(lambdaResponse) {
-    this.headers = lambdaResponse.headers
+    this.headers = normalizeHeaders(lambdaResponse)
     this.statusCode = lambdaResponse.statusCode
   }
 }
 
+/**
+ * normalizes query string parameters either from multi value query string parameters or normal query string parameters to a
+ * key map with comma separated strings
+ *
+ * @param {object} event The event with query string to normalize
+ * @returns {Object<string, string>} The normalized query string map
+ */
+function normalizeQueryStringParameters(event) {
+  if (!event.multiValueQueryStringParameters) {
+    return event.queryStringParameters
+  }
+  return Object.fromEntries(
+    Object.entries(event.multiValueQueryStringParameters).map(([param, value]) => {
+      if (Array.isArray(value)) {
+        return [param, value.join(',')]
+      }
+      return [param, value]
+    })
+  )
+}
+
+/**
+ * normalizes headers either from multi value headers or normal headers to a
+ * lowercase key map with comma separated string
+ *
+ * @param {object} event The event with headers to normalize
+ * @param {boolean} lowerCaseKey Whether to lowercase the header names or not
+ * @returns {Object<string, string>} The normalized headers map
+ */
+function normalizeHeaders(event, lowerCaseKey = false) {
+  return Object.fromEntries(
+    Object.entries(event.multiValueHeaders ?? event.headers).map(([headerKey, headerValue]) => {
+      const newKey = lowerCaseKey ? headerKey.toLowerCase() : headerKey
+
+      if (Array.isArray(headerValue)) {
+        return [newKey, headerValue.join(',')]
+      }
+      return [newKey, headerValue]
+    })
+  )
+}
+
 /**
  * Determines if Lambda event appears to be a valid Lambda Proxy event.
  *
@@ -43,14 +87,13 @@ class LambdaProxyWebResponse {
  *                    to create a web transaction.
  */
 function isLambdaProxyEvent(event) {
-  return !!(event.path && event.headers && event.httpMethod)
+  return !!(event.path && (event.headers ?? event.multiValueHeaders) && event.httpMethod)
 }
 
 /**
  * Determines if Lambda event appears to be a valid Lambda Proxy response.
  *
- * @param {object} event The response to inspect.
- * @param response
+ * @param {object} response The response to inspect.
  * @returns {boolean} Whether the given object contains fields necessary
  *                    to create a web transaction.
  */

package/lib/shim/constants.js

@@ -32,5 +32,11 @@ exports.MODULE_TYPE = {
   TRANSACTION: 'transaction',
 
   /** Web server framework module, such as Express or Restify. */
-  WEB_FRAMEWORK: 'web-framework'
+  WEB_FRAMEWORK: 'web-framework',
+
+  /**
+   * Used to load supportability metrics on installed verisions of packages
+   * that the Node.js agent does not instrument(i.e. - otel instrumentation or top logging libraries)
+   */
+  TRACKING: 'tracking'
 }

package/lib/shimmer.js

@@ -530,6 +530,13 @@ function instrumentPostLoad(agent, nodule, moduleName, resolvedName) {
     NAMES.FEATURES.INSTRUMENTATION.ON_REQUIRE
   )
 
+  // Tracking instrumentation is only used to add the supportability metrics
+  // that occur directly above this.  No reason to attempt to load instrumentation
+  // as it does not exist.
+  if (instrumentation.type === MODULE_TYPE.TRACKING) {
+    return nodule
+  }
+
   try {
     if (instrumentation.onRequire(shim, nodule, moduleName) !== false) {
       nodule = shim.getExport(nodule)
@@ -580,7 +587,6 @@ function _firstPartyInstrumentation(agent, fileName, shim, nodule, moduleName) {
 
 function _postLoad(agent, nodule, name, resolvedName) {
   const instrumentation = shimmer.getInstrumentationNameFromModuleName(name)
-
   const registeredInstrumentation = shimmer.registeredInstrumentations[instrumentation]
   const hasPostLoadInstrumentation =
     registeredInstrumentation && registeredInstrumentation.onRequire
@@ -596,7 +602,6 @@ function _postLoad(agent, nodule, name, resolvedName) {
 
 function _onResolveFileName(agent, requiredNameOrPath, resolvedFilepath) {
   const instrumentation = shimmer.getInstrumentationNameFromModuleName(requiredNameOrPath)
-
   const registeredInstrumentation = shimmer.registeredInstrumentations[instrumentation]
   const hasResolvedFileInstrumentation =
     registeredInstrumentation && registeredInstrumentation.onResolved

package/lib/transaction/trace/index.js

@@ -8,6 +8,7 @@
 /* eslint sonarjs/cognitive-complexity: ["error", 19] -- TODO: https://issues.newrelic.com/browse/NEWRELIC-5252 */
 
 const codec = require('../../util/codec')
+const urltils = require('../../util/urltils')
 const Segment = require('./segment')
 const { Attributes, MAXIMUM_CUSTOM_ATTRIBUTES } = require('../../attributes')
 const logger = require('../../logger').child({ component: 'trace' })
@@ -329,7 +330,9 @@ Trace.prototype._getRequestUri = function _getRequestUri() {
   const canAddUri = this.attributes.hasValidDestination(DESTINATIONS.TRANS_TRACE, REQUEST_URI_KEY)
   let requestUri = null // must be null if excluded
   if (canAddUri) {
-    requestUri = this.transaction.url || UNKNOWN_URI_PLACEHOLDER
+    // obfuscate the path if config is set
+    const url = urltils.obfuscatePath(this.transaction.agent.config, this.transaction.url)
+    requestUri = url || UNKNOWN_URI_PLACEHOLDER
   }
 
   return requestUri

package/lib/util/urltils.js

@@ -6,6 +6,7 @@
 'use strict'
 
 const url = require('url')
+const logger = require('../logger').child({ component: 'urltils' })
 
 const LOCALHOST_NAMES = {
   'localhost': true,
@@ -162,6 +163,29 @@ module.exports = {
     }
   },
 
+  /**
+   * Obfuscates path parameters with regex from config
+   *
+   * @param {Config} config The configuration containing the regex
+   * @param {string} path The path to be obfuscated
+   * @returns {string} The obfuscated path or the original path
+   */
+  obfuscatePath: function obfuscatePath(config, path) {
+    const { enabled, regex } = config.url_obfuscation
+    if (typeof path !== 'string' || !enabled || !regex) {
+      return path
+    }
+
+    const { pattern, flags = '', replacement = '' } = regex
+    try {
+      const regexPattern = new RegExp(pattern, flags)
+      return path.replace(regexPattern, replacement)
+    } catch (e) {
+      logger.warn('Invalid regular expression for url_obfuscation.regex.pattern', pattern)
+      return path
+    }
+  },
+
   /**
    * Copy a set of request parameters from one object to another,
    * but do not overwrite any existing parameters in destination,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "newrelic",
-  "version": "9.8.1",
+  "version": "9.10.0",
   "author": "New Relic Node.js agent team <nodejs@newrelic.com>",
   "license": "Apache-2.0",
   "contributors": [
@@ -179,10 +179,10 @@
     "newrelic-naming-rules": "./bin/test-naming-rules.js"
   },
   "dependencies": {
-    "@grpc/grpc-js": "^1.7.3",
-    "@grpc/proto-loader": "^0.7.3",
-    "@newrelic/aws-sdk": "^5.0.0",
-    "@newrelic/koa": "^7.0.0",
+    "@grpc/grpc-js": "^1.8.4",
+    "@grpc/proto-loader": "^0.7.4",
+    "@newrelic/aws-sdk": "^5.0.2",
+    "@newrelic/koa": "^7.1.1",
     "@newrelic/superagent": "^6.0.0",
     "@tyriar/fibonacci-heap": "^2.0.7",
     "concat-stream": "^2.0.0",
@@ -198,7 +198,7 @@
     "@newrelic/native-metrics": "^9.0.0"
   },
   "devDependencies": {
-    "@newrelic/eslint-config": "^0.2.0",
+    "@newrelic/eslint-config": "^0.3.0",
     "@newrelic/newrelic-oss-cli": "^0.1.2",
     "@newrelic/proxy": "^2.0.0",
     "@newrelic/test-utilities": "^7.2.0",
@@ -208,6 +208,7 @@
     "async": "^3.2.4",
     "c8": "^7.12.0",
     "chai": "^4.1.2",
+    "clean-jsdoc-theme": "^4.2.4",
     "commander": "^7.0.0",
     "eslint": "^8.24.0",
     "eslint-config-prettier": "^8.3.0",
@@ -216,16 +217,15 @@
     "eslint-plugin-jsdoc": "^39.3.6",
     "eslint-plugin-node": "^11.1.0",
     "eslint-plugin-prettier": "^3.4.0",
-    "eslint-plugin-sonarjs": "^0.15.0",
+    "eslint-plugin-sonarjs": "^0.18.0",
     "express": "*",
     "glob": "^7.1.2",
     "got": "^11.8.5",
     "husky": "^6.0.0",
-    "jsdoc": "^3.6.3",
+    "jsdoc": "^4.0.0",
     "lint-staged": "^11.0.0",
     "lockfile-lint": "^4.9.6",
     "memcached": ">=0.2.8",
-    "minami": "^1.2.3",
     "nock": "11.8.0",
     "prettier": "^2.3.2",
     "proxyquire": "^1.8.0",
@@ -234,7 +234,7 @@
     "rimraf": "^2.6.3",
     "should": "*",
     "sinon": "^4.5.0",
-    "tap": "^16.0.1",
+    "tap": "^16.3.4",
     "temp": "^0.8.1",
     "testdouble": "^3.16.6",
     "when": "*"