newrelic 5.13.0 → 6.2.0

package/.travis.yml

@@ -1,28 +1,25 @@
-language: node_js
-node_js:
-  # - "6"
-  - "8"
-  - "10"
+language: generic
 env:
   global:
     - MONGODB=2.6.11
   matrix:
-    - SUITE=smoke
-    - SUITE=unit
-    - SUITE=integration
-    - SUITE=lint
-    - SUITE=security
-    - SUITE=versioned
-matrix:
-  exclude:
-    - node_js: "6"
-      env: SUITE=security
-    - node_js: "6"
-      env: SUITE=lint
-    - node_js: "8"
-      env: SUITE=security
-    - node_js: "8"
-      env: SUITE=lint
+    # NODE 8
+    - NR_NODE_VERSION=8 SUITE=smoke
+    - NR_NODE_VERSION=8 SUITE=unit
+    - NR_NODE_VERSION=8 SUITE=integration
+    - NR_NODE_VERSION=8 SUITE=versioned
+    # NODE 10
+    - NR_NODE_VERSION=10 SUITE=smoke
+    - NR_NODE_VERSION=10 SUITE=unit
+    - NR_NODE_VERSION=10 SUITE=integration
+    - NR_NODE_VERSION=10 SUITE=versioned
+    # NODE 12 --
+    - NR_NODE_VERSION=12 SUITE=smoke
+    - NR_NODE_VERSION=12 SUITE=unit
+    - NR_NODE_VERSION=12 SUITE=integration
+    - NR_NODE_VERSION=12 SUITE=lint
+    - NR_NODE_VERSION=12 SUITE=security
+    - NR_NODE_VERSION=12 SUITE=versioned
 services:
   - memcached
   - mysql
@@ -34,9 +31,11 @@ addons:
     packages:
       - rabbitmq-server
 before_install:
+  - source ./bin/travis-node.sh
   - ./bin/travis-setup.sh
 install: if [ "$SUITE" != "smoke" ]; then npm ci; fi
 cache:
   directories:
     - "$HOME/.npm"
 script: npm run $SUITE
+after_script: find /home/travis/.npm/_logs -type f -exec cat '{}' +

package/NEWS.md

