newrelic 4.4.0 → 4.7.0

package/lib/transaction/dt-payload.js

@@ -7,6 +7,12 @@ const DT_VERSION_MAJOR = 0
 const DT_VERSION_MINOR = 1
 
 module.exports = class DistributedTracePayload {
+  /**
+   * The class reponsible for producing distributed trace payloads.
+   * Created by calling {@link TransactionHandle#createDistributedTracePayload}.
+   *
+   * @constructor
+   */
   constructor(payload) {
     logger.trace('DistributedTracePayload created with %s', payload)
     this.plainTextPayload = JSON.stringify({
@@ -16,11 +22,21 @@ module.exports = class DistributedTracePayload {
     this.base64Payload = null
   }
 
+  /**
+   * @returns {String} The base64 encoded JSON representation of the
+   * distributed trace payload.
+   */
   text() {
     logger.trace('DistributedTracePayload text: %s', this.plainTextPayload)
     return this.plainTextPayload
   }
 
+  /**
+   * Construct a payload suitable for HTTP transport.
+   *
+   * @returns {String} The base64 encoded JSON representation of the
+   * distributed trace payload.
+   */
   httpSafe() {
     if (!this.base64Payload) {
       this.base64Payload = makeBuffer(this.plainTextPayload, 'utf-8').toString('base64')

package/lib/transaction/handle.js

@@ -33,7 +33,7 @@ module.exports = class TransactionHandle {
   *
   * Proxy method for Transaction#createDistrubtedTracePayload.
   *
-  * @returns {DistributedTracePayload} The created payload.
+  * @returns {DistributedTracePayload} The created payload object.
   *
   */
   createDistributedTracePayload() {

package/lib/transaction/index.js

@@ -122,6 +122,7 @@ function Transaction(agent) {
   this.traceId = null
   this.parentSpanId = null
   this.isDistributedTrace = null
+  this.acceptedDistributedTrace = null
 
   // Lazy evaluate the priority and sampling in case we end up accepting a payload.
   this.priority = null
@@ -192,6 +193,10 @@ Transaction.prototype.end = function end(done) {
       transaction.record()
     }
 
+    // This is function currently must be called after all recorders have been fired due
+    // to some of the recorders (namely the db recorders) add parameters to the segments.
+    transaction.trace.generateSpanEvents()
+
     transaction.agent.emit('transactionFinished', transaction)
     if (typeof done === 'function') {
       done(transaction)
@@ -687,7 +692,7 @@ Transaction.prototype.getIntrinsicAttributes = function getIntrinsicAttributes()
 
     // If CAT is enabled, extract the path hashes and referring transaction info.
     if (config.cross_application_tracer.enabled) {
-      if (config.feature_flag.distributed_tracing) {
+      if (config.distributed_tracing.enabled) {
         this.addDistributedTraceIntrinsics(this._intrinsicAttributes)
       } else {
         this._intrinsicAttributes.path_hash = hashes.calculatePathHash(
@@ -749,7 +754,7 @@ function acceptDistributedTracePayload(payload, transport) {
   }
 
   const config = this.agent.config
-  const distTraceEnabled = config.feature_flag.distributed_tracing
+  const distTraceEnabled = config.distributed_tracing.enabled
   const catEnabled = config.cross_application_tracer.enabled
   const trustedAccount = config.trusted_account_key || config.account_id
 
@@ -765,6 +770,23 @@ function acceptDistributedTracePayload(payload, transport) {
     return
   }
 
+  if (!parsed.v || !parsed.d) {
+    if (!parsed.v) {
+      logger.warn(
+        'Received a distributed trace payload with no version field',
+        this.id
+      )
+    }
+    if (!parsed.d) {
+      logger.warn(
+        'Received a distributed trace payload with no data field',
+        this.id
+      )
+    }
+    this.agent.recordSupportability('DistributedTrace/AcceptPayload/ParseException')
+    return
+  }
+
   const majorVersion = parsed.v && typeof parsed.v[0] === 'number' && parsed.v[0]
   if (majorVersion == null) {
     logger.warn('Invalid distributed trace payload, not accepting')
@@ -792,10 +814,10 @@ function acceptDistributedTracePayload(payload, transport) {
     return
   }
 
-  const accountId = data.tk || data.ac
-  if (accountId !== trustedAccount) {
+  const trustedAccountKey = data.tk || data.ac
+  if (trustedAccountKey !== trustedAccount) {
     this.agent.recordSupportability(
-      `DistributedTrace/AcceptPayload/UntrustedAccount/${accountId}`
+      `DistributedTrace/AcceptPayload/Ignored/UntrustedAccount`
     )
     return
   }
@@ -804,7 +826,7 @@ function acceptDistributedTracePayload(payload, transport) {
 
   this.parentType = data.ty
   this.parentApp = data.ap
-  this.parentAcct = accountId
+  this.parentAcct = data.ac
   this.parentTransportType = transport
   this.parentTransportDuration = Math.max(0, (Date.now() - data.ti) / 1000)
   this.traceId = data.tr
@@ -823,6 +845,10 @@ function acceptDistributedTracePayload(payload, transport) {
   }
 
   this.isDistributedTrace = true
+  // Track if the distributed trace was created through accepting, since
+  // there is potentially no data difference between creation from
+  // Mobile or Browser trace payloads and creation.
+  this.acceptedDistributedTrace = true
 
   this.agent.recordSupportability('DistributedTrace/AcceptPayload/Success')
 }
@@ -873,7 +899,7 @@ function createDistributedTracePayload() {
   const config = this.agent.config
   const accountId = config.account_id
   const appId = config.application_id
-  const distTraceEnabled = config.feature_flag.distributed_tracing
+  const distTraceEnabled = config.distributed_tracing.enabled
   const catEnabled = config.cross_application_tracer.enabled
 
   if (!accountId || !appId || !distTraceEnabled || !catEnabled) {
@@ -898,7 +924,7 @@ function createDistributedTracePayload() {
     ti: Date.now()
   }
 
-  if (this.agent.config.span_events.enabled && currSegment) {
+  if (this.agent.config.span_events.enabled && this.sampled && currSegment) {
     data.id = currSegment.id
   }
 
@@ -918,7 +944,8 @@ function createDistributedTracePayload() {
 Transaction.prototype.addDistributedTraceIntrinsics = addDistributedTraceIntrinsics
 function addDistributedTraceIntrinsics(attrs) {
   this._calculatePriority()
-  // *always* add these if DT flag is enabled
+
+  // *always* add these if DT flag is enabled.
   attrs.traceId = this.traceId || this.id
   attrs.guid = this.id
   attrs.priority = this.priority

package/lib/transaction/trace/attributes.js

@@ -1,5 +1,7 @@
 'use strict'
 
+const byteUtils = require('../../util/byte-limit')
+
 module.exports = TraceAttributes
 
 /**
@@ -20,7 +22,7 @@ function TraceAttributes(opts) {
  */
 TraceAttributes.prototype.isValidLength = isValidLength
 function isValidLength(str) {
-  return Buffer.byteLength(str, 'utf8') < 256
+  return byteUtils.isValidLength(str, 256)
 }
 
 /**
@@ -55,7 +57,10 @@ TraceAttributes.prototype.get = function get(dest) {
       continue
     }
 
-    attrs[key] = typeof attr.value === 'string' ? truncate(attr.value) : attr.value
+    attrs[key] = typeof attr.value === 'string'
+      ? byteUtils.truncate(attr.value, 255)
+      : attr.value
+
     if (++attrCount >= this.limit) {
       break
     }
@@ -83,31 +88,6 @@ TraceAttributes.prototype.reset = function reset() {
   this.attributes = Object.create(null)
 }
 
-/**
- * Trims a string value to 255 bytes, if necessary.
- *
- * @private
- *
- * @param {string} val - The value to truncate to 255 bytes.
- *
- * @return {string} The truncated value.
- */
-function truncate(val) {
-  // First truncation handles the simple case of only one-byte characters.
-  if (!isValidLength(val)) {
-    val = val.substring(0, 255)
-  }
-
-  // Our limitation is on byte length, and the string could contain multi-byte
-  // characters. Doing a byte-substring could chop a character in half. We need
-  // to pop the remaining characters off one by one until we have a good length.
-  var l = val.length
-  while (!isValidLength(val)) {
-    val = val.substring(0, --l)
-  }
-  return val
-}
-
 /**
  * Checks incoming attribute value against valid types:
  * string, number, boolean, & null.

package/lib/transaction/trace/index.js

@@ -49,72 +49,63 @@ function Trace(transaction) {
  * segments that support recording.
  */
 Trace.prototype.end = function end() {
-  var config = this.transaction.agent.config
-  var segments = []
-  var processFn
-
-  if (config.span_events.enabled && config.feature_flag.distributed_tracing) {
-    segments.push(new DTTraceNode(
-      this.root,
-      this.transaction.id,
-      this.transaction.parentId || null
-    ))
-    processFn = makeDTNodeProcessor(this.transaction.agent.spans)
-  } else {
-    segments.push(this.root)
-    processFn = processNode
-  }
+  var segments = [this.root]
 
   while (segments.length) {
     var segment = segments.pop()
-    processFn(segment, segments)
+    _softEndSegment(segment)
+    Array.prototype.push.apply(segments, segment.getChildren())
   }
 }
 
-function DTTraceNode(segment, parentId, grandparentId) {
-  this.segment = segment
-  this.parentId = parentId
-  this.grandparentId = grandparentId
-}
-
-function makeDTNodeProcessor(spanAggregator) {
-  var addMoreSpans = true
-  return function processNodeDT(segmentInfo, segments) {
-    var segment = segmentInfo.segment
+/**
+ * Iterates over the trace tree and generates a span event for each segment.
+ */
+Trace.prototype.generateSpanEvents = function generateSpanEvents() {
+  var config = this.transaction.agent.config
 
-    if (segment.timer.softEnd()) {
-      segment._updateRootTimer()
-      // timer.softEnd() returns true if the timer was ended prematurely, so
-      // in that case we can name the segment as truncated
-      segment.name = NAMES.TRUNCATED.PREFIX + segment.name
+  if (
+    this.transaction.sampled &&
+    config.span_events.enabled &&
+    config.distributed_tracing.enabled
+  ) {
+    var toProcess = []
+    // Root segment does not become a span, so we need to process it separately.
+    const spanAggregator = this.transaction.agent.spans
+    const children = this.root.getChildren()
+    for (let i = 0; i < children.length; ++i) {
+      toProcess.push(new DTTraceNode(children[i], this.transaction.parentSpanId))
     }
 
-    // This assumes that spans will have their transaction's priority. If insertion of
-    // one event fails, all following will fail due to having the same priority.
-    if (addMoreSpans) {
-      addMoreSpans = spanAggregator.addSegment(
-        segment,
-        segmentInfo.parentId,
-        segmentInfo.grandparentId
+    while (toProcess.length) {
+      var segmentInfo = toProcess.pop()
+      var 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.
+      spanAggregator.addSegment(segment, segmentInfo.parentId)
+
+      Array.prototype.push.apply(
+        toProcess,
+        segment.getChildren().map(child => new DTTraceNode(child, segment.id))
       )
     }
-
-    var children = segment.getChildren()
-    Array.prototype.push.apply(
-      segments,
-      children.map(child => new DTTraceNode(child, segment.id, segmentInfo.parentId))
-    )
   }
 }
 
-function processNode(segment, segments) {
+function DTTraceNode(segment, parentId) {
+  this.segment = segment
+  this.parentId = parentId
+}
+
+function _softEndSegment(segment) {
   if (segment.timer.softEnd()) {
     segment._updateRootTimer()
     // timer.softEnd() returns true if the timer was ended prematurely, so
     // in that case we can name the segment as truncated
     segment.name = NAMES.TRUNCATED.PREFIX + segment.name
   }
-  Array.prototype.push.apply(segments, segment.getChildren())
 }
 
 /**

package/lib/util/byte-limit.js

@@ -0,0 +1,40 @@
+'use strict'
+
+/**
+ * Checks if a given string is within agent attribute limits.
+ *
+ * @param {string} str - Object key name or value
+ * @param {number} limit - String byte limit
+ */
+function isValidLength(str, limit) {
+  return Buffer.byteLength(str, 'utf8') < limit
+}
+
+/**
+ * Trims a string value to given byte limit, if necessary.
+ *
+ * @private
+ *
+ * @param {string} val - The value to truncate to given byte limit.
+ * @param {number} limit - The byte limit
+ *
+ * @return {string} The truncated value.
+ */
+function truncate(val, limit) {
+  // First truncation handles the simple case of only one-byte characters.
+  if (!isValidLength(val + 1)) {
+    val = val.substring(0, limit)
+  }
+
+  // Our limitation is on byte length, and the string could contain multi-byte
+  // characters. Doing a byte-substring could chop a character in half. We need
+  // to pop the remaining characters off one by one until we have a good length.
+  var l = val.length
+  while (!isValidLength(val, limit + 1)) {
+    val = val.substring(0, --l)
+  }
+  return val
+}
+
+module.exports.isValidLength = isValidLength
+module.exports.truncate = truncate

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "newrelic",
-  "version": "4.4.0",
+  "version": "4.7.0",
   "author": "New Relic Node.js agent team <nodejs@newrelic.com>",
   "licenses": [
     {
@@ -96,7 +96,7 @@
   ],
   "homepage": "http://github.com/newrelic/node-newrelic",
   "engines": {
-    "node": ">=4.0.0",
+    "node": ">=4.0.0 <11.0.0",
     "npm": ">=2.0.0"
   },
   "directories": {

package/.npmignore

@@ -1,4 +0,0 @@
-test
-examples
-out
-Makefile