newrelic 5.3.0 → 5.6.2

package/lib/config/index.js

@@ -140,6 +140,7 @@ function Config(config) {
   // product-level related
   this.collect_traces = true
   this.collect_errors = true
+  this.collect_span_events = true
 
   // override options for utilization stats
   this.utilization.logical_processors = null
@@ -320,15 +321,25 @@ Config.prototype._fromServer = function _fromServer(params, key) {
     case 'collect_analytics_events':
       // never enable from server-side
       // but we allow the server to disable
-      if (params.collect_analytics_events === false)
+      if (params.collect_analytics_events === false) {
         this.transaction_events.enabled = false
+      }
       break
 
     case 'collect_custom_events':
       // never enable from server-side
       // but we allow the server to disable
-      if (params.collect_custom_events === false)
+      if (params.collect_custom_events === false) {
         this.custom_insights_events.enabled = false
+      }
+      break
+
+    case 'collect_span_events':
+      // never enable from server-side
+      // but we allow the server to disable
+      if (params.collect_span_events === false) {
+        this.span_events.enabled = false
+      }
       break
 
     case 'allow_all_headers':
@@ -924,7 +935,7 @@ Config.prototype._loggingManuallySet = function _loggingManuallySet(inputConfig)
  * @param {*} inputConfig configuration passed to the Config constructor
  */
 Config.prototype._enforceServerless = function _enforceServerless(inputConfig) {
-  const DT_KEYS = ['trusted_account_key', 'application_id', 'account_id']
+  const DT_KEYS = ['trusted_account_key', 'primary_application_id', 'account_id']
   if (this.serverless_mode.enabled) {
     // Explicitly disable old CAT in serverless_mode
     if (this.cross_application_tracer.enabled) {
@@ -1267,7 +1278,8 @@ Config.prototype.publicSettings = function publicSettings() {
  *                        config file.
  */
 function initialize(config) {
-  /* When the logger is required here, it bootstraps itself and then
+  /**
+   * 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.
    */
@@ -1342,16 +1354,39 @@ function _noConfigFile() {
  */
 function getOrCreateInstance() {
   if (_configInstance === null) {
-    _configInstance = initialize()
+    try {
+      _configInstance = initialize()
+    } catch (err) {
+      /* eslint-disable no-console */
+      console.error('New Relic for Node.js is disabled due to an error:')
+      console.error(err.stack)
+      /* eslint-enable no-console */
+
+      // 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.setLogger = Config.prototype.setLogger
+    }
   }
   return _configInstance
 }
 
+function getInstance() {
+  return _configInstance
+}
+
+function createInstance(config) {
+  _configInstance = initialize(config)
+  return _configInstance
+}
+
 /**
  * Preserve the legacy initializer, but also allow consumers to manage their
  * own configuration if they choose.
  */
 Config.initialize = initialize
 Config.getOrCreateInstance = getOrCreateInstance
+Config.getInstance = getInstance
+Config.createInstance = createInstance
 
 module.exports = Config

package/lib/errors/index.js

@@ -77,8 +77,7 @@ function createError(transaction, exception, customAttributes, config) {
   if (!config.high_security && config.api.custom_attributes_enabled && customAttributes) {
     for (var key in customAttributes) {
       if (props.hasOwn(customAttributes, key)) {
-        var dest = config.attributeFilter.filter(
-          'transaction',
+        var dest = config.attributeFilter.filterTransaction(
           DESTINATIONS.ERROR_EVENT,
           key
         )

package/lib/header-attributes.js

@@ -67,7 +67,6 @@ const REQUEST_HEADER_PREFIX = 'request.headers.'
 const RESPONSE_HEADER_PREFIX = 'response.headers.'
 const REQUEST_HEADER_NAMES = Object.create(null)
 const RESPONSE_HEADER_NAMES = Object.create(null)
-const TRANSACTION_SCOPE = 'transaction'
 
 _setHeaderAttrNames(REQUEST_HEADER_NAMES, REQUEST_HEADER_PREFIX)
 _setHeaderAttrNames(RESPONSE_HEADER_NAMES, RESPONSE_HEADER_PREFIX)
@@ -125,7 +124,6 @@ function _collectHeaders(headers, nameMap, prefix, transaction) {
 
       var attributeName = nameMap[headerKey] || prefix + _headerToCamelCase(headerKey)
       transaction.trace.attributes.addAttribute(
-        TRANSACTION_SCOPE,
         DESTS.TRANS_COMMON,
         attributeName,
         header

package/lib/instrumentation/core/http-outbound.js

@@ -61,10 +61,22 @@ module.exports = function instrumentOutbound(agent, opts, makeRequest) {
 
   const name = NAMES.EXTERNAL.PREFIX + hostname
 
+  const parent = agent.tracer.getSegment()
+  if (parent && parent.opaque) {
+    logger.trace(
+      'Not capturing data for outbound request (%s) because parent segment opaque (%s)',
+      name,
+      parent.name
+    )
+
+    return makeRequest(opts)
+  }
+
+
   return agent.tracer.addSegment(
     name,
     recordExternal(hostname, 'http'),
-    null,
+    parent,
     false,
     instrumentRequest
   )

package/lib/instrumentation/core/http.js

@@ -32,7 +32,6 @@ const NEWRELIC_TRANSACTION_HEADER = 'x-newrelic-transaction'
 const NEWRELIC_SYNTHETICS_HEADER = 'x-newrelic-synthetics'
 const CONTENT_LENGTH_REGEX = /^Content-Length$/i
 const TRANSACTION_INFO_KEY = '__NR_transactionInfo'
-const TRANSACTION_SCOPE = 'transaction'
 
 
 // For incoming requests this instrumentation functions by wrapping
@@ -90,7 +89,6 @@ function wrapEmitWithTransaction(agent, emit, isHTTPS) {
 
     // URL is sent as an agent attribute with transaction events
     transaction.trace.attributes.addAttribute(
-      TRANSACTION_SCOPE,
       DESTS.TRANS_EVENT | DESTS.ERROR_EVENT,
       'request.uri',
       transaction.url
@@ -185,7 +183,6 @@ function wrapEmitWithTransaction(agent, emit, isHTTPS) {
         if (response.statusCode != null) {
           var responseCode = String(response.statusCode)
           transaction.trace.attributes.addAttribute(
-            TRANSACTION_SCOPE,
             DESTS.TRANS_COMMON,
             'httpResponseCode',
             responseCode
@@ -193,7 +190,6 @@ function wrapEmitWithTransaction(agent, emit, isHTTPS) {
 
           if (/^\d+$/.test(responseCode)) {
             transaction.trace.attributes.addAttribute(
-              TRANSACTION_SCOPE,
               DESTS.TRANS_COMMON,
               'response.status',
               responseCode
@@ -202,7 +198,6 @@ function wrapEmitWithTransaction(agent, emit, isHTTPS) {
         }
         if (response.statusMessage !== undefined) {
           transaction.trace.attributes.addAttribute(
-            TRANSACTION_SCOPE,
             DESTS.TRANS_COMMON,
             'httpResponseMessage',
             response.statusMessage
@@ -258,7 +253,6 @@ function initializeRequest(transaction, request) {
 
   if (request.method != null) {
     transaction.trace.attributes.addAttribute(
-      TRANSACTION_SCOPE,
       DESTS.TRANS_COMMON,
       'request.method',
       request.method

package/lib/instrumentation/memcached.js

@@ -46,11 +46,12 @@ module.exports = function initialize(agent, memcached, moduleName, shim) {
       // Capture connection info for datastore instance metric.
       var location = null
       if (typeof server === 'string') {
-        location = server.split(':')
+        location = server
       } else if (this.HashRing && this.HashRing.get && metacall.key) {
-        location = this.HashRing.get(metacall.key).split(':')
+        location = this.HashRing.get(metacall.key)
       }
       if (location) {
+        location = location.split(':')
         parameters.host = location[0]
         parameters.port_path_or_id = location[1]
       }

package/lib/serverless/aws-lambda.js

@@ -13,7 +13,7 @@ const ATTR_DEST = require('../config/attribute-filter').DESTINATIONS
 const COLD_START_KEY = 'aws.lambda.coldStart'
 const EVENT_SOURCE_ARN_KEY = 'aws.lambda.eventSource.arn'
 const NAMES = require('../metrics/names')
-const TRANSACTION_SCOPE = 'transaction'
+
 
 // A function with no references used to stub out closures
 function cleanClosure() {}
@@ -134,7 +134,6 @@ class AwsLambda {
 
       const awsAttributes = awsLambda._getAwsAgentAttributes(event, context)
       transaction.trace.attributes.addAttributes(
-        TRANSACTION_SCOPE,
         ATTR_DEST.TRANS_COMMON,
         awsAttributes
       )
@@ -223,7 +222,6 @@ function setWebRequest(shim, transaction, request) {
   transaction.url = urltils.scrub(request.url.path)
   transaction.verb = request.method
   transaction.trace.attributes.addAttribute(
-    TRANSACTION_SCOPE,
     ATTR_DEST.TRANS_COMMON,
     'request.method',
     request.method
@@ -234,7 +232,6 @@ function setWebRequest(shim, transaction, request) {
 
   // URL is sent as an agent attribute with transaction events
   transaction.trace.attributes.addAttribute(
-    TRANSACTION_SCOPE,
     ATTR_DEST.TRANS_EVENT | ATTR_DEST.ERROR_EVENT,
     'request.uri',
     request.url.path
@@ -277,7 +274,6 @@ function setWebResponse(transaction, response) {
 
   const responseCode = String(response.statusCode)
   transaction.trace.attributes.addAttribute(
-    TRANSACTION_SCOPE,
     ATTR_DEST.TRANS_COMMON,
     'httpResponseCode',
     responseCode
@@ -285,7 +281,6 @@ function setWebResponse(transaction, response) {
 
   if (/^\d+$/.test(responseCode)) {
     transaction.trace.attributes.addAttribute(
-      TRANSACTION_SCOPE,
       ATTR_DEST.TRANS_COMMON,
       'response.status',
       responseCode)

package/lib/shim/datastore-shim.js

@@ -9,9 +9,7 @@ const ParsedStatement = require('../db/parsed-statement')
 const Shim = require('./shim')
 const urltils = require('../util/urltils')
 const util = require('util')
-const {DESTINATIONS} = require('../config/attribute-filter')
 
-const SEGMENT_SCOPE = 'segment'
 
 /**
  * An enumeration of well-known datastores so that new instrumentations can use
@@ -321,6 +319,8 @@ function setDatastore(datastore) {
     ALL: metrics.DB.PREFIX + datastore + '/' + metrics.ALL
   }
 
+  this._datastore = datastore
+
   this._logger = this._logger.child({datastore: this._metrics.PREFIX})
   this.logger.trace({metrics: this._metrics}, 'Datastore metric names set')
 }
@@ -645,16 +645,16 @@ function captureInstanceAttributes(host, port, database) {
 
   // Normalize the instance attributes.
   var attributes = _normalizeParameters.call(this, {
-    host: host,
+    host,
     port_path_or_id: port,
     database_name: database
   })
 
-  segment.attributes.addAttributes(
-    SEGMENT_SCOPE,
-    DESTINATIONS.TRANS_SEGMENT,
-    attributes
-  )
+  for (let key in attributes) {
+    if (attributes[key]) {
+      segment.addAttribute(key, attributes[key])
+    }
+  }
 }
 
 /**
@@ -882,6 +882,8 @@ function _normalizeParameters(parameters) {
   var config = this.agent.config
   var dsTracerConf = config.datastore_tracer
 
+  parameters.product = parameters.product || this._datastore
+
   // Add database name if provided and enabled.
   if (!dsTracerConf.database_name_reporting.enabled) {
     delete parameters.database_name

package/lib/shim/message-shim.js

@@ -10,7 +10,7 @@ var Shim = require('./shim') // For Shim.defineProperty
 var util = require('util')
 
 var ATTR_DESTS = require('../config/attribute-filter').DESTINATIONS
-const TRANSACTION_SCOPE = 'transaction'
+
 
 /**
  * Enumeration of well-known message brokers.
@@ -23,6 +23,7 @@ const LIBRARY_NAMES = {
   IRONMQ: 'IronMQ',
   KAFKA: 'Kafka',
   RABBITMQ: 'RabbitMQ',
+  SNS: 'SNS',
   SQS: 'SQS'
 }
 
@@ -746,7 +747,6 @@ function recordSubscribedConsume(nodule, properties, spec) {
         for (var key in msgDesc.parameters) {
           if (props.hasOwn(msgDesc.parameters, key)) {
             tx.trace.attributes.addAttribute(
-              TRANSACTION_SCOPE,
               ATTR_DESTS.NONE,
               'message.parameters.' + key,
               msgDesc.parameters[key])
@@ -758,7 +758,6 @@ function recordSubscribedConsume(nodule, properties, spec) {
         if (!shim.agent.config.high_security) {
           if (msgDesc.routingKey) {
             tx.trace.attributes.addAttribute(
-              TRANSACTION_SCOPE,
               ATTR_DESTS.TRANS_COMMON,
               'message.routingKey',
               msgDesc.routingKey
@@ -766,7 +765,6 @@ function recordSubscribedConsume(nodule, properties, spec) {
           }
           if (shim.isString(msgDesc.queue)) {
             tx.trace.attributes.addAttribute(
-              TRANSACTION_SCOPE,
               ATTR_DESTS.TRANS_COMMON,
               'message.queueName',
               msgDesc.queue

package/lib/shim/shim.js

@@ -922,6 +922,7 @@ function record(nodule, properties, recordNamer) {
       var shouldCreateSegment = !(
         parent.opaque || (segDesc.internal && parent.internal && shim === parent.shim)
       )
+
       var segment = shouldCreateSegment ? _rawCreateSegment(shim, segDesc) : parent
 
       return _doRecord.call(this, segment, args, segDesc, shouldCreateSegment)
@@ -1445,6 +1446,17 @@ function createSegment(name, recorder, parent) {
 }
 
 function _rawCreateSegment(shim, opts) {
+  // Grab parent segment when none in opts so we can check opaqueness
+  opts.parent = opts.parent || shim.getActiveSegment()
+
+  // When parent exists and is opaque, no new segment will be created
+  // by tracer.createSegment and the parent will be returned. We bail
+  // out early so we do not risk modifying the parent segment.
+  if (opts.parent && opts.parent.opaque) {
+    shim.logger.trace(opts, 'Did not create segment because parent is opaque')
+    return opts.parent
+  }
+
   var segment = shim.tracer.createSegment(opts.name, opts.recorder, opts.parent)
   if (segment) {
     segment.internal = opts.internal

package/lib/spans/span-event.js

@@ -1,13 +1,12 @@
 'use strict'
 
+const Config = require('../config')
 const {truncate} = require('../util/byte-limit')
-const Attributes = require('../attributes')
 
 const {DESTINATIONS} = require('../config/attribute-filter')
 const NAMES = require('../metrics/names')
 const HTTP_LIBRARY = 'http'
-const SPAN_KIND_ATTRIBUTE = 'client'
-const SEGMENT_SCOPE = 'segment'
+const CLIENT_KIND = 'client'
 const CATEGORIES = {
   HTTP: 'http',
   DATASTORE: 'datastore',
@@ -15,6 +14,28 @@ const CATEGORIES = {
 }
 const EMPTY_USER_ATTRS = Object.freeze(Object.create(null))
 
+/**
+ * All the intrinsic attributes for span events, regardless of kind.
+ */
+class SpanIntrinsics {
+  constructor() {
+    this.type = 'Span'
+    this.traceId = null
+    this.guid = null
+    this.parentId = null
+    this.transactionId = null
+    this.sampled = null
+    this.priority = null
+    this.name = null
+    this.category = CATEGORIES.GENERIC
+    this.component = null
+    this.timestamp = null
+    this.duration = null
+    this['nr.entryPoint'] = null
+    this['span.kind'] = null
+  }
+}
+
 /**
  * General span event class.
  *
@@ -25,25 +46,9 @@ const EMPTY_USER_ATTRS = Object.freeze(Object.create(null))
  * @class
  */
 class SpanEvent {
-  constructor(segment) {
-    let filter = null
-    if (segment && segment.transaction) {
-      filter = segment.transaction.agent.config.attributeFilter
-    }
-    this.attributes = new Attributes({filter})
-    this.intrinsics = {
-      type: 'Span',
-      traceId: null,
-      guid: null,
-      parentId: null,
-      transactionId: null,
-      sampled: null,
-      priority: null,
-      name: null,
-      category: CATEGORIES.GENERIC,
-      timestamp: null,
-      duration: null
-    }
+  constructor(attributes) {
+    this.attributes = attributes
+    this.intrinsics = new SpanIntrinsics()
   }
 
   static get CATEGORIES() {
@@ -70,61 +75,53 @@ class SpanEvent {
    * @return {SpanEvent} The constructed event.
    */
   static fromSegment(segment, parentId = null) {
+    const attributes = segment.attributes.get(DESTINATIONS.SPAN_EVENT)
+
     let span = null
     if (HttpSpanEvent.testSegment(segment)) {
-      span = new HttpSpanEvent(segment)
+      span = new HttpSpanEvent(attributes)
     } else if (DatastoreSpanEvent.testSegment(segment)) {
-      span = new DatastoreSpanEvent(segment)
+      span = new DatastoreSpanEvent(attributes)
     } else {
-      span = new SpanEvent()
+      span = new SpanEvent(attributes)
     }
 
     const tx = segment.transaction
 
-    Object.assign(span.intrinsics, {
-      traceId: tx.traceId || tx.id,
-      guid: segment.id,
-      parentId,
-      transactionId: tx.id,
-      sampled: tx.sampled,
-      priority: tx.priority,
-      name: segment.name,
-      'nr.entryPoint': tx.baseSegment === segment ? true : null,
-      // Timestamp in milliseconds, duration in seconds. Yay consistency!
-      timestamp: segment.timer.start,
-      duration: segment.timer.getDurationInMillis() / 1000
-    })
+    span.intrinsics.traceId = tx.traceId || tx.id
+    span.intrinsics.guid = segment.id
+    span.intrinsics.parentId = parentId
+    span.intrinsics.transactionId = tx.id
+    span.intrinsics.sampled = tx.sampled
+    span.intrinsics.priority = tx.priority
+    span.intrinsics.name = segment.name
+
+    // Only set this if it will be `true`. Must be `null` otherwise.
+    if (tx.baseSegment === segment) {
+      span.intrinsics['nr.entryPoint'] = true
+    }
+
+    // Timestamp in milliseconds, duration in seconds. Yay consistency!
+    span.intrinsics.timestamp = segment.timer.start
+    span.intrinsics.duration = segment.timer.getDurationInMillis() / 1000
 
     return span
   }
 
   toJSON() {
-    const intrinsics = Object.create(null)
-    for (let key in this.intrinsics) {
-      if (this.intrinsics[key] != null) {
-        intrinsics[key] = this.intrinsics[key]
-      }
-    }
-
     return [
-      intrinsics,
+      _filterNulls(this.intrinsics),
       EMPTY_USER_ATTRS,
-      this.attributes.get(DESTINATIONS.SPAN_EVENT)
+      _filterNulls(this.attributes)
     ]
   }
 
   addAttribute(key, value, truncateExempt = false) {
-    this.attributes.addAttribute(
-      SEGMENT_SCOPE,
-      DESTINATIONS.SPAN_EVENT,
-      key,
-      value,
-      truncateExempt
-    )
-  }
-
-  getAttributes() {
-    return this.attributes.get(DESTINATIONS.SPAN_EVENT)
+    const {attributeFilter} = Config.getInstance()
+    const dest = attributeFilter.filterSegment(DESTINATIONS.SPAN_EVENT, key)
+    if (dest & DESTINATIONS.SPAN_EVENT) {
+      this.attributes[key] = truncateExempt ? value : _truncate(value)
+    }
   }
 }
 
@@ -135,23 +132,25 @@ class SpanEvent {
  * @class
  */
 class HttpSpanEvent extends SpanEvent {
-  constructor(segment) {
-    super(segment)
+  constructor(attributes) {
+    super(attributes)
 
-    const segmentAttributes = segment.getAttributes()
+    this.intrinsics.category = CATEGORIES.HTTP
+    this.intrinsics.component = attributes.library || HTTP_LIBRARY
+    this.intrinsics['span.kind'] = CLIENT_KIND
 
-    Object.assign(this.intrinsics, {
-      category: CATEGORIES.HTTP,
-      component: segmentAttributes.library || HTTP_LIBRARY,
-      'span.kind': SPAN_KIND_ATTRIBUTE,
-    })
+    if (attributes.library) {
+      attributes.library = null
+    }
 
-    if (segmentAttributes.url) {
-      this.addAttribute('http.url', segmentAttributes.url)
+    if (attributes.url) {
+      this.addAttribute('http.url', attributes.url)
+      attributes.url = null
     }
 
-    if (segmentAttributes.procedure) {
-      this.addAttribute('http.method', segmentAttributes.procedure)
+    if (attributes.procedure) {
+      this.addAttribute('http.method', attributes.procedure)
+      attributes.procedure = null
     }
   }
 
@@ -167,45 +166,50 @@ class HttpSpanEvent extends SpanEvent {
  * @class.
  */
 class DatastoreSpanEvent extends SpanEvent {
-  constructor(segment) {
-    super(segment)
+  constructor(attributes) {
+    super(attributes)
 
-    const segmentAttributes = segment.getAttributes()
+    this.intrinsics.category = CATEGORIES.DATASTORE
+    this.intrinsics['span.kind'] = CLIENT_KIND
 
-    Object.assign(this.intrinsics, {
-      category: CATEGORIES.DATASTORE,
-      'span.kind': SPAN_KIND_ATTRIBUTE,
-    })
+    if (attributes.product) {
+      this.intrinsics.component = attributes.product
+      attributes.product = null
+    }
 
-    if (segmentAttributes.product) {
-      this.addAttribute( 'component', segmentAttributes.product)
+    if (attributes.collection) {
+      this.addAttribute('db.collection', attributes.collection)
+      attributes.collection = null
     }
 
-    if (segmentAttributes.sql || segmentAttributes.sql_obfuscated) {
+    if (attributes.sql || attributes.sql_obfuscated) {
       let sql = null
-      if (segmentAttributes.sql_obfuscated) {
-        sql = _truncate(segmentAttributes.sql_obfuscated)
-      } else if (segmentAttributes.sql) {
-        sql = _truncate(segmentAttributes.sql)
+      if (attributes.sql_obfuscated) {
+        sql = _truncate(attributes.sql_obfuscated)
+        attributes.sql_obfuscated = null
+      } else if (attributes.sql) {
+        sql = _truncate(attributes.sql)
+        attributes.sql = null
       }
 
       // Flag as exempt from normal attribute truncation
       this.addAttribute('db.statement', sql, true)
     }
 
-    if (segmentAttributes.database_name) {
-      this.addAttribute('db.instance', segmentAttributes.database_name)
+    if (attributes.database_name) {
+      this.addAttribute('db.instance', attributes.database_name)
+      attributes.database_name = null
     }
 
-    if (segmentAttributes.host) {
-      this.addAttribute('peer.hostname', segmentAttributes.host)
+    if (attributes.host) {
+      this.addAttribute('peer.hostname', attributes.host)
 
-      if (segmentAttributes.port_path_or_id) {
-        this.addAttribute(
-          'peer.address',
-          `${segmentAttributes.host}:${segmentAttributes.port_path_or_id}`
-        )
+      if (attributes.port_path_or_id) {
+        const address = `${attributes.host}:${attributes.port_path_or_id}`
+        this.addAttribute('peer.address', address)
+        attributes.port_path_or_id = null
       }
+      attributes.host = null
     }
   }
 
@@ -222,4 +226,14 @@ function _truncate(val) {
   return truncated
 }
 
+function _filterNulls(obj) {
+  const out = Object.create(null)
+  for (let key in obj) {
+    if (obj[key] != null) {
+      out[key] = obj[key]
+    }
+  }
+  return out
+}
+
 module.exports = SpanEvent

package/lib/timer.js

@@ -142,7 +142,9 @@ Timer.prototype.setDurationInMillis = function setDurationInMillis(duration, sta
   // anywhere except to calculate duration, and we are setting duration
   // this is fine.
   this.hrstart = [Math.floor(start / 1e3), start % 1e3 * 1e6]
-  this.start = start
+  if (start != null) {
+    this.start = start
+  }
 }
 
 /**