newrelic 8.15.0 → 8.17.1

package/NEWS.md

@@ -1,3 +1,22 @@
+### v8.17.1 (2022-08-02)
+ * Fixed issue where instrumetned code invoked within a @grpc/grpc-js client callback would not get tracked by the agent.
+
+   Bound the external client segment to the onReceiveStatus listener to propagate transaction context to the grpc client callbacks.
+
+ * Fixed issue with truncate in `lib/util/application-logging.js`. It now checks that the argument is a string before checking its length.
+
+### v8.17.0 (2022-07-27)
+
+* Added instrumentation for `grpc-js` server unary, client-streaming, server-streaming and bidirectional streaming handlers.
+
+### v8.16.0 (2022-07-21)
+
+* Automatic application log forwarding is now enabled by default. This version of the agent will automatically send enriched application logs to New Relic. To learn more about about this feature, see the [APM logs in context documentation](https://docs.newrelic.com/docs/apm/new-relic-apm/getting-started/get-started-logs-context/). For additional configuration options, see the [Node.js logs in context documentation](https://docs.newrelic.com/docs/logs/logs-context/configure-logs-context-nodejs). To learn about how to toggle log ingestion on or off by account, see our documentation to [disable automatic logging](https://docs.newrelic.com/docs/logs/logs-context/disable-automatic-logging) via the UI or API.
+
+* Added a support statement to our release notes
+
+* Added node 18 to CI workflows.
+
 ### v8.15.0 (2022-07-07)
 
 * Added instrumentation for grpc-js unary, streaming, and bidirectional client calls.
@@ -83,7 +102,7 @@
     * Added sent, seen and dropped metrics that collected on every harvest cycle around log lines.
 
     * Added supportability metrics for some popular logging frameworks.
-    
+
     * Added supportability metrics to record if the logging features are enabled.
 
     * Added a storage mechanisms to transactions to keep logs until transaction ends.
@@ -148,7 +167,7 @@
 
 * 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. 
+* 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.
 

package/THIRD_PARTY_NOTICES.md

@@ -26,7 +26,6 @@ code, the source code can be found at [https://github.com/newrelic/node-newrelic
 * [json-stringify-safe](#json-stringify-safe)
 * [readable-stream](#readable-stream)
 * [semver](#semver)
-* [winston-transport](#winston-transport)
 
 **[devDependencies](#devDependencies)**
 
@@ -66,7 +65,6 @@ code, the source code can be found at [https://github.com/newrelic/node-newrelic
 * [q](#q)
 * [redis](#redis)
 * [request](#request)
-* [restify](#restify)
 * [rimraf](#rimraf)
 * [should](#should)
 * [sinon](#sinon)
@@ -296,7 +294,7 @@ This product includes source derived from [@grpc/grpc-js](https://github.com/grp
 
 ### @grpc/proto-loader
 
-This product includes source derived from [@grpc/proto-loader](https://github.com/grpc/grpc-node) ([v0.6.13](https://github.com/grpc/grpc-node/tree/v0.6.13)), distributed under the [Apache-2.0 License](https://github.com/grpc/grpc-node/blob/v0.6.13/LICENSE):
+This product includes source derived from [@grpc/proto-loader](https://github.com/grpc/grpc-node) ([v0.6.9](https://github.com/grpc/grpc-node/tree/v0.6.9)), distributed under the [Apache-2.0 License](https://github.com/grpc/grpc-node/blob/v0.6.9/LICENSE):
 
 ```
                                  Apache License
@@ -1331,36 +1329,6 @@ WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
 ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR
 IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 
-```
-
-### winston-transport
-
-This product includes source derived from [winston-transport](https://github.com/winstonjs/winston-transport) ([v4.5.0](https://github.com/winstonjs/winston-transport/tree/v4.5.0)), distributed under the [MIT License](https://github.com/winstonjs/winston-transport/blob/v4.5.0/LICENSE):
-
-```
-The MIT License (MIT)
-
-Copyright (c) 2015 Charlie Robbins & the contributors.
-
-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.
-
-
 ```
 
 
@@ -1801,7 +1769,7 @@ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLI
 
 ### @newrelic/test-utilities
 
-This product includes source derived from [@newrelic/test-utilities](https://github.com/newrelic/node-test-utilities) ([v6.5.5](https://github.com/newrelic/node-test-utilities/tree/v6.5.5)), distributed under the [Apache-2.0 License](https://github.com/newrelic/node-test-utilities/blob/v6.5.5/LICENSE):
+This product includes source derived from [@newrelic/test-utilities](https://github.com/newrelic/node-test-utilities) ([v6.5.2](https://github.com/newrelic/node-test-utilities/tree/v6.5.2)), distributed under the [Apache-2.0 License](https://github.com/newrelic/node-test-utilities/blob/v6.5.2/LICENSE):
 
 ```
                                  Apache License
@@ -3208,33 +3176,6 @@ If the Work includes a "NOTICE" text file as part of its distribution, then any
 END OF TERMS AND CONDITIONS
 ```
 
-### restify
-
-This product includes source derived from [restify](https://github.com/restify/node-restify) ([v8.5.1](https://github.com/restify/node-restify/tree/v8.5.1)), distributed under the [MIT License](https://github.com/restify/node-restify/blob/v8.5.1/LICENSE):
-
-```
-Copyright (c) 2011 Mark Cavage, All rights reserved.
-
-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
-
-```
-
 ### rimraf
 
 This product includes source derived from [rimraf](https://github.com/isaacs/rimraf) ([v2.7.1](https://github.com/isaacs/rimraf/tree/v2.7.1)), distributed under the [ISC License](https://github.com/isaacs/rimraf/blob/v2.7.1/LICENSE):
@@ -3323,12 +3264,12 @@ THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
 ### tap
 
-This product includes source derived from [tap](https://github.com/tapjs/node-tap) ([v16.0.1](https://github.com/tapjs/node-tap/tree/v16.0.1)), distributed under the [ISC License](https://github.com/tapjs/node-tap/blob/v16.0.1/LICENSE):
+This product includes source derived from [tap](https://github.com/tapjs/node-tap) ([v15.1.6](https://github.com/tapjs/node-tap/tree/v15.1.6)), distributed under the [ISC License](https://github.com/tapjs/node-tap/blob/v15.1.6/LICENSE):
 
 ```
 The ISC License
 
-Copyright (c) 2011-2022 Isaac Z. Schlueter and Contributors
+Copyright (c) Isaac Z. Schlueter and Contributors
 
 Permission to use, copy, modify, and/or distribute this software for any
 purpose with or without fee is hereby granted, provided that the above

package/lib/config/default.js

@@ -770,6 +770,18 @@ exports.config = () => ({
     database_name_reporting: { enabled: true }
   },
 
+  /**
+   * Controls behavior of gRPC server instrumentation.
+   */
+  grpc: {
+    /**
+     * Enables recording of non-zero gRPC status codes. Default is `true`.
+     *
+     * @env NEW_RELIC_GRPC_RECORD_ERRORS
+     */
+    record_errors: true
+  },
+
   /**
    * Controls the behavior of span events produced by the agent.
    */
@@ -950,7 +962,7 @@ exports.config = () => ({
        *
        * @env NEW_RELIC_APPLICATION_LOGGING_FORWARDING_ENABLED
        */
-      enabled: false,
+      enabled: true,
       /**
        * Number of log records to send per minute to New Relic.
        *

package/lib/config/env.js

@@ -123,6 +123,9 @@ const ENV_MAPPING = {
       enabled: 'NEW_RELIC_DATASTORE_DATABASE_NAME_REPORTING_ENABLED'
     }
   },
+  grpc: {
+    record_errors: 'NEW_RELIC_GRPC_RECORD_ERRORS'
+  },
   span_events: {
     enabled: 'NEW_RELIC_SPAN_EVENTS_ENABLED',
     attributes: {
@@ -240,6 +243,7 @@ const BOOLEAN_VARS = new Set([
   'NEW_RELIC_BROWSER_MONITOR_DEBUG',
   'NEW_RELIC_HIGH_SECURITY',
   'NEW_RELIC_SLOW_SQL_ENABLED',
+  'NEW_RELIC_GRPC_RECORD_ERRORS',
   'NEW_RELIC_SPAN_EVENTS_ENABLED',
   'NEW_RELIC_SPAN_EVENTS_ATTRIBUTES_ENABLED',
   'NEW_RELIC_DISTRIBUTED_TRACING_ENABLED',

package/lib/instrumentation/grpc-js/grpc.js

@@ -6,80 +6,217 @@
 'use strict'
 
 const recordExternal = require('../../metrics/recorders/http_external')
+const recordHttp = require('../../metrics/recorders/http')
+const { DESTINATIONS } = require('../../config/attribute-filter')
+const DESTINATION = DESTINATIONS.TRANS_EVENT | DESTINATIONS.ERROR_EVENT
+const semver = require('semver')
 
 module.exports = function instrument(shim) {
-  const callStream = shim.require('./build/src/call-stream')
-  shim.wrap(callStream.Http2CallStream.prototype, 'start', (shim, original) => {
-    return function wrappedStart() {
-      const activeSegment = shim.getActiveSegment()
-      if (!activeSegment) {
-        return original.apply(this, arguments)
+  const genericShim = shim.makeSpecializedShim(shim.GENERIC, 'call-stream')
+  const callStream = genericShim.require('./build/src/call-stream')
+  genericShim.wrap(callStream.Http2CallStream.prototype, 'start', wrapStart)
+
+  const webFrameworkShim = shim.makeSpecializedShim(shim.WEB_FRAMEWORK, 'server')
+  const server = webFrameworkShim.require('./build/src/server')
+  webFrameworkShim.setFramework('gRPC')
+  webFrameworkShim.wrap(server.Server.prototype, 'register', wrapRegister)
+}
+
+/**
+ * Instruments grpc-js client by intercepting the function that
+ * initiates client requests. This handles all four types of client
+ * invocations: unary, client-streaming, server-streaming, and
+ * bidirectional streaming.
+ *
+ * @param {object} shim the generic shim to instrument with
+ * @param {Function} original the original function
+ * @returns {Function} the instrumented function
+ */
+function wrapStart(shim, original) {
+  return function wrappedStart() {
+    const activeSegment = shim.getActiveSegment()
+    if (!activeSegment) {
+      return original.apply(this, arguments)
+    }
+
+    const channel = this.channel
+    const authorityName = (channel.target && channel.target.path) || channel.getDefaultAuthority
+
+    const segment = shim.createSegment({
+      name: `External/${authorityName}${this.methodName}`,
+      opaque: true,
+      recorder: recordExternal(authorityName, 'gRPC')
+    })
+
+    return shim.applySegment(callStart, segment, true, this, arguments)
+
+    function callStart() {
+      const args = shim.argsToArray.apply(shim, arguments)
+
+      const transaction = segment.transaction
+
+      const originalMetadata = args[0]
+      const nrMetadata = originalMetadata.clone()
+
+      const outboundAgentHeaders = Object.create(null)
+      if (shim.agent.config.distributed_tracing.enabled) {
+        transaction.insertDistributedTraceHeaders(outboundAgentHeaders)
+        Object.keys(outboundAgentHeaders).forEach((key) => {
+          nrMetadata.add(key, outboundAgentHeaders[key])
+        })
+      } else {
+        shim.logger.debug('Distributed tracing disabled by instrumentation.')
       }
 
-      const channel = this.channel
-      const authorityName = (channel.target && channel.target.path) || channel.getDefaultAuthority
+      args[0] = nrMetadata
 
-      const segment = shim.createSegment({
-        name: `External/${authorityName}${this.methodName}`,
-        opaque: true,
-        recorder: recordExternal(authorityName, 'gRPC')
-      })
+      const originalListener = args[1]
+      const nrListener = Object.assign({}, originalListener)
+      nrListener.onReceiveStatus = (status) => {
+        const { code, details } = status
+
+        segment.addAttribute('grpc.statusCode', code)
+        segment.addAttribute('grpc.statusText', details)
+
+        // Java captures client errors based on status code
+        // but has specific gRPC configuration to turn off
+        if (code !== 0) {
+          // this is currently just creating an error from the details string
+          shim.agent.errors.add(segment.transaction, details)
+        }
 
-      return shim.applySegment(callStart, segment, true, this, arguments)
+        segment.addAttribute('component', 'gRPC')
 
-      function callStart() {
-        const args = shim.argsToArray.apply(shim, arguments)
+        const protocol = 'grpc'
 
-        const transaction = segment.transaction
+        const url = `${protocol}://${authorityName}${this.methodName}`
 
-        const originalMetadata = args[0]
-        const nrMetadata = originalMetadata.clone()
+        segment.addAttribute('http.url', url)
+        segment.addAttribute('http.method', this.methodName)
 
-        const outboundAgentHeaders = Object.create(null)
-        if (shim.agent.config.distributed_tracing.enabled) {
-          transaction.insertDistributedTraceHeaders(outboundAgentHeaders)
-          Object.keys(outboundAgentHeaders).forEach((key) => {
-            nrMetadata.add(key, outboundAgentHeaders[key])
-          })
-        } else {
-          shim.logger.debug('Distributed tracing disabled by instrumentation.')
+        if (originalListener && originalListener.onReceiveStatus) {
+          const onReceiveStatuts = shim.bindSegment(originalListener.onReceiveStatus, segment)
+          onReceiveStatuts(status)
         }
+        segment.end()
+      }
 
-        args[0] = nrMetadata
+      args[1] = nrListener
 
-        const originalListener = args[1]
-        const nrListener = Object.assign({}, originalListener)
-        nrListener.onReceiveStatus = (status) => {
-          const { code, details } = status
+      return original.apply(this, args)
+    }
+  }
+}
 
-          segment.addAttribute('grpc.statusCode', code)
-          segment.addAttribute('grpc.statusText', details)
+/**
+ * Instruments the grpc-js server by intercepting the moment when
+ * server methods are registered from the method implementations
+ * provided to grpc-js. This handles all four types of server
+ * invocations: unary, client-streaming, server-streaming, and
+ * bidirectional streaming.
+ *
+ * @param {object} shim the web shim to instrument with
+ * @param {Function} original the original function
+ * @returns {Function} the instrumented function
+ */
+function wrapRegister(shim, original) {
+  const constants = shim.require('./build/src/constants')
 
-          // Java captures client errors based on status code
-          // but has specific gRPC configuration to turn off
-          if (code !== 0) {
-            // this is currently just creating an error from the details string
-            shim.agent.errors.add(segment.transaction, details)
-          }
+  return function wrappedRegister() {
+    const args = shim.argsToArray.apply(shim, arguments)
 
-          segment.addAttribute('component', 'gRPC')
+    const name = args[0]
+    const handler = args[1]
+    const type = args[args.length - 1]
 
-          const protocol = 'grpc'
+    if (this.handlers.has(name)) {
+      shim.logger.debug(
+        `Not re-instrumenting gRPC method handler for ${name}: it is already registered in the server.`
+      )
+      return original.apply(this, arguments)
+    }
 
-          const url = `${protocol}://${authorityName}${this.methodName}`
+    args[1] = shim.bindCreateTransaction(instrumentedHandler, { type: shim.WEB })
 
-          segment.addAttribute('http.url', url)
-          segment.addAttribute('http.method', this.methodName)
+    return original.apply(this, args)
 
-          segment.end()
+    function instrumentedHandler(stream) {
+      const { transaction, segment } = createTransaction()
+      acceptDTHeaders(stream, transaction)
+      instrumentEventListeners(stream, transaction)
+      return shim.applySegment(handler, segment, true, this, arguments)
+    }
 
-          originalListener && originalListener.onReceiveStatus(status)
-        }
+    function createTransaction() {
+      const parent = shim.getActiveSegment()
+      const transaction = parent.transaction
 
-        args[1] = nrListener
+      // Create the transaction segment using the request URL for now. Once a
+      // better name can be determined this segment will be renamed to that.
+      const segment = shim.createSegment(name, recordHttp)
+      segment.start()
 
-        return original.apply(this, args)
-      }
+      transaction.type = 'web'
+      transaction.baseSegment = segment
+      transaction.url = name
+
+      transaction.trace.attributes.addAttribute(DESTINATION, 'request.method', transaction.url)
+
+      transaction.trace.attributes.addAttribute(DESTINATION, 'request.uri', transaction.url)
+
+      shim.setTransactionUri(transaction.url)
+
+      // This attribute isn't required by the spec, but it seems useful to have
+      transaction.trace.attributes.addAttribute(DESTINATION, 'grpc.type', type)
+      return { transaction, segment }
     }
-  })
+
+    function acceptDTHeaders(stream, transaction) {
+      const metadata = stream.metadata
+      Object.entries(metadata.getMap()).forEach(([key, value]) => {
+        transaction.trace.attributes.addAttribute(DESTINATION, `request.headers.${key}`, value)
+      })
+
+      const headers = Object.create(null)
+      headers.tracestate = metadata.get('tracestate').join(',')
+      headers.traceparent = metadata.get('traceparent').join(',')
+      headers.newrelic = metadata.get('newrelic').join(',')
+      transaction.acceptDistributedTraceHeaders('HTTP', headers)
+    }
+
+    function instrumentEventListeners(stream, transaction) {
+      const agent = shim.agent
+      stream.call.once('callEnd', (statusCode) => {
+        transaction.trace.attributes.addAttribute(DESTINATION, 'response.status', statusCode)
+        if (statusCode !== 0 && agent.config.grpc.record_errors) {
+          const status = constants.Status[statusCode]
+          const error = new Error(`gRPC status code ${statusCode}: ${status}`)
+          agent.errors.add(transaction, error)
+        }
+      })
+      stream.call.once('streamEnd', () => {
+        transaction.end()
+      })
+      // TODO should also instrument the 'data' event on the stream
+      // object, as that can ensue in lots of processing when the
+      // client is streaming. https://issues.newrelic.com/browse/NEWRELIC-1460
+    }
+  }
+}
+
+module.exports = function instrument(shim) {
+  const genericShim = shim.makeSpecializedShim(shim.GENERIC, 'call-stream')
+  const callStream = genericShim.require('./build/src/call-stream')
+  genericShim.wrap(callStream.Http2CallStream.prototype, 'start', wrapStart)
+
+  const webFrameworkShim = shim.makeSpecializedShim(shim.WEB_FRAMEWORK, 'server')
+  const grpcVersion = shim.require('./package.json').version
+  if (semver.lt(grpcVersion, '1.4.0')) {
+    shim.logger.debug('gRPC server-side instrumentation only supported on grpc-js >=1.4.0')
+    return
+  }
+
+  const server = webFrameworkShim.require('./build/src/server')
+  webFrameworkShim.setFramework('gRPC')
+  webFrameworkShim.wrap(server.Server.prototype, 'register', wrapRegister)
 }

package/lib/instrumentation/grpc-js/nr-hooks.js

@@ -12,7 +12,7 @@ const grpc = require('./grpc')
  */
 module.exports = [
   {
-    type: 'generic',
+    type: 'conglomerate', // generic shim for client, web framework shim for server
     moduleName: '@grpc/grpc-js',
     onResolved: grpc
   }

package/lib/instrumentation/mongodb/common.js

@@ -127,13 +127,22 @@ common.makeBulkDescFunc = function makeBulkDescFunc(shim) {
  *
  * @param {Shim} shim
  * @param {Instrumentation} instrumenter instance of mongo APM class
+ * @param {object} [options={}] provide command names to skip updating host/port as they are unrelated to the active query.  This is only in v3 because after every command is runs `endSessions` which runs on the admin database
  */
-common.captureAttributesOnStarted = function captureAttributesOnStarted(shim, instrumenter) {
+common.captureAttributesOnStarted = function captureAttributesOnStarted(
+  shim,
+  instrumenter,
+  options = { skipCommands: [] }
+) {
   instrumenter.on('started', function onMongoEventStarted(evnt) {
+    if (options.skipCommands.includes(evnt.commandName)) {
+      return
+    }
     // This assumes that this `started` event is fired _after_ our wrapper
     // starts and creates the segment. We perform a check of the segment name
     // out of an excess of caution.
     const connId = evnt.connectionId
+
     if (connId) {
       // used in v3 when connection is a cluster pool
       if (typeof connId === 'number') {
@@ -165,7 +174,7 @@ common.captureAttributesOnStarted = function captureAttributesOnStarted(shim, in
  * @param {object} client mongo client instance
  */
 function setHostPort(shim, connStr, db, client) {
-  const parts = connStr.split(':')
+  const parts = common.parseAddress(connStr)
   // in v3 when running with a cluster of socket connections
   // the address is `undefined:undefined`. we will instead attempt
   // to get connection details from the client symbol NR_ATTRS
@@ -189,7 +198,7 @@ function setHostPort(shim, connStr, db, client) {
 
 /**
  * Get the database_name, host, port_path_or_id
- * for the query segment. v4 refactored where the toplogy is stored.
+ * for the query segment. v4 refactored where the topology is stored.
  * You can now get the details via the client obj that's deeply nested
  * See: https://github.com/mongodb/node-mongodb-native/pull/2594/files#diff-1d214e57ddda9095d296e5700ebce701333bfefcf417e234c584d14091b2f50dR168
  *
@@ -202,8 +211,8 @@ function getInstanceAttributeParameters(shim, obj) {
     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)
+    if (topology) {
+      return doCapture(topology, databaseName)
     }
   } else if (
     obj.s &&
@@ -241,13 +250,13 @@ function getInstanceAttributeParameters(shim, obj) {
 
   function doCapture(conf, database) {
     // in older versions of 3.x the host/port
-    // lived directly on the topology.s.options
+    // lived directly on the topology
     let host = conf.host
     let port = conf.port
 
     // servers is an array but we will always pull the first for consistency
-    if (conf.servers && conf.servers.length) {
-      ;[{ host, port }] = conf.servers
+    if (conf.s && conf.s.options && conf.s.options.servers && conf.s.options.servers.length) {
+      ;[{ host, port }] = conf.s.options.servers
     }
 
     // host is a domain socket. set host as localhost and use the domain
@@ -264,3 +273,16 @@ function getInstanceAttributeParameters(shim, obj) {
     }
   }
 }
+
+/**
+ * Parses mongo address that accounts for IPv6
+ *
+ * @param {string} address mongo address string
+ * @returns {Array} host/port of address string
+ */
+common.parseAddress = function parseAddress(address) {
+  const lastColon = address.lastIndexOf(':')
+  const host = address.slice(0, lastColon)
+  const port = address.slice(lastColon + 1)
+  return [host, port]
+}

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

@@ -18,7 +18,7 @@ const {
  * parser used to grab the collection and operation
  * on every mongo operation
  *
- * @param {Object} operation
+ * @param {object} operation
  */
 function queryParser(operation) {
   let collection = this.collectionName || 'unknown'
@@ -40,7 +40,7 @@ function queryParser(operation) {
  * is a cluster of domain sockets
  *
  * @param {Shim} shim
- * @param {Object} mongodb resolved package
+ * @param {object} mongodb resolved package
  */
 function instrumentClient(shim, mongodb) {
   shim.recordOperation(mongodb.MongoClient, 'connect', function wrappedConnect(shim, _, __, args) {
@@ -61,13 +61,16 @@ function instrumentClient(shim, mongodb) {
  * add necessary attributes to segments
  *
  * @param {Shim} shim
- * @param {Object} mongodb resolved package
+ * @param {object} mongodb resolved package
  */
 module.exports = function instrument(shim, mongodb) {
   shim.setParser(queryParser)
   instrumentClient(shim, mongodb)
   const instrumenter = mongodb.instrument(Object.create(null), () => {})
-  captureAttributesOnStarted(shim, instrumenter)
+  // in v3 of mongo endSessions fires after every command and it updates the active segment
+  // attributes with the admin database name which stomps on the database name where the original
+  // command runs on
+  captureAttributesOnStarted(shim, instrumenter, { skipCommands: ['endSessions'] })
   instrumentCursor(shim, mongodb.Cursor)
   instrumentCursor(shim, shim.require('./lib/aggregation_cursor'))
   instrumentCursor(shim, shim.require('./lib/command_cursor'))

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

@@ -5,13 +5,13 @@
 
 'use strict'
 
-const { instrumentCollection, instrumentCursor, instrumentDb } = require('./common')
+const { instrumentCollection, instrumentCursor, instrumentDb, parseAddress } = require('./common')
 
 /**
  * parser used to grab the collection and operation
  * from a running query
  *
- * @param {Object} operation
+ * @param {object} operation
  */
 function queryParser(operation) {
   let collection = this.collectionName || 'unknown'
@@ -34,7 +34,7 @@ function queryParser(operation) {
  */
 function cmdStartedHandler(shim, evnt) {
   if (evnt.connectionId) {
-    let [host, port] = evnt.address.split(':')
+    let [host, port] = parseAddress(evnt.address)
 
     // connection via socket get port from 1st host
     // socketPath property
@@ -45,7 +45,7 @@ function cmdStartedHandler(shim, evnt) {
       if (hosts && hosts.length && hosts[0].socketPath) {
         port = hosts[0].socketPath
       }
-    } else if (host === '127.0.0.1') {
+    } else if (['127.0.0.1', '::1'].includes(host)) {
       host = 'localhost'
     }
 

package/lib/util/application-logging.js

@@ -16,7 +16,7 @@ const { LOGGING } = require('../metrics/names')
  * @returns {string}
  */
 utils.truncate = function truncate(str) {
-  if (str.length > OUTPUT_LENGTH) {
+  if (typeof str === 'string' && str.length > OUTPUT_LENGTH) {
     return str.substring(0, MAX_LENGTH) + '...'
   }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "newrelic",
-  "version": "8.15.0",
+  "version": "8.17.1",
   "author": "New Relic Node.js agent team <nodejs@newrelic.com>",
   "license": "Apache-2.0",
   "contributors": [
@@ -213,7 +213,6 @@
     "q": "*",
     "redis": "^1.0.0",
     "request": "^2.88.0",
-    "restify": "^8.4.0",
     "rimraf": "^2.6.3",
     "should": "*",
     "sinon": "^4.5.0",