newrelic 8.8.0 → 8.9.0

package/NEWS.md

@@ -1,3 +1,43 @@
+### v8.9.0 (2022-03-15)
+
+* Added support for `initializeUnorderedBulkOp`, and `initializeOrderedBulkOp` in mongodb v3 instrumentation.
+
+  Thanks to Denis Lantsman (@dlants) for the contribution.
+
+* Updated logger to delay logging until configuration is parsed. The logger will now queue all log entries that occur before the agent can parse the configuration.
+
+  Thanks to Cody Landry (@codylandry) for the contribution.
+
+* Added `NEW_RELIC_ALLOW_ALL_HEADERS` as a boolean environment variable, same behavior as existing `allow_all_headers`.
+
+* Updated the AWS IMDBS v2 endpoint to use `latest` to align with the internal agent specification.
+
+* Bumped `@newrelic/koa` to ^6.1.1.
+
+* Added Next.js to External Modules list in README.
+
+* Updated mysql and mysql2 versioned tests to run against their own databases on the MySQL instance.
+
+* Removed upper-bound testing from restify versioned tests so future major versions will be covered.
+
+* Removed upper-bound testing from mysql2 versioned tests to cover existing and future major versions. 
+
+  Continues to skip version 1.6.2 which had a bug that broke tests which was resolved in 1.6.3.
+
+* Updated @hapi/hapi Node 16 versioned test runs to run against @hapi/hapi >=20.1.2 so future major releases will be ran.
+
+* Fixed sparse checkout of non-default branch for external versioned tests.
+
+* Added external versioned tests for the Apollo Server plugin instrumentation.
+
+* Added nock delay to test timeouts in utilization integration tests.
+
+* Added newrelic-node-nextjs to external versioned tests to be run on every PR.
+
+* Updated external version test running to support more test scenarios.
+  * Adds `test/versioned-external` to lint ignore to avoid issues for scripts in tests that auto run linting tools (next/react).
+  * Adds `index.js` and `nr-hooks.js` to files automatically checked-out for test runs.
+
 ### v8.8.0 (2022-02-23)
 
 * Updated AWS metadata capture to utilize IMDSv2.

package/README.md

