newrelic 9.5.0 → 9.7.0

package/NEWS.md

@@ -1,3 +1,17 @@
+### v9.7.0 (2022-11-14)
+
+* Added new configuration option, `grpc.ignore_status_codes`, which can be used to select nonzero gRPC status codes to ignore and not report as errors.
+
+### v9.6.0 (2022-11-09)
+
+* Dropped support for `vision`, and instead only instrument `@hapi/vision`.
+
+* Updated configuration system to automatically create an environment variable mapping for a new config value.
+   * It will follow a convention of `NEW_RELIC_PATH_TO_CONFIG_KEY`.
+   * For example if there is a new configuration option of `config.nested.object_path.enabled` the env var would be `NEW_RELIC_NESTED_OBJECT_PATH.ENABLED`.
+   
+* Removed `transaction_tracer.hide_internals` configuration. All of the internal configuration is now handled by Javascript symbols instead of non-enumerable properties, so there is no longer a performance penalty, as symbols are already hidden by default.
+
 ### v9.5.0 (2022-10-26)
 
 * Increased the default limit of custom events from 1,000 events per minute to 3,000 events per minute. In the scenario that custom events were being limited, this change will allow more custom events to be sent to New Relic. There is also a new configurable maximum limit of 100,000 events per minute. To change the limits, see the documentation for [custom_insights_events](https://docs.newrelic.com/docs/apm/agents/nodejs-agent/installation-configuration/nodejs-agent-configuration#custom_events_max_samples_stored). To learn more about the change and how to determine if custom events are being dropped, see our Explorers Hub [post](https://discuss.newrelic.com/t/send-more-custom-events-with-the-latest-apm-agents/190497).

package/api.js

@@ -5,6 +5,8 @@
 
 'use strict'
 
+/* eslint sonarjs/cognitive-complexity: ["error", 21] -- TODO: https://issues.newrelic.com/browse/NEWRELIC-5252 */
+
 const util = require('util')
 const logger = require('./lib/logger').child({ component: 'api' })
 const recordWeb = require('./lib/metrics/recorders/http')

package/bin/test-naming-rules.js

@@ -64,7 +64,7 @@ function run(opts) {
   let appliedRules = []
 
   // responsible for handling default rules provided by the server
-  const defaultNormalizer = loadDefaultNormalizer(config, runtimeRules)
+  const defaultNormalizer = loadDefaultNormalizer(config)
 
   // rules defined by user in local configuration file
   const userNormalizer = loadUserNormalizer(config, runtimeRules)

package/esm-loader.mjs

@@ -197,11 +197,9 @@ async function wrapEsmSource(url, specifier) {
     const _wrappedModule = wrapModule(_originalModule, '${specifier}', '${trimmedUrl}')
     ${props
       .map((propName) => {
-        const propertyExportSource = `
+        return `
     let _${propName} = _wrappedModule.${propName}
     export { _${propName} as ${propName} }`
-
-        return propertyExportSource
       })
       .join('\n')}
   `

package/index.js

@@ -14,6 +14,7 @@ require('./lib/util/unwrapped-core')
 
 const featureFlags = require('./lib/feature_flags').prerelease
 const psemver = require('./lib/util/process-version')
+const symbols = require('./lib/symbols')
 let logger = require('./lib/logger') // Gets re-loaded after initialization.
 
 const pkgJSON = require('./package.json')
@@ -23,15 +24,15 @@ logger.info(
   process.version
 )
 
-if (require.cache.__NR_cache) {
+if (require.cache[symbols.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')
+  if (require.cache[symbols.cache].agent) {
+    require.cache[symbols.cache].agent.recordSupportability('Agent/DoubleLoad')
   }
-  module.exports = require.cache.__NR_cache
+  module.exports = require.cache[symbols.cache]
 } else {
   initialize()
 }
@@ -98,7 +99,7 @@ function initialize() {
     API = require('./stub_api')
   }
 
-  require.cache.__NR_cache = module.exports = new API(agent)
+  require.cache[symbols.cache] = module.exports = new API(agent)
 
   // 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/adaptive-sampler.js

@@ -79,8 +79,7 @@ class AdaptiveSampler {
    * the number of objects sampled in this window.
    *
    * @param {number} roll - The number to compare against the threshold
-   *
-   * @return {bool} True if the object should be sampled.
+   * @returns {bool} True if the object should be sampled.
    */
   shouldSample(roll) {
     ++this._seen

package/lib/agent.js

@@ -5,6 +5,8 @@
 
 'use strict'
 
+/* eslint sonarjs/cognitive-complexity: ["error", 23] -- TODO: https://issues.newrelic.com/browse/NEWRELIC-5252 */
+
 const AdaptiveSampler = require('./adaptive-sampler')
 const CollectorAPI = require('./collector/api')
 const ServerlessCollector = require('./collector/serverless')

package/lib/aggregators/event-aggregator.js

@@ -76,7 +76,7 @@ class EventAggregator extends Aggregator {
   /**
    * Fetches all the span events aggregated.
    *
-   * @return {array.<Event>} An array of span events from the aggregator.
+   * @returns {Array.<Event>} An array of span events from the aggregator.
    */
   getEvents() {
     return this._items.toArray()
@@ -85,7 +85,7 @@ class EventAggregator extends Aggregator {
   /**
    * Resets the contents of the aggregator and all counters.
    *
-   * @return {PriorityQueue} The old collection of aggregated events.
+   * @returns {PriorityQueue} The old collection of aggregated events.
    */
   clearEvents() {
     // ???: might be more efficient to clear here and come up with an efficient way to

package/lib/attributes.js

@@ -22,7 +22,6 @@ class Attributes {
    * @param {string} scope
    *  The scope of the attributes this will collect. Must be `transaction` or
    *  `segment`.
-   *
    * @param {number} [limit=Infinity]
    *  The maximum number of attributes to retrieve for each destination.
    */
@@ -61,7 +60,7 @@ class Attributes {
    * attributes allowed, no more than that number will be included in the result.
    *
    * @param {AttributeFilter.DESTINATIONS} dest
-   * @return {object}
+   * @returns {object}
    */
   get(dest) {
     const attrs = Object.create(null)
@@ -168,8 +167,7 @@ class Attributes {
  * Creates a filter function for the given scope.
  *
  * @param {string} scope - The scope of the filter to make.
- *
- * @return {function} A function that performs attribute filtering for the given
+ * @returns {Function} A function that performs attribute filtering for the given
  *  scope.
  */
 function makeFilter(scope) {

package/lib/collector/api.js

@@ -5,6 +5,8 @@
 
 'use strict'
 
+/* eslint sonarjs/cognitive-complexity: ["error", 16] -- TODO: https://issues.newrelic.com/browse/NEWRELIC-5252 */
+
 const CollectorResponse = require('./response')
 const facts = require('./facts')
 const logger = require('../logger').child({ component: 'collector_api' })
@@ -89,6 +91,10 @@ function CollectorAPI(agent) {
   }
 }
 
+CollectorAPI.prototype._throwCallbackError = function _throwCallbackError() {
+  throw new TypeError('callback is required')
+}
+
 /**
  * Updates all methods except preconnect w/ new host/port pairs sent down from server
  * during preconnect (via redirect_host). Preconnect does not update.
@@ -107,7 +113,7 @@ CollectorAPI.prototype._updateEndpoints = function _updateEndpoints(endpoint) {
 
 CollectorAPI.prototype.connect = function connect(callback) {
   if (!callback) {
-    throw new TypeError('callback is required')
+    this._throwCallbackError()
   }
 
   logger.trace('Starting collector.')
@@ -376,7 +382,7 @@ CollectorAPI.prototype.reportSettings = function reportSettings(callback) {
  */
 CollectorAPI.prototype.error_data = function errorData(errors, callback) {
   if (!callback) {
-    throw new TypeError('callback is required')
+    this._throwCallbackError()
   }
   if (!errors) {
     return callback(new TypeError('must pass errors to send'))
@@ -387,7 +393,7 @@ CollectorAPI.prototype.error_data = function errorData(errors, callback) {
 
 CollectorAPI.prototype.error_event_data = function errorEvents(events, callback) {
   if (!callback) {
-    throw new TypeError('callback is required')
+    this._throwCallbackError()
   }
   if (!events) {
     return callback(new TypeError('must pass errors to send'))
@@ -403,7 +409,7 @@ CollectorAPI.prototype.analytic_event_data = transactionEvents
  */
 function transactionEvents(events, callback) {
   if (!callback) {
-    throw new TypeError('callback is required')
+    this._throwCallbackError()
   }
   if (!events) {
     return callback(new TypeError('must pass events to send'))
@@ -414,7 +420,7 @@ function transactionEvents(events, callback) {
 
 CollectorAPI.prototype.custom_event_data = function customEvents(events, callback) {
   if (!callback) {
-    throw new TypeError('callback is required')
+    this._throwCallbackError()
   }
   if (!events) {
     return callback(new TypeError('must pass events to send'))
@@ -441,7 +447,7 @@ CollectorAPI.prototype.custom_event_data = function customEvents(events, callbac
  */
 CollectorAPI.prototype.metric_data = function metricData(metrics, callback) {
   if (!callback) {
-    throw new TypeError('callback is required')
+    this._throwCallbackError()
   }
   if (!metrics) {
     return callback(new TypeError('must pass metrics to send'))
@@ -464,7 +470,7 @@ CollectorAPI.prototype.metric_data = function metricData(metrics, callback) {
  */
 CollectorAPI.prototype.sql_trace_data = function queryData(queries, callback) {
   if (!callback) {
-    throw new TypeError('callback is required')
+    this._throwCallbackError()
   }
   if (!queries) {
     return callback(new TypeError('must pass queries to send'))
@@ -474,7 +480,7 @@ CollectorAPI.prototype.sql_trace_data = function queryData(queries, callback) {
 
 CollectorAPI.prototype.span_event_data = function spanEvents(events, callback) {
   if (!callback) {
-    throw new TypeError('callback is required')
+    this._throwCallbackError()
   }
   if (!events) {
     return callback(new TypeError('must pass spans to send'))
@@ -503,7 +509,7 @@ CollectorAPI.prototype.transaction_sample_data = transactionSampleData
  */
 function transactionSampleData(traces, callback) {
   if (!callback) {
-    throw new TypeError('callback is required')
+    this._throwCallbackError()
   }
   if (!traces) {
     return callback(new TypeError('must pass traces to send'))
@@ -527,7 +533,7 @@ function transactionSampleData(traces, callback) {
  */
 CollectorAPI.prototype.log_event_data = function logEventData(logRecords, callback) {
   if (!callback) {
-    throw new TypeError('callback is required')
+    this._throwCallbackError()
   }
   if (!logRecords) {
     return callback(new TypeError('must pass logRecords to send'))
@@ -545,7 +551,7 @@ CollectorAPI.prototype.log_event_data = function logEventData(logRecords, callba
  */
 CollectorAPI.prototype.shutdown = function shutdown(callback) {
   if (!callback) {
-    throw new TypeError('callback is required')
+    this._throwCallbackError()
   }
 
   logger.info('Shutting down collector.')
@@ -620,6 +626,7 @@ CollectorAPI.prototype._sendData = function _sendData(method, data, callback) {
 
     // TODO: log the payload if exists?
 
+    /*
     if (response.agentRun === AGENT_RUN_BEHAVIOR.SHUTDOWN) {
       // TODO: for now, shut handled in _handleResponseCode for consistency
       // either find way to safely change while side-by-side or move
@@ -635,7 +642,8 @@ CollectorAPI.prototype._sendData = function _sendData(method, data, callback) {
       // })
 
       callback(null, { retainData: response.retainData })
-    } else if (response.agentRun === AGENT_RUN_BEHAVIOR.RESTART) {
+      */
+    if (response.agentRun === AGENT_RUN_BEHAVIOR.RESTART) {
       // TODO: almost seems better to leg aggregator finish (cb) then restart?
 
       // TODO: ensure harvesting stopped for all other endpoints. same for shutdown.

package/lib/collector/facts.js

@@ -142,13 +142,11 @@ function getAllIPAddresses() {
  * @param appNames
  */
 function getIdentifierOverride(appNames) {
-  const identifier = [
+  return [
     'nodejs',
     // NOTE: The concat is necessary to prevent sort from happening in-place.
     appNames.concat([]).sort().join(',')
   ].join(':')
-
-  return identifier
 }
 
 /**

package/lib/collector/parse-response.js

@@ -22,7 +22,9 @@ const logger = require('../logger').child({ component: 'new_relic_response' })
  *                                error, the value returned by the server
  *                                (if any), and the raw JSON of the
  *                                server's response.
- *
+ * @param name
+ * @param response
+ * @param callback
  * @returns Function Another callback that is meant to be invoked with
  *                   any errors from reading the response stream, as
  *                   well as a string containing the full response.

package/lib/collector/remote-method.js

@@ -16,6 +16,7 @@ const Sink = require('../util/stream-sink')
 const agents = require('./http-agents')
 const isValidLength = require('../util/byte-limit').isValidLength
 const { DATA_USAGE } = require('../metrics/names')
+const symbols = require('../symbols')
 
 function getMetricName(name) {
   return `${DATA_USAGE.PREFIX}/${name}/${DATA_USAGE.SUFFIX}`
@@ -249,12 +250,13 @@ RemoteMethod.prototype._safeRequest = function _safeRequest(options) {
 
   // If trace level is not explicitly enabled check to see if the audit log is
   // enabled.
-  if (logConfig != null && logConfig.level !== 'trace' && auditLog.enabled) {
-    // If the filter property is empty, then always log the event otherwise
-    // check to see if the filter includes this method.
-    if (auditLog.endpoints.length === 0 || auditLog.endpoints.indexOf(this.name) > -1) {
-      level = 'info'
-    }
+  if (
+    logConfig != null &&
+    logConfig.level !== 'trace' &&
+    auditLog.enabled &&
+    (auditLog.endpoints.length === 0 || auditLog.endpoints.indexOf(this.name) > -1)
+  ) {
+    level = 'info'
   }
 
   const logBody = Buffer.isBuffer(options.body) ? 'Buffer ' + options.body.length : options.body
@@ -295,7 +297,7 @@ RemoteMethod.prototype._request = function _request(options) {
     path: options.path,
     headers: this._headers(options),
     agent: agents.keepAliveAgent(),
-    __NR__connection: true // Who measures the metrics measurer?
+    [symbols.offTheRecord]: true // don't let the http instrumentation record this request
   }
   let request
 
@@ -348,12 +350,10 @@ RemoteMethod.prototype._path = function _path() {
     query[RUN_ID_NAME] = this._config.run_id
   }
 
-  const formatted = url.format({
+  return url.format({
     pathname: RAW_METHOD_PATH,
     query: query
   })
-
-  return formatted
 }
 
 /**

package/lib/config/attribute-filter.js

@@ -5,6 +5,8 @@
 
 '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 = {
@@ -52,7 +54,6 @@ exports.DESTINATIONS = DESTINATIONS
  *
  * @class
  * @private
- *
  * @param {Config} config - The configuration object for the agent.
  */
 function AttributeFilter(config) {
@@ -87,8 +88,7 @@ function AttributeFilter(config) {
  *
  * @param {DESTINATIONS}  destinations  - The locations the attribute wants to be put.
  * @param {string}        key           - The name of the attribute to test.
- *
- * @return {DESTINATIONS} The destinations the attribute should be put.
+ * @returns {DESTINATIONS} The destinations the attribute should be put.
  */
 AttributeFilter.prototype.filterTransaction = filterTransaction
 function filterTransaction(destinations, key) {
@@ -100,8 +100,7 @@ function filterTransaction(destinations, key) {
  *
  * @param {DESTINATIONS}  destinations  - The locations the attribute wants to be put.
  * @param {string}        key           - The name of the attribute to test.
- *
- * @return {DESTINATIONS} The destinations the attribute should be put.
+ * @returns {DESTINATIONS} The destinations the attribute should be put.
  */
 AttributeFilter.prototype.filterSegment = function filterSegment(destinations, key) {
   return this._filter(SEGMENT_SCOPE_DETAILS, destinations, key)
@@ -112,8 +111,7 @@ AttributeFilter.prototype.filterSegment = function filterSegment(destinations, k
  *
  * @param {DESTINATIONS}  destinations  - The locations the attribute wants to be put.
  * @param {string}        key           - The name of the attribute to test.
- *
- * @return {DESTINATIONS} The destinations the attribute should be put.
+ * @returns {DESTINATIONS} The destinations the attribute should be put.
  */
 AttributeFilter.prototype.filterAll = function filterSegment(destinations, key) {
   return this._filter(DESTINATION_DETAILS, destinations, key)
@@ -122,11 +120,10 @@ AttributeFilter.prototype.filterAll = function filterSegment(destinations, key)
 /**
  * Tests a given key against the global and destination filters.
  *
- * @param {array}         scope         - The destination details for filtering.
+ * @param {Array}         scope         - The destination details for filtering.
  * @param {DESTINATIONS}  destinations  - The locations the attribute wants to be put.
  * @param {string}        key           - The name of the attribute to test.
- *
- * @return {DESTINATIONS} The destinations the attribute should be put.
+ * @returns {DESTINATIONS} The destinations the attribute should be put.
  */
 AttributeFilter.prototype._filter = function _filter(scope, destinations, key) {
   // This method could be easily memoized since for a given destination and key
@@ -212,9 +209,12 @@ AttributeFilter.prototype.update = function update() {
 /**
  * Applies the global and destination rules to this key.
  *
+ * @param globalInclude
+ * @param globalExclude
+ * @param destConfig
+ * @param key
  * @private
- *
- * @return {bool|number} True if this key is explicitly included, false if it is
+ * @returns {bool|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) {
@@ -289,10 +289,8 @@ function _matchRules(rules, key) {
  * Converts the raw rules into a set of regular expressions to test against.
  *
  * @private
- *
- * @param {array.<string>} rules - The set of rules to compose.
- *
- * @return {object} An object with `exact` and `wildcard` properties which are
+ * @param {Array.<string>} rules - The set of rules to compose.
+ * @returns {object} An object with `exact` and `wildcard` properties which are
  * `RegExp` instances for testing keys.
  */
 function _importRules(rules) {