newrelic 6.13.1 → 7.0.1

package/lib/instrumentation/core/http.js

@@ -15,7 +15,6 @@ const util = require('util')
 const url = require('url')
 const urltils = require('../../util/urltils')
 const properties = require('../../util/properties')
-const psemver = require('../../util/process-version')
 const headerAttributes = require('../../header-attributes')
 const headerProcessing = require('../../header-processing')
 
@@ -27,8 +26,6 @@ const DESTS = require('../../config/attribute-filter').DESTINATIONS
  * CONSTANTS
  *
  */
-const SHOULD_WRAP_HTTPS = psemver.satisfies('>=9.0.0 || 8.9.0')
-const SHOULD_FORMAT_ARGS = psemver.satisfies('>=10.0.0')
 const NR_CONNECTION_PROP = '__NR__connection'
 const NEWRELIC_ID_HEADER = 'x-newrelic-id'
 const NEWRELIC_APP_DATA_HEADER = 'x-newrelic-app-data'
@@ -172,16 +169,7 @@ function wrapEmitWithTransaction(agent, emit, isHTTPS) {
 
       if (response) {
         if (response.statusCode != null) {
-          /*
-          TODO: remove with next major release
-          httpResponseCode attribute is deprecated
-          */
           var responseCode = String(response.statusCode)
-          transaction.trace.attributes.addAttribute(
-            DESTS.TRANS_COMMON,
-            'httpResponseCode',
-            responseCode
-          )
 
           if (/^\d+$/.test(responseCode)) {
             transaction.trace.attributes.addAttribute(
@@ -191,16 +179,6 @@ function wrapEmitWithTransaction(agent, emit, isHTTPS) {
             )
               
             segment.addSpanAttribute('http.statusCode', responseCode)
-
-            /*
-            TODO: remove with next major release
-            response.status attribute is deprecated
-            */
-            transaction.trace.attributes.addAttribute(
-              DESTS.TRANS_COMMON,
-              'response.status',
-              responseCode
-            )
           }
         }
 
@@ -212,16 +190,6 @@ function wrapEmitWithTransaction(agent, emit, isHTTPS) {
           )
 
           segment.addSpanAttribute('http.statusText', response.statusMessage)
-
-          /*
-            TODO: remove with next major release
-            httpResponseMessage attribute is deprecated
-          */
-          transaction.trace.attributes.addAttribute(
-            DESTS.TRANS_COMMON,
-            'httpResponseMessage',
-            response.statusMessage
-          )
         }
 
         var headers = response.getHeaders()
@@ -442,37 +410,30 @@ function urlToOptions(_url) {
 }
 
 function wrapRequest(agent, request) {
-  // URL as a global was not added until Node v10
-  const URLClass = global.URL ? global.URL : url.URL
   return function wrappedRequest(input, options, cb) {
-    let reqArgs = arguments
-    if (SHOULD_FORMAT_ARGS) {
-      // Support new function signatures in Node v10+. If the first argument is a URL,
-      // merge it into the options object. This code is copied from Node internals.
-      if (typeof input === 'string') {
-        const urlStr = input
-        input = urlToOptions(new URLClass(urlStr))
-      } else if (input.constructor && input.constructor.name === 'URL') {
-        input = urlToOptions(input)
-      } else {
-        cb = options
-        options = input
-        input = null
-      }
-
-      if (typeof options === 'function') {
-        cb = options
-        options = input || {}
-      } else {
-        options = Object.assign(input || {}, options)
-      }
-
-      reqArgs = [options, cb]
+    // If the first argument is a URL, merge it into the options object.
+    // This code is copied from Node internals.
+    if (typeof input === 'string') {
+      const urlStr = input
+      input = urlToOptions(new URL(urlStr))
+    } else if (input.constructor && input.constructor.name === 'URL') {
+      input = urlToOptions(input)
     } else {
-      // Node v8 function signature had options as the first argument
+      cb = options
       options = input
+      input = null
+    }
+
+    if (typeof options === 'function') {
+      cb = options
+      options = input || {}
+    } else {
+      options = Object.assign(input || {}, options)
     }
 
+    let reqArgs = [options, cb]
+
+
     // Don't pollute metrics and calls with NR connections
     const internalOnly = options && options[NR_CONNECTION_PROP]
     if (internalOnly) {
@@ -552,28 +513,19 @@ module.exports = function initialize(agent, http, moduleName) {
 
   var agentProto = http && http.Agent && http.Agent.prototype
 
-  // As of node 0.8, http.request() is the right way to originate outbound
-  // requests. From 0.11 until 9, the `https` module simply called through to
-  // the `http` methods, so to prevent double-instrumenting we need to check
-  // what module we're instrumenting and what version of Node we're on. This
-  // change originally also appeared in 8.9.0 but was reverted in 8.9.1.
-  //
-  // TODO: Remove `SHOULD_WRAP_HTTPS` after deprecating Node <9.
-  if (SHOULD_WRAP_HTTPS || !IS_HTTPS) {
-    shimmer.wrapMethod(
-      http,
-      'http',
-      'request',
-      wrapRequest.bind(null, agent)
-    )
+  shimmer.wrapMethod(
+    http,
+    'http',
+    'request',
+    wrapRequest.bind(null, agent)
+  )
 
-    shimmer.wrapMethod(
-      http,
-      'http',
-      'get',
-      wrapRequest.bind(null, agent)
-    )
-  }
+  shimmer.wrapMethod(
+    http,
+    'http',
+    'get',
+    wrapRequest.bind(null, agent)
+  )
 
   shimmer.wrapMethod(
     agentProto,

package/lib/metrics/names.js

@@ -240,10 +240,13 @@ const SPAN_EVENTS = {
 const INFINITE_TRACING = {
   SEEN: SUPPORTABILITY.INFINITE_TRACING + '/Span/Seen',
   SENT: SUPPORTABILITY.INFINITE_TRACING + '/Span/Sent',
+  DROPPED: SUPPORTABILITY.INFINITE_TRACING + '/Span/Dropped',
   SPAN_RESPONSE_ERROR: SUPPORTABILITY.INFINITE_TRACING + '/Span/Response/Error',
   SPAN_RESPONSE_GRPC_UNIMPLEMENTED: SUPPORTABILITY.INFINITE_TRACING + '/Span/gRPC/UNIMPLEMENTED',
   SPAN_RESPONSE_GRPC_STATUS: SUPPORTABILITY.INFINITE_TRACING + '/Span/gRPC/%s',
-  DRAIN_DURATION: SUPPORTABILITY.INFINITE_TRACING + '/Drain/Duration'
+  QUEUE_CAPACITY: SUPPORTABILITY.INFINITE_TRACING + '/Span/QueueCapacity',
+  QUEUE_SIZE: SUPPORTABILITY.INFINITE_TRACING + '/Span/QueueSize',
+  DRAIN_DURATION: SUPPORTABILITY.INFINITE_TRACING + '/Drain/Duration',
 }
 
 module.exports = {

package/lib/serverless/aws-lambda.js

@@ -389,26 +389,8 @@ function setWebResponse(transaction, response) {
   transaction.statusCode = response.statusCode
 
   const responseCode = String(response.statusCode)
-  /*
-  TODO: remove with next major release
-  httpResponseCode attribute is deprecated
-  */
-  transaction.trace.attributes.addAttribute(
-    ATTR_DEST.TRANS_COMMON,
-    'httpResponseCode',
-    responseCode
-  )
 
   if (/^\d+$/.test(responseCode)) {
-    /*
-    TODO: remove with next major release
-    response.status attribute is deprecated
-    */
-    transaction.trace.attributes.addAttribute(
-      ATTR_DEST.TRANS_COMMON,
-      'response.status',
-      responseCode)
-
     transaction.trace.attributes.addAttribute(
       ATTR_DEST.TRANS_COMMON,
       'http.statusCode',

package/lib/spans/span-context.js

@@ -21,6 +21,9 @@ class SpanContext {
       customAttributes || new PrioritizedAttributes(ATTRIBUTE_SCOPE, MAXIMUM_CUSTOM_ATTRIBUTES)
 
     this.ATTRIBUTE_PRIORITY = ATTRIBUTE_PRIORITY
+
+    this.hasError = false
+    this.errorDetails = null
   }
 
   addIntrinsicAttribute(key, value) {
@@ -36,6 +39,21 @@ class SpanContext {
       priority
     )
   }
+
+  /**
+   * Set error details to be potentially be used to create span
+   * attributes. Attributes will be created unless the transaction
+   * ends with an ignored error status code.
+   *
+   * Last error wins.
+   */
+  setError(details) {
+    this.hasError = true
+
+    // Error details will be used to create attributes unless the transaction ends
+    // with an ignored status code.
+    this.errorDetails = details
+  }
 }
 
 module.exports = SpanContext

package/lib/spans/span-event.js

@@ -84,9 +84,21 @@ class SpanEvent {
    * @return {SpanEvent} The constructed event.
    */
   static fromSegment(segment, parentId = null, isRoot = false) {
+    const spanContext = segment.getSpanContext()
+
+    // Since segments already hold span agent attributes and we want to leverage
+    // filtering, we add to the segment attributes prior to processing.
+    if (spanContext.hasError && !segment.transaction.hasIgnoredErrorStatusCode()) {
+      const details = spanContext.errorDetails
+      segment.addSpanAttribute('error.message', details.message)
+      segment.addSpanAttribute('error.class', details.type)
+      if (details.expected) {
+        segment.addSpanAttribute('error.expected', details.expected)
+      }
+    }
+
     const attributes = segment.attributes.get(DESTINATIONS.SPAN_EVENT)
 
-    const spanContext = segment.getSpanContext()
     const customAttributes = spanContext.customAttributes.get(DESTINATIONS.SPAN_EVENT)
 
     let span = null
@@ -98,7 +110,6 @@ class SpanEvent {
       span = new SpanEvent(attributes, customAttributes)
     }
 
-
     for (const [key, value] of Object.entries(spanContext.intrinsicAttributes)) {
       span.intrinsics[key] = value
     }

package/lib/spans/span-streamer.js

@@ -8,10 +8,10 @@
 const logger = require('../logger').child({component: 'span-streamer'})
 const NAMES = require('../metrics/names').INFINITE_TRACING
 
+const SPAN_DROP_MSG_INTERVAL_MS = 30000
 const SPAN_DROP_MSG =
-  'Queue full, dropping spans.'
-const SPAN_DROP_INTERVAL = 5
-
+  'Queue full, dropping spans. ' +
+  `Will not warn again for ${SPAN_DROP_MSG_INTERVAL_MS / 1000} seconds.`
 
 class SpanStreamer {
   constructor(license_key, connection, metrics, queue_size) {
@@ -47,21 +47,20 @@ class SpanStreamer {
 
     // If not writeable (because of backpressure) queue the span
     if (!this._writable) {
-      if (this.spans.length <= this.queue_size) {
+      if (this.spans.length < this.queue_size) {
         this.spans.push(span)
         return
       }
 
+      // While this can be directionally calculated between seen/sent the
+      // queue makes that a bit more disconnected. This will be a bit more specific.
+      this._metrics.getOrCreateMetric(NAMES.DROPPED).incrementCallCount()
+
       // If the queue is full drop the span
       logger.infoOncePer(
-        // key for the OncePer
-        'SPAN_DROP_MSG',
-        // interval in ms
-        SPAN_DROP_INTERVAL * 1000,
-        // message
-        SPAN_DROP_MSG + ' Will not warn again for %s seconds.',
-        // variables to put in log message
-        SPAN_DROP_INTERVAL
+        'SPAN_DROP_MSG', // key for the OncePer
+        SPAN_DROP_MSG_INTERVAL_MS,
+        SPAN_DROP_MSG
       )
 
       return
@@ -121,14 +120,21 @@ class SpanStreamer {
   }
 
   sendQueue() {
+    logger.trace('Sending spans from queue.')
+
     // Continue sending the spans that were in the queue. _writable is checked
     // so that if a send fails while clearing the queue, this drain handler can
     // finish, and the drain handler setup on the failed send will then attempt
     // to clear the queue
     while (this.spans.length > 0 && this._writable) {
       const nextObject = this.spans.shift()
-      this.send(nextObject)
+      this.send(nextObject.toStreamingFormat())
     }
+
+    logger.trace(
+      'Finished sending spans from queue. Items left in queue: %s',
+      this.spans.length
+    )
   }
 
   connect(agent_run_id, requestHeadersMap) {
@@ -144,6 +150,11 @@ class SpanStreamer {
   disconnect() {
     this.connection.disconnect()
   }
+
+  createMetrics() {
+    this._metrics.getOrCreateMetric(NAMES.QUEUE_CAPACITY).recordValue(this.queue_size)
+    this._metrics.getOrCreateMetric(NAMES.QUEUE_SIZE).recordValue(this.spans.length)
+  }
 }
 
 module.exports = SpanStreamer

package/lib/spans/streaming-span-event-aggregator.js

@@ -98,6 +98,10 @@ class StreamingSpanEventAggregator extends Aggregator {
 
     this.requestHeadersMap = config.request_headers_map
   }
+
+  createMetrics() {
+    this.stream.createMetrics()
+  }
 }
 
 module.exports = StreamingSpanEventAggregator

package/lib/spans/streaming-span-event.js

@@ -102,9 +102,21 @@ class StreamingSpanEvent {
   }
 
   static fromSegment(segment, parentId = null, isRoot = false) {
+    const spanContext = segment.getSpanContext()
+
+    // Since segments already hold span agent attributes and we want to leverage
+    // filtering, we add to the segment attributes prior to processing.
+    if (spanContext.hasError && !segment.transaction.hasIgnoredErrorStatusCode()) {
+      const details = spanContext.errorDetails
+      segment.addSpanAttribute('error.message', details.message)
+      segment.addSpanAttribute('error.class', details.type)
+      if (details.expected) {
+        segment.addSpanAttribute('error.expected', details.expected)
+      }
+    }
+
     const agentAttributes = segment.attributes.get(DESTINATIONS.SPAN_EVENT)
 
-    const spanContext = segment.getSpanContext()
     const customAttributes = spanContext.customAttributes.get(DESTINATIONS.SPAN_EVENT)
 
     const transaction = segment.transaction

package/lib/transaction/dt-payload.js

@@ -13,7 +13,7 @@ const DT_VERSION_MINOR = 1
 module.exports = class DistributedTracePayload {
   /**
    * The class reponsible for producing distributed trace payloads.
-   * Created by calling {@link TransactionHandle#createDistributedTracePayload}.
+   * Created by calling {@link TransactionHandle#_createDistributedTracePayload}.
    *
    * @constructor
    */

package/lib/transaction/handle.js

@@ -5,9 +5,7 @@
 
 'use strict'
 
-const util = require('util')
 const logger = require('../logger').child({component: 'transactionHandle'})
-const DistributedTracePayloadStub = require('./dt-payload').Stub
 
 const NAMES = require('../../lib/metrics/names')
 
@@ -61,7 +59,6 @@ class TransactionHandle {
    */
   acceptDistributedTraceHeaders(transportType, headers) {
     incrementApiSupportMetric(this._metrics, 'acceptDistributedTraceHeaders')
-
     return this._transaction.acceptDistributedTraceHeaders(transportType, headers)
   }
 
@@ -71,48 +68,10 @@ class TransactionHandle {
    */
   insertDistributedTraceHeaders(headers) {
     incrementApiSupportMetric(this._metrics, 'insertDistributedTraceHeaders')
-
     return this._transaction.insertDistributedTraceHeaders(headers)
   }
-
-  /**
-  *
-  * Proxy method for Transaction#createDistrubtedTracePayload.
-  *
-  * @returns {DistributedTracePayload} The created payload object.
-  *
-  */
-  createDistributedTracePayload() {
-    return this._transaction.createDistributedTracePayload()
-  }
-
-  /**
-  *
-  * Proxy method for Transaction#acceptDistributedTracePayload
-  *
-  * @param {String} The payload to accept as the parent to the current trace
-  *
-  */
-  acceptDistributedTracePayload(payload) {
-    return this._transaction.acceptDistributedTracePayload(payload)
-  }
 }
 
-// TODO: Fully remove functions in future Major release. v7.0.0?
-TransactionHandle.prototype.acceptDistributedTracePayload = util.deprecate(
-  TransactionHandle.prototype.acceptDistributedTracePayload,
-  'TransactionHandle#acceptDistributedTracePayload has been deprecated! ' +
-  'Please use TransactionHandle#acceptDistributedTraceHeaders ' +
-  'which supports multiple distributed trace formats.'
-)
-
-TransactionHandle.prototype.createDistributedTracePayload = util.deprecate(
-  TransactionHandle.prototype.createDistributedTracePayload,
-  'TransactionHandle#createDistributedTracePayload has been deprecated! ' +
-  'Please use TransactionHandle#insertDistributedTraceHeaders ' +
-  'which supports multiple distributed trace formats.'
-)
-
 module.exports = TransactionHandle
 
 function incrementApiSupportMetric(metrics, functionName) {
@@ -147,19 +106,6 @@ module.exports.Stub = class TransactionHandleStub {
     logger.debug("No transaction found when calling Transaction.isSampled")
   }
 
-  createDistributedTracePayload() {
-    logger.debug(
-      "No transaction found when calling Transaction.createDistributedTracePayload"
-    )
-    return new DistributedTracePayloadStub()
-  }
-
-  acceptDistributedTracePayload() {
-    logger.debug(
-      "No transaction found when calling Transaction.acceptDistributedTracePayload"
-    )
-  }
-
   acceptDistributedTraceHeaders() {
     logger.debug("No transaction found when calling Transaction.acceptDistributedTraceHeaders")
   }

package/lib/transaction/index.js

@@ -679,7 +679,6 @@ Transaction.prototype.measure = function measure(name, scope, duration, exclusiv
 Transaction.prototype._setApdex = function _setApdex(name, duration, keyApdexInMillis) {
   var apdexStats = this.metrics.getOrCreateApdexMetric(name, null, keyApdexInMillis)
 
-
   // if we have an error-like status code, and all the errors are
   // expected, we know the status code was caused by an expected
   // error, so we will not report "frustrating".  Otherwise, we
@@ -747,19 +746,13 @@ function _linkExceptionToSegment(exception) {
     return
   }
 
-  const config = this.agent.config
-
-  // Add error attributes to the span
-  const details = exception.getErrorDetails(config)
-  segment.addSpanAttribute('error.message', details.message)
-  segment.addSpanAttribute('error.class', details.type)
-
-  const isExpected =
-    errorHelper.isExpectedErrorClass(config, details.type) ||
-    errorHelper.isExpectedErrorMessage(config, details.type, details.message)
-
-  if (isExpected) {
-    segment.addSpanAttribute('error.expected', isExpected)
+  const spanContext = segment.getSpanContext()
+  if (spanContext) {
+    // Exception attributes will be added to span unless transaction
+    // status code has been ignored. Last error wins.
+    const config = this.agent.config
+    const details = exception.getErrorDetails(config)
+    spanContext.setError(details)
   }
 
   // Add the span/segment ID to the exception as agent attributes
@@ -793,6 +786,14 @@ function _addUserError(exception) {
   this.userErrors.push(exception)
 }
 
+/**
+ * Returns if the transaction's current status code is errored
+ * but considered ignored via the config.
+ */
+Transaction.prototype.hasIgnoredErrorStatusCode = function _hasIgnoredErrorStatusCode() {
+  return urltils.isIgnoredError(this.agent.config, this.statusCode)
+}
+
 /**
  * Returns true if an error happened during the transaction or if the transaction itself is
  * considered to be an error.
@@ -885,19 +886,14 @@ function acceptDistributedTraceHeaders(transportType, headers) {
 
   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 {
+  } else if (NEWRELIC_TRACE_HEADER in headers) {
+    logger.trace('Accepting newrelic DT payload for transaction %s', this.id)
     // 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)
-    }
+    this._acceptDistributedTracePayload(payload, transport)
   }
 }
 
@@ -928,7 +924,7 @@ function insertDistributedTraceHeaders(headers) {
   }
 
   try {
-    const newrelicFormatData = this.createDistributedTracePayload().httpSafe()
+    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) {
@@ -992,8 +988,8 @@ function acceptTraceContextPayload(traceparent, tracestate, transport) {
  * @param {object} payload                - The distributed trace payload to accept.
  * @param {string} [transport='Unknown']  - The transport type that delivered the payload.
  */
-Transaction.prototype.acceptDistributedTracePayload = acceptDistributedTracePayload
-function acceptDistributedTracePayload(payload, transport) {
+Transaction.prototype._acceptDistributedTracePayload = _acceptDistributedTracePayload
+function _acceptDistributedTracePayload(payload, transport) {
   if (!payload) {
     this.agent.recordSupportability('DistributedTrace/AcceptPayload/Ignored/Null')
     return
@@ -1088,11 +1084,6 @@ function acceptDistributedTracePayload(payload, transport) {
     return
   }
 
-  // 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
   this.parentAcct = data.ac
@@ -1162,9 +1153,9 @@ Transaction.prototype._getParsedPayload = function _getParsedPayload(payload) {
 /**
  * Creates a distributed trace payload.
  */
-Transaction.prototype.createDistributedTracePayload = createDistributedTracePayload
+Transaction.prototype._createDistributedTracePayload = _createDistributedTracePayload
 
-function createDistributedTracePayload() {
+function _createDistributedTracePayload() {
   const config = this.agent.config
   const accountId = config.account_id
   const appId = config.primary_application_id
@@ -1184,11 +1175,6 @@ 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()
   const data = {
     ty: 'App',

package/lib/transaction/tracecontext.js

@@ -63,7 +63,14 @@ class TraceContext {
     // If no segment/span is in context, generate one so we can have a valid traceparent
     const segment = this.transaction.agent.tracer.getSegment()
     let parentId = segment && segment.id
-    parentId = parentId || hashes.makeId(16)
+    if (!parentId) {
+      parentId = hashes.makeId(16)
+      logger.debug(
+        'No segment/span in context. Generated new traceparent parentId (%s) for traceId (%s)',
+        parentId,
+        traceId
+      )
+    }
 
     return `${W3C_TRACEPARENT_VERSION}-${traceId}-${parentId}-${this.createFlagsHex()}`
   }
@@ -103,7 +110,11 @@ class TraceContext {
       const segment = this.transaction.agent.tracer.getSegment()
       if (segment) {
         spanId = segment.id
+      } else {
+        logger.debug('No segment/span in context. Not sending spanId in tracestate.')
       }
+    } else {
+      logger.trace('Span events disabled. Not sending spanId in tracestate.')
     }
 
     const transactionId = config.transaction_events.enabled ? this.transaction.id : ''
@@ -130,11 +141,15 @@ class TraceContext {
       return
     }
 
-    headers[TRACE_CONTEXT_PARENT_HEADER] = this.createTraceparent()
+    const traceParent = this.createTraceparent()
+    headers[TRACE_CONTEXT_PARENT_HEADER] = traceParent
+
+    logger.trace('traceparent added with %s', traceParent)
 
     const tracestate = this.createTracestate()
     if (tracestate) {
       headers[TRACE_CONTEXT_STATE_HEADER] = tracestate
+      logger.trace('tracestate added with %s', tracestate)
     }
 
     this.transaction.agent.recordSupportability('TraceContext/Create/Success')