@@ -70,6 +70,7 @@ There are several modules that can be installed and configured to accompany the
  * [@newrelic/winston-enricher](https://github.com/newrelic/newrelic-node-log-extensions/tree/main/packages/winston-log-enricher): Provides distributed trace and span information output as JSON-formatted log messages in Winston.  This is most commonly used with the New Relic Logs product.
  * [@newrelic/pino-enricher](https://github.com/newrelic/newrelic-node-log-extensions/tree/main/packages/pino-log-enricher): Provides distributed trace and span information output as JSON-formatted log messages in Pino.  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.
+ * [@newrelic/next](https://github.com/newrelic/newrelic-node-nextjs): Provides instrumentation for the [Next.js](https://github.com/vercel/next.js/) npm package.
 
 There are several modules included within the Node.js agent to add more instrumentation for 3rd party modules:
 

package/lib/config/default.js

@@ -134,6 +134,8 @@ exports.config = () => ({
    * When true, all request headers except for those listed in attributes.exclude
    * will be captured for all traces, unless otherwise specified in a destination's
    * attributes include/exclude lists.
+   *
+   * @env NEW_RELIC_ALLOW_ALL_HEADERS
    */
   allow_all_headers: false,
 

package/lib/config/env.js

@@ -21,6 +21,7 @@ const ENV_MAPPING = {
   proxy_user: 'NEW_RELIC_PROXY_USER',
   proxy_pass: 'NEW_RELIC_PROXY_PASS',
   agent_enabled: 'NEW_RELIC_ENABLED',
+  allow_all_headers: 'NEW_RELIC_ALLOW_ALL_HEADERS',
   attributes: {
     enabled: 'NEW_RELIC_ATTRIBUTES_ENABLED',
     exclude: 'NEW_RELIC_ATTRIBUTES_EXCLUDE',
@@ -206,6 +207,7 @@ const OBJECT_LIST_VARS = new Set(['NEW_RELIC_NAMING_RULES'])
 // fancy--just use 'true' and 'false', everybody.
 const BOOLEAN_VARS = new Set([
   'NEW_RELIC_ENABLED',
+  'NEW_RELIC_ALLOW_ALL_HEADERS',
   'NEW_RELIC_ATTRIBUTES_ENABLED',
   'NEW_RELIC_ERROR_COLLECTOR_ENABLED',
   'NEW_RELIC_ERROR_COLLECTOR_ATTRIBUTES_ENABLED',

package/lib/config/index.js

@@ -1623,7 +1623,8 @@ function initialize(config) {
   /**
    * When the logger is required here, it bootstraps itself and then
    * injects itself into this module's closure via setLogger on the
-   * instance of the logger it creates.
+   * instance of the logger it creates.  Logs are queued until config
+   * has been loaded to apply logging settings to bootstrapping logs
    */
   logger = require('../logger')
 
@@ -1712,7 +1713,14 @@ function getOrCreateInstance() {
 
       // Config construction has potential to throw due to invalid settings.
       // This allows the agent to return a stub api without crashing the process.
-      _configInstance = Object.assign(defaultConfig(), { agent_enabled: false })
+      _configInstance = Object.assign(defaultConfig(), {
+        agent_enabled: false,
+        logging: {
+          enabled: true,
+          filepath: 'stdout'
+        }
+      })
+
       _configInstance.setLogger = Config.prototype.setLogger
     }
   }

package/lib/instrumentation/mongodb/common.js

@@ -43,6 +43,23 @@ common.instrumentCollection = function instrumentCollection(shim, Collection) {
   }
 }
 
+/**
+ * Instruments the execute method on
+ * the BulkOperationBase class
+ *
+ * @param {Shim} shim
+ * @param {BulkOperationModule} bulk operation module, typically from mongodb/lib/bulk/common
+ * @param BulkOperationModule
+ */
+common.instrumentBulkOperation = function instrumentBulkOperation(shim, BulkOperationModule) {
+  const BulkOperationBase = BulkOperationModule && BulkOperationModule.BulkOperationBase
+
+  if (BulkOperationBase && BulkOperationBase.prototype) {
+    const proto = BulkOperationBase.prototype
+    shim.recordBatchQuery(proto, 'execute', common.makeBulkDescFunc(shim, 'execute'))
+  }
+}
+
 /**
  * Instruments all methods from constants.DB_OPS on
  * the Db class.
@@ -84,6 +101,25 @@ common.makeQueryDescFunc = function makeQueryDescFunc(shim, methodName) {
   }
 }
 
+/**
+ * Sets up the desc for all instrumented bulk operations
+ *
+ * @param {Shim} shim
+ * @param {string} methodName
+ */
+common.makeBulkDescFunc = function makeBulkDescFunc(shim) {
+  return function bulkDescFunc() {
+    const parameters = getInstanceAttributeParameters(shim, this)
+    return {
+      query: this.isOrdered ? 'orderedBulk' : 'unorderedBulk',
+      parameters,
+      promise: true,
+      callback: shim.LAST,
+      opaque: true
+    }
+  }
+}
+
 /**
  * Sets up a listener for `started` on instrumenter(mongo APM). This applies to
  * mongo <4. The listener adds the following attributes to the active segment:
@@ -161,9 +197,10 @@ function setHostPort(shim, connStr, db, client) {
  * @param obj
  */
 function getInstanceAttributeParameters(shim, obj) {
-  if (obj.s && obj.s.db && obj.s.topology) {
+  if (obj.s && obj.s.topology) {
     shim.logger.trace('Adding datastore instance attributes from obj.s.db + obj.s.topology')
-    const databaseName = obj.s.db.databaseName || null
+    const databaseName =
+      (obj.s.db && obj.s.db.databaseName) || (obj.s.namespace && obj.s.namespace.db) || null
     const topology = obj.s.topology
     if (topology.s && topology.s.options) {
       return doCapture(topology.s.options, databaseName)

package/lib/instrumentation/mongodb/v3-mongo.js

@@ -7,6 +7,7 @@
 
 const {
   captureAttributesOnStarted,
+  instrumentBulkOperation,
   instrumentCollection,
   instrumentCursor,
   instrumentDb,
@@ -27,6 +28,8 @@ function queryParser(operation) {
     collection = this.operation.target
   } else if (this.ns) {
     collection = this.ns.split(/\./)[1] || collection
+  } else if (this.s && this.s.collection && this.s.collection.collectionName) {
+    collection = this.s.collection.collectionName
   }
   return { operation, collection }
 }
@@ -68,6 +71,7 @@ module.exports = function instrument(shim, mongodb) {
   instrumentCursor(shim, mongodb.Cursor)
   instrumentCursor(shim, shim.require('./lib/aggregation_cursor'))
   instrumentCursor(shim, shim.require('./lib/command_cursor'))
+  instrumentBulkOperation(shim, shim.require('./lib/bulk/common'))
   instrumentCollection(shim, mongodb.Collection)
   instrumentDb(shim, mongodb.Db)
 

package/lib/logger.js

@@ -9,12 +9,16 @@ const Logger = require('./util/logger')
 const fs = require('./util/unwrapped-core').fs
 
 // create bootstrapping logger
-module.exports = new Logger({
+const logger = new Logger({
   name: 'newrelic_bootstrap',
-  stream: process.stdout,
-  level: 'info'
+  level: 'info',
+
+  // logger is configured below.  Logs are queued until configured
+  configured: false
 })
 
+module.exports = logger
+
 /**
  * Don't load config until this point, because it requires this
  * module, and if it gets loaded too early, module.exports will have no
@@ -28,8 +32,8 @@ if (config) {
     enabled: config.logging.enabled
   }
 
-  // create the "real" logger
-  module.exports = new Logger(options)
+  // configure logger
+  logger.configure(options)
 
   if (config.logging.enabled) {
     let stream
@@ -52,9 +56,6 @@ if (config) {
           /* eslint-enable no-console */
         })
     }
-    module.exports.pipe(stream)
+    logger.pipe(stream)
   }
-
-  // now tell the config module to switch to the real logger
-  config.setLogger(module.exports)
 }

package/lib/util/logger.js

@@ -39,7 +39,8 @@ function Logger(options, extra) {
   const passedInLevel = this.coerce(options.level)
   this.options = {
     _level: passedInLevel,
-    enabled: options.enabled === undefined ? true : options.enabled
+    enabled: options.enabled === undefined ? true : options.enabled,
+    configured: options.configured === undefined ? true : !!options.configured
   }
   this._nestedLog = false
   this.name = options.name
@@ -47,12 +48,30 @@ function Logger(options, extra) {
   this.extra = extra || Object.create(null)
   this.buffer = ''
   this.reading = false
+  this.logQueue = []
   if (options.stream) {
     this.pipe(options.stream)
   }
 }
 Logger.MAX_LOG_BUFFER = MAX_LOG_BUFFER
 
+Logger.prototype.configure = function configure(options) {
+  if (options.name !== undefined) {
+    this.name = options.name
+  }
+
+  if (options.enabled !== undefined) {
+    this.options.enabled = options.enabled
+  }
+
+  if (options.level !== undefined) {
+    this.options._level = this.coerce(options.level)
+  }
+
+  this.options.configured = true
+  this._flushQueuedLogs()
+}
+
 Logger.prototype.coerce = function coerce(value) {
   if (!isNaN(parseInt(value, 10)) && isFinite(value)) {
     // value is numeric
@@ -74,6 +93,11 @@ Object.keys(LEVELS).forEach(function buildLevel(_level) {
   const level = Logger.prototype.coerce(LEVELS[_level])
 
   function log(extra) {
+    if (!this.options.configured) {
+      this.logQueue.unshift({ level: _level, args: arguments })
+      return
+    }
+
     if (!this.options.enabled) {
       return false
     }
@@ -149,6 +173,13 @@ Object.keys(LEVELS).forEach(function buildLevel(_level) {
   }
 })
 
+Logger.prototype._flushQueuedLogs = function _flushQueuedLogs() {
+  while (this.logQueue.length) {
+    const { level, args } = this.logQueue.shift()
+    this[level].apply(this, args)
+  }
+}
+
 Object.assign(Logger.prototype, loggingFunctions)
 
 Logger.prototype.child = function child(extra) {
@@ -196,6 +227,10 @@ Logger.prototype._read = function _read() {
  * already converted the objects to strings.
  * Returns a boolean representing the status of the write
  * (success/failure)
+ *
+ * @param level
+ * @param args
+ * @param extra
  */
 Logger.prototype.write = function write(level, args, extra) {
   if (this._nestedLog) {

package/lib/utilization/aws-info.js

@@ -42,7 +42,7 @@ function fetchAWSInfo(agent, callback) {
       headers: { 'X-aws-ec2-metadata-token': authToken },
       host: INSTANCE_HOST,
       method: 'GET',
-      path: '/2016-09-02/dynamic/instance-identity/document',
+      path: '/latest/dynamic/instance-identity/document',
       timeout: 500
     }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "newrelic",
-  "version": "8.8.0",
+  "version": "8.9.0",
   "author": "New Relic Node.js agent team <nodejs@newrelic.com>",
   "license": "Apache-2.0",
   "contributors": [
@@ -162,7 +162,7 @@
     "@grpc/grpc-js": "^1.5.5",
     "@grpc/proto-loader": "^0.6.9",
     "@newrelic/aws-sdk": "^4.1.1",
-    "@newrelic/koa": "^6.1.0",
+    "@newrelic/koa": "^6.1.1",
     "@newrelic/superagent": "^5.1.0",
     "@tyriar/fibonacci-heap": "^2.0.7",
     "async": "^3.2.3",