newrelic 6.3.0 → 6.5.0

package/lib/instrumentation/core/http.js

@@ -12,10 +12,7 @@ const urltils = require('../../util/urltils')
 const properties = require('../../util/properties')
 const psemver = require('../../util/process-version')
 const headerAttributes = require('../../header-attributes')
-const TRACE_CONTEXT_PARENT_HEADER
-  = require('../../transaction/tracecontext').TRACE_CONTEXT_PARENT_HEADER
-const TRACE_CONTEXT_STATE_HEADER
-  = require('../../transaction/tracecontext').TRACE_CONTEXT_STATE_HEADER
+const headerProcessing = require('../../header-processing')
 
 const NAMES = require('../../metrics/names')
 const DESTS = require('../../config/attribute-filter').DESTINATIONS
@@ -26,15 +23,12 @@ const DESTS = require('../../config/attribute-filter').DESTINATIONS
  *
  */
 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 REQUEST_HEADER = 'x-request-start'
-const QUEUE_HEADER = 'x-queue-start'
 const NEWRELIC_ID_HEADER = 'x-newrelic-id'
 const NEWRELIC_APP_DATA_HEADER = 'x-newrelic-app-data'
-const NEWRELIC_TRACE_HEADER = 'newrelic'
 const NEWRELIC_TRANSACTION_HEADER = 'x-newrelic-transaction'
 const NEWRELIC_SYNTHETICS_HEADER = 'x-newrelic-synthetics'
-const CONTENT_LENGTH_REGEX = /^Content-Length$/i
 const TRANSACTION_INFO_KEY = '__NR_transactionInfo'
 
 
@@ -118,57 +112,14 @@ function wrapEmitWithTransaction(agent, emit, isHTTPS) {
       'Applying user naming rules for RUM.')
     transaction.applyUserNamingRules(request.url)
 
