newrelic 6.3.0 → 6.5.0

package/lib/transaction/index.js

@@ -13,7 +13,6 @@ var url = require('url')
 var urltils = require('../util/urltils')
 const TraceContext = require('./tracecontext').TraceContext
 
-
 /*
  *
  * CONSTANTS
@@ -47,8 +46,14 @@ const TRANSPORT_TYPES_SET = _makeValueSet(TRANSPORT_TYPES)
 const REQUIRED_DT_KEYS = ['ty', 'ac', 'ap', 'tr', 'ti']
 const DTPayload = require('./dt-payload')
 const DTPayloadStub = DTPayload.Stub
+
 const TRACE_CONTEXT_PARENT_HEADER = 'traceparent'
+const TRACE_CONTEXT_STATE_HEADER = 'tracestate'
+const NEWRELIC_TRACE_HEADER = 'newrelic'
 
+const MULTIPLE_INSERT_MESSAGE =
+  'insertDistributedTraceHeaders called on headers object that already contains ' +
+  'distributed trace data. These may be overwritten. traceparent? \'%s\', newrelic? \'%s\'.'
 
 /**
  * Bundle together the metrics and the trace segment for a single agent
@@ -76,7 +81,7 @@ function Transaction(agent) {
   ++agent.activeTransactions
 
   this.numSegments = 0
-  this.id = hashes.makeId()
+  this.id = hashes.makeId(16)
 
   this.trace = new Trace(this)
   this.exceptions = []
@@ -121,7 +126,18 @@ function Transaction(agent) {
   this.parentAcct = null
   this.parentTransportType = null
   this.parentTransportDuration = null
-  this.traceId = null
+  this._traceId = null
+  Object.defineProperty(this, "traceId", {
+    get() {
+      if (this._traceId === null) {
+        this._traceId = hashes.makeId(32)
+      }
+      return this._traceId
+    },
+    set(traceId) {
+      this._traceId = traceId
+    }
+  })
   this.parentSpanId = null
   this.isDistributedTrace = null
   this.acceptedDistributedTrace = null
@@ -662,19 +678,40 @@ Transaction.prototype.alternatePathHashes = function alternatePathHashes() {
   return altHashes.length === 0 ? null : altHashes.sort().join(',')
 }
 
+/**
+ * Add the error information to the current segment and add the segment ID as
+ * an attribute onto the exception.
+ *
+ * @param {Exception}   exception  The exception object to be collected.
+ */
+Transaction.prototype._linkExceptionToSegment = _linkExceptionToSegment
+
+function _linkExceptionToSegment(exception) {
+  const segment = this.agent.tracer.getSegment()
+  if (!segment) {
+    return
+  }
+
+  // Add error attributes to the span
+  const details = exception.getErrorDetails(this.agent.config)
+  segment.addAttribute('error.message', details.message)
+  segment.addAttribute('error.class', details.type)
+
+  // Add the span/segment ID to the exception as agent attributes
+  exception.agentAttributes.spanId = segment.id
+}
+
 /**
  * Associate an exception with the transaction.  When the transaction ends,
  * the exception will be collected along with the transaction details.
  *
- * @param {Error}   exception         The exception to be collected.
- * @param {object}  customAttributes  Any custom attributes associated with
- *                                    the request (optional).
- * @param {number}  timestamp         The timestamp for when the exception occurred.
+ * @param {Exception}   exception  The exception object to be collected.
  */
 Transaction.prototype.addException = _addException
 
