newrelic 9.7.0 → 9.7.2

package/lib/config/attribute-filter.js

@@ -5,8 +5,6 @@
 
 'use strict'
 
-/* eslint sonarjs/cognitive-complexity: ["error", 16] -- TODO: https://issues.newrelic.com/browse/NEWRELIC-5252 */
-
 const NO_MATCH = -Infinity
 const EXACT_MATCH = Infinity
 const DESTINATIONS = {
@@ -54,7 +52,7 @@ exports.DESTINATIONS = DESTINATIONS
  *
  * @class
  * @private
- * @param {Config} config - The configuration object for the agent.
+ * @param {object} config - The configuration object for the agent.
  */
 function AttributeFilter(config) {
   this.config = config
@@ -152,6 +150,7 @@ AttributeFilter.prototype._filter = function _filter(scope, destinations, key) {
 
     // Check for a cached result for this key.
     let result = this._cache[destName][key]
+
     if (result === undefined) {
       if (globalInclude === null) {
         globalInclude = _matchRules(this._rules.global.include, key)
@@ -166,13 +165,7 @@ AttributeFilter.prototype._filter = function _filter(scope, destinations, key) {
       }
     }
 
-    if (result === NO_MATCH) {
-      // No match, no-op.
-    } else if (result) {
-      destinations |= destId // Positive match, add it in.
-    } else {
-      destinations &= ~destId // Negative match, remove it.
-    }
+    destinations = _updateDestinations(destinations, destId, result)
   }
 
   return destinations
@@ -209,12 +202,12 @@ AttributeFilter.prototype.update = function update() {
 /**
  * Applies the global and destination rules to this key.
  *
- * @param globalInclude
- * @param globalExclude
- * @param destConfig
- * @param key
  * @private
- * @returns {bool|number} True if this key is explicitly included, false if it is
+ * @param {number} globalInclude Global inclusion match
+ * @param {number} globalExclude Global exclusion match
+ * @param {object} destConfig Destination specific include/exclude rules
+ * @param {string} key The attribute name
+ * @returns {boolean|number} True if this key is explicitly included, false if it is
  *  explicitly excluded, or `NO_MATCH` if no rule applies.
  */
 function _doTest(globalInclude, globalExclude, destConfig, key) {
@@ -259,16 +252,14 @@ function _doTest(globalInclude, globalExclude, destConfig, key) {
 /**
  * Tests the given key against the given rule set.
  *
- * @private
- *
  * This method assumes that the rule set is sorted from best possible match to
  * least possible match. Unsorted lists may result in a lesser score being given
  * to the value.
  *
- * @param {array.<string>}  rules - The set of rules to match against.
+ * @private
+ * @param {Array.<string>}  rules - The set of rules to match against.
  * @param {string}          key   - The name of the attribute to look for.
- *
- * @return {number} The strength of the match, from `0` for no-match to `Infinity`
+ * @returns {number} The strength of the match, from `0` for no-match to `Infinity`
  *  for exact matches.
  */
 function _matchRules(rules, key) {
@@ -322,13 +313,11 @@ function _importRules(rules) {
 /**
  * Converts an array of attribute rules into a regular expression string.
  *
- * @private
- *
  * `["foo.bar", "foo.bang"]` becomes "(?:foo\.(?:bar|bang))"
  *
- * @param {array.<string>} rules - The set of rules compose into a regex.
- *
- * @return {string} The rules composed into a single regular expression string.
+ * @private
+ * @param {Array.<string>} rules - The set of rules compose into a regex.
+ * @returns {string} The rules composed into a single regular expression string.
  */
 function _convertRulesToRegex(rules) {
   return (
@@ -416,3 +405,24 @@ function _convertRulesToRegex(rules) {
     ')'
   ) // Step 5) Merge all the regex strings into one.
 }
+
+/**
+ * Helper method for updating our list of destinations
+ *
+ * @private
+ * @param {object} destinations list of destination ids
+ * @param {string} id destination id
+ * @param {boolean} result whether or not we found a match
+ * @returns {object} potentially modified list of destinations
+ */
+function _updateDestinations(destinations, id, result) {
+  if (result === NO_MATCH) {
+    // No match, no-op.
+  } else if (result) {
+    destinations |= id // Positive match, add it in.
+  } else {
+    destinations &= ~id // Negative match, remove it.
+  }
+
+  return destinations
+}

package/lib/config/default.js

@@ -5,8 +5,6 @@
 
 'use strict'
 
-/* eslint sonarjs/cognitive-complexity: ["error", 17] -- TODO: https://issues.newrelic.com/browse/NEWRELIC-5252*/
-
 const defaultConfig = module.exports
 const { array, int, float, boolean, object, objectList, allowList } = require('./formatters')
 
@@ -20,6 +18,8 @@ const { array, int, float, boolean, object, objectList, allowList } = require('.
  * an override if the env var does not follow our standard convention.  We should not have
  * to add any more overrides as all new configuration values should follow the convention of
  * `NEW_RELIC_PATH_TO_CONFIG_KEY`
+ *
+ * @returns {object} configuration definition
  */
 defaultConfig.definition = () => ({
   newrelic_home: {
@@ -438,7 +438,7 @@ defaultConfig.definition = () => ({
      * This flag dictates whether the agent attempts to read files
      * to get info about the container the process is running in.
      *
-     * @env NEW_RELIC_UTILIZATION_DETECT_DOCKER
+     * env NEW_RELIC_UTILIZATION_DETECT_DOCKER
      */
     detect_docker: {
       formatter: boolean,
@@ -547,7 +547,7 @@ defaultConfig.definition = () => ({
      * slow trace aggregator if no slow transactions have been recorded for the
      * last 5 harvest cycles, restarting the aggregation process.
      *
-     * @env NEW_RELIC_TRACER_TOP_N
+     * env NEW_RELIC_TRACER_TOP_N
      */
     top_n: {
       formatter: int,
@@ -604,7 +604,7 @@ defaultConfig.definition = () => ({
      *
      * By default, socket.io long-polling is ignored.
      *
-     * @env NEW_RELIC_IGNORING_RULES
+     * env NEW_RELIC_IGNORING_RULES
      */
     ignore: {
       formatter: array,
@@ -762,7 +762,7 @@ defaultConfig.definition = () => ({
        * Prefix of attributes to exclude in transaction events.
        * Allows * as wildcard at end.
        *
-       * @env NEW_RELIC_TRANSACTION_EVENTS_ATTRIBUTES_EXCLUDE
+       * env NEW_RELIC_TRANSACTION_EVENTS_ATTRIBUTES_EXCLUDE
        */
       exclude: {
         formatter: array,
@@ -772,7 +772,7 @@ defaultConfig.definition = () => ({
        * Prefix of attributes to include in transaction events.
        * Allows * as wildcard at end.
        *
-       * @env NEW_RELIC_TRANSACTION_EVENTS_ATTRIBUTES_INCLUDE
+       * env NEW_RELIC_TRANSACTION_EVENTS_ATTRIBUTES_INCLUDE
        */
       include: {
         formatter: array,
@@ -895,7 +895,7 @@ defaultConfig.definition = () => ({
      * Sets the maximum number of slow query samples that will be collected in a
      * single harvest cycle.
      *
-     * @env NEW_RELIC_MAX_SQL_SAMPLES
+     * env NEW_RELIC_MAX_SQL_SAMPLES
      */
     max_samples: {
       formatter: int,
@@ -906,9 +906,11 @@ defaultConfig.definition = () => ({
   /**
    * Controls behavior of datastore instance metrics.
    *
+   * @property {object} instance_reporting container around enabling flag
    * @property {boolean} [instance_reporting.enabled=true]
    *  Enables reporting the host and port/path/id of database servers. Default
    *  is `true`.
+   * @property {object} database_name_reporting container around enabling flag
    * @property {boolean} [database_name_reporting.enabled=true]
    *  Enables reporting of database/schema names. Default is `true`.
    */
@@ -1076,6 +1078,7 @@ defaultConfig.definition = () => ({
   /**
    * Controls behavior of message broker tracing.
    *
+   * @property {object} segment_parameters property around enabling flag
    * @property {boolean} [segment_parameters.enabled=true]
    *  Enables reporting parameters on message broker segments.
    */
@@ -1189,17 +1192,29 @@ defaultConfig.definition = () => ({
    * disallow the use of New Relic's server-side configuration for agents.
    * To do so, set this to true.
    *
-   * @env NEW_RELIC_IGNORE_SERVER_SIDE_CONFIG
+   * env NEW_RELIC_IGNORE_SERVER_SIDE_CONFIG
    */
   ignore_server_configuration: {
     formatter: boolean,
     default: false,
     env: 'NEW_RELIC_IGNORE_SERVER_SIDE_CONFIG'
+  },
+
+  /**
+   * Toggles whether to capture code.* attributes on spans
+   */
+  code_level_metrics: {
+    enabled: {
+      formatter: boolean,
+      default: false
+    }
   }
 })
 
 /**
  * Creates a new default config
+ *
+ * @returns {object} default configuration object
  */
 defaultConfig.config = () => {
   const config = Object.create(null)
@@ -1223,19 +1238,12 @@ function buildConfig(definition, config, paths = [], objectKeys = 1) {
     const type = typeof value
     keysSeen++
     if (type === 'string') {
-      if (paths.length) {
-        setNestedKey(conf, [...paths, key], value)
-      } else {
-        conf[key] = value
-      }
+      assignConfigValue({ config: conf, key, value, paths })
     } else if (type === 'object') {
       if (value.hasOwnProperty('default')) {
-        if (paths.length) {
-          setNestedKey(conf, [...paths, key], value.default)
-        } else {
-          conf[key] = value.default
-        }
+        assignConfigValue({ config: conf, key, value: value.default, paths })
       } else {
+        // add the current leaf node key to the paths and recurse through function again
         const { length } = Object.keys(value)
         paths.push(key)
         buildConfig(definition[key], conf, paths, length)
@@ -1252,6 +1260,24 @@ function buildConfig(definition, config, paths = [], objectKeys = 1) {
   }
 }
 
+/**
+ * Assigns a value to a configuration option. In the case of a nested key
+ * it will properly build the structure leading to the value
+ *
+ * @param {object} params args to fn
+ * @param {object} params.config object that is used to construct the agent config
+ * @param {string} params.key name of the configuration option
+ * @param {string} params.value value the configuration option
+ * @param {Array} [params.paths=[]] an array to capture the leaf node keys to properly assign defaults for nested objects
+ */
+function assignConfigValue({ config, key, value, paths }) {
+  if (paths.length) {
+    setNestedKey(config, [...paths, key], value)
+  } else {
+    config[key] = value
+  }
+}
+
 /**
  * Properly sets the value of a nested key by creating the shells of empty parents
  *