newrelic 9.8.1 → 9.9.0

package/NEWS.md

@@ -1,3 +1,32 @@
+### 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

@@ -2680,7 +2680,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
@@ -9355,12 +9355,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

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/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.9.0",
   "author": "New Relic Node.js agent team <nodejs@newrelic.com>",
   "license": "Apache-2.0",
   "contributors": [
@@ -221,7 +221,7 @@
     "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",
@@ -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": "*"