newrelic 13.4.0 → 13.6.0

package/lib/config/index.js

@@ -123,7 +123,8 @@ function Config(config) {
   this.primary_application_id = null
   this.trusted_account_ids = null
   this.trusted_account_key = null
-  this.sampling_target = 10
+
+  this.sampling_target = this.distributed_tracing.sampler.adaptive_sampling_target
   this.sampling_target_period_in_seconds = 60
   this.max_payload_size_in_bytes = DEFAULT_MAX_PAYLOAD_SIZE_IN_BYTES
 
@@ -184,9 +185,9 @@ function Config(config) {
     if (this.security_policies_token) {
       throw new Error(
         'Security Policies and High Security Mode cannot both be present ' +
-          'in the agent configuration. If Security Policies have been set ' +
-          'for your account, please ensure the security_policies_token is ' +
-          'set but high_security is disabled (default).'
+        'in the agent configuration. If Security Policies have been set ' +
+        'for your account, please ensure the security_policies_token is ' +
+        'set but high_security is disabled (default).'
       )
     }
     this._applyHighSecurity()
@@ -199,8 +200,20 @@ function Config(config) {
   this.parsedLabels = parseLabels(this.labels, logger)
   this.loggingLabels = this._setApplicationLoggingLabels()
 }
+
 util.inherits(Config, EventEmitter)
 
+// Expose sampling_target as an accessor that proxies to distributed_tracing.sampler.adaptive_sampling_target.
+Object.defineProperty(Config.prototype, 'sampling_target', {
+  get: function () {
+    return this.distributed_tracing.sampler.adaptive_sampling_target
+  },
+  set: function (value) {
+    this.distributed_tracing.sampler.adaptive_sampling_target = value
+    this.emit('sampling_target', value)
+  }
+})
+
 /**
  * Compares the labels list to the application logging excluded label list and removes any labels that need to be excluded.
  * Then prefixing each label with "tags."
@@ -264,9 +277,9 @@ Config.prototype.onConnect = function onConnect(json, recursion) {
     return
   }
 
-  Object.keys(json).forEach(function updateProp(key) {
+  for (const key of Object.keys(json)) {
     this._fromServer(json, key)
-  }, this)
+  }
 
   this._warnDeprecations()
 
@@ -639,11 +652,11 @@ Config.prototype._alwaysUpdateIfChanged = function _alwaysUpdateIfChanged(json,
   const value = json[key]
   if (value != null && this[key] !== value) {
     if (Array.isArray(value) && Array.isArray(this[key])) {
-      value.forEach(function pushIfNew(element) {
+      for (const element of value) {
         if (this[key].indexOf(element) === -1) {
           this[key].push(element)
         }
-      }, this)
+      }
     } else {
       this[key] = value
     }
@@ -690,16 +703,16 @@ function _validateThenUpdateStatusCodes(remote, local, remoteKey, localKey) {
   }
 
   let valid = true
-  valueToTest.forEach(function validateArray(thingToTest) {
+  for (const thingToTest of valueToTest) {
     if (!(typeof thingToTest === 'string' || typeof thingToTest === 'number')) {
       logger.warn(
         'Saw SSC (ignore|expect)_status_code that is not a number or string,' +
-          'will not merge: %s',
+        'will not merge: %s',
         thingToTest
       )
       valid = false
     }
-  })
+  }
   if (!valid) {
     return
   }
@@ -734,7 +747,7 @@ function _validateThenUpdateErrorClasses(remote, local, remoteKey, localKey) {
   }
 
   let valid = true
-  Object.keys(valueToTest).forEach(function validateArray(key) {
+  for (const key of Object.keys(valueToTest)) {
     const thingToTest = valueToTest[key]
     if (typeof thingToTest !== 'string') {
       logger.warn(
@@ -743,7 +756,7 @@ function _validateThenUpdateErrorClasses(remote, local, remoteKey, localKey) {
       )
       valid = false
     }
-  })
+  }
   if (!valid) {
     return
   }
@@ -788,13 +801,13 @@ function _validateThenUpdateErrorMessages(remote, local, remoteKey, localKey) {
   }
 
   let valid = true
-  Object.keys(valueToTest).forEach(function validateArray(key) {
+  for (const key of Object.keys(valueToTest)) {
     const arrayToTest = valueToTest[key]
     if (!Array.isArray(arrayToTest)) {
       logger.warn('Saw SSC message array that is not an array, will not merge: %s', arrayToTest)
       valid = false
     }
-  })
+  }
   if (!valid) {
     return
   }
@@ -858,7 +871,7 @@ Config.prototype.logDisabled = function logDisabled(json, key) {
   if (value != null) {
     logger.debug(
       'Server-side configuration of %s is currently disabled by local configuration. ' +
-        '(Server sent value of %s.)',
+      '(Server sent value of %s.)',
       key,
       value
     )
@@ -877,7 +890,7 @@ Config.prototype.logUnsupported = function logUnsupported(json, key) {
   if (value !== null && value !== undefined) {
     logger.debug(
       'Server-side configuration of %s is currently not supported by the ' +
-        'Node.js agent. (Server sent value of %s.)',
+      'Node.js agent. (Server sent value of %s.)',
       key,
       value
     )
@@ -1045,15 +1058,15 @@ Config.prototype._fromPassed = function _fromPassed(external, internal, arbitrar
     internal = this
   }
 
-  Object.keys(external).forEach(function overwrite(key) {
+  for (const key of Object.keys(external)) {
     // if it's not in the defaults, it doesn't exist
     if (!arbitrary && !(key in internal)) {
-      return
+      continue
     }
 
     if (key === 'ssl' && !isTruthular(external.ssl)) {
       logger.warn(SSL_WARNING)
-      return
+      continue
     }
 
     let node = null
@@ -1061,7 +1074,7 @@ Config.prototype._fromPassed = function _fromPassed(external, internal, arbitrar
       node = external[key]
     } catch {
       logger.warn('Error thrown on access of user config for key: %s', key)
-      return
+      continue
     }
 
     if (typeof node === 'object' && !Array.isArray(node) && !(node instanceof RegExp)) {
@@ -1071,7 +1084,7 @@ Config.prototype._fromPassed = function _fromPassed(external, internal, arbitrar
     } else {
       internal[key] = node
     }
-  }, this)
+  }
 }
 
 /**
@@ -1104,12 +1117,12 @@ Config.prototype._fromSpecial = function _fromSpecial() {
 Config.prototype._featureFlagsFromEnv = function _featureFlagsFromEnv() {
   const flags = Object.keys(featureFlag.prerelease).concat(featureFlag.released)
   const config = this
-  flags.forEach(function checkFlag(flag) {
+  for (const flag of flags) {
     const envVal = process.env['NEW_RELIC_FEATURE_FLAG_' + flag.toUpperCase()]
     if (envVal) {
       config.feature_flag[flag] = isTruthular(envVal)
     }
-  })
+  }
 }
 
 /**
@@ -1218,8 +1231,8 @@ Config.prototype._serverlessLogging = function _serverlessLogging(inputConfig) {
 
     logger.info(
       'Logging is disabled by default when serverless_mode is enabled. ' +
-        'If desired, enable logging via config file or environment variable and ' +
-        'set filepath to a valid path for current environment, stdout or stderr.'
+      'If desired, enable logging via config file or environment variable and ' +
+      'set filepath to a valid path for current environment, stdout or stderr.'
     )
   }
 }
@@ -1241,17 +1254,17 @@ Config.prototype._serverlessNativeMetrics = function _serverlessNativeMetrics(in
   ) {
     logger.info(
       'Enabling the native-metrics module when in serverless mode may greatly ' +
-        'increase cold-start times. Given the limited benefit of the VM metrics' +
-        'and general lack of control in a serverless environment, we do not ' +
-        'recommend this trade-off.'
+      'increase cold-start times. Given the limited benefit of the VM metrics' +
+      'and general lack of control in a serverless environment, we do not ' +
+      'recommend this trade-off.'
     )
   } else {
     this.plugins.native_metrics.enabled = false
 
     logger.info(
       'The native-metrics module is disabled by default when serverless_mode ' +
-        'is enabled.  If desired, enable the native-metrics module via config file ' +
-        'or environment variable.'
+      'is enabled.  If desired, enable the native-metrics module via config file ' +
+      'or environment variable.'
     )
   }
 }
@@ -1305,8 +1318,8 @@ Config.prototype._serverlessDT = function _serverlessDT() {
     if (this.distributed_tracing.enabled) {
       logger.warn(
         'Using distributed tracing in serverless mode requires account_id be ' +
-          'defined, either in your newrelic.js file or via environment variables. ' +
-          'Disabling distributed tracing.'
+        'defined, either in your newrelic.js file or via environment variables. ' +
+        'Disabling distributed tracing.'
       )
       this.distributed_tracing.enabled = false
     }
@@ -1328,16 +1341,16 @@ Config.prototype._serverlessDT = function _serverlessDT() {
  */
 Config.prototype._preventServerlessDT = function _preventServerlessDT() {
   // Don't allow DT config settings to be set if serverless_mode is disabled
-  SERVERLESS_DT_KEYS.forEach((key) => {
+  for (const key of SERVERLESS_DT_KEYS) {
     if (this[key]) {
       logger.warn(
         key +
-          ' was configured locally without enabling serverless_mode. ' +
-          'This local value will be ignored and set by the New Relic servers.'
+        ' was configured locally without enabling serverless_mode. ' +
+        'This local value will be ignored and set by the New Relic servers.'
       )
       this[key] = null
     }
-  })
+  }
 }
 
 /**
@@ -1489,7 +1502,9 @@ Config.prototype._applyHighSecurity = function _applyHighSecurity() {
   this.attributes.exclude.push('request.parameters.*')
 
   function checkNode(base, target, settings) {
-    Object.keys(settings).forEach(checkKey.bind(null, base, target, settings))
+    for (const key of Object.keys(settings)) {
+      checkKey(base, target, settings, key)
+    }
   }
 
   function checkKey(base, target, settings, key) {
@@ -1518,7 +1533,7 @@ Config.prototype._applyHighSecurity = function _applyHighSecurity() {
  * @param {Array} keys keys from a LASP policy
  * @returns {CollectorResponse} creates CollectorResponse with either preserve or shutdown
  */
-function _laspReponse(keys) {
+function _laspResponse(keys) {
   if (keys.length) {
     logger.error('The agent received one or more unexpected security policies and will shut down.')
     return CollectorResponse.fatal(null)
@@ -1530,7 +1545,7 @@ function _laspReponse(keys) {
  * Applies the server side LASP policies to a local configuration object
  *
  * @param {Agent} agent Agent instance
- * @param {bject} policies server side LASP policy
+ * @param {object} policies server side LASP policy
  * @returns {object} { missingRequired, finalPolicies } list of missing required fields and finalized LASP policy
  */
 Config.prototype._buildLaspPolicy = function _buildLaspPolicy(agent, policies) {
@@ -1604,18 +1619,18 @@ Config.prototype.applyLasp = function applyLasp(agent, policies) {
   const keys = Object.keys(policies)
 
   if (!this.security_policies_token) {
-    return _laspReponse(keys)
+    return _laspResponse(keys)
   }
 
   const { finalPolicies, missingRequired } = this._buildLaspPolicy(agent, policies)
 
   const missingLASP = []
-  Object.keys(LASP_MAP).forEach(function checkPolicy(name) {
+  for (const name of Object.keys(LASP_MAP)) {
     if (!policies[name]) {
       // agent is expecting a policy that was not sent from server -- fail
       missingLASP.push(name)
     }
-  })
+  }
 
   let fatalMessage = null
   if (missingLASP.length) {
@@ -1642,14 +1657,14 @@ Config.prototype.applyLasp = function applyLasp(agent, policies) {
 }
 
 Config.prototype.validateFlags = function validateFlags() {
-  Object.keys(this.feature_flag).forEach(function forEachFlag(key) {
+  for (const key of Object.keys(this.feature_flag)) {
     if (featureFlag.released.indexOf(key) > -1) {
       logger.warn('Feature flag %s has been released', key)
     }
     if (featureFlag.unreleased.indexOf(key) > -1) {
       logger.warn('Feature flag %s has been deprecated', key)
     }
-  })
+  }
 }
 
 function redactValue(value) {
@@ -1670,7 +1685,7 @@ function redactValue(value) {
  * Get a JSONifiable object containing all settings we want to report to the
  * collector and store in the environment_values table.
  *
- * @returns {object} containing simple key-value pairs of settings
+ * @returns {object|undefined} containing simple key-value pairs of settings, or undefined if an error occurred
  */
 Config.prototype.publicSettings = function publicSettings() {
   let settings = Object.create(null)

package/lib/config/merge-server-config.js

@@ -32,28 +32,28 @@ class MergeServerConfig {
   }
 
   updateArray(value, local, localKey) {
-    value.forEach((element) => {
+    for (const element of value) {
       if (local[localKey].indexOf(element) === -1) {
         local[localKey].push(element)
       }
-    })
+    }
   }
 
   updateObject(value, local, localKey) {
     // go through each key of the object and update it
-    Object.keys(value).forEach((element) => {
+    for (const element of Object.keys(value)) {
       if (Array.isArray(local[localKey][element]) && Array.isArray(value[element])) {
         // if both key-values are arrays, push the remote value onto the local array
-        value[element].forEach((elementValue) => {
+        for (const elementValue of value[element]) {
           if (local[localKey][element].indexOf(elementValue) === -1) {
             local[localKey][element].push(elementValue)
           }
-        })
+        }
       } else {
         // otherwise, replace the local value with the server value
         local[localKey][element] = value[element]
       }
-    })
+    }
   }
 }
 

package/lib/core-instrumentation.js

@@ -32,6 +32,10 @@ module.exports = {
     type: InstrumentationDescriptor.TYPE_TRANSACTION,
     file: 'http.js'
   },
+  http2: {
+    type: InstrumentationDescriptor.TYPE_TRANSACTION,
+    file: 'http2.js'
+  },
   inspector: {
     type: InstrumentationDescriptor.TYPE_GENERIC,
     file: 'inspector.js'

package/lib/db/query-parsers/elasticsearch.js

@@ -72,18 +72,19 @@ function parsePath(pathString, method) {
       operation = 'index.create'
       return { collection, operation }
     }
-    path.forEach((segment, idx) => {
+    for (let idx = 0; idx < path.length; idx++) {
+      const segment = path[idx]
       const prev = idx - 1
-      let opname
       if (segment === '_search') {
         collection = path?.[prev] || defaultCollection
         operation = 'search'
       } else if (segment[0] === '_') {
-        opname = segment.substring(1)
+        const 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

package/lib/db/query-parsers/sql.js

@@ -40,7 +40,7 @@ module.exports = function parseSql(sql) {
       try {
         logger.trace('parseSQL got an a non-string sql that looks like: %s', stringify(sql))
       } catch (err) {
-        logger.debug(err, 'Unabler to stringify SQL')
+        logger.debug(err, 'Unable to stringify SQL')
       }
     }
     return {

package/lib/environment.js

@@ -240,7 +240,7 @@ function getGlobalPackages() {
  */
 function flattenVersions(packages) {
   const info = Object.create(null)
-  packages.forEach((pair) => {
+  for (const pair of packages) {
     const p = pair[0]
     const v = pair[1]
 
@@ -251,7 +251,7 @@ function flattenVersions(packages) {
     } else {
       info[p] = [v]
     }
-  })
+  }
 
   return Object.keys(info)
     .map((key) => [key, info[key].join(', ')])
@@ -277,7 +277,7 @@ function flattenVersions(packages) {
 function remapConfigSettings() {
   if (process.config && process.config.variables) {
     const variables = process.config.variables
-    Object.keys(variables).forEach((key) => {
+    for (const key of Object.keys(variables)) {
       if (remapping[key]) {
         let value = variables[key]
 
@@ -290,7 +290,7 @@ function remapConfigSettings() {
 
         addSetting(remapping[key], value)
       }
-    })
+    }
 
     addMissingProcessVars()
   }
@@ -334,10 +334,10 @@ async function getOtherPackages() {
     2
   )
 
-  otherPackages.forEach((pkg) => {
+  for (const pkg of otherPackages) {
     other.packages.push.apply(other.packages, pkg.packages)
     other.dependencies.push.apply(other.dependencies, pkg.dependencies)
-  })
+  }
 
   _log('Done getting other packages')
   return other
@@ -442,21 +442,21 @@ function refreshSyncOnly() {
   settings = Object.create(null)
   // add persisted settings
   if (framework.length) {
-    framework.forEach(function addFrameworks(fw) {
+    for (const fw of framework) {
       addSetting('Framework', fw)
-    })
+    }
   }
 
   if (dispatcher.length) {
-    dispatcher.forEach(function addDispatchers(d) {
+    for (const d of dispatcher) {
       addSetting('Dispatcher', d)
-    })
+    }
   }
 
   if (dispatcherVersion.length) {
-    dispatcher.forEach(function addDispatchers(d) {
+    for (const d of dispatcher) {
       addSetting(DISPATCHER_VERSION, d)
-    })
+    }
   }
 
   gatherEnv()
@@ -498,11 +498,11 @@ async function getJSON() {
   }
 
   const items = []
-  Object.keys(settings).forEach(function settingKeysForEach(key) {
-    settings[key].forEach(function settingsValuesForEach(setting) {
+  for (const [key, value] of Object.entries(settings)) {
+    for (const setting of value) {
       items.push([key, setting])
-    })
-  })
+    }
+  }
   _log('JSON got')
   return items
 }

package/lib/errors/index.js

@@ -58,7 +58,7 @@ class Exception {
  * because everything's an object in JS. I'm not entirely sure why we do this, but
  * weird enough to make note of
  *
- * @param {Transaction} transaction  The agent transaction, coming from the instrumentatation
+ * @param {Transaction} transaction  The agent transaction, coming from the instrumentation
  * @param {Exception}   exception    An custom Exception object with the error and other information
  * @param {object}      config       The configuration to use when creating the object
  * @returns {Array} an Array of Error information, [0] -> placeholder,

package/lib/harvester.js

@@ -18,11 +18,11 @@ module.exports = class Harvester {
    * Calls start on every registered aggregator that is enabled.
    */
   start() {
-    this.aggregators.forEach((aggregator) => {
+    for (const aggregator of this.aggregators) {
       if (aggregator.enabled) {
         aggregator.start()
       }
-    })
+    }
   }
 
   /**
@@ -57,7 +57,9 @@ module.exports = class Harvester {
    * Calls stop on every registered aggregator.
    */
   stop() {
-    this.aggregators.forEach((aggregator) => aggregator.stop())
+    for (const aggregator of this.aggregators) {
+      aggregator.stop()
+    }
   }
 
   /**
@@ -66,15 +68,15 @@ module.exports = class Harvester {
    * @param {object} config updated agent configuration
    */
   update(config) {
-    this.aggregators.forEach((aggregator) => {
+    for (const aggregator of this.aggregators) {
       aggregator.reconfigure(config)
-    })
+    }
   }
 
   /**
    * Registers an aggregator with the Harvester instance.
    *
-   * @param {Object} aggregator Aggregator instance
+   * @param {object} aggregator Aggregator instance
    */
   add(aggregator) {
     this.aggregators.push(aggregator)

package/lib/header-attributes.js

@@ -78,9 +78,9 @@ _setHeaderAttrNames(REQUEST_HEADER_NAMES, REQUEST_HEADER_PREFIX)
 _setHeaderAttrNames(RESPONSE_HEADER_NAMES, RESPONSE_HEADER_PREFIX)
 
 function _setHeaderAttrNames(dest, prefix) {
-  Object.keys(HEADER_ATTR_NAMES).forEach(function forEachHeader(h) {
-    dest[h] = prefix + HEADER_ATTR_NAMES[h]
-  })
+  for (const header of Object.keys(HEADER_ATTR_NAMES)) {
+    dest[header] = prefix + HEADER_ATTR_NAMES[header]
+  }
 }
 
 function _headerToCamelCase(header) {

package/lib/header-processing.js

@@ -15,8 +15,8 @@ const CONTENT_LENGTH_REGEX = /^Content-Length$/i
  * Queue time is provided by certain providers by stamping the request
  * header with the time the request arrived at the router.
  *
- * @param {Object} logger Logger instance
- * @param {Object} requestHeaders Incoming request headers
+ * @param {object} logger Logger instance
+ * @param {object} requestHeaders Incoming request headers
  */
 function getQueueTime(logger, requestHeaders) {
   const headerValue = requestHeaders[REQUEST_START_HEADER] || requestHeaders[QUEUE_HEADER]
@@ -62,7 +62,7 @@ function convertUnit(time) {
  *
  * If no header is found, returns -1
  *
- * @param {Object} headers Incoming request headers
+ * @param {object} headers Incoming request headers
  */
 function getContentLengthFromHeaders(headers) {
   const contentLength = -1

package/lib/health-reporter.js

@@ -112,7 +112,7 @@ class HealthReporter {
    * object that has an `agent_control` property which is an instance of
    * {@link AgentControlConfig}.
    * @param {object} [params.logger] A standard logger instance.
-   * @param {function} [params.setInterval] A function to use as `setInterval`.
+   * @param {Function} [params.setInterval] A function to use as `setInterval`.
    * Must return an interval object that supports the `unref()` method.
    */
   constructor({
@@ -217,7 +217,7 @@ class HealthReporter {
    * initiate an immediate write of the status file, and then invoke the
    * provided callback.
    *
-   * @param {function} done Callback to be invoked after the status file has
+   * @param {Function} done Callback to be invoked after the status file has
    * been updated.
    */
   stop(done) {