newrelic 9.6.0 → 9.7.1

package/lib/agent.js

@@ -14,7 +14,6 @@ const ErrorCollector = require('./errors/error-collector')
 const ErrorTraceAggregator = require('./errors/error-trace-aggregator')
 const ErrorEventAggregator = require('./errors/error-event-aggregator')
 const EventEmitter = require('events').EventEmitter
-const hashes = require('./util/hashes')
 const logger = require('./logger')
 const LogAggregator = require('./aggregators/log-aggregator')
 const MetricMapper = require('./metrics/mapper')
@@ -31,6 +30,15 @@ const uninstrumented = require('./uninstrumented')
 const util = require('util')
 const createSpanEventAggregator = require('./spans/create-span-event-aggregator')
 const createContextManager = require('./context-manager/create-context-manager')
+const {
+  maybeAddDatabaseAttributes,
+  maybeAddExternalAttributes,
+  addRequiredCATAttributes,
+  maybeAddExtraCATAttributes,
+  maybeAddParentAttributes,
+  maybeAddQueueAttributes,
+  maybeAddSyntheticAttributes
+} = require('./util/attributes')
 
 // Map of valid states to whether or not data collection is valid
 const STATES = {
@@ -56,7 +64,7 @@ const DEFAULT_HARVEST_INTERVAL_MS = 60000
  * available. Don't try to recover here, because without configuration the
  * agent can't be brought up to a useful state.
  *
- * @param config
+ * @param {object} config Agent configuration object
  */
 function Agent(config) {
   EventEmitter.call(this)
@@ -199,8 +207,8 @@ util.inherits(Agent, EventEmitter)
  * managed by index.js. An agent will be created even if the agent's disabled by
  * the configuration.
  *
- * @config {boolean} agent_enabled Whether to start up the agent.
  * @param {Function} callback Continuation and error handler.
+ * @returns {void}
  */
 Agent.prototype.start = function start(callback) {
   if (!callback) {
@@ -454,8 +462,8 @@ Agent.prototype.startAggregators = function startAggregators() {
  * Completes any final setup upon full connection to New Relic
  * servers and sets the agent state to 'started'.
  *
- * @param shouldImmediatelyHarvest
- * @param callback
+ * @param {boolean} shouldImmediatelyHarvest Whether we should immediately schedule a harvest, or wait a cycle
+ * @param {Function} callback callback function that executes after harvest completes (now if immediate, otherwise later)
  */
 Agent.prototype.onConnect = function onConnect(shouldImmediatelyHarvest, callback) {
   this._reconfigureAggregators(this.config)
@@ -514,7 +522,7 @@ Agent.prototype._scheduleHarvests = function _scheduleHarvests(shouldImmediately
  *  Bypasses standard collector connection by immediately invoking the startup
  *  callback, after gathering local environment details.
  *
- * @param {Function} callback
+ * @param {Function} callback Immediately invoked callback
  */
 Agent.prototype._serverlessModeStart = function _serverlessModeStart(callback) {
   logger.info('New Relic for Node.js starting in serverless mode -- skipping connection process.')
@@ -529,7 +537,7 @@ Agent.prototype._serverlessModeStart = function _serverlessModeStart(callback) {
  * "hard" restart. This requires working with shimmer to strip the
  * current instrumentation and patch to the module loader.
  *
- * @param callback
+ * @param {Function} callback callback function to invoke after agent stop
  */
 Agent.prototype.stop = function stop(callback) {
   if (!callback) {
@@ -587,9 +595,6 @@ Agent.prototype._resetEvents = function resetEvents() {
 
 /**
  * Resets custom events.
- *
- * @param {boolean} forceReset
- *   Flag signalling unconditional reset, sent during LASP application.
  */
 Agent.prototype._resetCustomEvents = function resetCustomEvents() {
   this.customEventAggregator.clear()
@@ -696,6 +701,8 @@ Agent.prototype.setState = function setState(newState) {
 /**
  * Return true if the agent is in a run state that can collect and
  * process data.
+ *
+ * @returns {boolean} Whether or not the agent can collect data in its current state
  */
 Agent.prototype.canCollectData = function canCollectData() {
   return STATES[this._state]
@@ -735,84 +742,26 @@ function _addIntrinsicAttrsFromTransaction(transaction) {
     error: transaction.hasErrors()
   }
 
-  let metric = transaction.metrics.getMetric(NAMES.QUEUETIME)
-  if (metric) {
-    intrinsicAttributes.queueDuration = metric.total
-  }
-
-  metric = transaction.metrics.getMetric(NAMES.EXTERNAL.ALL)
-  if (metric) {
-    intrinsicAttributes.externalDuration = metric.total
-    intrinsicAttributes.externalCallCount = metric.callCount
-  }
-
-  metric = transaction.metrics.getMetric(NAMES.DB.ALL)
-  if (metric) {
-    intrinsicAttributes.databaseDuration = metric.total
-    intrinsicAttributes.databaseCallCount = metric.callCount
-  }
+  maybeAddQueueAttributes(transaction, intrinsicAttributes)
+  maybeAddExternalAttributes(transaction, intrinsicAttributes)
+  maybeAddDatabaseAttributes(transaction, intrinsicAttributes)
+  maybeAddSyntheticAttributes(transaction, intrinsicAttributes)
 
   if (this.config.distributed_tracing.enabled) {
     transaction.addDistributedTraceIntrinsics(intrinsicAttributes)
-    if (transaction.parentSpanId) {
-      intrinsicAttributes.parentSpanId = transaction.parentSpanId
-    }
-
-    if (transaction.parentId) {
-      intrinsicAttributes.parentId = transaction.parentId
-    }
+    maybeAddParentAttributes(transaction, intrinsicAttributes)
   } else if (
     this.config.cross_application_tracer.enabled &&
     !transaction.invalidIncomingExternalTransaction &&
     (transaction.referringTransactionGuid || transaction.includesOutboundRequests())
   ) {
-    intrinsicAttributes['nr.guid'] = transaction.id
-    intrinsicAttributes['nr.tripId'] = transaction.tripId || transaction.id
-    intrinsicAttributes['nr.pathHash'] = hashes.calculatePathHash(
-      this.config.applications()[0],
-      transaction.getFullName(),
-      transaction.referringPathHash
-    )
-    if (transaction.referringPathHash) {
-      intrinsicAttributes['nr.referringPathHash'] = transaction.referringPathHash
-    }
-    if (transaction.referringTransactionGuid) {
-      const refId = transaction.referringTransactionGuid
-      intrinsicAttributes['nr.referringTransactionGuid'] = refId
-    }
-    const alternatePathHashes = transaction.alternatePathHashes()
-    if (alternatePathHashes) {
-      intrinsicAttributes['nr.alternatePathHashes'] = alternatePathHashes
-    }
-    if (transaction.baseSegment && transaction.type === 'web') {
-      const apdex =
-        this.config.web_transactions_apdex[transaction.getFullName()] || this.config.apdex_t
-      const duration = transaction.baseSegment.getDurationInMillis() / 1000
-      intrinsicAttributes['nr.apdexPerfZone'] = calculateApdexZone(duration, apdex)
-    }
-  }
-
-  if (transaction.syntheticsData) {
-    intrinsicAttributes['nr.syntheticsResourceId'] = transaction.syntheticsData.resourceId
-    intrinsicAttributes['nr.syntheticsJobId'] = transaction.syntheticsData.jobId
-    intrinsicAttributes['nr.syntheticsMonitorId'] = transaction.syntheticsData.monitorId
+    addRequiredCATAttributes(transaction, intrinsicAttributes, this.config)
+    maybeAddExtraCATAttributes(transaction, intrinsicAttributes, this.config)
   }
 
   return intrinsicAttributes
 }
 
-function calculateApdexZone(duration, apdexT) {
-  if (duration <= apdexT) {
-    return 'S' // satisfied
-  }
-
-  if (duration <= apdexT * 4) {
-    return 'T' // tolerating
-  }
-
-  return 'F' // frustrated
-}
-
 Agent.prototype._addEventFromTransaction = function _addEventFromTransaction(tx) {
   if (!this.config.transaction_events.enabled) {
     return
@@ -831,7 +780,7 @@ Agent.prototype._addEventFromTransaction = function _addEventFromTransaction(tx)
  * Put all the logic for handing finalized transactions off to the tracers and
  * metric collections in one place.
  *
- * @param {Transaction} transaction Newly-finalized transaction.
+ * @param {object} transaction Newly-finalized transaction.
  */
 Agent.prototype._transactionFinished = function _transactionFinished(transaction) {
   // Allow the API to explicitly set the ignored status.
@@ -879,7 +828,7 @@ Agent.prototype.setLambdaFunctionVersion = function setLambdaFunctionVersion(fun
 /**
  * Get the current transaction (if there is one) from the tracer.
  *
- * @returns {Transaction} The current transaction.
+ * @returns {object} The current transaction.
  */
 Agent.prototype.getTransaction = function getTransaction() {
   return this.tracer.getTransaction()
@@ -936,7 +885,7 @@ Agent.prototype._listenForConfigChanges = function _listenForConfigChanges() {
  *   utilization.full_hostname. If utilization.full_hostname is null or empty,
  *   this will be the hostname specified in the connect request as host.
  *
- * @returns {LinkingMetadata} The linking object with the data above
+ * @returns {object} The LinkingMetadata object with the data above
  */
 Agent.prototype.getLinkingMetadata = function getLinkingMetadata() {
   const segment = this.tracer.getSegment()
@@ -986,7 +935,7 @@ Agent.prototype.getNRLinkingMetadata = function getNRLinkingMetadata() {
    * Retries value for a given key but defaults to `` if falsey
    *
    * @param {string} key in linking metadata
-   * @returns {string}
+   * @returns {string} Metadata value or empty string
    */
   function getValue(key) {
     return metadata[key] || ''
@@ -1037,7 +986,7 @@ function generateEventHarvestSupportMetrics(agent, harvestConfig) {
  * Increments the call counts of application logging supportability metrics
  * on every connect cycle
  *
- * @param {Agent} agent
+ * @param {object} agent Instantiation of Node.js agent
  */
 function generateLoggingSupportMetrics(agent) {
   const loggingConfig = agent.config.application_logging

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) {