-    /**
-     * Calculate Queue Time
-     *
-     * Queue time is provided by certain providers by stamping the request
-     * header with the time the request arrived at the router.
-     *
-     * Units for queue time are
-     */
-    var qtime = request.headers[REQUEST_HEADER] || request.headers[QUEUE_HEADER]
-    if (qtime) {
-      var split = qtime.split('=')
-      if (split.length > 1) {
-        qtime = split[1]
-      }
-
-      var start = parseFloat(qtime)
-
-      if (isNaN(start)) {
-        logger.warn('Queue time header parsed as NaN (%s)', qtime)
-      } else {
-        // nano seconds
-        if (start > 1e18) start = start / 1e6
-        // micro seconds
-        else if (start > 1e15) start = start / 1e3
-        // seconds
-        else if (start < 1e12) start = start * 1e3
-
-        transaction.queueTime = Date.now() - start
-      }
+    const queueTimeStamp = headerProcessing.getQueueTime(logger, request.headers)
+    if (queueTimeStamp) {
+      transaction.queueTime = Date.now() - queueTimeStamp
     }
+
     if (agent.config.distributed_tracing.enabled) {
-      if (agent.config.feature_flag.dt_format_w3c) {
-        const traceparent = request.headers[TRACE_CONTEXT_PARENT_HEADER]
-        const tracestate = request.headers[TRACE_CONTEXT_STATE_HEADER]
-        if (traceparent && tracestate) {
-          logger.trace(
-            'Accepting trace context payload for transaction %s',
-            transaction.id
-          )
-          transaction.traceContext.acceptTraceContextPayload(traceparent, tracestate)
-        }
-      } else {
-        const payload = request.headers[NEWRELIC_TRACE_HEADER]
-        if (payload) {
-          logger.trace(
-            'Accepting distributed trace payload for transaction %s',
-            transaction.id
-          )
-          transaction.acceptDistributedTracePayload(payload, transport)
-        }
-      }
+      // Node http headers are automatically lowercase
+      transaction.acceptDistributedTraceHeaders(transport, request.headers)
     } else if (agent.config.cross_application_tracer.enabled) {
       var encKey = agent.config.encoding_key
       var incomingCatId = request.headers[NEWRELIC_ID_HEADER]
@@ -202,6 +153,10 @@ 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,
@@ -210,6 +165,16 @@ function wrapEmitWithTransaction(agent, emit, isHTTPS) {
           )
 
           if (/^\d+$/.test(responseCode)) {
+            transaction.trace.attributes.addAttribute(
+              DESTS.TRANS_COMMON,
+              'http.statusCode',
+              responseCode
+            )
+
+            /*
+            TODO: remove with next major release
+            response.status attribute is deprecated
+            */
             transaction.trace.attributes.addAttribute(
               DESTS.TRANS_COMMON,
               'response.status',
@@ -217,7 +182,18 @@ function wrapEmitWithTransaction(agent, emit, isHTTPS) {
             )
           }
         }
+
         if (response.statusMessage !== undefined) {
+          transaction.trace.attributes.addAttribute(
+            DESTS.TRANS_COMMON,
+            'http.statusText',
+            response.statusMessage
+          )
+
+          /*
+            TODO: remove with next major release
+            httpResponseMessage attribute is deprecated
+          */
           transaction.trace.attributes.addAttribute(
             DESTS.TRANS_COMMON,
             'httpResponseMessage',
@@ -225,8 +201,7 @@ function wrapEmitWithTransaction(agent, emit, isHTTPS) {
           )
         }
 
-        // TODO: Just use `getHeaders()` after deprecating Node <7.7.
-        var headers = (response.getHeaders && response.getHeaders()) || response._headers
+        var headers = response.getHeaders()
         if (headers) {
           headerAttributes.collectResponseHeaders(headers, transaction)
         }
@@ -379,25 +354,12 @@ function wrapWriteHead(agent, writeHead) {
     var new_headers = arguments[arguments.length - 1]
 
     if (typeof new_headers === 'object') {
-      for (var header in new_headers) {  // jshint ignore: line
-        if (CONTENT_LENGTH_REGEX.test(header)) {
-          contentLength = new_headers[header]
-          break
-        }
-      }
+      contentLength = headerProcessing.getContentLengthFromHeaders(new_headers)
     }
 
-    if (contentLength === -1 && this._headers) {
-      // JSHint complains about ownProperty stuff, but since we are looking
-      // for a specific name that doesn't matter so I'm disabling it.
-      // Outbound headers can be capitalized in any way, use regex instead
-      // of direct lookup.
-      for (var userHeader in this._headers) {  // jshint ignore: line
-        if (CONTENT_LENGTH_REGEX.test(userHeader)) {
-          contentLength = this._headers[userHeader]
-          break
-        }
-      }
+    const currentHeaders = this.getHeaders()
+    if (contentLength === -1 && currentHeaders) {
+      contentLength = headerProcessing.getContentLengthFromHeaders(currentHeaders)
     }
     // Stored on the tx so we can push a metric with this time instead of
     // actual duration.
@@ -434,8 +396,60 @@ function wrapWriteHead(agent, writeHead) {
   }
 }
 
+// Taken from the Node code base, internal/url.js
+function urlToOptions(_url) {
+  const options = {
+    protocol: _url.protocol,
+    hostname: typeof _url.hostname === 'string' && _url.hostname.startsWith('[') ?
+      _url.hostname.slice(1, -1) :
+      _url.hostname,
+    hash: _url.hash,
+    search: _url.search,
+    pathname: _url.pathname,
+    path: `${_url.pathname || ''}${_url.search || ''}`,
+    href: _url.href
+  }
+  if (_url.port !== '') {
+    options.port = Number(_url.port)
+  }
+  if (_url.username || _url.password) {
+    options.auth = `${_url.username}:${_url.password}`
+  }
+  return options
+}
+
 function wrapRequest(agent, request) {
-  return function wrappedRequest(options) {
+  // 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]
+    } else {
+      // Node v8 function signature had options as the first argument
+      options = input
+    }
+
     // Don't pollute metrics and calls with NR connections
     const internalOnly = options && options[NR_CONNECTION_PROP]
     if (internalOnly) {
@@ -453,13 +467,12 @@ function wrapRequest(agent, request) {
           logOpts.port
         )
       }
-      return request.apply(this, arguments)
+      return request.apply(this, reqArgs)
     }
 
-    const args = agent.tracer.slice(arguments)
+    const args = agent.tracer.slice(reqArgs)
     const context = this
 
-    // hostname & port logic pulled directly from node's 0.10 lib/http.js
     return instrumentOutbound(agent, options, function makeRequest(opts) {
       args[0] = opts
       return request.apply(context, args)
@@ -467,28 +480,6 @@ function wrapRequest(agent, request) {
   }
 }
 
-function wrapLegacyRequest(agent, request) {
-  return function wrappedLegacyRequest(method, path, headers) {
-    var makeRequest = request.bind(this, method, path, headers)
-
-    if (agent.tracer.getTransaction()) {
-      return instrumentOutbound(agent, this, makeRequest)
-    }
-
-    logger.trace('No transaction, not recording external to %s:%s', this.host, this.port)
-    return makeRequest()
-  }
-}
-
-function wrapLegacyClient(agent, proto) {
-  shimmer.wrapMethod(
-    proto,
-    'http.Client.prototype',
-    'request',
-    wrapLegacyRequest.bind(null, agent)
-  )
-}
-
 module.exports = function initialize(agent, http, moduleName) {
   if (!http) {
     logger.debug('Did not get http module, not instrumenting!')
@@ -545,7 +536,7 @@ module.exports = function initialize(agent, http, moduleName) {
   // 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) {
+  if (SHOULD_WRAP_HTTPS || !IS_HTTPS) {
     shimmer.wrapMethod(
       http,
       'http',
@@ -553,21 +544,12 @@ module.exports = function initialize(agent, http, moduleName) {
       wrapRequest.bind(null, agent)
     )
 
-    // Upon updating to https-proxy-agent v2, we are now using
-    // agent-base v4, which patches https.get to use https.request.
-    //
-    // https://github.com/TooTallNate/node-agent-base/commit/7de92df780e147d4618
-    //
-    // This means we need to skip instrumenting to avoid double
-    // instrumenting external requests.
-    if (!IS_HTTPS && psemver.satisfies('>=8')) {
-      shimmer.wrapMethod(
-        http,
-        'http',
-        'get',
-        wrapRequest.bind(null, agent)
-      )
-    }
+    shimmer.wrapMethod(
+      http,
+      'http',
+      'get',
+      wrapRequest.bind(null, agent)
+    )
   }
 
   shimmer.wrapMethod(
@@ -592,58 +574,6 @@ module.exports = function initialize(agent, http, moduleName) {
       }
     }
   )
-
-  // http.Client is deprecated, but still in use
-  // TODO: Remove this once Node <7 is deprecated.
-  var DeprecatedClient, deprecatedCreateClient
-  function clearGetters() {
-    if (DeprecatedClient) {
-      delete http.Client
-      http.Client = DeprecatedClient
-    }
-    if (deprecatedCreateClient) {
-      delete http.createClient
-      http.createClient = deprecatedCreateClient
-    }
-  }
-
-  // TODO: Remove this once Node <7 is deprecated.
-  DeprecatedClient = shimmer.wrapDeprecated(
-    http,
-    'http',
-    'Client',
-    {
-      get: function get() {
-        var example = new DeprecatedClient(80, 'localhost')
-        wrapLegacyClient(agent, example.constructor.prototype)
-        clearGetters()
-
-        return DeprecatedClient
-      },
-      set: function set(NewClient) {
-        DeprecatedClient = NewClient
-      }
-    }
-  )
-
-  // TODO: Remove this once Node <7 is deprecated.
-  deprecatedCreateClient = shimmer.wrapDeprecated(
-    http,
-    'http',
-    'createClient',
-    {
-      get: function get() {
-        var example = deprecatedCreateClient(80, 'localhost')
-        wrapLegacyClient(agent, example.constructor.prototype)
-        clearGetters()
-
-        return deprecatedCreateClient
-      },
-      set: function set(newCreateClient) {
-        deprecatedCreateClient = newCreateClient
-      }
-    }
-  )
 }
 
 /**

package/lib/instrumentation/hapi/hapi-17.js

@@ -1,6 +1,7 @@
 'use strict'
 
-var shared = require('./shared')
+const shared = require('./shared')
+const record = require('../../metrics/recorders/generic')
 
 // TODO: abstract and consolidate mostly-shared hapi functionality
 module.exports = function initialize(agent, hapi, moduleName, shim) {
@@ -154,14 +155,20 @@ function wrapPreHandlers(shim, container, path) {
     }
     return container
   } else if (shim.isFunction(container)) {
-    return wrapRouteHandler(shim, container, path)
+    return wrapPreHandler(shim, container, path)
   } else if (container.method && shim.isFunction(container.method)) {
     return shim.wrap(container, 'method', function wrapHandler(shim, handler) {
-      return wrapRouteHandler(shim, handler, path)
+      return wrapPreHandler(shim, handler, path)
     })
   }
 }
 
+function wrapPreHandler(shim, container, path) {
+  return shim.record(container, (shim) => {
+    return {name: [shim.HAPI, ' pre handler: ','(',path,')'].join(''), recorder: record}
+  })
+}
+
 function wrapRouteHandler(shim, handler, path) {
   return shim.recordMiddleware(handler, {
     route: path,

package/lib/metrics/names.js

@@ -11,6 +11,7 @@ const SUPPORTABILITY = {
   UNINSTRUMENTED: 'Supportability/Uninstrumented',
   EVENTS: 'Supportability/Events',
   API: 'Supportability/API',
+  TRANSACTION_API: 'Supportability/API/Transaction',
   UTILIZATION: 'Supportability/utilization',
   DEPENDENCIES: 'Supportability/InstalledDependencies',
   NODEJS: 'Supportability/Nodejs',

package/lib/serverless/aws-lambda.js

@@ -2,22 +2,23 @@
 
 const apiGateway = require('./api-gateway')
 const headerAttributes = require('../header-attributes')
+const get = require('../util/get')
 const logger = require('../logger').child({component: 'aws-lambda'})
 const recordBackground = require('../metrics/recorders/other')
 const recordWeb = require('../metrics/recorders/http')
 const TransactionShim = require('../shim/transaction-shim')
 const urltils = require('../util/urltils')
-const TRACE_CONTEXT_PARENT_HEADER
-  = require('../transaction/tracecontext').TRACE_CONTEXT_PARENT_HEADER
-const TRACE_CONTEXT_STATE_HEADER
-  = require('../transaction/tracecontext').TRACE_CONTEXT_STATE_HEADER
 
 // CONSTANTS
 const ATTR_DEST = require('../config/attribute-filter').DESTINATIONS
 const COLD_START_KEY = 'aws.lambda.coldStart'
-const EVENT_SOURCE_ARN_KEY = 'aws.lambda.eventSource.arn'
+const EVENT_SOURCE_PREFIX = 'aws.lambda.eventSource'
+const EVENT_SOURCE_ARN_KEY = `${EVENT_SOURCE_PREFIX}.arn`
+const EVENT_SOURCE_TYPE_KEY = `${EVENT_SOURCE_PREFIX}.eventType`
 const NAMES = require('../metrics/names')
 
+const EVENT_SOURCE_INFO = require('./event-sources')
+
 // A function with no references used to stub out closures
 function cleanClosure() {}
 
@@ -38,13 +39,27 @@ class AwsLambda {
     this.shim = new TransactionShim(agent, 'aws-lambda')
   }
 
-  // FOR TESTING PURPORSES ONLY
+  // FOR TESTING PURPOSES ONLY
   _resetModuleState() {
     patchCalled = false
     coldStartRecorded = false
     transactionEnders = []
   }
 
+  _detectEventType(event) {
+    const pathMatch = (obj, path) => {
+      return get(obj, path, null) !== null
+    }
+
+    for (const typeInfo of Object.values(EVENT_SOURCE_INFO)) {
+      if (typeInfo.required_keys.every((path) => pathMatch(event, path))) {
+        return typeInfo
+      }
+    }
+
+    return null
+  }
+
   patchLambdaHandler(handler) {
     const awsLambda = this
     const shim = this.shim
@@ -161,13 +176,34 @@ class AwsLambda {
 
       segment.start()
 
-      let res = shim.applySegment(handler, segment, false, this, args)
+      let res
+      try {
+        res = shim.applySegment(handler, segment, false, this, args)
+      } catch (err) {
+        uncaughtException = err
+        txnEnder()
+        throw err
+      }
       if (shim.isPromise(res)) {
-        res = shim.interceptPromise(res, txnEnder)
+        res = lambdaInterceptPromise(res, txnEnder)
       }
       return res
     }
 
+    // In order to capture error events
+    // we need to store the error in uncaughtException
+    // otherwise the transaction will end before they are captured
+    function lambdaInterceptPromise(prom, cb) {
+      return prom.then(function onThen(arg) {
+        cb()
+        return arg
+      }, function onCatch(err) {
+        uncaughtException = err
+        cb()
+        throw err // This is not our error, just rethrowing the promise rejection.
+      })
+    }
+
     function wrapCallbackAndCaptureError(transaction, txnEnder, cb, processResult) {
       return function wrappedCallback() {
         let err = arguments[0]
@@ -195,6 +231,22 @@ class AwsLambda {
       'aws.requestId': context.awsRequestId
     }
 
+    const eventSourceInfo = this._detectEventType(event)
+
+    if (eventSourceInfo) {
+      attributes[EVENT_SOURCE_TYPE_KEY] = eventSourceInfo.name
+
+      for (const key of Object.keys(eventSourceInfo.attributes)) {
+        const value = get(event, eventSourceInfo.attributes[key], null)
+
+        if (value === null) {
+          continue
+        }
+
+        attributes[key] = value
+      }
+    }
+
     setEventSourceAttributes(event, attributes)
 
     if (!coldStartRecorded) {
@@ -223,6 +275,11 @@ function setEventSourceAttributes(event, attributes) {
   } else if (event.records && event.deliveryStreamArn) {
     // Kinesis Firehose
     attributes[EVENT_SOURCE_ARN_KEY] = event.deliveryStreamArn
+  } else if (event.requestContext && event.requestContext.elb &&
+    event.requestContext.elb.targetGroupArn) {
+    attributes[EVENT_SOURCE_ARN_KEY] = event.requestContext.elb.targetGroupArn
+  } else if (event.resources && event.resources[0]) {
+    attributes[EVENT_SOURCE_ARN_KEY] = event.resources[0]
   } else {
     logger.trace('Unable to determine ARN for event type.', event)
   }
@@ -263,34 +320,23 @@ function setWebRequest(shim, transaction, request) {
   headerAttributes.collectRequestHeaders(request.headers, transaction)
 
   if (shim.agent.config.distributed_tracing.enabled) {
-    // W3C Fork based on format
-    if (shim.agent.config.feature_flag.dt_format_w3c) {
-      const traceparent = request.headers[TRACE_CONTEXT_PARENT_HEADER]
-      const tracestate = request.headers[TRACE_CONTEXT_STATE_HEADER]
-      if (traceparent && tracestate) {
-        logger.trace(
-          'Accepting trace context payload for transaction %s',
-          transaction.id
-        )
-        transaction.acceptTraceContextPayload(traceparent, tracestate)
-      }
-    } else {
-      // These are the three cases specified in the DT spec
-      // https://source.datanerd.us/agents/agent-specs/blob/master/Distributed-Tracing.md#supported-transports
-      const payload = request.headers.newrelic || request.headers.NEWRELIC ||
-        request.headers.Newrelic
-  
-      if (payload) {
-        logger.trace(
-          'Accepting distributed trace payload for transaction %s',
-          transaction.id
-        )
-        transaction.acceptDistributedTracePayload(payload, request.transportType)
-      }
-    }
+    const lowercaseHeaders = lowercaseObjectKeys(request.headers)
+
+    const transportType = request.transportType && request.transportType.toUpperCase()
+    transaction.acceptDistributedTraceHeaders(transportType, lowercaseHeaders)
   }
 }
 
+function lowercaseObjectKeys(original) {
+  const lowercaseObject = Object.keys(original)
+    .reduce((destination, key) => {
+      destination[key.toLowerCase()] = original[key]
+      return destination
+    }, {})
+
+  return lowercaseObject
+}
+
 function endTransaction(transaction, enderIndex) {
   if (transactionEnders[enderIndex] === cleanClosure) {
     // In the case where we have already been called, we return early. There may be a