newrelic 7.5.2 → 8.3.0

package/lib/transaction/trace/aggregator.js

@@ -5,7 +5,7 @@
 
 'use strict'
 const a = require('async')
-const logger = require('../../logger').child({component: 'Transaction Trace Aggregator'})
+const logger = require('../../logger').child({ component: 'Transaction Trace Aggregator' })
 
 /*
  *
@@ -32,23 +32,22 @@ class TransactionTraceAggregator extends TraceAggregator {
 
     super(opts, collector)
     /*
-    * From
-    *
-    * https://newrelic.atlassian.net/wiki/display/eng/Transaction+Trace+Collection+Improvements
-    *
-    * 5 Transaction Trace Guarantee
-    *
-    * For the initial experience problem, the Agent will sample up to 1
-    * transaction per minute until it has sampled 5 transactions. This
-    * guarantees that the agent will always report some transaction traces.
-    * There is no time out for this sampling period - the agent always
-    * samples until it has collected 5 transactions. The agent doesn't
-    * simply report the first 5 transactions that it sees because it's
-    * likely (particularly for a local dev test) that all 5 transactions
-    * would be associated with one request (a single web page and its
-    * resources).
-    */
-
+     * From
+     *
+     * https://newrelic.atlassian.net/wiki/display/eng/Transaction+Trace+Collection+Improvements
+     *
+     * 5 Transaction Trace Guarantee
+     *
+     * For the initial experience problem, the Agent will sample up to 1
+     * transaction per minute until it has sampled 5 transactions. This
+     * guarantees that the agent will always report some transaction traces.
+     * There is no time out for this sampling period - the agent always
+     * samples until it has collected 5 transactions. The agent doesn't
+     * simply report the first 5 transactions that it sees because it's
+     * likely (particularly for a local dev test) that all 5 transactions
+     * would be associated with one request (a single web page and its
+     * resources).
+     */
 
     const config = opts.config
     this.reported = 0
