newrelic 7.5.2 → 8.3.0

package/bin/test-naming-rules.js

@@ -1,5 +1,4 @@
 #! /usr/bin/env node
-
 /*
  * Copyright 2020 New Relic Corporation. All rights reserved.
  * SPDX-License-Identifier: Apache-2.0
@@ -19,7 +18,7 @@ var options = null
 if (arrayContainsAny(process.argv, '-h', '-?', '--help')) {
   printHelp()
 } else if (process.argv.length === 3) {
-  options = {rules: null, urls: path.resolve(cwd, process.argv[2])}
+  options = { rules: null, urls: path.resolve(cwd, process.argv[2]) }
 } else if (process.argv.length === 4) {
   options = {
     rules: path.resolve(cwd, process.argv[2]),
@@ -73,8 +72,8 @@ function run(opts) {
   defaultNormalizer.on('appliedRule', onAppliedRule)
   userNormalizer.on('appliedRule', onAppliedRule)
 
-  var urlsFile = fs.createReadStream(opts.urls, {encoding: 'utf-8'})
-  var reader = readline.createInterface({input: urlsFile, output: null})
+  var urlsFile = fs.createReadStream(opts.urls, { encoding: 'utf-8' })
+  var reader = readline.createInterface({ input: urlsFile, output: null })
   reader.on('line', function onUrlLine(urlLine) {
     appliedRules = []
     var scrubbedUrl = urltils.scrub(urlLine)
@@ -93,7 +92,10 @@ function run(opts) {
         var match = appliedRules[i]
         console.log(
           ' %s: %s => %s (rule %s)',
-          (i + 1), match.original, match.normalized, match.rule.pattern
+          i + 1,
+          match.original,
+          match.normalized,
+          match.rule.pattern
         )
       }
     }
@@ -120,33 +122,37 @@ function loadDefaultNormalizer(config) {
   var normalizer = new MetricNormalizer(config, 'URL')
 
   // Add in the rules the collector would ship down.
-  normalizer.load([{
-    'match_expression':
-      '.*\\.(ace|arj|ini|txt|udl|plist|css|gif|ico|jpe?g|js|png|swf|woff|caf|' +
-      'aiff|m4v|mpe?g|mp3|mp4|mov)$',
-    'replacement': '/*.\\1',
-    'replace_all': false,
-    'each_segment': false,
-    'ignore': false,
-    'terminate_chain': true,
-    'eval_order': 1000
-  }, {
-    'match_expression': '^[0-9][0-9a-f_,.-]*$',
-    'replacement': '*',
-    'replace_all': false,
-    'each_segment': true,
-    'ignore': false,
-    'terminate_chain': false,
-    'eval_order': 1001
-  }, {
-    'match_expression': '^(.*)/[0-9][0-9a-f_,-]*\\.([0-9a-z][0-9a-z]*)$',
-    'replacement': '\\1/.*\\2',
-    'replace_all': false,
-    'each_segment': false,
-    'ignore': false,
-    'terminate_chain': false,
-    'eval_order': 1002
-  }])
+  normalizer.load([
+    {
+      match_expression:
+        '.*\\.(ace|arj|ini|txt|udl|plist|css|gif|ico|jpe?g|js|png|swf|woff|caf|' +
+        'aiff|m4v|mpe?g|mp3|mp4|mov)$',
+      replacement: '/*.\\1',
+      replace_all: false,
+      each_segment: false,
+      ignore: false,
+      terminate_chain: true,
+      eval_order: 1000
+    },
+    {
+      match_expression: '^[0-9][0-9a-f_,.-]*$',
+      replacement: '*',
+      replace_all: false,
+      each_segment: true,
+      ignore: false,
+      terminate_chain: false,
+      eval_order: 1001
+    },
+    {
+      match_expression: '^(.*)/[0-9][0-9a-f_,-]*\\.([0-9a-z][0-9a-z]*)$',
+      replacement: '\\1/.*\\2',
+      replace_all: false,
+      each_segment: false,
+      ignore: false,
+      terminate_chain: false,
+      eval_order: 1002
+    }
+  ])
 
   return normalizer
 }

package/bin/tracetractor

@@ -1,5 +1,4 @@
 #!/usr/bin/env node
-
 /*
  * Copyright 2020 New Relic Corporation. All rights reserved.
  * SPDX-License-Identifier: Apache-2.0

package/index.js

@@ -16,7 +16,6 @@ const featureFlags = require('./lib/feature_flags').prerelease
 const psemver = require('./lib/util/process-version')
 let logger = require('./lib/logger') // Gets re-loaded after initialization.
 
-
 const pkgJSON = require('./package.json')
 logger.info(
   'Using New Relic for Node.js. Agent version: %s; Node version: %s.',
@@ -43,24 +42,23 @@ function initialize() {
   let message = null
 
   try {
-    logger.debug(
-      'Process was running %s seconds before agent was loaded.',
-      preAgentTime
-    )
+    logger.debug('Process was running %s seconds before agent was loaded.', preAgentTime)
 
-    // TODO: Update this check when Node v10 is deprecated.
-    if (psemver.satisfies('<10.0.0')) {
-      message = 'New Relic for Node.js requires a version of Node equal to or\n' +
-                'greater than 10.0.0. Not starting!'
+    if (!psemver.satisfies(pkgJSON.engines.node)) {
+      // TODO: Update this message when Node v12 is deprecated.
+      message =
+        'New Relic for Node.js requires a version of Node equal to or\n' +
+        'greater than 12.0.0. Not starting!'
 
       logger.error(message)
       throw new Error(message)
+    }
 
-      // TODO: Update this check when Node v16 support is added
-    } else if (!psemver.satisfies(pkgJSON.engines.node) || psemver.satisfies('>=15.0.0')) {
+    // TODO: Update this check when Node v18 support is added
+    if (psemver.satisfies('>=17.0.0')) {
       logger.warn(
         'New Relic for Node.js %s has not been tested on Node.js %s. Please ' +
-        'update the agent or downgrade your version of Node.js',
+          'update the agent or downgrade your version of Node.js',
         pkgJSON.version,
         process.version
       )
@@ -131,9 +129,7 @@ function createAgent(config) {
   const appNames = agent.config.applications()
 
   if (config.logging.diagnostics) {
-    logger.warn(
-      'Diagnostics logging is enabled, this may cause significant overhead.'
-    )
+    logger.warn('Diagnostics logging is enabled, this may cause significant overhead.')
   }
 
   if (appNames.length < 1) {
@@ -175,9 +171,7 @@ function createAgent(config) {
 function addStartupSupportabilities(agent) {
   // TODO: As new versions come out, make sure to update Angler metrics.
   const nodeMajor = /^v?(\d+)/.exec(process.version)
-  agent.recordSupportability(
-    'Nodejs/Version/' + ((nodeMajor && nodeMajor[1]) || 'unknown')
-  )
+  agent.recordSupportability('Nodejs/Version/' + ((nodeMajor && nodeMajor[1]) || 'unknown'))
 
   const configFlags = Object.keys(agent.config.feature_flag)
   for (let i = 0; i < configFlags.length; ++i) {

package/lib/agent.js

@@ -57,7 +57,9 @@ const DEFAULT_HARVEST_INTERVAL_MS = 60000
 function Agent(config) {
   EventEmitter.call(this)
 
-  if (!config) throw new Error('Agent must be created with a configuration!')
+  if (!config) {
+    throw new Error('Agent must be created with a configuration!')
+  }
 
   // The agent base attributes which last throughout its lifetime.
   this._state = 'stopped'
@@ -84,10 +86,7 @@ function Agent(config) {
     this.collector
   )
 
-  this.metrics.on(
-    'starting metric_data data send.',
-    this._beforeMetricDataSend.bind(this)
-  )
+  this.metrics.on('starting metric_data data send.', this._beforeMetricDataSend.bind(this))
 
   this.spanEventAggregator = createSpanEventAggregator(config, this.collector, this.metrics)
 
@@ -126,7 +125,7 @@ function Agent(config) {
     this.collector
   )
 
-  const errorEventAggregator =  new ErrorEventAggregator(
+  const errorEventAggregator = new ErrorEventAggregator(
     {
       periodMs: config.event_harvest_config.report_period_ms,
       limit: config.event_harvest_config.harvest_limits.error_event_data
@@ -135,12 +134,7 @@ function Agent(config) {
     this.metrics
   )
 
-  this.errors = new ErrorCollector(
-    config,
-    errorTraceAggregator,
-    errorEventAggregator,
-    this.metrics
-  )
+  this.errors = new ErrorCollector(config, errorTraceAggregator, errorEventAggregator, this.metrics)
 
   // Transaction tracing.
   this.tracer = new Tracer(this)
@@ -195,15 +189,16 @@ util.inherits(Agent, EventEmitter)
  * @param {Function} callback Continuation and error handler.
  */
 Agent.prototype.start = function start(callback) {
-  if (!callback) throw new TypeError('callback required!')
+  if (!callback) {
+    throw new TypeError('callback required!')
+  }
 
   const agent = this
 
   this.setState('starting')
 
   if (this.config.agent_enabled !== true) {
-    logger.warn('The New Relic Node.js agent is disabled by its configuration. ' +
-                'Not starting!')
+    logger.warn('The New Relic Node.js agent is disabled by its configuration. ' + 'Not starting!')
 
     this.setState('stopped')
     return process.nextTick(callback)
@@ -216,9 +211,11 @@ Agent.prototype.start = function start(callback) {
   }
 
   if (!this.config.license_key) {
-    logger.error('A valid account license key cannot be found. ' +
-                 'Has a license key been specified in the agent configuration ' +
-                 'file or via the NEW_RELIC_LICENSE_KEY environment variable?')
+    logger.error(
+      'A valid account license key cannot be found. ' +
+        'Has a license key been specified in the agent configuration ' +
+        'file or via the NEW_RELIC_LICENSE_KEY environment variable?'
+    )
 
     this.setState('errored')
     sampler.stop()
@@ -232,40 +229,17 @@ Agent.prototype.start = function start(callback) {
     if (error || response.shouldShutdownRun()) {
       agent.setState('errored')
       sampler.stop()
-      callback(
-        error || new Error('Failed to connect to collector'),
-        response && response.payload
-      )
+      callback(error || new Error('Failed to connect to collector'), response && response.payload)
       return
     }
 
     if (agent.collector.isConnected()) {
-      agent.onConnect()
-      agent.setState('started')
       const config = response.payload
 
-      if (agent.config.no_immediate_harvest) {
-        agent.startAggregators()
+      const shouldImmediatelyHarvest = !agent.config.no_immediate_harvest
+      agent.onConnect(shouldImmediatelyHarvest, () => {
         callback(null, config)
-      } else {
-        // For data collection that streams immediately, dont delay capture/sending until
-        // the harvest of everything else has completed.
-        agent.startStreaming()
-
-        // Harvest immediately for quicker data display, but after at least 1
-        // second or the collector will throw away the data.
-        //
-        // NOTE: this setTimeout is deliberately NOT unref'd due to it being
-        // the last step in the Agent startup process
-        setTimeout(function afterTimeout() {
-          logger.info(`Starting initial ${INITIAL_HARVEST_DELAY_MS}ms harvest.`)
-
-          agent.forceHarvestAll(function afterAllAggregatorsSend() {
-            agent.startAggregators()
-            callback(null, config)
-          })
-        }, INITIAL_HARVEST_DELAY_MS)
-      }
+      })
     } else {
       callback(new Error('Collector did not connect and did not error'))
     }
@@ -281,12 +255,9 @@ Agent.prototype.forceHarvestAll = function forceHarvestAll(callback) {
   const promises = []
 
   const metricPromise = new Promise((resolve) => {
-    agent.metrics.once(
-      'finished metric_data data send.',
-      function onMetricsFinished() {
-        resolve()
-      }
-    )
+    agent.metrics.once('finished metric_data data send.', function onMetricsFinished() {
+      resolve()
+    })
     agent.metrics.send()
   })
 
@@ -341,12 +312,9 @@ Agent.prototype.forceHarvestAll = function forceHarvestAll(callback) {
 
   if (agent.config.transaction_tracer.enabled && agent.config.collect_traces) {
     const transactionTracePromise = new Promise((resolve) => {
-      agent.traces.once(
-        'finished transaction_sample_data data send.',
-        function onTracesFinished() {
-          resolve()
-        }
-      )
+      agent.traces.once('finished transaction_sample_data data send.', function onTracesFinished() {
+        resolve()
+      })
       agent.traces.send()
     })
 
@@ -355,20 +323,16 @@ Agent.prototype.forceHarvestAll = function forceHarvestAll(callback) {
 
   if (agent.config.slow_sql.enabled) {
     const sqlTracePromise = new Promise((resolve) => {
-      agent.queries.once(
-        'finished sql_trace_data data send.',
-        function onSqlTracesFinished() {
-          resolve()
-        }
-      )
+      agent.queries.once('finished sql_trace_data data send.', function onSqlTracesFinished() {
+        resolve()
+      })
       agent.queries.send()
     })
 
     promises.push(sqlTracePromise)
   }
 
-  const errorCollectorEnabled =
-    agent.config.error_collector && agent.config.error_collector.enabled
+  const errorCollectorEnabled = agent.config.error_collector && agent.config.error_collector.enabled
 
   if (errorCollectorEnabled && agent.config.collect_errors) {
     const errorTracePromise = new Promise((resolve) => {
@@ -436,8 +400,7 @@ Agent.prototype.startAggregators = function startAggregators() {
     this.queries.start()
   }
 
-  if (this.config.distributed_tracing.enabled &&
-      this.config.span_events.enabled) {
+  if (this.config.distributed_tracing.enabled && this.config.span_events.enabled) {
     this.spanEventAggregator.start()
   }
 
@@ -450,18 +413,58 @@ Agent.prototype.startAggregators = function startAggregators() {
   }
 }
 
-Agent.prototype.onConnect = function onConnect() {
-  this.metrics.reconfigure(this.config)
-  this.errors.reconfigure(this.config)
-  this.traces.reconfigure(this.config)
-  this.queries.reconfigure(this.config)
-  this.spanEventAggregator.reconfigure(this.config)
-  this.transactionEventAggregator.reconfigure(this.config)
-  this.customEventAggregator.reconfigure(this.config)
+/**
+ * Completes any final setup upon full connection to New Relic
+ * servers and sets the agent state to 'started'.
+ */
+Agent.prototype.onConnect = function onConnect(shouldImmediatelyHarvest, callback) {
+  this._reconfigureAggregators(this.config)
 
   if (this.config.certificates && this.config.certificates.length > 0) {
     this.metrics.getOrCreateMetric(NAMES.FEATURES.CERTIFICATES).incrementCallCount()
   }
+
+  this._scheduleHarvests(shouldImmediatelyHarvest, callback)
+
+  this.setState('started')
+}
+
+Agent.prototype._reconfigureAggregators = function _reconfigureAggregators(config) {
+  this.metrics.reconfigure(config)
+  this.errors.reconfigure(config)
+  this.traces.reconfigure(config)
+  this.queries.reconfigure(config)
+  this.spanEventAggregator.reconfigure(config)
+  this.transactionEventAggregator.reconfigure(config)
+  this.customEventAggregator.reconfigure(config)
+}
+
+Agent.prototype._scheduleHarvests = function _scheduleHarvests(shouldImmediatelyHarvest, callback) {
+  if (!shouldImmediatelyHarvest) {
+    this.startAggregators()
+    setImmediate(callback)
+    return
+  }
+
+  const agent = this
+
+  // For data collection that streams immediately, dont delay capture/sending until
+  // the harvest of everything else has completed.
+  agent.startStreaming()
+
+  // Harvest immediately for quicker data display, but after at least 1
+  // second or the collector will throw away the data.
+  //
+  // NOTE: this setTimeout is deliberately NOT unref'd due to it being
+  // the last step in the Agent startup process
+  setTimeout(function afterTimeout() {
+    logger.info(`Starting initial ${INITIAL_HARVEST_DELAY_MS}ms harvest.`)
+
+    agent.forceHarvestAll(function afterAllAggregatorsSend() {
+      agent.startAggregators()
+      callback()
+    })
+  }, INITIAL_HARVEST_DELAY_MS)
 }
 
 /**
@@ -471,9 +474,7 @@ Agent.prototype.onConnect = function onConnect() {
  * @param {Function} callback
  */
 Agent.prototype._serverlessModeStart = function _serverlessModeStart(callback) {
-  logger.info(
-    'New Relic for Node.js starting in serverless mode -- skipping connection process.'
-  )
+  logger.info('New Relic for Node.js starting in serverless mode -- skipping connection process.')
 
   setImmediate(() => callback(null, this.config))
 }
@@ -486,7 +487,9 @@ Agent.prototype._serverlessModeStart = function _serverlessModeStart(callback) {
  * current instrumentation and patch to the module loader.
  */
 Agent.prototype.stop = function stop(callback) {
-  if (!callback) throw new TypeError('callback required!')
+  if (!callback) {
+    throw new TypeError('callback required!')
+  }
 
   const agent = this
 
@@ -597,12 +600,15 @@ Agent.prototype._beforeMetricDataSend = function _beforeMetricDataSend() {
 Agent.prototype._generateEntityStatsAndClear = function _generateHarvestMetrics() {
   // Note some information about the size of this harvest.
   if (logger.traceEnabled()) {
-    logger.trace({
-      segmentTotal: this.totalActiveSegments,
-      harvestCreated: this.segmentsCreatedInHarvest,
-      harvestCleared: this.segmentsClearedInHarvest,
-      activeTransactions: this.activeTransactions
-    }, 'Entity stats on metric harvest')
+    logger.trace(
+      {
+        segmentTotal: this.totalActiveSegments,
+        harvestCreated: this.segmentsCreatedInHarvest,
+        harvestCleared: this.segmentsClearedInHarvest,
+        activeTransactions: this.activeTransactions
+      },
+      'Entity stats on metric harvest'
+    )
   }
 
   // Reset the counters.
@@ -618,7 +624,9 @@ Agent.prototype._generateEntityStatsAndClear = function _generateHarvestMetrics(
  * @param {object} configuration New config JSON from the collector.
  */
 Agent.prototype.reconfigure = function reconfigure(configuration) {
-  if (!configuration) throw new TypeError('must pass configuration')
+  if (!configuration) {
+    throw new TypeError('must pass configuration')
+  }
 
   this.config.onConnect(configuration)
 }
@@ -709,10 +717,8 @@ function _addIntrinsicAttrsFromTransaction(transaction) {
     }
   } else if (
     this.config.cross_application_tracer.enabled &&
-    !transaction.invalidIncomingExternalTransaction && (
-      transaction.referringTransactionGuid ||
-      transaction.includesOutboundRequests()
-    )
+    !transaction.invalidIncomingExternalTransaction &&
+    (transaction.referringTransactionGuid || transaction.includesOutboundRequests())
   ) {
     intrinsicAttributes['nr.guid'] = transaction.id
     intrinsicAttributes['nr.tripId'] = transaction.tripId || transaction.id
@@ -733,10 +739,8 @@ function _addIntrinsicAttrsFromTransaction(transaction) {
       intrinsicAttributes['nr.alternatePathHashes'] = alternatePathHashes
     }
     if (transaction.baseSegment && transaction.type === 'web') {
-      var apdex = (
-        this.config.web_transactions_apdex[transaction.getFullName()] ||
-        this.config.apdex_t
-      )
+      var apdex =
+        this.config.web_transactions_apdex[transaction.getFullName()] || this.config.apdex_t
       var duration = transaction.baseSegment.getDurationInMillis() / 1000
       intrinsicAttributes['nr.apdexPerfZone'] = calculateApdexZone(duration, apdex)
     }
@@ -764,17 +768,15 @@ function calculateApdexZone(duration, apdexT) {
 }
 
 Agent.prototype._addEventFromTransaction = function _addEventFromTransaction(tx) {
-  if (!this.config.transaction_events.enabled) return
+  if (!this.config.transaction_events.enabled) {
+    return
+  }
 
   const intrinsicAttributes = this._addIntrinsicAttrsFromTransaction(tx)
   const userAttributes = tx.trace.custom.get(DESTINATIONS.TRANS_EVENT)
   const agentAttributes = tx.trace.attributes.get(DESTINATIONS.TRANS_EVENT)
 
-  const event = [
-    intrinsicAttributes,
-    userAttributes,
-    agentAttributes
-  ]
+  const event = [intrinsicAttributes, userAttributes, agentAttributes]
 
   this.transactionEventAggregator.add(event, tx.priority || Math.random())
 }
@@ -822,9 +824,9 @@ Agent.prototype.setLambdaArn = function setLambdaArn(arn) {
   }
 }
 
-Agent.prototype.setLambdaFunctionVersion = function setLambdaFunctionVersion(function_version) {
+Agent.prototype.setLambdaFunctionVersion = function setLambdaFunctionVersion(functionVersion) {
   if (this.collector instanceof ServerlessCollector) {
-    this.collector.setLambdaFunctionVersion(function_version)
+    this.collector.setLambdaFunctionVersion(functionVersion)
   }
 }
 
@@ -865,12 +867,9 @@ Agent.prototype._listenForConfigChanges = function _listenForConfigChanges() {
   this.config.on('sampling_target', function updateSamplingTarget(target) {
     self.transactionSampler.samplingTarget = target
   })
-  this.config.on(
-    'sampling_target_period_in_seconds',
-    function updateSamplePeriod(period) {
-      self.transactionSampler.samplingPeriod = period * 1000
-    }
-  )
+  this.config.on('sampling_target_period_in_seconds', function updateSamplePeriod(period) {
+    self.transactionSampler.samplingPeriod = period * 1000
+  })
   this.config.on('event_harvest_config', function onHarvestConfigReceived(harvestConfig) {
     if (harvestConfig) {
       generateEventHarvestSupportMetrics(self, harvestConfig)
@@ -889,9 +888,7 @@ function generateEventHarvestSupportMetrics(agent, harvestConfig) {
 
   const analyticLimit = harvestLimits.analytic_event_data
   if (analyticLimit) {
-    const analyticLimitMetric = agent.metrics.getOrCreateMetric(
-      harvestLimitNames.ANALYTIC
-    )
+    const analyticLimitMetric = agent.metrics.getOrCreateMetric(harvestLimitNames.ANALYTIC)
     analyticLimitMetric.recordValue(analyticLimit)
   }
 

package/lib/aggregators/base-aggregator.js

@@ -6,7 +6,7 @@
 'use strict'
 
 const EventEmitter = require('events').EventEmitter
-const logger = require('../logger').child({component: 'base_aggregator'})
+const logger = require('../logger').child({ component: 'base_aggregator' })
 
 class Aggregator extends EventEmitter {
   constructor(opts, collector) {

package/lib/aggregators/event-aggregator.js

@@ -6,7 +6,7 @@
 'use strict'
 
 const Aggregator = require('./base-aggregator')
-const logger = require('../logger').child({component: 'event_aggregator'})
+const logger = require('../logger').child({ component: 'event_aggregator' })
 const PriorityQueue = require('../priority-queue')
 
 /**
@@ -49,7 +49,7 @@ class EventAggregator extends Aggregator {
 
     const didAdd = this.addEvent.apply(this, arguments)
 
-    if (didAdd && (this._items.overflow() === 0)) {
+    if (didAdd && this._items.overflow() === 0) {
       this._metrics.getOrCreateMetric(this._metricNames.SENT).incrementCallCount()
     } else {
       this._metrics.getOrCreateMetric(this._metricNames.DROPPED).incrementCallCount()
@@ -129,7 +129,9 @@ class EventAggregator extends Aggregator {
     const toMerge = Math.min(events.length, this.limit - this.length)
     logger.warn(
       'Merging %d of %d events into %s for next harvest',
-      toMerge, events.length, this.constructor.name
+      toMerge,
+      events.length,
+      this.constructor.name
     )
 
     const seen = events.length
@@ -140,9 +142,7 @@ class EventAggregator extends Aggregator {
     this._metrics.getOrCreateMetric(this._metricNames.SENT).incrementCallCount(sent)
 
     if (dropped > 0) {
-      this._metrics
-        .getOrCreateMetric(this._metricNames.DROPPED)
-        .incrementCallCount(dropped)
+      this._metrics.getOrCreateMetric(this._metricNames.DROPPED).incrementCallCount(dropped)
     }
 
     // merge modifies incoming events collection.