newrelic 8.0.0 → 8.4.0

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() {
@@ -150,14 +137,14 @@ TraceSegment.prototype.getSpanId = function getSpanId() {
 TraceSegment.prototype.captureDBInstanceAttributes = captureDBInstanceAttributes
 
 function captureDBInstanceAttributes(host, port, database) {
-  var config = this.transaction.agent.config
-  var dsTracerConf = config.datastore_tracer
+  const config = this.transaction.agent.config
+  const dsTracerConf = config.datastore_tracer
 
   // Add database name if provided and enabled.
   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,18 +175,17 @@ 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
  * the end).
  */
 TraceSegment.prototype.setNameFromTransaction = function setNameFromTransaction() {
-  var transaction = this.transaction
+  const transaction = this.transaction
 
   // transaction name and transaciton segment name must match
   this.name = transaction.getFullName()
@@ -216,10 +203,10 @@ TraceSegment.prototype.setNameFromTransaction = function setNameFromTransaction(
  * segment's parameters onto the transaction.
  */
 TraceSegment.prototype.markAsWeb = function markAsWeb() {
-  var transaction = this.transaction
+  const transaction = this.transaction
   this.setNameFromTransaction()
 
-  var traceAttrs = transaction.trace.attributes.get(DESTINATIONS.TRANS_TRACE)
+  const traceAttrs = transaction.trace.attributes.get(DESTINATIONS.TRANS_TRACE)
   Object.keys(traceAttrs).forEach((key) => {
     if (!this.attributes.has(key)) {
       this.addAttribute(key, traceAttrs[key])
@@ -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())
 }
 
 /**
@@ -277,13 +262,9 @@ TraceSegment.prototype.finalize = function finalize() {
  * in time.
  */
 TraceSegment.prototype._updateRootTimer = function _updateRootTimer() {
-  var root = this.transaction.trace.root
+  const root = this.transaction.trace.root
   if (this.timer.endsAfter(root.timer)) {
-    var newDuration = (
-      this.timer.start +
-      this.getDurationInMillis() -
-      root.timer.start
-    )
+    const newDuration = this.timer.start + this.getDurationInMillis() - root.timer.start
     root.overwriteDurationInMillis(newDuration)
   }
 }
@@ -309,8 +290,8 @@ TraceSegment.prototype.add = function add(childName, recorder) {
     return this
   }
   logger.trace('Adding segment %s to %s in %s', childName, this.name, this.transaction.id)
-  var segment = new TraceSegment(this.transaction, childName, recorder)
-  var config = this.transaction.agent.config
+  const segment = new TraceSegment(this.transaction, childName, recorder)
+  const config = this.transaction.agent.config
 
   if (this.transaction.trace.segmentsSeen++ >= config.max_trace_segments) {
     segment._collect = false
@@ -369,8 +350,8 @@ function getExclusiveDurationInMillis() {
 }
 
 TraceSegment.prototype.getChildren = function getChildren() {
-  var children = []
-  for (var i = 0, len = this.children.length; i < len; ++i) {
+  const children = []
+  for (let i = 0, len = this.children.length; i < len; ++i) {
     if (!this.children[i].ignore) {
       children.push(this.children[i])
     }
@@ -379,8 +360,8 @@ TraceSegment.prototype.getChildren = function getChildren() {
 }
 
 TraceSegment.prototype.getCollectedChildren = function getCollectedChildren() {
-  var children = []
-  for (var i = 0, len = this.children.length; i < len; ++i) {
+  const children = []
+  for (let i = 0, len = this.children.length; i < len; ++i) {
     if (this.children[i]._collect && !this.children[i].ignore) {
       children.push(this.children[i])
     }
@@ -400,16 +381,22 @@ 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 = []
+  let children = this.getChildren()
+  const childPairs = []
   while (children.length) {
-    var child = children.pop()
-    var pair = child.timer.toRange()
+    const child = children.pop()
+    const 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,19 +454,13 @@ 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.
       // to preserve the chronological order of the children, push them
       // onto the stack backwards (so the first one created is on top).
-      for (var i = segmentChildren.length - 1; i >= 0; --i) {
+      for (let i = segmentChildren.length - 1; i >= 0; --i) {
         segmentsToProcess.push({
           segment: segmentChildren[i],
           destination: childArray

package/lib/transaction/tracecontext.js

@@ -5,7 +5,7 @@
 
 'use strict'
 
-const logger = require('../logger').child({component: 'TraceContext'})
+const logger = require('../logger').child({ component: 'TraceContext' })
 const hashes = require('../util/hashes')
 
 const TRACE_CONTEXT_PARENT_HEADER = 'traceparent'
@@ -89,8 +89,8 @@ class TraceContext {
     if (!accountId || !appId || !trustedAccountKey) {
       logger.debug(
         'Unable to create tracestate header due to missing required fields ' +
-        '(account_id: %s, primary_application_id: %s, trusted_account_key: %s) in transaction %s' +
-        'This may occur if a trace is created prior to the agent fully starting.',
+          '(account_id: %s, primary_application_id: %s, trusted_account_key: %s) in transaction %s' +
+          'This may occur if a trace is created prior to the agent fully starting.',
         accountId,
         appId,
         trustedAccountKey,
@@ -122,7 +122,8 @@ class TraceContext {
     const priority = this.transaction.priority ? this.transaction.priority.toFixed(6) : ''
     const timestamp = Date.now()
 
-    const nrTraceState = `${trustedAccountKey}@nr=${version}-${parentType}-${accountId}` +
+    const nrTraceState =
+      `${trustedAccountKey}@nr=${version}-${parentType}-${accountId}` +
       `-${appId}-${spanId}-${transactionId}-${sampled}-${priority}-${timestamp}`
 
     if (this._traceStateRaw) {
@@ -220,15 +221,9 @@ class TraceContext {
       traceContextData.traceId = parsedParent.traceId
       traceContextData.parentSpanId = parsedParent.parentId
     } else {
-      logger.trace(
-        'Invalid traceparent for transaction %s: %s',
-        this.transaction.id,
-        traceparent
-      )
+      logger.trace('Invalid traceparent for transaction %s: %s', this.transaction.id, traceparent)
 
-      this.transaction.agent.recordSupportability(
-        'TraceContext/TraceParent/Parse/Exception'
-      )
+      this.transaction.agent.recordSupportability('TraceContext/TraceParent/Parse/Exception')
       // From the W3C spec: If the vendor failed to parse traceparent, it MUST NOT
       // attempt to parse tracestate
       return traceContextData
@@ -246,10 +241,7 @@ class TraceContext {
     const parsedState = this._validateAndParseTraceStateHeader(tracestate)
 
     if (!parsedState.traceStateValid) {
-      logger.trace('Invalid tracestate for transaction %s: %s',
-        this.transaction.id,
-        tracestate
-      )
+      logger.trace('Invalid tracestate for transaction %s: %s', this.transaction.id, tracestate)
 
       this.transaction.agent.recordSupportability('TraceContext/TraceState/Parse/Exception')
       return traceContextData
@@ -261,10 +253,7 @@ class TraceContext {
     // These need to be kept to be added to root span events as an attribute
     this.tracingVendors = parsedState.vendors
 
-    if (
-      parsedState.intrinsics &&
-      parsedState.intrinsics.version !== NR_TRACESTATE_VERSION
-    ) {
+    if (parsedState.intrinsics && parsedState.intrinsics.version !== NR_TRACESTATE_VERSION) {
       logger.trace(
         'Incoming tracestate version: %s, agent tracestate version: %s',
         parsedState.intrinsics.version,
@@ -282,20 +271,19 @@ class TraceContext {
       traceContextData.transactionId = parsedState.intrinsics.transactionId
       traceContextData.sampled = parsedState.intrinsics.sampled
       traceContextData.priority = parsedState.intrinsics.priority
-      traceContextData.transportDuration =
-        Math.max(0, (Date.now() - parsedState.intrinsics.timestamp) / 1000)
+      traceContextData.transportDuration = Math.max(
+        0,
+        (Date.now() - parsedState.intrinsics.timestamp) / 1000
+      )
 
       this.trustedParentId = parsedState.intrinsics.spanId
       this._traceStateRaw = parsedState.newTraceState
 
       this.transaction.agent.recordSupportability('TraceContext/Accept/Success')
     } else if (parsedState.entryFound) {
-      logger.error('Invalid tracestate for transaction %s: %s',
-        this.transaction.id, tracestate)
+      logger.error('Invalid tracestate for transaction %s: %s', this.transaction.id, tracestate)
 
-      this.transaction.agent.recordSupportability(
-        'TraceContext/TraceState/InvalidNrEntry'
-      )
+      this.transaction.agent.recordSupportability('TraceContext/TraceState/InvalidNrEntry')
     }
 
     return traceContextData
@@ -387,7 +375,7 @@ class TraceContext {
    * instrinsics on any relevant New Relic tracestate strings found
    */
   _validateAndParseTraceStateHeader(tracestate) {
-    let tsd = {
+    const tsd = {
       entryFound: false,
       entryValid: undefined,
       entryInvalidReason: undefined,
@@ -405,8 +393,8 @@ class TraceContext {
     if (!hasTrustKey) {
       logger.debug(
         'Unable to accept any New Relic tracestate list members. ' +
-        'Missing trusted_account_key. ' +
-        'This may occur if a trace is received prior to the agent fully starting.'
+          'Missing trusted_account_key. ' +
+          'This may occur if a trace is received prior to the agent fully starting.'
       )
 
       this.transaction.agent.recordSupportability('TraceContext/TraceState/Accept/Exception')
@@ -429,14 +417,15 @@ class TraceContext {
         if (listMemberParts.length !== 2) {
           tsd.traceStateValid = false
           logger.debug('Unable to parse tracestate list members.')
-          this.transaction.agent
-            .recordSupportability('TraceContext/TraceState/Parse/Exception/ListMember')
+          this.transaction.agent.recordSupportability(
+            'TraceContext/TraceState/Parse/Exception/ListMember'
+          )
 
           return tsd
         }
 
         const [vendorKey, vendorValue] = listMemberParts
-        if (hasTrustKey && (vendorKey === expectedNrKey)) {
+        if (hasTrustKey && vendorKey === expectedNrKey) {
           // Matching members do not get added to vendors.
           // We'll replace the first valid entry and drop the rest
           // (which would be invalid members if they exist).
@@ -510,18 +499,17 @@ class TraceContext {
     const intrinsics = this._parseIntrinsics(nrTracestateValue)
 
     // Functions that return true when the field is invalid
-    const isNull = v => v == null
+    const isNull = (v) => v == null
     const intrinsicInvalidations = {
-      version: isNaN,     // required, int
+      version: isNaN, // required, int
       parentType: isNull, // required, str
-      accountId: isNull,  // required, str
-      appId: isNull,      // required, str
-      sampled:  v => v == null ? false : isNaN(v), // not required, int
-      priority: v => v == null ? false : isNaN(v), // not required, float
-      timestamp: isNaN    // required, int
+      accountId: isNull, // required, str
+      appId: isNull, // required, str
+      sampled: (v) => (v == null ? false : isNaN(v)), // not required, int
+      priority: (v) => (v == null ? false : isNaN(v)), // not required, float
+      timestamp: isNaN // required, int
     }
 
-
     // If a field is found invalid, flag the entry as not valid
     intrinsics.entryValid = true
     for (const key of Object.keys(intrinsicInvalidations)) {
@@ -538,7 +526,9 @@ class TraceContext {
     }
 
     intrinsics.parentType = PARENT_TYPES[intrinsics.parentType]
-    if (!intrinsics.parentType) intrinsics.entryValid = false
+    if (!intrinsics.parentType) {
+      intrinsics.entryValid = false
+    }
 
     return intrinsics
   }
@@ -554,10 +544,10 @@ class TraceContext {
       parentType: parseInt,
 
       // these two can be null, don't try to parse a null
-      sampled: v => v == null ? v : parseInt(v, 10),
-      priority: v => v == null ? v : parseFloat(v),
+      sampled: (v) => (v == null ? v : parseInt(v, 10)),
+      priority: (v) => (v == null ? v : parseFloat(v)),
 
-      timestamp: parseInt,
+      timestamp: parseInt
     }
 
     for (const key of Object.keys(intrinsicConversions)) {
@@ -575,7 +565,9 @@ class TraceContext {
 
     // convert empty strings to null
     splitValues.forEach((value, i) => {
-      if (value === '') splitValues[i] = null
+      if (value === '') {
+        splitValues[i] = null
+      }
     })
 
     const intrinsics = {