-function _addException(exception, customAttributes, timestamp) {
-  this.exceptions.push([exception, customAttributes, timestamp])
+function _addException(exception) {
+  this._linkExceptionToSegment(exception)
+  this.exceptions.push(exception)
 }
 
 /**
@@ -682,20 +719,18 @@ function _addException(exception, customAttributes, timestamp) {
  * When the transaction ends, the exception will be collected along with the transaction
  * details.
  *
- * @param {Error}   exception         The exception to be collected.
- * @param {object}  customAttributes  Any custom attributes associated with
- *                                    the request (optional).
- * @param {number}  timestamp         The timestamp for when the exception occurred.
+ * @param {Exception}   exception  The exception object to be collected.
  */
 Transaction.prototype.addUserError = _addUserError
 
-function _addUserError(exception, customAttributes, timestamp) {
-  this.userErrors.push([exception, customAttributes, timestamp])
+function _addUserError(exception) {
+  this._linkExceptionToSegment(exception)
+  this.userErrors.push(exception)
 }
 
 /**
- * Returns true if an error happened during the transaction or if the transaction itself
- * is considered to be an error.
+ * Returns true if an error happened during the transaction or if the transaction itself is
+ * considered to be an error.
  */
 Transaction.prototype.hasErrors = function _hasErrors() {
   var isErroredTransaction = urltils.isError(this.agent.config, this.statusCode)
@@ -704,10 +739,7 @@ Transaction.prototype.hasErrors = function _hasErrors() {
   return (transactionHasExceptions || transactionHasuserErrors || isErroredTransaction)
 }
 
-/**
- * Returns true if all the errors/exceptions collected so far
- * are expected errors.
- */
+// Returns true if all the errors/exceptions collected so far are expected errors
 Transaction.prototype.hasOnlyExpectedErrors = function hasOnlyExpectedErrors() {
   if (0 === this.exceptions.length) {
     return false
@@ -719,13 +751,13 @@ Transaction.prototype.hasOnlyExpectedErrors = function hasOnlyExpectedErrors() {
     const isUnexpected = !(
       errorHelper.isExpectedException(
         this,
-        exception[0],
+        exception.error,
         this.agent.config,
         urltils
       ) ||
       errorHelper.shouldIgnoreError(
         this,
-        exception[0],
+        exception.error,
         this.agent.config
       )
     )
@@ -772,6 +804,123 @@ Transaction.prototype.getIntrinsicAttributes = function getIntrinsicAttributes()
   return Object.assign(Object.create(null), this._intrinsicAttributes)
 }
 
+/**
+ * Parsing incoming headers for use in a distributed trace.
+ * W3C TraceContext format is preferred over the NewRelic DT format.
+ * NewRelic DT format will be used if no `traceparent` header is found.
+ * @param @param {string} [transport='Unknown'] - The transport type that delivered the trace.
+ * @param {object} headers - Headers to search for supported trace formats. Keys must be lowercase.
+ */
+Transaction.prototype.acceptDistributedTraceHeaders = acceptDistributedTraceHeaders
+function acceptDistributedTraceHeaders(transportType, headers) {
+  const transport = TRANSPORT_TYPES_SET[transportType] ? transportType : TRANSPORT_TYPES.UNKNOWN
+
+  // assumes header keys already lowercase
+  const traceparent = headers[TRACE_CONTEXT_PARENT_HEADER]
+
+  if (traceparent) {
+    logger.trace('Accepting trace context DT payload for transaction %s', this.id)
+
+    // assumes header keys already lowercase
+    const tracestate = headers[TRACE_CONTEXT_STATE_HEADER]
+
+    this.acceptTraceContextPayload(traceparent, tracestate, transport)
+  } else {
+    // assumes header keys already lowercase
+    const payload = headers[NEWRELIC_TRACE_HEADER]
+    if (payload) {
+      logger.trace('Accepting newrelic DT payload for transaction %s', this.id)
+
+      this.acceptDistributedTracePayload(payload, transport)
+    }
+  }
+}
+
+/**
+ * Inserts distributed trace headers into the provided headers map.
+ * @param {Object} headers
+ */
+Transaction.prototype.insertDistributedTraceHeaders = insertDistributedTraceHeaders
+function insertDistributedTraceHeaders(headers) {
+  if (!headers) {
+    logger.trace('insertDistributedTraceHeaders called without headers.')
+    return
+  }
+
+  checkForExistingNrTraceHeaders(headers)
+
+  // Ensure we have priority before generating trace headers.
+  this._calculatePriority()
+
+  this.traceContext.addTraceContextHeaders(headers)
+  this.isDistributedTrace = true
+
+  logger.trace('Added outbound request w3c trace context headers in transaction %s', this.id)
+
+  if (this.agent.config.distributed_tracing.exclude_newrelic_header) {
+    logger.trace('Excluding newrelic header due to exclude_newrelic_header: true')
+    return
+  }
+
+  try {
+    const newrelicFormatData = this.createDistributedTracePayload().httpSafe()
+    headers[NEWRELIC_TRACE_HEADER] = newrelicFormatData
+    logger.trace('Added outbound request distributed tracing headers in transaction %s', this.id)
+  } catch (error) {
+    logger.trace(error, 'Failed to create distributed trace payload')
+  }
+}
+
+function checkForExistingNrTraceHeaders(headers) {
+  const traceparentHeader = headers[TRACE_CONTEXT_PARENT_HEADER]
+  const newrelicHeader = headers[NEWRELIC_TRACE_HEADER]
+
+  const hasExisting = traceparentHeader || newrelicHeader
+  if (hasExisting) {
+    logger.trace(MULTIPLE_INSERT_MESSAGE, traceparentHeader, newrelicHeader)
+  }
+}
+
+Transaction.prototype.acceptTraceContextPayload = acceptTraceContextPayload
+function acceptTraceContextPayload(traceparent, tracestate, transport) {
+  if (this.isDistributedTrace) {
+    logger.warn(
+      'Already accepted or created a distributed trace payload for transaction %s, ignoring call',
+      this.id
+    )
+
+    if (this.acceptedDistributedTrace) {
+      this.agent.recordSupportability('TraceContext/Accept/Ignored/Multiple')
+    } else {
+      this.agent.recordSupportability('TraceContext/Accept/Ignored/CreateBeforeAccept')
+    }
+
+    return
+  }
+
+  const traceContext =
+    this.traceContext.acceptTraceContextPayload(traceparent, tracestate)
+
+  if (traceContext.acceptedTraceparent) {
+    this.acceptedDistributedTrace = true
+    this.isDistributedTrace = true
+
+    this.traceId = traceContext.traceId
+    this.parentSpanId = traceContext.parentSpanId
+    this.parentTransportDuration = traceContext.transportDuration
+    this.parentTransportType = transport
+
+    if (traceContext.acceptedTracestate) {
+      this.parentType = traceContext.parentType
+      this.parentAcct = traceContext.accountId
+      this.parentApp = traceContext.appId
+      this.parentId = traceContext.transactionId
+      this.sampled = traceContext.sampled
+      this.priority = traceContext.priority
+    }
+  }
+}
+
 /**
  * Parses incoming distributed trace header payload.
  *
@@ -787,7 +936,7 @@ function acceptDistributedTracePayload(payload, transport) {
 
   if (this.isDistributedTrace) {
     logger.warn(
-      'Already accepted distributed trace payload for transaction %s, ignoring call',
+      'Already accepted or created a distributed trace payload for transaction %s, ignoring call',
       this.id
     )
     if (this.parentId) {
@@ -874,7 +1023,10 @@ function acceptDistributedTracePayload(payload, transport) {
     return
   }
 
-  transport = TRANSPORT_TYPES_SET[transport] ? transport : 'Unknown'
+  // TODO: This should be removable / covered by acceptDistributedTraceHeaders
+  // once the Transaction#acceptDistributedTracePayload API that directly invokes
+  // this acceptDistributedTracePayload is fully removed in a future Major version.
+  transport = TRANSPORT_TYPES_SET[transport] ? transport : TRANSPORT_TYPES.UNKNOWN
 
   this.parentType = data.ty
   this.parentApp = data.ap
@@ -967,6 +1119,9 @@ function createDistributedTracePayload() {
     return new DTPayloadStub()
   }
 
+  // TODO: This should be removable / covered by insertDistributedTraceHeaders
+  // once the Transaction#createDistributedTracePayload API that directly invokes
+  // this createDistributedTracePayload is fully removed in a future Major version.
   this._calculatePriority()
 
   const currSegment = this.agent.tracer.getSegment()
@@ -975,7 +1130,7 @@ function createDistributedTracePayload() {
     ac: accountId,
     ap: appId,
     tx: this.id,
-    tr: this.getTraceId(),
+    tr: this.traceId,
     pr: this.priority,
     sa: this.sampled,
     ti: Date.now()
@@ -1003,7 +1158,7 @@ function addDistributedTraceIntrinsics(attrs) {
   this._calculatePriority()
 
   // *always* add these if DT flag is enabled.
-  attrs.traceId = this.getTraceId()
+  attrs.traceId = this.traceId
   attrs.guid = this.id
   attrs.priority = this.priority
 
@@ -1082,11 +1237,4 @@ function addRequestParameters(requestParameters) {
   }
 }
 
-/**
- * Gets the current distributed trace traceId
- */
-Transaction.prototype.getTraceId = function getTraceId() {
-  return this.traceId || this.id
-}
-
 module.exports = Transaction

package/lib/transaction/trace/index.js

@@ -2,7 +2,7 @@
 
 var codec = require('../../util/codec')
 var Segment = require('./segment')
-var Attributes = require('../../attributes')
+var {Attributes, MAXIMUM_CUSTOM_ATTRIBUTES} = require('../../attributes')
 var logger = require('../../logger').child({component: 'trace'})
 
 
@@ -29,7 +29,7 @@ function Trace(transaction) {
   this.segmentsSeen = 0
   this.totalTimeCache = null
 
-  this.custom = new Attributes(ATTRIBUTE_SCOPE, 64)
+  this.custom = new Attributes(ATTRIBUTE_SCOPE, MAXIMUM_CUSTOM_ATTRIBUTES)
   this.attributes = new Attributes(ATTRIBUTE_SCOPE)
 
   // sending displayName if set by user
@@ -79,7 +79,7 @@ Trace.prototype.generateSpanEvents = function generateSpanEvents() {
     const spanAggregator = this.transaction.agent.spanEventAggregator
     const children = this.root.getChildren()
     for (let i = 0; i < children.length; ++i) {
-      toProcess.push(new DTTraceNode(children[i], this.transaction.parentSpanId))
+      toProcess.push(new DTTraceNode(children[i], this.transaction.parentSpanId, true))
     }
 
     while (toProcess.length) {
@@ -89,7 +89,7 @@ Trace.prototype.generateSpanEvents = function generateSpanEvents() {
       // 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.
-      spanAggregator.addSegment(segment, segmentInfo.parentId)
+      spanAggregator.addSegment(segment, segmentInfo.parentId, segmentInfo.isRoot)
 
       const nodes = segment.getChildren()
       for (let i = 0; i < nodes.length; ++i) {
@@ -100,9 +100,10 @@ Trace.prototype.generateSpanEvents = function generateSpanEvents() {
   }
 }
 
-function DTTraceNode(segment, parentId) {
+function DTTraceNode(segment, parentId, isRoot = false) {
   this.segment = segment
   this.parentId = parentId
+  this.isRoot = isRoot
 }
 
 /**

package/lib/transaction/trace/segment.js

@@ -6,7 +6,7 @@ const Timer = require('../../timer')
 const urltils = require('../../util/urltils')
 const hashes = require('../../util/hashes')
 
-const Attributes = require('../../attributes')
+const {Attributes, MAXIMUM_CUSTOM_ATTRIBUTES} = require('../../attributes')
 const ExclusiveCalculator = require('./exclusive-time-calculator')
 
 const NAMES = require('../../metrics/names')
@@ -52,6 +52,7 @@ function TraceSegment(transaction, name, recorder) {
   }
 
   this.attributes = new Attributes(ATTRIBUTE_SCOPE)
+  this.customAttributes = new Attributes(ATTRIBUTE_SCOPE, MAXIMUM_CUSTOM_ATTRIBUTES)
 
   this.children = []
 
@@ -90,6 +91,16 @@ TraceSegment.prototype.getAttributes = function getAttributes() {
   return this.attributes.get(DESTINATIONS.TRANS_SEGMENT)
 }
 
+TraceSegment.prototype.addCustomSpanAttribute = 
+function addCustomSpanAttribute(key, value, truncateExempt = false) {
+  this.customAttributes.addAttribute(
+    DESTINATIONS.SPAN_EVENT,
+    key,
+    value,
+    truncateExempt
+  )
+}
+
 TraceSegment.prototype.getSpanId = function getSpanId() {
   const conf = this.transaction.agent.config
   const enabled = conf.span_events.enabled && conf.distributed_tracing.enabled