@@ -1,3 +1,169 @@
+### 6.2.0 (2019-11-25):
+
+* Upgraded `tap` to resolve `handlebars` audit warnings.
+
+* Added `getLinkingMetadata()` method to the API.
+
+  This new method can be used to retrieve the identifying information for the
+  agent and current active span and trace. Please consult [the documentation](https://docs.newrelic.com/docs/agents/nodejs-agent/api-guides/nodejs-agent-api#getLinkingMetadata)
+  for more information.
+
+* Added `getTraceMetadata()` to the agent API.
+
+  This new method can be used to retrieve the current active Distributed Tracing
+  span and trace ids. Please consult [the documentation](https://docs.newrelic.com/docs/agents/nodejs-agent/api-guides/nodejs-agent-api#getTraceMetadata)
+  for more information.
+
+* Added an `isSampled()` method to `Transaction` and `TransactionHandle`.
+
+  This new method can be used to retrieve the sampling decision made for a given
+  transaction. Please consult [the documentation](https://docs.newrelic.com/docs/agents/nodejs-agent/api-guides/nodejs-agent-api#transaction-handle-isSampled)
+  for more information.
+
+### 6.1.0 (2019-11-05):
+
+* `@newrelic/native-metrics` module is defaulted to disabled in serverless mode.
+
+  This can reduce lambda cold-start times by up to 170ms. The `native-metrics` module
+  can rarely load in serverless environments due to differences from build environment to
+  deployed environment and offers little value in a serverless environment.
+
+* Added env var `NEW_RELIC_NATIVE_METRICS_ENABLED` to enable/disable the
+  native-metrics module
+
+* Added a test for querying poolCluster.of()
+
+* Removed unused `mysql` bootstrap test code.
+
+* Increased timeout for `index-bad-version` test to reduce flickers on Node 12.
+
+* Changed file modification to leverage `writeFile` for `watchFile` test. This
+  triggers the watcher in a reasonable amount of time much more consistently.
+
+* Added `@newrelic/aws-sdk` module to agent for auto-include on install.
+
+* Added splitting of application name using semicolons in the env var.
+
+* Removed testing of Bluebird 3.7 on Node v10 until they fix [the segfault
+  issue](https://github.com/petkaantonov/bluebird/issues/1618).
+
+* Instrumented `connection.execute` for `mysql2`.
+
+* Added HTTP method to segment attributes for external requests.
+
+* Updated the `bin/ssl.sh` such that it uses verbose output, will exit on first
+  error code, and will refuse to proceed with LibreSSL (which can't generate certs).
+
+* Added a `clear` sub-command to `bin/ssl.sh` that will allow developers to quickly
+  remove generated ssl/cert files and regenerate (useful is switch between platforms
+  via containers/docker and certs needs to be regenerated)
+
+### 6.0.0 (2019-10-29):
+
+* Added official parity support for Node 12.
+  * Exception: Errors resulting in unhandled rejections will no longer be scoped to the
+  transaction that was active when the rejected promise was created.
+
+    As of node 12, the promise responsible for triggering the init async hook will
+  no longer be passed through on the promise wrap instance. This breaks the linkage
+  used to relate a given promise rejection to the transaction it was scheduled in.
+
+* **BREAKING** Removed support for Node 6, 7, and 9.
+
+  The minimum supported version is now Node v8. For further information on our
+  support policy, see:
+  https://docs.newrelic.com/docs/agents/nodejs-agent/getting-started/compatibility-requirements-nodejs-agent.
+
+  * Bumped version of `@newrelic/superagent` instrumentation to `v2.0.0`.
+  * Bumped version of `@newrelic/native-metrics` to `v5.0.0`.
+
+* **BREAKING** Bumped version of `@newrelic/koa` instrumentation to `v3.0.0`
+  `@newrelic/koa` update includes changes to transaction naming in addition to
+  dropping Node versions 6, 7, and 9. See `@newrelic/koa`release notes for what was
+  included in `v2.0.0` and `v3.0.0` updates. https://github.com/newrelic/node-newrelic-koa/blob/master/NEWS.md.
+
+* **BREAKING** `max_samples_stored` behavior has changed to replace
+  `max_samples_per_minute`. `max_samples_per_minute` is no longer a configuration
+  parameter.
+
+  The new behavior for `max_samples_stored` is as follows: "The agent will collect
+  all events up to this number per minute. If there are more than that, a statistical
+  sampling will be collected." This usage of the configuration is consistent with
+  other agents.
+
+  If your application has previously used `max_samples_per_minute` as an upper bound,
+  you may need to lower the threshold to a valid maximum to avoid data being dropped
+  on the server. No larger than 10k is recommended.
+
+* Updated utilization callback test to point to a host that can't represent a valid
+  provider. Previously, location where CI provider runs tests could cause test to
+  fail.
+
+* Added support for `Promise.allSettled()` method in Bluebird 3.7.
+
+* Bumped `mongodb` dev dependency past security warning.
+
+* Fixed `mongodb` versioned tests so they are self-contained by using version under
+  test for setup/teardown instead of agent dev-dependency version.
+
+* Forced filename resolution if not already cached on module load. This should not
+  occur in normal/non-test scenarios but provides a fall-back to maintain
+  functionality.
+
+* Refactored `restify` versioned tests to be less dependent on the order of asynchronous
+  operations.
+
+* Updated README to reference Pug rather than Jade.
+
+### 5.13.1 (2019-10-10):
+
+* Added back generation of entity stats logging and uninstrumented support metric
+  generation on metric harvests.
+
+* Removed legacy harvest code from main agent.
+
+* Updated `https-proxy-agent` to v3 for security fix.
+
+  Shoutout to @asturur for the contribution.
+
+* Added diagnostic code injector.
+
+  The agent may now be configured to make transaction state checks via code
+  injection. This may be turned on by setting `code_injector.diagnostics.enabled`
+  to `true`. While this option is enabled, code around async boundaries will be added
+  to track transactions, and log a message when they are not properly reinstated.
+
+* Fixed bug where `API.shutdown()` would not properly harvest when configured to.
+
+* `primary_application_id` now defaults to 'Unknown' in serverless mode to allow
+  Distributed Tracing to function correctly when `NEW_RELIC_PRIMARY_APPLICATION_ID`
+  is not defined.
+
+* Upgraded `tap` to latest version
+
+* Upgraded `mocha` to latest version.
+
+* Adds `--exit` flag to mocha test runs to prevent infinite runs on CI.
+
+* Fixed bug where multiple agent restarts would cause the number of 'stopped'
+  listeners to exceed limit.
+
+* Fixed inconsistent async return from collector API.
+
+  This could result in an infinite loop due to attempting to merge before clearing.
+  *This bug should not have impacted normal agent runs but was uncovered for certain
+  test cases.*
+
+* Fixed tests that leave work scheduled on the event loop.
+
+* Fixed issue that could result in vendor utilization detection failure.
+  As a part of this fix, the request that hits the timeout will immediately abort
+  instead of hanging around for the default timeout.
+
+### 5.13.0 (2019-10-01):
+
+* Same as 5.12.0
+
 ### 5.12.0 (2019-10-01):
 
 * Now supports Restify 7 and 8.

package/README.md

@@ -73,11 +73,11 @@ Here's the list of the most important variables and their values:
 * `NEW_RELIC_LICENSE_KEY`: Your New Relic license key. This is a required
   setting with no default value.
 * `NEW_RELIC_APP_NAME`: The name of this application, for reporting to New
-  Relic's servers. This value can be also be a comma-delimited list of names.
-  This is a required setting with no default value. (NOTE: as a convenience to
-  Azure users, the module will use `APP_POOL_ID` as the application name if
-  it's set, so you can use the name you chose for your Azure Web Server without
-  setting it twice.)
+  Relic's servers. This value can be also be a comma-delimited, or
+  semicolon-delimited, list of names.  This is a required setting with no
+  default value. (NOTE: as a convenience to Azure users, the module will use
+  `APP_POOL_ID` as the application name if it's set, so you can use the name
+  you chose for your Azure Web Server without setting it twice.)
 * `NEW_RELIC_NO_CONFIG_FILE`: Inhibit loading of the configuration file
   altogether. Use with care. This presumes that all important configuration
   will be available via environment variables, and some log messages assume
@@ -109,15 +109,15 @@ enable browser timings.
 
 - Insert the result of `newrelic.getBrowserTimingHeader()` into your html page.
 - The browser timing headers should be placed in the beginning of your `<head>` tag.
-  - As an exception to the above, for maximum IE compatability, the results of
+  - As an exception to the above, for maximum IE compatibility, the results of
     `getBrowserTimingHeader()` should be placed *after* any
     `X-UA-COMPATIBLE HTTP-EQUIV` meta tags.
 - Do *not* cache the header, call it once for every request.
 
 ### Example
 
-Below is an example using `express` and `jade`; Express is a popular web
-application framework, and `jade` is a popular template module. Although the
+Below is an example using `express` and `pug`; Express is a popular web
+application framework, and `pug` is a popular template module. Although the
 specifics are different for other frameworks, the general approach described
 below should work in most cases.
 
@@ -140,9 +140,9 @@ app.get('/user/:id', function (req, res) {
 app.listen(process.env.PORT);
 ```
 
-*layout.jade:*
+*layout.pug:*
 
-```jade
+```pug
 doctype html
 html
   head

package/api.js

@@ -128,6 +128,57 @@ API.prototype.getTransaction = function getTransaction() {
   return new TransactionHandle(transaction)
 }
 
+/**
+ * This method returns an object with the following keys/data:
+ * - `trace.id`: The current trace ID
+ * - `span.id`: The current span ID
+ * - `entity.name`: The application name specified in the connect request as
+ *   app_name. If multiple application names are specified this will only be
+ *   the first name
+ * - `entity.type`: The string "SERVICE"
+ * - `entity.guid`: The entity ID returned in the connect reply as entity_guid
+ * - `hostname`: The hostname as specified in the connect request as
+ *   utilization.full_hostname. If utilization.full_hostname is null or empty,
+ *   this will be the hostname specified in the connect request as host.
+ *
+ * @returns {LinkingMetadata} The linking object with the data above
+ */
+API.prototype.getLinkingMetadata = function getLinkingMetadata(omitSupportability) {
+  if (omitSupportability !== true) {
+    const metric = this.agent.metrics.getOrCreateMetric(
+      NAMES.SUPPORTABILITY.API + '/getLinkingMetadata'
+    )
+    metric.incrementCallCount()
+  }
+
+  const agent = this.agent
+
+  const segment = agent.tracer.getSegment()
+  const config = agent.config
+
+  const linkingMetadata = {
+    'entity.name': config.applications()[0],
+    'entity.type': 'SERVICE',
+    'hostname': config.getHostnameSafe()
+  }
+
+  if (config.distributed_tracing.enabled && segment) {
+    linkingMetadata['trace.id'] = segment.transaction.getTraceId()
+    const spanId = segment.getSpanId()
+    if (spanId) {
+      linkingMetadata['span.id'] = spanId
+    }
+  } else {
+    logger.debug('getLinkingMetadata with no active transaction')
+  }
+
+  if (config.entity_guid) {
+    linkingMetadata['entity.guid'] = config.entity_guid
+  }
+
+  return linkingMetadata
+}
+
 /**
  * Specify the `Dispatcher` and `Dispatcher Version` environment values.
  * A dispatcher is typically the service responsible for brokering
@@ -1327,6 +1378,36 @@ function instrumentMessages(moduleName, onRequire, onError) {
   shimmer.registerInstrumentation(opts)
 }
 
+/**
+ * Returns the current trace and span id.
+ *
+ * @returns {*} The object containing the current trace and span ids
+ */
+API.prototype.getTraceMetadata = function getTraceMetadata() {
+  var metric = this.agent.metrics.getOrCreateMetric(
+    NAMES.SUPPORTABILITY.API + '/getTraceMetadata'
+  )
+  metric.incrementCallCount()
+
+  const metadata = {}
+
+  const segment = this.agent.tracer.getSegment()
+  if (!segment) {
+    logger.debug("No transaction found when calling API#getTraceMetadata")
+  } else if (!this.agent.config.distributed_tracing.enabled) {
+    logger.debug("Distributed tracing disabled when calling API#getTraceMetadata")
+  } else {
+    metadata.traceId = segment.transaction.getTraceId()
+
+    const spanId = segment.getSpanId()
+    if (spanId) {
+      metadata.spanId = spanId
+    }
+  }
+
+  return metadata
+}
+
 /**
  * Shuts down the agent.
  *
@@ -1405,8 +1486,9 @@ function _doShutdown(api, options, callback) {
     }
 
     agent.on('started', function shutdownHarvest() {
-      agent.harvest(afterHarvest)
+      agent.forceHarvestAll(afterHarvest)
     })
+
     agent.on('errored', function logShutdownError(error) {
       agent.stop(callback)
       if (error) {
@@ -1417,7 +1499,7 @@ function _doShutdown(api, options, callback) {
       }
     })
   } else if (options.collectPendingData) {
-    agent.harvest(afterHarvest)
+    agent.forceHarvestAll(afterHarvest)
   } else {
     agent.stop(callback)
   }

package/bin/run-versioned-tests.sh

@@ -1,5 +1,7 @@
 #! /bin/bash
 
+set -x
+
 VERSIONED_MODE="${VERSIONED_MODE:---major}"
 if [[ $TRAVIS_BRANCH == `git describe --tags --always HEAD` ]]; then
   VERSIONED_MODE=--minor
@@ -20,4 +22,4 @@ fi
 export AGENT_PATH=`pwd`
 
 # This is meant to be temporary. Remove once new major version with fixes rolled into agent.
-time ./node_modules/.bin/versioned-tests $VERSIONED_MODE -i 2 --skip koa ${directories[@]}
+time ./node_modules/.bin/versioned-tests $VERSIONED_MODE -i 2 ${directories[@]}

package/bin/ssl.sh

@@ -1,5 +1,21 @@
 #! /bin/sh
 
+# https://www.gnu.org/software/bash/manual/html_node/The-Set-Builtin.html
+set -e  # exit if any command fails
+set -x  # be chatty and show the lines we're running
+
+# LibreSSL fails on the openssl ca step for reasons
+# that are mysterious and not understood, so let
+# bail early if we detect that's the case
+ENGINE_OPENSSL=`openssl version | awk '{print $(1)}'`
+if [ "$ENGINE_OPENSSL" == "LibreSSL" ]
+then
+    echo "LibreSSL is not supported, please install a stock openssl and \n"
+    echo "make sure that openssl binary is in your PATH"
+    exit 1
+fi
+
+# CACONFIG is the only non-generated file
 CACONFIG="test/lib/test-ca.conf"
 SSLKEY="test/lib/test-key.key"
 CACERT="test/lib/ca-certificate.crt"
@@ -7,16 +23,36 @@ CAINDEX="test/lib/ca-index"
 CASERIAL="test/lib/ca-serial"
 CERTIFICATE="test/lib/self-signed-test-certificate.crt"
 
+# USAGE: ./bin/ssl.sh clear
+# a sub command to remove all the generated files and start over
+if [ "$1" == "clear" ]
+then
+    rm $SSLKEY
+    rm $CACERT
+    rm $CAINDEX
+    rm $CASERIAL
+    rm $CERTIFICATE
+    exit 0
+fi
+
+# if there's already a certificate, then exit, but
+# exit with a success code so build continue
 if [ -a $CERTIFICATE ]; then
   exit 0;
 fi
 
+# generates an RSA key
 openssl genrsa -out $SSLKEY 1024
 
+# ca-index is the "certificate authority" database
+# and ca-serial is a file that openssl will read
+# "the next serial number for the ca-index entry"
+# from.
 touch $CAINDEX
-
 echo 000a > $CASERIAL
 
+# this generates a certificate for the
+# certificate authority
 openssl req \
   -new \
   -subj "/O=testsuite/OU=New Relic CA/CN=Node.js test CA" \
@@ -25,12 +61,17 @@ openssl req \
   -x509 \
   -out $CACERT
 
+# this generates a "certificate signing request" file
 openssl req \
   -new \
   -subj "/O=testsuite/OU=Node.js agent team/CN=ssl.lvh.me" \
   -key $SSLKEY \
   -out server.csr
 
+# using the files generated above, this tells the
+# certificate authority about the request for a certificate,
+# which generates the self-signed-test-certificate.crt file.
+# This is the file used by the web server
 openssl ca \
   -batch \
   -cert $CACERT \
@@ -39,4 +80,5 @@ openssl ca \
   -in server.csr \
   -out $CERTIFICATE
 
+# remove the signing request now that we're done with it
 rm -f server.csr

package/bin/travis-node.sh

@@ -0,0 +1,51 @@
+#!/bin/bash
+
+# https://stackoverflow.com/questions/16989598/bash-comparing-version-numbers/24067243
+# tests version strings using `sort`'s -V option
+function version_gt() { test "$(printf '%s\n' "$@" | sort -V | head -n 1)" != "$1"; }
+
+sudo apt-get update
+
+# so dumb that we need python-software-properties
+# to get add-apt-repository
+sudo apt-get -y install build-essential libssl-dev curl python-software-properties time sudo
+
+# update gcc to something that will install pg-native module
+sudo add-apt-repository -y ppa:ubuntu-toolchain-r/test
+sudo apt-get -y update
+sudo apt-get -y install gcc-4.9 g++-4.9
+sudo rm /usr/bin/g++
+sudo rm /usr/bin/gcc
+sudo ln -s /usr/bin/g++-4.9 /usr/bin/g++
+sudo ln -s /usr/bin/gcc-4.9 /usr/bin/gcc
+
+# Where is ppa:ubuntu-toolchain-r/test?
+# sudo add-apt-repository -y ppa:ubuntu-toolchain-r/test
+# sudo apt-get -y update
+# sudo apt-get -y install libstdc++6-4.7-dev
+
+# only do for NODE 12 AND for old glibc
+
+GLIBC_VERSION_CHECK=`ldd --version | head -n 1 | awk '{print $NF}'`
+
+if [ -z $NR_NODE_VERSION ]; then
+    echo "please define NR_NODE_VERSION in local env"
+    exit 1
+fi
+
+if [ $NR_NODE_VERSION -gt 11 ] && version_gt 2.17 $GLIBC_VERSION_CHECK;then
+  echo "Installing updated glibc\n"
+  # can we get this from an actual repository?
+  curl -LO 'http://launchpadlibrarian.net/130794928/libc6_2.17-0ubuntu4_amd64.deb'
+  sudo dpkg -i libc6_2.17-0ubuntu4_amd64.deb
+else
+  echo "Skipping glibc update\n"
+fi
+
+# install nvm
+curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.35.0/install.sh | bash
+export NVM_DIR="$HOME/.nvm"
+[ -s "$NVM_DIR/nvm.sh" ] && \. "$NVM_DIR/nvm.sh"
+[ -s "$NVM_DIR/bash_completion" ] && \. "$NVM_DIR/bash_completion"
+
+nvm install $NR_NODE_VERSION

package/bin/travis-setup.sh

@@ -48,7 +48,3 @@ if [ "$SUITE" = "versioned" ]; then
 else
   echo " --- no $SUITE installation requirements --- "
 fi
-
-
-# Always install time.
-sudo apt-get install -qq time