newrelic 7.3.1 → 7.4.0

package/NEWS.md

@@ -1,3 +1,27 @@
+### v7.4.0 (2021-05-11)
+
+* Updated third party notices and manifest for husky and lint-staged.
+
+* Updated redis versioned tests to use unique DB indexes per file to avoid collisions and flushing of in-progress tests.
+
+* Pinned hapi 17 versioned tests to only minor/patch versions within 17.x.
+
+* Bumped timeout for redis versioned tests.
+
+* Wired up husky + lint staged to execute linting on all changed files in pre-commit hook.
+
+* Handled a proxy misconfiguration of collector and log an actionable warning message.
+
+* Added `flaky_code` and `success_delay_ms` handling of flaky grpc connections to infinite tracing.
+
+* Added resources to README to highlight external modules that customers should be aware of and possibly use for their applications.
+
+* Logged all New Relic metadata env vars at startup.
+
+* Fixed images for improved reader experience.
+
+  Thank you to @henryjw for the contribution.
+
 ### v7.3.1 (2021-04-14)
 
 * Fixed issue with 'new_promise_tracking' feature flag functionality where segments for ended transactions would get propagated in certain cases by promises that had no continuations scheduled (via await or manually).

package/README.md

@@ -52,7 +52,7 @@ To use New Relic's Node.js agent entails these three steps, which are described
     /* ... the rest of your program ... */
 ```
 
-If you're compiling your JavaScript and can't control the final `require` order, the Node,js agent will work with node's `-r/--require` flag.
+If you're compiling your JavaScript and can't control the final `require` order, the Node.js agent will work with node's `-r/--require` flag.
 
     $ node -r newrelic your-program.js
     $ node --require newrelic your-program.js
@@ -61,11 +61,26 @@ If you're compiling your JavaScript and can't control the final `require` order,
 
 For more information on getting started, [check the Node.js docs](https://docs.newrelic.com/docs/agents/nodejs-agent/getting-started/introduction-new-relic-nodejs).
 
+### External Modules
+
+There are several modules that can be installed and configured to accompany the Node.js agent:
+
+ * [@newrelic/apollo-server-plugin](https://github.com/newrelic/newrelic-node-apollo-server-plugin): New Relic's official Apollo Server plugin for use with the Node.js agent.
+ * [@newrelic/winston-enricher](https://github.com/newrelic/newrelic-winston-logenricher-node): Provides distributed trace and span information output as JSON-formatted log messages.  This is most commonly used with the New Relic Logs product.
+ * [@newrelic/mysql](https://github.com/newrelic/node-newrelic-mysql)(**Experimental**): Standalone instrumentation for [mysql2](https://github.com/sidorares/node-mysql2#readme) and [mysql2/promise](https://github.com/sidorares/node-mysql2/blob/master/documentation/Promise-Wrapper.md) as well as the same instrumentation for [mysql](https://github.com/mysqljs/mysql#readme) within the Node.js agent.
+
+There are several modules included within the Node.js agent to add more instrumentation for 3rd party modules:
+
+ * [@newrelic/aws-sdk](https://github.com/newrelic/node-newrelic-aws-sdk):  Provides instrumentation for the [AWS SDK](https://www.npmjs.com/package/aws-sdk) npm package.
+ * [@newrelic/koa](https://github.com/newrelic/node-newrelic-koa): Provides instrumentation for [koa](https://koajs.com/), [koa-router](https://github.com/ZijianHe/koa-router), [@koa/router](https://github.com/koajs/router), and [koa-route](https://github.com/koajs/route) npm packages.
+ * [@newrelic/superagent](https://github.com/newrelic/node-newrelic-superagent): Provides instrumentation for [superagent](https://github.com/visionmedia/superagent) npm package.
+ * [@newrelic/native-metrics](https://github.com/newrelic/node-native-metrics): Provides hooks into the native v8 layer of Node.js to provide metrics to the Node.js agent.
+
 ## Usage
 
 ### Using the API
 
-The `newrelic` module returns an object with the Node agent's API methods attached.
+The `newrelic` module returns an object with the Node.js agent's API methods attached.
 
 ```js
     const newrelic = require('newrelic')

