newrelic 4.10.0 → 4.13.1

package/.eslintrc

@@ -8,6 +8,7 @@
     "ecmaVersion": 6
   },
   "rules": {
+    "indent": ["warn", 2, {"SwitchCase": 1}],
     "brace-style": "error",
     "comma-dangle": "off",
     "comma-style": ["error", "last"],
@@ -25,6 +26,7 @@
     "max-params": ["error", 5],
     "new-cap": "error",
     "no-console": "warn",
+    "no-debugger": "error",
     "no-else-return": "error",
     "no-floating-decimal": "error",
     "no-lonely-if": "error",

package/.npmignore

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

package/NEWS.md

@@ -1,3 +1,92 @@
+### 4.13.1 (2019-04-23):
+
+* Fixed bug where agent would stop sending data to New Relic servers when a connectivity
+  issue was encountered.
+
+* The agent will no longer crash the process in the event of unexpected calls to the
+  harvest callback.
+
+### 4.13.0 (2018-12-20):
+
+* Fixed clearing of active harvest via _stopHarvester()
+
+* Fixed handling of harvest endpoints when not all fail.
+
+* Added agent state "connecting" to indicate when handshake with New Relic servers
+  is starting. This can be triggered on startup and restarts.
+
+* Added `--no-package-lock` to `unit` and `integration` rules.
+
+* Released `protocol_17` feature flag.
+
+* The agent now reacts to failed New Relic requests based on response code, as
+  opposed to parsing an exception message in the response body.
+
+* Replaced `nsp` with `npm audit` in security checks.
+
+* Collector now specify `application/json` content-type when data is compressed
+  instead of `octet-stream`.
+
+* Bumped ecmaVersion in test .eslintrc to 8
+
+### 4.12.0 (2018-12-03):
+
+* Converted error handling in `CollectorAPI` and `RemoteMethod` to callbacks.
+
+  Previously many of the errors were thrown. For consistency with async errors,
+  these are now handed to the callback instead of thrown. The old behavior could
+  result in a crash under a few circumstances, such as when the agent exceeded a
+  configured maximum payload size. These errors came from `RemoteMethod._safeRequest`.
+  Since these errors are handed to the callback instead of thrown, this bug is no
+  longer a potential.
+
+* Added IP address collection and forwarding of metadata headers for upcoming
+  protocol 17.
+
+  These features are currently behind the `protocol_17` feature flag until all
+  parts of protocol 17 are implemented.
+
+* Refactored harvest interactions in preparation for protocol 17 status codes.
+
+### 4.11.0 (2018-11-15):
+
+* Changed totalTime attribute to be in decimal seconds instead of milliseconds for
+  transaction events.
+
+* Agent no longer produces spans on ignored transactions.
+
+  Previously, the agent would produce distributed tracing span events regardless
+  of the ignored status of the transaction the events originated from.
+
+* Extended Restify instrumentation to mark possible transaction names in order to
+  account for async response methods.
+
+* Added `protocol_17` feature flag.
+
+  Flag will be removed and protocol will be hard-coded to `17` once functionality
+  is released on New Relic backend.
+
+* Added switch statement indenting standard to eslintrc
+
+* This release also includes changes to the agent to enable monitoring of Lambda
+  functions. If you are interested in learning more or previewing New Relic Lambda
+  monitoring please email lambda_preview@newrelic.com.
+
+* Introduced "warn" level 2 space rule to eslintrc
+
+* Updated `hapi@16` versioned tests to only run on Node 6 and above.
+
+* Upgraded `@newrelic/test-utilities` to v2.
+
+* Pinned mysql2 to `<1.6.2` in versioned tests.
+
+* Added `waitForIdle` option to `API#shutdown`.
+
+  This new option will make the agent wait for all active transactions to finish
+  before actually shutting down. This does not pre-empt creation of new transactions,
+  so care must be taken to ensure the active transaction pool drains or the agent
+  will never shut down.
+
 ### 4.10.0 (2018-11-01):
 
 * Added `DatastoreShim#getDatabaseNameFromUseQuery`

package/api.js

@@ -1,21 +1,22 @@
 'use strict'
 
-var arity = require('./lib/util/arity')
-var util = require('util')
-var logger = require('./lib/logger').child({component: 'api'})
-var NAMES = require('./lib/metrics/names')
-var recordWeb = require('./lib/metrics/recorders/http')
-var recordBackground = require('./lib/metrics/recorders/other')
-var customRecorder = require('./lib/metrics/recorders/custom')
-var hashes = require('./lib/util/hashes')
-var properties = require('./lib/util/properties')
-var stringify = require('json-stringify-safe')
-var shimmer = require('./lib/shimmer')
-var Shim = require('./lib/shim/shim')
-var TransactionHandle = require('./lib/transaction/handle')
-
-const DESTS = require('./lib/config/attribute-filter').DESTINATIONS
+const arity = require('./lib/util/arity')
+const util = require('util')
+const logger = require('./lib/logger').child({component: 'api'})
+const recordWeb = require('./lib/metrics/recorders/http')
+const recordBackground = require('./lib/metrics/recorders/other')
+const customRecorder = require('./lib/metrics/recorders/custom')
+const hashes = require('./lib/util/hashes')
+const properties = require('./lib/util/properties')
+const stringify = require('json-stringify-safe')
+const shimmer = require('./lib/shimmer')
+const TransactionShim = require('./lib/shim/transaction-shim')
+const TransactionHandle = require('./lib/transaction/handle')
+const AwsLambda = require('./lib/serverless/aws-lambda')
+
+const ATTR_DEST = require('./lib/config/attribute-filter').DESTINATIONS
 const MODULE_TYPE = require('./lib/shim/constants').MODULE_TYPE
+const NAMES = require('./lib/metrics/names')
 
 /*
  *
@@ -55,7 +56,8 @@ const CUSTOM_EVENT_TYPE_REGEX = /^[a-zA-Z0-9:_ ]+$/
  */
 function API(agent) {
   this.agent = agent
-  this.shim = new Shim(agent, 'NewRelicAPI')
+  this.shim = new TransactionShim(agent, 'NewRelicAPI')
+  this.awsLambda = new AwsLambda(agent)
 }
 
 /**
@@ -83,8 +85,10 @@ API.prototype.setTransactionName = function setTransactionName(name) {
 
   if (!name) {
     if (transaction && transaction.url) {
-      logger.error("Must include name in setTransactionName call for URL %s.",
-                   transaction.url)
+      logger.error(
+        "Must include name in setTransactionName call for URL %s.",
+        transaction.url
+      )
     } else {
       logger.error("Must include name in setTransactionName call.")
     }
@@ -191,8 +195,10 @@ API.prototype.setControllerName = function setControllerName(name, action) {
 
   if (!name) {
     if (transaction && transaction.url) {
-      logger.error("Must include name in setControllerName call for URL %s.",
-                   transaction.url)
+      logger.error(
+        "Must include name in setControllerName call for URL %s.",
+        transaction.url
+      )
     } else {
       logger.error("Must include name in setControllerName call.")
     }
@@ -623,12 +629,12 @@ API.prototype.getBrowserTimingHeader = function getBrowserTimingHeader(options)
 
   var attrs = Object.create(null)
 
-  const customAttrs = trans.trace.custom.get(DESTS.BROWSER_EVENT)
+  const customAttrs = trans.trace.custom.get(ATTR_DEST.BROWSER_EVENT)
   if (!properties.isEmpty(customAttrs)) {
     attrs.u = customAttrs
   }
 
-  const agentAttrs = trans.trace.attributes.get(DESTS.BROWSER_EVENT)
+  const agentAttrs = trans.trace.attributes.get(ATTR_DEST.BROWSER_EVENT)
   if (!properties.isEmpty(agentAttrs)) {
     attrs.a = agentAttrs
   }
@@ -1567,33 +1573,59 @@ function instrumentMessages(moduleName, onRequire, onError) {
 /**
  * Shuts down the agent.
  *
- * @param {object}  [options]                           object with shut down options
- * @param {boolean} [options.collectPendingData=false]  If true, the agent will send any
- *                                                      pending data to the collector
- *                                                      before shutting down.
- * @param {number}  [options.timeout]                   time in ms to wait before
- *                                                      shutting down
- * @param {function} [callback]                         callback function that runs when
- *                                                      agent stopped
+ * @param {object} [options]
+ *  Object with shut down options.
+ *
+ * @param {boolean} [options.collectPendingData=false]
+ *  If true, the agent will send any pending data to the collector before
+ *  shutting down.
+ *
+ * @param {number} [options.timeout=0]
+ *  Time in milliseconds to wait before shutting down.
+ *
+ * @param {boolean} [options.waitForIdle=false]
+ *  If true, the agent will not shut down until there are no active transactions.
+ *
+ * @param {function} [callback]
+ *  Callback function that runs when agent stops.
  */
 API.prototype.shutdown = function shutdown(options, cb) {
-  var metric = this.agent.metrics.getOrCreateMetric(
-    NAMES.SUPPORTABILITY.API + '/shutdown'
-  )
-  metric.incrementCallCount()
+  this.agent.metrics.getOrCreateMetric(`${NAMES.SUPPORTABILITY.API}/shutdown`)
+    .incrementCallCount()
 
-  var callback = cb
-  if (!callback) {
-    if (typeof options === 'function') {
-      callback = options
-    } else {
-      callback = function noop() {}
-    }
+  let callback = cb
+  if (typeof options === 'function') {
+    // shutdown(cb)
+    callback = options
+    options = {}
+  } else if (typeof callback !== 'function') {
+    // shutdown([options])
+    callback = () => {}
   }
+  if (!options) {
+    // shutdown(null, cb)
+    options = {}
+  }
+
+  _doShutdown(this, options, callback)
+}
+
+function _doShutdown(api, options, callback) {
+  const agent = api.agent
 
-  var agent = this.agent
+  // If we need to wait for idle and there are currently active transactions,
+  // listen for transactions ending and check if we're ready to go.
+  if (options.waitForIdle && agent.activeTransactions) {
+    options.waitForIdle = false // To prevent recursive waiting.
+    agent.on('transactionFinished', function onTransactionFinished() {
+      if (agent.activeTransactions === 0) {
+        setImmediate(_doShutdown, api, options, callback)
+      }
+    })
+    return
+  }
 
-  function cb_harvest(error) {
+  function afterHarvest(error) {
     if (error) {
       logger.error(
         error,
@@ -1603,7 +1635,7 @@ API.prototype.shutdown = function shutdown(options, cb) {
     agent.stop(callback)
   }
 
-  if (options && options.collectPendingData && agent._state !== 'started') {
+  if (options.collectPendingData && agent._state !== 'started') {
     if (typeof options.timeout === 'number') {
       setTimeout(function shutdownTimeout() {
         agent.stop(callback)
@@ -1616,7 +1648,7 @@ API.prototype.shutdown = function shutdown(options, cb) {
     }
 
     agent.on('started', function shutdownHarvest() {
-      agent.harvest(cb_harvest)
+      agent.harvest(afterHarvest)
     })
     agent.on('errored', function logShutdownError(error) {
       agent.stop(callback)
@@ -1627,8 +1659,8 @@ API.prototype.shutdown = function shutdown(options, cb) {
         )
       }
     })
-  } else if (options && options.collectPendingData) {
-    agent.harvest(cb_harvest)
+  } else if (options.collectPendingData) {
+    agent.harvest(afterHarvest)
   } else {
     agent.stop(callback)
   }
@@ -1653,4 +1685,13 @@ function _checkKeyLength(object, maxLength) {
   return badKey
 }
 
+API.prototype.setLambdaHandler = function setLambdaHandler(handler) {
+  const metric = this.agent.metrics.getOrCreateMetric(
+    NAMES.SUPPORTABILITY.API + '/setLambdaHandler'
+  )
+  metric.incrementCallCount()
+
+  return this.awsLambda.patchLambdaHandler(handler)
+}
+
 module.exports = API

package/bin/travis-setup.sh

@@ -31,8 +31,11 @@ if [ "$SUITE" = "versioned" ]; then
   # npm 2 has an issue installing correctly for the superagent versioned tests.
   # TODO: Remove this check when deprecating Node <5.
   if [ "$(get_version npm)" == "2" ]; then
-    echo " -- upgrading npm --- "
+    echo " -- upgrading npm to 3 --- "
     npm install -g npm@3
+  elif [ "$(get_version npm)" == "5" ]; then
+    echo " --- upgrading npm to 6 --- "
+    npm install -g npm@6
   else
     echo " --- not upgrading npm ($(npm --version)) --- "
   fi
@@ -45,14 +48,19 @@ if [ "$SUITE" = "versioned" ]; then
   ./bin/travis-install-mongo.sh > /dev/null
 
   echo " --- done installing $SUITE requirements --- "
+
+elif [ "$SUITE" = "security" ]; then
+  # npm 6 has the `audit` command used for security check.
+  if [ "$(get_version npm)" != "6" ]; then
+    echo " -- upgrading npm to 6 --- "
+    npm install -g npm@6
+  else
+    echo " --- not upgrading npm ($(npm --version)) --- "
+  fi
 else
-  echo " --- not installing $SUITE requirements --- "
+  echo " --- no $SUITE installation requirements --- "
 fi
 
-if [ "$SUITE" = "security" ]; then
-  echo " --- installing nsp  --- "
-  npm install --no-save nsp
-fi
 
 # Always install time.
 sudo apt-get install -qq time

package/index.js

@@ -144,18 +144,20 @@ function createAgent(config) {
   var uninstrumented = require('./lib/uninstrumented')
   uninstrumented.check(shimmer.registeredInstrumentations)
 
-  agent.start(function cb_start(error) {
-    if (!error) {
-      return logger.debug("New Relic for Node.js is connected to New Relic.")
-    }
+  agent.start(function afterStart(error) {
+    if (error) {
+      var errorMessage = 'New Relic for Node.js halted startup due to an error:'
+      logger.error(error, errorMessage)
 
-    var errorMessage = "New Relic for Node.js halted startup due to an error:"
-    logger.error(error, errorMessage)
+      /* eslint-disable no-console */
+      console.error(errorMessage)
+      console.error(error.stack)
+      /* eslint-enable no-console */
 
-    /* eslint-disable no-console */
-    console.error(errorMessage)
-    console.error(error.stack)
-    /* eslint-enable no-console */
+      return
+    }
+
+    logger.debug('New Relic for Node.js is connected to New Relic.')
   })
 
   return agent

package/lib/adaptive-sampler.js

@@ -2,6 +2,7 @@
 
 class AdaptiveSampler {
   constructor(opts) {
+    this._serverless = opts.serverless
     this._seen = 0
     this._sampled = 0
     this._samplingPeriod = 0
@@ -12,6 +13,11 @@ class AdaptiveSampler {
     this._resetInterval = null
 
     this.samplingPeriod = opts.period
+
+    if (this._serverless) {
+      this._windowStart = null
+      opts.agent.on('transactionStarted', this.maybeUpdateWindow.bind(this))
+    }
   }
 
   get sampled() {
@@ -37,17 +43,34 @@ class AdaptiveSampler {
   }
 
   set samplingPeriod(period) {
-    clearInterval(this._resetInterval)
     this._samplingPeriod = period
+    if (!this._serverless) {
+      clearInterval(this._resetInterval)
 
-    if (period) {
-      this._resetInterval = setInterval(() => this._reset(), period)
-      this._resetInterval.unref()
+      if (period) {
+        this._resetInterval = setInterval(() => this._reset(), period)
+        this._resetInterval.unref()
+      }
+    }
+  }
+
+  /**
+   *  Used to determine if the sampling window should be reset based on the start time
+   *  of the provided transaction.
+   *
+   *  @param {object} transaction - The transaction to compare against the current
+   *                                window.
+   */
+  maybeUpdateWindow(transaction) {
+    const timestamp = transaction.timer.start
+    if (!this._windowStart || timestamp - this._windowStart >= this._samplingPeriod) {
+      this._windowStart = timestamp
+      this._reset()
     }
   }
 
   /**
-   * Determins if an object should be sampled based on the object's priority and
+   * Determines if an object should be sampled based on the object's priority and
    * the number of objects sampled in this window.
    *
    * @param {object} obj          - The object to check for sampleability.