newrelic 8.0.0 → 8.4.0

package/lib/transaction/name-state.js

@@ -5,11 +5,11 @@
 
 'use strict'
 
-var logger = require('../logger.js').child({component: 'name-state'})
-var NAMES = require('../metrics/names')
+const logger = require('../logger.js').child({ component: 'name-state' })
+const NAMES = require('../metrics/names')
 
 // TODO: Figure out a way to phase out legacy transaction names.
-var LEGACY_NAMING = {
+const LEGACY_NAMING = {
   Custom: true,
 
   Connect: true,
@@ -45,7 +45,7 @@ NameState.prototype.setName = function setName(prefix, verb, delimiter, path) {
   this.setPrefix(prefix)
   this.verb = verb && verb.toUpperCase()
   this.delimiter = delimiter
-  this.pathStack = path ? [{path: path, params: null}] : []
+  this.pathStack = path ? [{ path: path, params: null }] : []
   this._pathCache = null
   this.markedPath = []
   logger.trace('setName called on name state, path stack now %j', this.pathStack)
@@ -77,8 +77,7 @@ NameState.prototype.setPrefix = function setPrefix(prefix) {
     this.prefix = null
     return
   }
-  this.prefix = (prefix[prefix.length - 1] === '/') ?
-    prefix.substring(0, prefix.length - 1) : prefix
+  this.prefix = prefix[prefix.length - 1] === '/' ? prefix.substring(0, prefix.length - 1) : prefix
 }
 
 /**
@@ -108,8 +107,8 @@ NameState.prototype.isEmpty = function isEmpty() {
  */
 NameState.prototype.appendPath = function appendPath(path, params) {
   if (!this._frozen && path != null) {
-    var strPath = path instanceof RegExp ? path.source : String(path)
-    this.pathStack.push({path: strPath, params: params || null})
+    const strPath = path instanceof RegExp ? path.source : String(path)
+    this.pathStack.push({ path: strPath, params: params || null })
 
     if (path !== '') {
       this._pathCache = null
@@ -142,7 +141,7 @@ NameState.prototype.popPath = function popPath(path) {
   }
 
   this._pathCache = null
-  var pops = 0
+  let pops = 0
   if (path != null) {
     const idx = _findLastIndex(this.pathStack, (a) => a.path === path)
     if (idx !== -1) {
@@ -157,17 +156,17 @@ NameState.prototype.popPath = function popPath(path) {
 }
 
 NameState.prototype.getPath = function getPath() {
-  var ps = !this.pathStack.length ? this.markedPath : this.pathStack
-  var psLength = ps.length
+  const ps = !this.pathStack.length ? this.markedPath : this.pathStack
+  const psLength = ps.length
   if (this._pathCache) {
     return this._pathCache
   } else if (psLength === 0) {
     return null // nameState initialized but never set
   }
 
-  var path = '/'
-  for (var i = 0; i < psLength; ++i) {
-    var a = ps[i].path
+  let path = '/'
+  for (let i = 0; i < psLength; ++i) {
+    let a = ps[i].path
     if (a && a !== '/') {
       if (a[0] !== '/' && path[path.length - 1] !== '/') {
         path += '/'
@@ -178,11 +177,11 @@ NameState.prototype.getPath = function getPath() {
     }
   }
 
-  return this._pathCache = path
+  return (this._pathCache = path)
 }
 
 NameState.prototype.getNameNotFound = function getNameNotFound() {
-  var name = _getName(this, '(not found)')
+  const name = _getName(this, '(not found)')
   if (LEGACY_NAMING.hasOwnProperty(this.prefix)) {
     return name
   }
@@ -190,7 +189,7 @@ NameState.prototype.getNameNotFound = function getNameNotFound() {
 }
 
 NameState.prototype.getName = function getName() {
-  var path = this.getPath()
+  const path = this.getPath()
   if (path === null) {
     return null
   }
@@ -199,7 +198,7 @@ NameState.prototype.getName = function getName() {
 }
 
 NameState.prototype.getFullName = function getFullName() {
-  var name = this.getName()
+  const name = this.getName()
   if (LEGACY_NAMING.hasOwnProperty(this.prefix)) {
     return name
   }
@@ -235,7 +234,7 @@ NameState.prototype.reset = function reset() {
 }
 
 function _getName(nameState, path) {
-  var verb = nameState.verb ? '/' + nameState.verb : ''
+  const verb = nameState.verb ? '/' + nameState.verb : ''
   return (nameState.prefix || '') + verb + (nameState.delimiter || '') + path
 }
 

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

@@ -36,7 +36,7 @@ class ExclusiveCalculator {
           segment: segment,
           childPairs: []
         })
-        for (var i = children.length - 1; i >= 0; --i) {
+        for (let i = children.length - 1; i >= 0; --i) {
           this.toProcess.push(children[i])
         }
       }
@@ -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()
@@ -103,20 +103,17 @@ function merge(first, second) {
   }
 
   const res = []
-  var resIdx = 0
-  var firstIdx = 0
-  var secondIdx = 0
+  let resIdx = 0
+  let firstIdx = 0
+  let secondIdx = 0
   // 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++]
+  let 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++]
+    const 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

@@ -5,14 +5,13 @@
 
 'use strict'
 
-var codec = require('../../util/codec')
-var Segment = require('./segment')
-var {Attributes, MAXIMUM_CUSTOM_ATTRIBUTES} = require('../../attributes')
-var logger = require('../../logger').child({component: 'trace'})
+const codec = require('../../util/codec')
+const Segment = require('./segment')
+const { Attributes, MAXIMUM_CUSTOM_ATTRIBUTES } = require('../../attributes')
+const logger = require('../../logger').child({ component: 'trace' })
 
-
-var {DESTINATIONS} = require('../../config/attribute-filter')
-var FROM_MILLIS = 1e-3
+const { DESTINATIONS } = require('../../config/attribute-filter')
+const FROM_MILLIS = 1e-3
 const ATTRIBUTE_SCOPE = 'transaction'
 
 const REQUEST_URI_KEY = 'request.uri'
@@ -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
 
@@ -40,14 +41,10 @@ function Trace(transaction) {
   this.attributes = new Attributes(ATTRIBUTE_SCOPE)
 
   // sending displayName if set by user
-  var displayName = transaction.agent.config.getDisplayHost()
-  var hostName = transaction.agent.config.getHostnameSafe()
+  const displayName = transaction.agent.config.getDisplayHost()
+  const 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
   }
@@ -85,7 +82,7 @@ Trace.prototype.generateSpanEvents = function generateSpanEvents() {
     config.span_events.enabled &&
     config.distributed_tracing.enabled
   ) {
-    let toProcess = []
+    const toProcess = []
 
     // Root segment does not become a span, so we need to process it separately.
     const spanAggregator = this.transaction.agent.spanEventAggregator
@@ -116,8 +113,8 @@ Trace.prototype.generateSpanEvents = function generateSpanEvents() {
     }
 
     while (toProcess.length) {
-      let segmentInfo = toProcess.pop()
-      let segment = segmentInfo.segment
+      const segmentInfo = toProcess.pop()
+      const segment = segmentInfo.segment
 
       // Even though at some point we might want to stop adding events because all the priorities
       // should be the same, we need to count the spans as seen.
@@ -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,18 +203,24 @@ 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
-  var segments = this.root.getChildren()
-  var totalTimeInMillis = 0
+  if (this.totalTimeCache !== null) {
+    return this.totalTimeCache
+  }
+  if (this.root.children.length === 0) {
+    return 0
+  }
+  let segments = this.root.getChildren()
+  let totalTimeInMillis = 0
 
   while (segments.length !== 0) {
-    var segment = segments.pop()
+    const segment = segments.pop()
     totalTimeInMillis += segment.getExclusiveDurationInMillis()
     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
   ]
 }