package/THIRD_PARTY_NOTICES.md

@@ -49,7 +49,9 @@ code, the source code can be found at [https://github.com/newrelic/node-newrelic
 * [glob](#glob)
 * [got](#got)
 * [http-errors](#http-errors)
+* [husky](#husky)
 * [jsdoc](#jsdoc)
+* [lint-staged](#lint-staged)
 * [memcached](#memcached)
 * [minami](#minami)
 * [mongodb](#mongodb)
@@ -1927,7 +1929,7 @@ SOFTWARE.
 
 ### commander
 
-This product includes source derived from [commander](https://github.com/tj/commander.js) ([v7.0.0](https://github.com/tj/commander.js/tree/v7.0.0)), distributed under the [MIT License](https://github.com/tj/commander.js/blob/v7.0.0/LICENSE):
+This product includes source derived from [commander](https://github.com/tj/commander.js) ([v7.2.0](https://github.com/tj/commander.js/tree/v7.2.0)), distributed under the [MIT License](https://github.com/tj/commander.js/blob/v7.2.0/LICENSE):
 
 ```
 (The MIT License)
@@ -2016,7 +2018,7 @@ SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
 ### fastify
 
-This product includes source derived from [fastify](https://github.com/fastify/fastify) ([v2.14.1](https://github.com/fastify/fastify/tree/v2.14.1)), distributed under the [MIT License](https://github.com/fastify/fastify/blob/v2.14.1/LICENSE):
+This product includes source derived from [fastify](https://github.com/fastify/fastify) ([v2.15.3](https://github.com/fastify/fastify/tree/v2.15.3)), distributed under the [MIT License](https://github.com/fastify/fastify/blob/v2.15.3/LICENSE):
 
 ```
 MIT License
@@ -2139,6 +2141,35 @@ THE SOFTWARE.
 
 ```
 
+### husky
+
+This product includes source derived from [husky](https://github.com/typicode/husky) ([v6.0.0](https://github.com/typicode/husky/tree/v6.0.0)), distributed under the [MIT License](https://github.com/typicode/husky/blob/v6.0.0/LICENSE):
+
+```
+MIT License
+
+Copyright (c) 2021 typicode
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+```
+
 ### jsdoc
 
 This product includes source derived from [jsdoc](https://github.com/jsdoc/jsdoc) ([v3.6.3](https://github.com/jsdoc/jsdoc/tree/v3.6.3)), distributed under the [Apache-2.0 License](https://github.com/jsdoc/jsdoc/blob/v3.6.3/LICENSE.md):
@@ -2249,6 +2280,35 @@ https://github.com/jmblog/color-themes-for-google-code-prettify
 
 ```
 
+### lint-staged
+
+This product includes source derived from [lint-staged](https://github.com/okonet/lint-staged) ([v11.0.0](https://github.com/okonet/lint-staged/tree/v11.0.0)), distributed under the [MIT License](https://github.com/okonet/lint-staged/blob/v11.0.0/LICENSE):
+
+```
+The MIT License (MIT)
+
+Copyright (c) 2016 Andrey Okonetchnikov
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+```
+
 ### memcached
 
 This product includes source derived from [memcached](https://github.com/3rd-Eden/node-memcached) ([v2.2.2](https://github.com/3rd-Eden/node-memcached/tree/v2.2.2)), distributed under the [MIT License](https://github.com/3rd-Eden/node-memcached/blob/v2.2.2/LICENSE):

package/lib/collector/api.js

@@ -117,6 +117,22 @@ CollectorAPI.prototype.connect = function connect(callback) {
     this._reqHeadersMap = null
   }
 
+  /**
+   * Checks if proxy is configured to connect via `proxy_host` and `proxy_port`
+   * and if error code is EPROTO or ECONNRESET. This is an indication their proxy
+   * server only accepts HTTP connections, and we should provide an actionable warning to
+   * fix the misconfiguration by setting `proxy` to a fully qualified URL
+   *
+   * @param {Error} error
+   * @returns {Boolean}
+   */
+  function isProxyMisconfigured(error) {
+    const config = api._agent.config
+    return error &&
+      ['EPROTO', 'ECONNRESET'].includes(error.code) &&
+      config.proxy_host && config.proxy_port && !config.proxy
+  }
+
   function retry(error, response) {
     metric.incrementCallCount()
 
@@ -142,6 +158,14 @@ CollectorAPI.prototype.connect = function connect(callback) {
         ' (status code %s)',
         response.status
       )
+    } else if (isProxyMisconfigured(error)) {
+      logger.warn(
+        error,
+        'Your proxy server appears to be configured to accept connections over http. ' +
+        'When setting `proxy_host` and `proxy_port` New Relic attempts to connect over ' +
+        'SSL(https). If your proxy is configured to accept connections over http, try ' +
+        'setting `proxy` to a fully qualified URL(e.g http://proxy-host:8080).'
+      )
     }
 
     let backoff = BACKOFFS[Math.min(attempts, max) - 1]

package/lib/collector/facts.js

@@ -55,6 +55,8 @@ function facts(agent, callback) {
       }, {})
     }
 
+    logger.debug('New Relic metadata %o', results.metadata)
+
     results.event_harvest_config = {
       harvest_limits: {
         analytic_event_data: agent.config.transaction_events.max_samples_stored,

package/lib/grpc/connection.js

@@ -11,6 +11,12 @@ const logger = require('../logger').child({component: 'grpc_connection'})
 const EventEmitter = require('events')
 const NAMES = require('../metrics/names')
 const util = require('util')
+const GRPC_TEST_META = {
+  flaky: 'NEWRELIC_GRPCCONNECTION_METADATA_FLAKY',
+  delay: 'NEWRELIC_GRPCCONNECTION_METADATA_DELAY',
+  flaky_code: 'NEWRELIC_GRPCCONNECTION_METADATA_FLAKY_CODE',
+  success_delay_ms: 'NEWRELIC_GRPCCONNECTION_METADATA_SUCCESS_DELAY_MS'
+}
 
 const connectionStates = require('./connection/states')
 
@@ -163,22 +169,27 @@ class GrpcConnection extends EventEmitter {
       }
     }
 
-    // check environment variables for testing parameters and
-    // pass to server via meta-data.
-    const flaky = parseInt(env.NEWRELIC_GRPCCONNECTION_METADATA_FLAKY, 10)
-    const delay = parseInt(env.NEWRELIC_GRPCCONNECTION_METADATA_DELAY, 10)
-    if (flaky) {
-      logger.trace('Adding flaky metadata: %s', flaky)
-      metadata.add('flaky', flaky)
-    }
-    if (delay) {
-      logger.trace('Adding delay metadata: %s', delay)
-      metadata.add('delay',delay)
-    }
+    this._setTestMetadata(metadata, env)
 
     return metadata
   }
 
+  /**
+   * Adds test metadata used to simulate connectivity issues
+   * when appropriate env vars are set
+   *
+   * @param {Metadata} metadata
+   */
+  _setTestMetadata(metadata, env) {
+    for (const [key, envVar] of Object.entries(GRPC_TEST_META)) {
+      const value = parseInt(env[envVar], 10)
+      if (value) {
+        logger.trace('Adding %s metadata: %s', key, value)
+        metadata.add(key, value)
+      }
+    }
+  }
+
   /**
    * Disconnects from gRPC endpoint and schedules establishing a new connection.
    * @param {number} reconnectDelayMs number of milliseconds to wait before reconnecting.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "newrelic",
-  "version": "7.3.1",
+  "version": "7.4.0",
   "author": "New Relic Node.js agent team <nodejs@newrelic.com>",
   "license": "Apache-2.0",
   "contributors": [
@@ -176,7 +176,9 @@
     "glob": "^7.1.2",
     "got": "^8.0.1",
     "http-errors": "^1.7.3",
+    "husky": "^6.0.0",
     "jsdoc": "^3.6.3",
+    "lint-staged": "^11.0.0",
     "memcached": ">=0.2.8",
     "minami": "^1.1.1",
     "mongodb": "^3.3.3",