newrelic 9.4.0 → 9.6.0

package/lib/instrumentation/core/http.js

@@ -13,21 +13,20 @@ const cat = require('../../util/cat')
 const instrumentOutbound = require('./http-outbound')
 const url = require('url')
 const urltils = require('../../util/urltils')
-const properties = require('../../util/properties')
 const headerAttributes = require('../../header-attributes')
 const headerProcessing = require('../../header-processing')
 
 const NAMES = require('../../metrics/names')
 const DESTS = require('../../config/attribute-filter').DESTINATIONS
 
+const symbols = require('../../symbols')
+
 /*
  *
  * CONSTANTS
  *
  */
-const NR_CONNECTION_PROP = '__NR__connection'
 const NEWRELIC_SYNTHETICS_HEADER = 'x-newrelic-synthetics'
-const TRANSACTION_INFO_KEY = '__NR_transactionInfo'
 
 // For incoming requests this instrumentation functions by wrapping
 // `http.createServer` and `http.Server#addListener`. The former merely sets the
@@ -55,12 +54,6 @@ function wrapEmitWithTransaction(agent, emit, isHTTPS) {
     // Store the transaction information on the request and response.
     const txInfo = storeTxInfo(transaction, request, response)
 
-    // Hook for web framework instrumentations that don't have easy access to
-    // the request entry point.
-    if (properties.hasOwn(this, '__NR_onRequestStarted')) {
-      this.__NR_onRequestStarted(request, response)
-    }
-
     if (request) {
       initializeRequest(transaction, request)
     }
@@ -204,7 +197,6 @@ function storeTxInfo(transaction, request, response) {
     logger.debug('Missing request or response object! Not storing transaction info.')
     return
   }
-  const hideInternal = transaction.agent.config.transaction_tracer.hide_internals
 
   const txInfo = {
     transaction: transaction,
@@ -212,12 +204,7 @@ function storeTxInfo(transaction, request, response) {
     errorHandled: false,
     error: null
   }
-  if (hideInternal) {
-    properties.setInternal(request, TRANSACTION_INFO_KEY, txInfo)
-    properties.setInternal(response, TRANSACTION_INFO_KEY, txInfo)
-  } else {
-    request[TRANSACTION_INFO_KEY] = response[TRANSACTION_INFO_KEY] = txInfo
-  }
+  request[symbols.transactionInfo] = response[symbols.transactionInfo] = txInfo
 
   logger.trace('Stored transaction %s information on request and response', transaction.id)
 
@@ -245,7 +232,7 @@ function wrapResponseEnd(agent, proto) {
     }
 
     return function wrappedResEnd() {
-      const txInfo = this && this[TRANSACTION_INFO_KEY]
+      const txInfo = this && this[symbols.transactionInfo]
       if (!txInfo) {
         return end.apply(this, arguments)
       }
@@ -393,9 +380,9 @@ function wrapRequest(agent, request) {
     const reqArgs = [options, cb]
 
     // Don't pollute metrics and calls with NR connections
-    const internalOnly = options && options[NR_CONNECTION_PROP]
+    const internalOnly = options && options[symbols.offTheRecord]
     if (internalOnly) {
-      delete options[NR_CONNECTION_PROP]
+      delete options[symbols.offTheRecord]
     }
 
     // If this is not a request we're recording, exit early.

package/lib/instrumentation/core/timers.js

@@ -5,6 +5,8 @@
 
 'use strict'
 
+const symbols = require('../../symbols')
+
 module.exports = initialize
 
 function initialize(agent, timers, moduleName, shim) {
@@ -53,7 +55,7 @@ function initialize(agent, timers, moduleName, shim) {
   function wrapClearTimeout(shim, fn) {
     return function wrappedClearTimeout(timer) {
       if (timer && timer._onTimeout) {
-        const segment = timer._onTimeout.__NR_segment
+        const segment = timer._onTimeout[symbols.segment]
         if (segment && !segment.opaque) {
           segment.ignore = true
         }

package/lib/instrumentation/mysql/mysql.js

@@ -7,6 +7,7 @@
 
 const dbutils = require('../../db/utils')
 const properties = require('../../util/properties')
+const symbols = require('../../symbols')
 
 exports.callbackInitialize = function callbackInitialize(shim, mysql) {
   shim.setDatastore(shim.MYSQL)
@@ -17,7 +18,7 @@ exports.callbackInitialize = function callbackInitialize(shim, mysql) {
     shim.logger.debug('Wrapping Connection#query')
     if (wrapQueryable(shim, connection, false)) {
       const connProto = Object.getPrototypeOf(connection)
-      shim.setInternalProperty(connProto, '__NR_storeDatabase', true)
+      connProto[symbols.storeDatabase] = true
       shim.unwrap(mysql, 'createConnection')
     }
   }
@@ -133,7 +134,7 @@ function wrapQueryable(shim, queryable, isPoolQuery) {
     describe = describePoolQuery
   } else {
     describe = describeQuery
-    shim.setInternalProperty(proto, '__NR_databaseName', null)
+    proto[symbols.databaseName] = null
   }
 
   shim.recordQuery(proto, 'query', describe)
@@ -214,7 +215,7 @@ function getInstanceParameters(shim, queryable, query) {
   const parameters = { host: null, port_path_or_id: null, database_name: null }
   let conf = queryable.config
   conf = (conf && conf.connectionConfig) || conf
-  let databaseName = queryable.__NR_databaseName || null
+  let databaseName = queryable[symbols.databaseName] || null
   if (conf) {
     parameters.database_name = databaseName = databaseName || conf.database
 
@@ -235,10 +236,10 @@ function getInstanceParameters(shim, queryable, query) {
 }
 
 function storeDatabaseName(shim, queryable, query) {
-  if (queryable.__NR_storeDatabase) {
+  if (queryable[symbols.storeDatabase]) {
     const databaseName = dbutils.extractDatabaseChangeFromUse(query)
     if (databaseName) {
-      shim.setInternalProperty(queryable, '__NR_databaseName', databaseName)
+      queryable[symbols.databaseName] = databaseName
     }
   }
 }

package/lib/instrumentation/promise.js

@@ -8,6 +8,7 @@
 const util = require('util')
 const properties = require('../util/properties')
 const shimmer = require('../shimmer')
+const symbols = require('../symbols')
 
 /**
  * @namespace Library.Spec
@@ -213,13 +214,13 @@ module.exports = function initialize(agent, library, spec) {
         self: null,
         args: null
       }
-      if (!this.__NR_context) {
+      if (!this[symbols.context]) {
         const segmentName = 'Promise ' + executor.name || '<anonymous>'
         const segment = _createSegment(segmentName)
         Contextualizer.link(null, this, segment, spec.useFinally)
       }
       const args = [].slice.call(arguments)
-      args[0] = wrapExecutorContext(context, this.__NR_context.getSegment())
+      args[0] = wrapExecutorContext(context, this[symbols.context].getSegment())
       const ret = caller.apply(this, args)
 
       // Bluebird catches executor errors and auto-rejects when it catches them,
@@ -256,8 +257,8 @@ module.exports = function initialize(agent, library, spec) {
   function wrapResolver(context, fn) {
     return function wrappedResolveReject(val) {
       const promise = context.promise
-      if (promise && promise.__NR_context) {
-        promise.__NR_context.getSegment().touch()
+      if (promise && promise[symbols.context]) {
+        promise[symbols.context].getSegment().touch()
       }
       fn(val)
     }
@@ -333,15 +334,15 @@ module.exports = function initialize(agent, library, spec) {
         }
 
         return function __NR_wrappedThenHandler() {
-          if (!next || !next.__NR_context) {
+          if (!next || !next[symbols.context]) {
             return fn.apply(this, arguments)
           }
 
-          let promSegment = next.__NR_context.getSegment()
+          let promSegment = next[symbols.context].getSegment()
           const segmentName = segmentNamePrefix + (fn.name || '<anonymous>')
           const segment = _createSegment(segmentName, promSegment)
           if (segment && segment !== promSegment) {
-            next.__NR_context.setSegment(segment)
+            next[symbols.context].setSegment(segment)
             promSegment = segment
           }
 
@@ -350,7 +351,7 @@ module.exports = function initialize(agent, library, spec) {
             ret = agent.tracer.bindFunction(fn, promSegment, true).apply(this, arguments)
           } finally {
             if (ret && typeof ret.then === 'function') {
-              ret = next.__NR_context.continue(ret)
+              ret = next[symbols.context].continue(ret)
             }
           }
           return ret
@@ -453,9 +454,9 @@ function Contextualizer(idx, context, useFinally) {
 module.exports.Contextualizer = Contextualizer
 
 Contextualizer.link = function link(prev, next, segment, useFinally) {
-  let ctxlzr = prev && prev.__NR_context
+  let ctxlzr = prev && prev[symbols.context]
   if (ctxlzr && !ctxlzr.isActive()) {
-    ctxlzr = prev.__NR_context = null
+    ctxlzr = prev[symbols.context] = null
   }
 
   if (ctxlzr) {
@@ -497,17 +498,17 @@ Contextualizer.link = function link(prev, next, segment, useFinally) {
     const idx = ctxlzr.child === false ? ctxlzr.context.branch() : ctxlzr.idx
 
     // Create a new context for this next promise.
-    next.__NR_context = new Contextualizer(idx, ctxlzr.context, ctxlzr.useFinally)
-    next.__NR_context.parentIdx = ctxlzr.idx
+    next[symbols.context] = new Contextualizer(idx, ctxlzr.context, ctxlzr.useFinally)
+    next[symbols.context].parentIdx = ctxlzr.idx
 
     // If this was our first child, remember it in case we have a 2nd.
     if (ctxlzr.child === null) {
-      ctxlzr.child = next.__NR_context
+      ctxlzr.child = next[symbols.context]
     }
   } else if (segment) {
     // This next promise is the root of a chain. Either there was no previous
     // promise or the promise was created out of context.
-    next.__NR_context = new Contextualizer(0, new Context(segment), useFinally)
+    next[symbols.context] = new Contextualizer(0, new Context(segment), useFinally)
   }
 }
 
@@ -538,7 +539,7 @@ Contextualizer.prototype.toJSON = function toJSON() {
 
 Contextualizer.prototype.continue = function continueContext(prom) {
   const self = this
-  const nextContext = prom.__NR_context
+  const nextContext = prom[symbols.context]
   if (!nextContext) {
     return prom
   }

package/lib/instrumentation/undici.js

@@ -10,10 +10,7 @@ const recordExternal = require('../metrics/recorders/http_external')
 const logger = require('../logger').child({ component: 'undici' })
 const NAMES = require('../metrics/names')
 const NEWRELIC_SYNTHETICS_HEADER = 'x-newrelic-synthetics'
-const SYMBOLS = {
-  SEGMENT: Symbol('__NR_segment'),
-  PARENT_SEGMENT: Symbol('__NR_parent_segment')
-}
+const symbols = require('../symbols')
 const { executionAsyncResource } = require('async_hooks')
 
 let diagnosticsChannel = null
@@ -52,11 +49,11 @@ module.exports = function addUndiciChannels(agent, undici, modName, shim) {
     if (agent.config.feature_flag.undici_async_tracking) {
       const resource = executionAsyncResource()
 
-      if (!resource[SYMBOLS.PARENT_SEGMENT]) {
+      if (!resource[symbols.parentSegment]) {
         const parent = shim.getSegment()
-        resource[SYMBOLS.PARENT_SEGMENT] = parent
+        resource[symbols.parentSegment] = parent
       }
-      return resource[SYMBOLS.PARENT_SEGMENT]
+      return resource[symbols.parentSegment]
     }
     return shim.getSegment()
   }
@@ -71,7 +68,7 @@ module.exports = function addUndiciChannels(agent, undici, modName, shim) {
    */
   diagnosticsChannel.channel('undici:request:create').subscribe(({ request }) => {
     const parent = getParentSegment()
-    request[SYMBOLS.PARENT_SEGMENT] = parent
+    request[symbols.parentSegment] = parent
     if (!parent || (parent && parent.opaque)) {
       logger.trace(
         'Not capturing data for outbound request (%s) because parent segment opaque (%s)',
@@ -114,7 +111,7 @@ module.exports = function addUndiciChannels(agent, undici, modName, shim) {
    * @param {TLSSocket | net.Socket} socket active socket connection
    */
   diagnosticsChannel.channel('undici:client:sendHeaders').subscribe(({ request, socket }) => {
-    const parentSegment = request[SYMBOLS.PARENT_SEGMENT]
+    const parentSegment = request[symbols.parentSegment]
     if (!parentSegment || (parentSegment && parentSegment.opaque)) {
       return
     }
@@ -143,7 +140,7 @@ module.exports = function addUndiciChannels(agent, undici, modName, shim) {
         segment.addSpanAttribute(`request.parameters.${key}`, value)
       })
       segment.addAttribute('procedure', request.method || 'GET')
-      request[SYMBOLS.SEGMENT] = segment
+      request[symbols.segment] = segment
     }
   })
 
@@ -157,7 +154,7 @@ module.exports = function addUndiciChannels(agent, undici, modName, shim) {
    * @param {object} params.response { statusCode, headers, statusText }
    */
   diagnosticsChannel.channel('undici:request:headers').subscribe(({ request, response }) => {
-    const activeSegment = request[SYMBOLS.SEGMENT]
+    const activeSegment = request[symbols.segment]
     if (!activeSegment) {
       return
     }
@@ -211,8 +208,8 @@ module.exports = function addUndiciChannels(agent, undici, modName, shim) {
    * @param {Error} error
    */
   function endAndRestoreSegment(ctx, error) {
-    const activeSegment = ctx[SYMBOLS.SEGMENT]
-    const parentSegment = ctx[SYMBOLS.PARENT_SEGMENT]
+    const activeSegment = ctx[symbols.segment]
+    const parentSegment = ctx[symbols.parentSegment]
     if (activeSegment) {
       activeSegment.end()
 
@@ -238,5 +235,3 @@ module.exports = function addUndiciChannels(agent, undici, modName, shim) {
     shim.agent.errors.add(tx, error)
   }
 }
-
-module.exports.SYMBOLS = SYMBOLS

package/lib/instrumentations.js

@@ -36,7 +36,7 @@ module.exports = function instrumentations() {
     'restify': { type: MODULE_TYPE.WEB_FRAMEWORK },
     'superagent': { module: '@newrelic/superagent' },
     'undici': { type: MODULE_TYPE.TRANSACTION },
-    'vision': { type: MODULE_TYPE.WEB_FRAMEWORK },
+    '@hapi/vision': { type: MODULE_TYPE.WEB_FRAMEWORK },
     'when': { type: null },
     'winston': { type: MODULE_TYPE.GENERIC }
   }

package/lib/shim/constants.js

@@ -12,7 +12,7 @@
  * @readonly
  * @enum {string}
  */
-const MODULE_TYPE = {
+exports.MODULE_TYPE = {
   /** Utility/generic module, such as pooling libraries. */
   GENERIC: 'generic',
 
@@ -34,18 +34,3 @@ const MODULE_TYPE = {
   /** Web server framework module, such as Express or Restify. */
   WEB_FRAMEWORK: 'web-framework'
 }
-
-/**
- * Enumeration of symbols used by shims.
- *
- * @memberof Shim.prototype
- * @readonly
- * @enum {Symbol}
- */
-const SYMBOLS = {
-  /** Indicates distributed tracing should be disabled for a single request. */
-  DISABLE_DT: Symbol('Disable distributed tracing')
-}
-
-exports.MODULE_TYPE = MODULE_TYPE
-exports.SYMBOLS = SYMBOLS

package/lib/shim/datastore-shim.js

@@ -14,6 +14,7 @@ const ParsedStatement = require('../db/parsed-statement')
 const Shim = require('./shim')
 const urltils = require('../util/urltils')
 const util = require('util')
+const symbols = require('../symbols')
 
 /**
  * An enumeration of well-known datastores so that new instrumentations can use
@@ -616,7 +617,7 @@ function bindRowCallbackSegment(args, cbIdx, parentSegment) {
   }, parentSegment)
 
   // Mark this as wrapped and put it in the args array.
-  this.setInternalProperty(wrapper, '__NR_original', cb)
+  wrapper[symbols.original] = cb
   args[idx] = wrapper
 }
 

package/lib/shim/promise-shim.js

@@ -7,6 +7,7 @@
 
 const logger = require('../logger').child({ component: 'PromiseShim' })
 const Shim = require('./shim')
+const symbols = require('../symbols')
 
 /**
  * A helper class for wrapping promise modules.
@@ -108,7 +109,7 @@ class PromiseShim extends Shim {
       post: function postPromise(shim, Promise, name, args) {
         // This extra property is added by `_wrapExecutorContext` in the pre step.
         const executor = args[0]
-        const context = executor && executor.__NR_executorContext
+        const context = executor && executor[symbols.executorContext]
         if (!context || !shim.isFunction(context.executor)) {
           return
         }
@@ -159,14 +160,14 @@ class PromiseShim extends Shim {
           return caller.apply(this, arguments)
         }
 
-        if (!this.__NR_context) {
+        if (!this[symbols.context]) {
           Contextualizer.link(null, this, parent)
         }
 
         const args = shim.argsToArray.apply(shim, arguments)
         _wrapExecutorContext(shim, args)
         const ret = caller.apply(this, args)
-        const context = args[0].__NR_executorContext
+        const context = args[0][symbols.executorContext]
         context.promise = this
 
         // Bluebird catches executor errors and auto-rejects when it catches them,
@@ -343,7 +344,7 @@ function _wrapExecutorContext(shim, args) {
     self: null,
     args: null
   }
-  contextExporter.__NR_executorContext = context
+  contextExporter[symbols.executorContext] = context
   args[0] = contextExporter
 
   function contextExporter(resolve, reject) {
@@ -360,8 +361,8 @@ function _wrapExecutorContext(shim, args) {
 function _wrapResolver(context, fn) {
   return function wrappedResolveReject(val) {
     const promise = context.promise
-    if (promise && promise.__NR_context) {
-      promise.__NR_context.getSegment().touch()
+    if (promise && promise[symbols.context]) {
+      promise[symbols.context].getSegment().touch()
     }
     fn(val)
   }
@@ -409,14 +410,14 @@ function _wrapThen(shim, fn, name, useAllParams) {
       }
 
       return function __NR_wrappedThenHandler() {
-        if (!next || !next.__NR_context) {
+        if (!next || !next[symbols.context]) {
           return handler.apply(this, arguments)
         }
 
-        let promSegment = next.__NR_context.getSegment()
+        let promSegment = next[symbols.context].getSegment()
         const segment = promSegment || shim.getSegment()
         if (segment && segment !== promSegment) {
-          next.__NR_context.setSegment(segment)
+          next[symbols.context].setSegment(segment)
           promSegment = segment
         }
 
@@ -425,7 +426,7 @@ function _wrapThen(shim, fn, name, useAllParams) {
           ret = shim.applySegment(handler, promSegment, true, this, arguments)
         } finally {
           if (ret && typeof ret.then === 'function') {
-            ret = next.__NR_context.continueContext(ret)
+            ret = next[symbols.context].continueContext(ret)
           }
         }
         return ret
@@ -459,9 +460,9 @@ class Contextualizer {
   }
 
   static link(prev, next, segment) {
-    let ctxlzr = prev && prev.__NR_context
+    let ctxlzr = prev && prev[symbols.context]
     if (ctxlzr && !ctxlzr.isActive()) {
-      ctxlzr = prev.__NR_context = null
+      ctxlzr = prev[symbols.context] = null
     }
 
     if (ctxlzr) {
@@ -503,17 +504,17 @@ class Contextualizer {
       const idx = ctxlzr.child === false ? ctxlzr.context.branch() : ctxlzr.idx
 
       // Create a new context for this next promise.
-      next.__NR_context = new Contextualizer(idx, ctxlzr.context)
-      next.__NR_context.parentIdx = ctxlzr.idx
+      next[symbols.context] = new Contextualizer(idx, ctxlzr.context)
+      next[symbols.context].parentIdx = ctxlzr.idx
 
       // If this was our first child, remember it in case we have a 2nd.
       if (ctxlzr.child === null) {
-        ctxlzr.child = next.__NR_context
+        ctxlzr.child = next[symbols.context]
       }
     } else if (segment) {
       // This next promise is the root of a chain. Either there was no previous
       // promise or the promise was created out of context.
-      next.__NR_context = new Contextualizer(0, new Context(segment))
+      next[symbols.context] = new Contextualizer(0, new Context(segment))
     }
   }
 
@@ -542,7 +543,7 @@ class Contextualizer {
 
   continueContext(prom) {
     const self = this
-    const nextContext = prom.__NR_context
+    const nextContext = prom[symbols.context]
     if (!nextContext) {
       return prom
     }