@@ -56,8 +55,7 @@ class TransactionTraceAggregator extends TraceAggregator {
 
     // Setting up top n capacity.
     this.capacity = 1
-    if (config.transaction_tracer &&
-        config.transaction_tracer.top_n) {
+    if (config.transaction_tracer && config.transaction_tracer.top_n) {
       this.capacity = config.transaction_tracer.top_n
     }
 
@@ -69,22 +67,22 @@ class TransactionTraceAggregator extends TraceAggregator {
   }
 
   /**
-  * For every five harvest cycles (or "minutes"), if no new slow transactions
-  * have been added, reset the requestTime match and allow a new set of five
-  * to start populating the Top N Slow Trace list.
-  */
+   * For every five harvest cycles (or "minutes"), if no new slow transactions
+   * have been added, reset the requestTime match and allow a new set of five
+   * to start populating the Top N Slow Trace list.
+   */
   resetTimingTracker() {
     this.requestTimes = Object.create(null)
     this.noTraceSubmitted = 0
   }
 
   /**
-  * Add a trace to the slow trace list, if and only if it fulfills the necessary
-  * criteria.
-  *
-  * @param {Transaction} transaction The transaction, which we need to check
-  *                                  apdexT, as well as getting the trace.
-  */
+   * Add a trace to the slow trace list, if and only if it fulfills the necessary
+   * criteria.
+   *
+   * @param {Transaction} transaction The transaction, which we need to check
+   *                                  apdexT, as well as getting the trace.
+   */
   add(transaction) {
     if (!transaction) {
       return
@@ -124,8 +122,8 @@ class TransactionTraceAggregator extends TraceAggregator {
   }
 
   /**
-  * Reset the trace diversity settings.
-  */
+   * Reset the trace diversity settings.
+   */
   clear() {
     this.trace = null
     this.syntheticsTraces = []
@@ -184,10 +182,7 @@ class TransactionTraceAggregator extends TraceAggregator {
       return null
     }
 
-    return [
-      this.runId,
-      traces.map((trace) => trace.generateJSONSync())
-    ]
+    return [this.runId, traces.map((trace) => trace.generateJSONSync())]
   }
 
   _toPayload(callback) {
@@ -209,75 +204,85 @@ class TransactionTraceAggregator extends TraceAggregator {
   }
 
   /**
-  * Determine whether a new trace is more worth keeping than an old one.
-  * This gets called on every single transactionFinished event, so return as
-  * quickly as possible and call as few external functions as possible. On the
-  * converse, there's some complicated logic here, so spell things out.
-  *
-  * All specifications are from
-  * https://newrelic.atlassian.net/wiki/display/eng/Transaction+Trace+Collection+Improvements
-  *
-  * @param {string} name     Name of this transaction's key metric.
-  * @param {number} duration Time the transaction took, in milliseconds.
-  * @param {number} apdexT   Apdex tolerating threshold, in seconds.
-  */
+   * Determine whether a new trace is more worth keeping than an old one.
+   * This gets called on every single transactionFinished event, so return as
+   * quickly as possible and call as few external functions as possible. On the
+   * converse, there's some complicated logic here, so spell things out.
+   *
+   * All specifications are from
+   * https://newrelic.atlassian.net/wiki/display/eng/Transaction+Trace+Collection+Improvements
+   *
+   * @param {string} name     Name of this transaction's key metric.
+   * @param {number} duration Time the transaction took, in milliseconds.
+   * @param {number} apdexT   Apdex tolerating threshold, in seconds.
+   */
   isBetter(name, duration, apdexT) {
     /* 1. If the transaction duration is below the tracing threshold, the
-    *    transaction is skipped.
-    *
-    * The threshold for slow traces defaults to apdex_f, which is 4 * apdex_t.
-    */
+     *    transaction is skipped.
+     *
+     * The threshold for slow traces defaults to apdex_f, which is 4 * apdex_t.
+     */
     const config = this.config.transaction_tracer
     let isOverThreshold
 
-    if (config &&
-        config.transaction_threshold != null &&
-        config.transaction_threshold !== 'apdex_f' &&
-        typeof config.transaction_threshold === 'number') {
+    if (
+      config &&
+      config.transaction_threshold != null &&
+      config.transaction_threshold !== 'apdex_f' &&
+      typeof config.transaction_threshold === 'number'
+    ) {
       isOverThreshold = duration >= config.transaction_threshold * TO_MILLIS
     } else {
       isOverThreshold = duration >= 4 * TO_MILLIS * apdexT
     }
-    if (!isOverThreshold) return false
+    if (!isOverThreshold) {
+      return false
+    }
 
     /* 2. If the transaction duration is less than the duration of the current
-    *    slow transaction, the transaction is skipped.
-    */
+     *    slow transaction, the transaction is skipped.
+     */
     let slowerThanExisting = true
     if (this.trace) {
       slowerThanExisting = this.trace.getDurationInMillis() < duration
     }
-    if (!slowerThanExisting) return false
+    if (!slowerThanExisting) {
+      return false
+    }
 
     /* We always gather some slow transactions at the start, regardless of
-    * the size of Top N. This changes the behavior of the rest of the
-    * decision-making process in some subtle ways.
-    */
+     * the size of Top N. This changes the behavior of the rest of the
+     * decision-making process in some subtle ways.
+     */
     const hasMetGuarantee = this.reported >= 5
 
     /* 3. If the transaction's name is in the transaction map and its duration
-    *    is less than the response time in the map, it is skipped.
-    */
+     *    is less than the response time in the map, it is skipped.
+     */
     let slowerThanCaptured = true
     if (hasMetGuarantee) {
       if (this.requestTimes[name]) {
         slowerThanCaptured = this.requestTimes[name] < duration
       }
     }
-    if (!slowerThanCaptured) return false
+    if (!slowerThanCaptured) {
+      return false
+    }
 
     /* Not part of enumerated rules, but necessary for Top N support:
-    * Ensure this name is either already in the request time map
-    * or that the map still hasn't hit capacity.
-    */
-    if (hasMetGuarantee &&
-        !this.requestTimes[name] &&
-        Object.keys(this.requestTimes).length >= this.capacity) {
+     * Ensure this name is either already in the request time map
+     * or that the map still hasn't hit capacity.
+     */
+    if (
+      hasMetGuarantee &&
+      !this.requestTimes[name] &&
+      Object.keys(this.requestTimes).length >= this.capacity
+    ) {
       return false
     }
 
     /* 4. The transaction is held as the slowest transaction.
-    */
+     */
     return true
   }
 }

package/lib/transaction/trace/exclusive-time-calculator.js

@@ -60,7 +60,7 @@ class ExclusiveCalculator {
     // of children left to process is 0).
     while (--parent.childrenLeft === 0) {
       // pull off the finished parent and assign the exclusive duration
-      const {segment: finishedParent, childPairs} = this.parentStack.pop()
+      const { segment: finishedParent, childPairs } = this.parentStack.pop()
       const timer = finishedParent.timer
       const finishedEnd = timer.getDurationInMillis() + timer.start
       let duration = finishedParent.getDurationInMillis()
@@ -109,14 +109,11 @@ function merge(first, second) {
   // N.B. this is destructive, it will be updating the end times for range arrays in
   // the input arrays.  If we need to reuse these arrays for anything, this behavior
   // must be changed.
-  var currInterval = first[firstIdx][0] < second[secondIdx][0]
-    ? first[firstIdx++]
-    : second[secondIdx++]
+  var currInterval =
+    first[firstIdx][0] < second[secondIdx][0] ? first[firstIdx++] : second[secondIdx++]
 
   while (firstIdx < first.length && secondIdx < second.length) {
-    var next = first[firstIdx][0] < second[secondIdx][0]
-      ? first[firstIdx++]
-      : second[secondIdx++]
+    var next = first[firstIdx][0] < second[secondIdx][0] ? first[firstIdx++] : second[secondIdx++]
     if (next[0] <= currInterval[1]) {
       // if the segment overlaps, update the end of the current merged segment
       currInterval[1] = Math.max(next[1], currInterval[1])
@@ -127,7 +124,6 @@ function merge(first, second) {
     }
   }
 
-
   const firstIsRemainder = firstIdx !== first.length
   const remainder = firstIsRemainder ? first : second
   let remainderIdx = firstIsRemainder ? firstIdx : secondIdx
@@ -140,7 +136,7 @@ function merge(first, second) {
   res[resIdx++] = currInterval
 
   // append the remaining non-overlapping ranges
-  for (;remainderIdx < remainder.length; ++remainderIdx) {
+  for (; remainderIdx < remainder.length; ++remainderIdx) {
     res[resIdx++] = remainder[remainderIdx]
   }
 

package/lib/transaction/trace/index.js

@@ -7,11 +7,10 @@
 
 var codec = require('../../util/codec')
 var Segment = require('./segment')
-var {Attributes, MAXIMUM_CUSTOM_ATTRIBUTES} = require('../../attributes')
-var logger = require('../../logger').child({component: 'trace'})
+var { Attributes, MAXIMUM_CUSTOM_ATTRIBUTES } = require('../../attributes')
+var logger = require('../../logger').child({ component: 'trace' })
 
-
-var {DESTINATIONS} = require('../../config/attribute-filter')
+var { DESTINATIONS } = require('../../config/attribute-filter')
 var FROM_MILLIS = 1e-3
 const ATTRIBUTE_SCOPE = 'transaction'
 
@@ -25,7 +24,9 @@ const UNKNOWN_URI_PLACEHOLDER = '/Unknown'
  * @param {Transaction} transaction The transaction bound to the trace.
  */
 function Trace(transaction) {
-  if (!transaction) throw new Error('All traces must be associated with a transaction.')
+  if (!transaction) {
+    throw new Error('All traces must be associated with a transaction.')
+  }
 
   this.transaction = transaction
 
@@ -43,11 +44,7 @@ function Trace(transaction) {
   var displayName = transaction.agent.config.getDisplayHost()
   var hostName = transaction.agent.config.getHostnameSafe()
   if (displayName !== hostName) {
-    this.attributes.addAttribute(
-      DESTINATIONS.TRANS_COMMON,
-      'host.displayName',
-      displayName
-    )
+    this.attributes.addAttribute(DESTINATIONS.TRANS_COMMON, 'host.displayName', displayName)
 
     this.displayName = displayName
   }
@@ -198,7 +195,6 @@ Trace.prototype.getExclusiveDurationInMillis = function getExclusiveDurationInMi
   return this.root.getExclusiveDurationInMillis()
 }
 
-
 /**
  * The duration of all segments in a transaction trace.  The root is not
  * accounted for, since it doesn't represent a unit of work.
@@ -207,8 +203,12 @@ Trace.prototype.getExclusiveDurationInMillis = function getExclusiveDurationInMi
  *                   milliseconds
  */
 Trace.prototype.getTotalTimeDurationInMillis = function getTotalTimeDurationInMillis() {
-  if (this.totalTimeCache !== null) return this.totalTimeCache
-  if (this.root.children.length === 0) return 0
+  if (this.totalTimeCache !== null) {
+    return this.totalTimeCache
+  }
+  if (this.root.children.length === 0) {
+    return 0
+  }
   var segments = this.root.getChildren()
   var totalTimeInMillis = 0
 
@@ -218,7 +218,9 @@ Trace.prototype.getTotalTimeDurationInMillis = function getTotalTimeDurationInMi
     segments = segments.concat(segment.getChildren())
   }
 
-  if (!this.transaction.isActive()) this.totalTimeCache = totalTimeInMillis
+  if (!this.transaction.isActive()) {
+    this.totalTimeCache = totalTimeInMillis
+  }
   return totalTimeInMillis
 }
 
@@ -299,15 +301,15 @@ Trace.prototype._generatePayload = function _generatePayload(data) {
 
   return [
     this.root.timer.start, // start
-    this.transaction.getResponseTimeInMillis(),  // response time
-    this.transaction.getFullName(),              // path
-    requestUri,  // request.uri
-    data,                   // encodedCompressedData
-    this.transaction.id,    // guid
-    null,                   // reserved for future use
-    false,                  // forcePersist
-    null,                   // xraySessionId
-    syntheticsResourceId    // synthetics resource id
+    this.transaction.getResponseTimeInMillis(), // response time
+    this.transaction.getFullName(), // path
+    requestUri, // request.uri
+    data, // encodedCompressedData
+    this.transaction.id, // guid
+    null, // reserved for future use
+    false, // forcePersist
+    null, // xraySessionId
+    syntheticsResourceId // synthetics resource id
   ]
 }
 
@@ -353,7 +355,7 @@ Trace.prototype._serializeTrace = function _serializeTrace() {
     }, // moved to userAttributes
     this.root.toJSON(),
     attributes,
-    []  // FIXME: parameter groups
+    [] // FIXME: parameter groups
   ]
 }
 

package/lib/transaction/trace/segment.js

@@ -5,13 +5,13 @@
 
 'use strict'
 
-const {DESTINATIONS} = require('../../config/attribute-filter')
-const logger = require('../../logger').child({component: 'segment'})
+const { DESTINATIONS } = require('../../config/attribute-filter')
+const logger = require('../../logger').child({ component: 'segment' })
 const Timer = require('../../timer')
 const urltils = require('../../util/urltils')
 const hashes = require('../../util/hashes')
 
-const {Attributes} = require('../../attributes')
+const { Attributes } = require('../../attributes')
 const ExclusiveCalculator = require('./exclusive-time-calculator')
 const SpanContext = require('../../spans/span-context')
 
@@ -23,7 +23,6 @@ const STATE = {
 }
 const ATTRIBUTE_SCOPE = 'segment'
 
-
 /**
  * Initializes the segment and binds the recorder to itself, if provided.
  *
@@ -93,32 +92,20 @@ TraceSegment.prototype.getSpanContext = function getSpanContext() {
   return this._spanContext
 }
 
-TraceSegment.prototype.addAttribute =
-function addAttribute(key, value, truncateExempt = false) {
-  this.attributes.addAttribute(
-    DESTINATIONS.SEGMENT_SCOPE,
-    key,
-    value,
-    truncateExempt
-  )
+TraceSegment.prototype.addAttribute = function addAttribute(key, value, truncateExempt = false) {
+  this.attributes.addAttribute(DESTINATIONS.SEGMENT_SCOPE, key, value, truncateExempt)
 }
 
-TraceSegment.prototype.addSpanAttribute =
-function addSpanAttribute(key, value, truncateExempt = false) {
-  this.attributes.addAttribute(
-    DESTINATIONS.SPAN_EVENT,
-    key,
-    value,
-    truncateExempt
-  )
+TraceSegment.prototype.addSpanAttribute = function addSpanAttribute(
+  key,
+  value,
+  truncateExempt = false
+) {
+  this.attributes.addAttribute(DESTINATIONS.SPAN_EVENT, key, value, truncateExempt)
 }
 
-TraceSegment.prototype.addSpanAttributes =
-function addSpanAttributes(attributes) {
-  this.attributes.addAttributes(
-    DESTINATIONS.SPAN_EVENT,
-    attributes
-  )
+TraceSegment.prototype.addSpanAttributes = function addSpanAttributes(attributes) {
+  this.attributes.addAttributes(DESTINATIONS.SPAN_EVENT, attributes)
 }
 
 TraceSegment.prototype.getAttributes = function getAttributes() {
@@ -157,7 +144,7 @@ function captureDBInstanceAttributes(host, port, database) {
   if (database !== false && dsTracerConf.database_name_reporting.enabled) {
     this.addAttribute(
       'database_name',
-      typeof database === 'number' ? database : (database || INSTANCE_UNKNOWN)
+      typeof database === 'number' ? database : database || INSTANCE_UNKNOWN
     )
   }
 
@@ -168,7 +155,8 @@ function captureDBInstanceAttributes(host, port, database) {
     if (host && urltils.isLocalhost(host)) {
       host = config.getHostnameSafe(host)
     }
-    if (!host || host === 'UNKNOWN_BOX') { // Config's default name of a host.
+    if (!host || host === 'UNKNOWN_BOX') {
+      // Config's default name of a host.
       host = INSTANCE_UNKNOWN
     }
 
@@ -187,11 +175,10 @@ TraceSegment.prototype.isInCallbackState = function isInCallbackState() {
 
 TraceSegment.prototype.probe = function probe(action) {
   if (this.transaction.traceStacks) {
-    this.transaction.probe(action, {segment: this.name})
+    this.transaction.probe(action, { segment: this.name })
   }
 }
 
-
 /**
  * For use when a transaction is ending.  The transaction segment should
  * be named after the transaction it belongs to (which is only known by
@@ -243,7 +230,6 @@ function overwriteDurationInMillis(duration, start) {
   this.timer.overwriteDurationInMillis(duration, start)
 }
 
-
 TraceSegment.prototype.start = function start() {
   this.timer.begin()
 }
@@ -252,7 +238,9 @@ TraceSegment.prototype.start = function start() {
  * Stop timing the related action.
  */
 TraceSegment.prototype.end = function end() {
-  if (!this.timer.isActive()) return
+  if (!this.timer.isActive()) {
+    return
+  }
   this.probe('Ended')
   this.timer.end()
   this._updateRootTimer()
@@ -266,10 +254,7 @@ TraceSegment.prototype.finalize = function finalize() {
     this.name = NAMES.TRUNCATED.PREFIX + this.name
   }
 
-  this.addAttribute(
-    'nr_exclusive_duration_millis',
-    this.getExclusiveDurationInMillis()
-  )
+  this.addAttribute('nr_exclusive_duration_millis', this.getExclusiveDurationInMillis())
 }
 
 /**
@@ -279,11 +264,7 @@ TraceSegment.prototype.finalize = function finalize() {
 TraceSegment.prototype._updateRootTimer = function _updateRootTimer() {
   var root = this.transaction.trace.root
   if (this.timer.endsAfter(root.timer)) {
-    var newDuration = (
-      this.timer.start +
-      this.getDurationInMillis() -
-      root.timer.start
-    )
+    var newDuration = this.timer.start + this.getDurationInMillis() - root.timer.start
     root.overwriteDurationInMillis(newDuration)
   }
 }
@@ -400,8 +381,12 @@ TraceSegment.prototype.getCollectedChildren = function getCollectedChildren() {
  */
 TraceSegment.prototype._getChildPairs = function _getChildPairs(end) {
   // quick optimization
-  if (this.children.length < 1) return []
-  if (!end) end = Infinity
+  if (this.children.length < 1) {
+    return []
+  }
+  if (!end) {
+    end = Infinity
+  }
 
   var children = this.getChildren()
   var childPairs = []
@@ -409,7 +394,9 @@ TraceSegment.prototype._getChildPairs = function _getChildPairs(end) {
     var child = children.pop()
     var pair = child.timer.toRange()
 
-    if (pair[0] >= end) continue
+    if (pair[0] >= end) {
+      continue
+    }
 
     children = children.concat(child.getChildren())
 
@@ -450,13 +437,15 @@ TraceSegment.prototype.toJSON = function toJSON() {
   const resultDest = []
   // array of objects relating a segment and the destination for its
   // serialized data.
-  const segmentsToProcess = [{
-    segment: this,
-    destination: resultDest
-  }]
+  const segmentsToProcess = [
+    {
+      segment: this,
+      destination: resultDest
+    }
+  ]
 
   while (segmentsToProcess.length !== 0) {
-    const {segment, destination} = segmentsToProcess.pop()
+    const { segment, destination } = segmentsToProcess.pop()
 
     const start = segment.timer.startedRelativeTo(segment.transaction.trace.root.timer)
     const duration = segment.getDurationInMillis()
@@ -465,13 +454,7 @@ TraceSegment.prototype.toJSON = function toJSON() {
     const childArray = []
 
     // push serialized data into the specified destination
-    destination.push([
-      start,
-      start + duration,
-      segment.name,
-      segment.getAttributes(),
-      childArray
-    ])
+    destination.push([start, start + duration, segment.name, segment.getAttributes(), childArray])
 
     if (segmentChildren.length) {
       // push the children and the parent's children array into the stack.