newrelic 6.3.0 → 6.5.0

package/{.eslintrc → .eslintrc.js}

@@ -1,4 +1,4 @@
-{
+module.exports = {
   "env": {
     "es6": true,
     "node": true,
@@ -7,6 +7,7 @@
   "parserOptions": {
     "ecmaVersion": 6
   },
+  "ignorePatterns": ["invalid-json/"],
   "rules": {
     "indent": ["warn", 2, {"SwitchCase": 1}],
     "brace-style": "error",
@@ -21,7 +22,7 @@
     "func-names": "error",
     "guard-for-in": "error",
     "key-spacing": ["off", { "beforeColon": false }],
-    "max-len": ["error", 90, { "ignoreUrls": true }],
+    "max-len": ["error", 100, { "ignoreUrls": true }],
     "max-nested-callbacks": ["error", 3],
     "max-params": ["error", 5],
     "new-cap": "error",
@@ -52,6 +53,7 @@
     "strict": "error",
     "quote-props": [ "off", "consistent-as-needed" ],
     "quotes": ["off", "single"],
+    "use-isnan": "error",
     "wrap-iife": "error"
   },
   "overrides": [

package/.travis.yml

@@ -18,7 +18,6 @@ env:
     - NR_NODE_VERSION=12 SUITE=unit
     - NR_NODE_VERSION=12 SUITE=integration
     - NR_NODE_VERSION=12 SUITE=lint
-    - NR_NODE_VERSION=12 SUITE=security
     - NR_NODE_VERSION=12 SUITE=versioned
 services:
   - memcached

package/NEWS.md

@@ -1,3 +1,139 @@
+### 6.5.0 (2020-03-18):
+
+* Added error attributes to spans.
+  * The public api method `noticeError()` now attaches exception details to the currently executing
+    span. Spans with error details are now highlighted red in the Distributed Tracing UI. Also, the
+    attributes `error.class` and `error.message` are added to the span. If multiple errors are
+    recorded for a single span, only the final error's attributes will be added to the span.
+
+  * Added ID of the span in which an error occurred to the corresponding transaction error event.
+
+* Added new public API methods `addCustomSpanAttribute` and `addCustomSpanAttributes` to add
+  attributes to the currently executing span.
+
+* Added new attributes to http outbound spans: `http.statusCode` and `http.statusText`.
+
+* Updated W3C Trace Context "Known Issues and Workaround" notes with latest accurate consideration.
+
+* Converted unit tests to run via `tap`. Removes `mocha` dependency.
+
+* Fixed route naming when hapi's `pre` route handlers share functions.
+
+* Fixed `child_process` instrumentation so that handlers can be effectively removed
+  when attached via `.once()` or manually removed via `removeListener()`.
+
+### 6.4.2 (2020-02-27):
+
+* Support new http[s] get/request function signature in Node v10+
+
+* Added the following Span Event attributes:
+  - http.statusCode
+  - http.statusText
+
+  The above attributes will be replacing the following *deprecated* attributes:
+  - httpResponseCode
+  - response.status
+  - response.statusMessage
+
+  The deprecated attributes will be removed with the next major release of the Agent.
+
+* Updates version check to be in alignment with [our stated support
+  policy](https://docs.newrelic.com/docs/agents/nodejs-agent/getting-started/compatibility-requirements-nodejs-agent)
+  and the version constraints in package.json
+
+* Redacts individual certificates configuration values before sending to server
+  settings. When configured, these values will now appear like: `{certificates.0: ****}`.
+
+### 6.4.1 (2020-02-20):
+
+* Bumped `@newrelic/aws-sdk` version to `v1.1.2` from `v1.1.1`.
+  https://github.com/newrelic/node-newrelic-aws-sdk/blob/master/CHANGELOG.md
+
+  Notable improvements include:
+  * Fixed issue where instrumentation would crash pulling `host` and `port` values
+  when `AmazonDaxClient` was used as the service for `DocumentClient`.
+
+* Prevented passing CI with `.only()` in mocha tests.
+
+* Removed CI restriction for Node `12.15`. Node shipped a fix for the `12.16`
+  breakage in `12.16.1`.
+
+* Removed calls to `OutgoingMessage.prototype._headers` in favor of using public
+  `getHeaders` API (thanks to @adityasabnis for bringing this to our attention).
+
+* Removed engine upper-bound to enable easier experimentation of newer Node versions
+  with the agent for customers.
+
+  Please see https://docs.newrelic.com/docs/agents/nodejs-agent/getting-started/compatibility-requirements-nodejs-agent for officially supported versions.
+  Incompatibilities are expected for odd-numbered releases, which are not supported,
+  and even-numbered releases before "official" support has been released.
+
+* Reduced "... Aggregator data send." log messages to `debug` level to reduce noise
+  of default logs.
+
+* Fixed issue where disabled agent would return an empty string instead of an empty
+  object from API#getLinkingMetadata().
+
+  This issue would cause the `@newrelic/winston-enricher` module to crash when
+  attempting to inject log metatdata.
+
+* Reduced logging level of raw `x-queue-start` or `x-request-start` header values
+  to avoid logging very large values at default logging levels.
+
+### 6.4.0 (2020-02-12):
+
+* Added support for W3C Trace Context, with easy upgrade from New Relic trace
+  context.
+
+  * Distributed Tracing now supports W3C Trace Context headers for HTTP protocols
+    when distributed tracing is enabled. Our implementation can accept and emit both
+    the W3C trace header format and the New Relic trace header format. This simplifies
+    agent upgrades, allowing trace context to be propagated between services with older
+    and newer releases of New Relic agents. W3C trace header format will always be
+    accepted and emitted. New Relic trace header format will be accepted, and you can
+    optionally disable emission of the New Relic trace header format.
+
+  * When distributed tracing is enabled with `distributed_tracing.enabled: true`,
+    the Node agent will now accept W3C's `traceparent` and `tracestate` headers when
+    calling `TransactionHandle#acceptDistributedTraceHeaders` or automatically via
+    `http` instrumentation. When calling `Transaction#insertDistributedTraceHeaders`,
+    or automatically via `http` instrumentation, the Node agent will include the W3C
+    headers along with the New Relic distributed tracing header, unless the New Relic
+    trace header format is disabled using `distributed_tracing.exclude_newrelic_header:true`.
+
+  * Added `TransactionHandle#acceptDistributedTraceHeaders` API for accepting both
+    New Relic and W3C TraceContext distributed traces.
+
+    Deprecated `TransactionHandle#acceptDistributedTracePayload` which will be removed
+    in a future major release.
+
+  * Added `TransactionHandle#insertDistributedTraceHeaders` API for adding outbound
+    distributed trace headers. Both W3C TraceContext and New Relic formats will be
+    included unless `distributed_tracing.exclude_newrelic_header: true`.
+
+    Deprecated `TransactionHandle#createDistributedTracePayload` which will be removed
+    in a future major release.
+
+  Known Issues and Workarounds
+
+  * If a .NET agent is initiating distributed traces as the root service, you must update
+    that .NET agent to version `8.24` or later before upgrading your downstream Node
+    New Relic agents to this agent release.
+
+* Pins Node 12 version to `v12.15` to avoid breakages with `v12.16.0` until cause(s)
+  resolved.
+
+* AWS Lambda Improvements
+
+  * Fixed issue where lambda invocation errors were not noticed in Node 10 or Node 12 environments.
+  * Added collection of additional AWS Lambda event source meta data.
+  * Added event type detection for lambda invocation events.
+  * Expanded ARN harvest to include ALB and CloudWatch.
+
+* Improved Transaction and Trace ID generation.
+
+* Updated publish-docs script to use `npm run` instead of `make`.
+
 ### 6.3.0 (2020-01-27):
 
 * Bumped `@newrelic/aws-sdk` to `v1.1.1` from `v1.0.0`.

package/README.md

@@ -741,3 +741,4 @@ license and the licenses of its dependencies.
 [5]: https://newrelic.com/application-monitoring/features
 [6]: https://github.com/newrelic/node-newrelic/blob/master/lib/config/default.js
 [7]: https://docs.newrelic.com/docs/agents/nodejs-agent/installation-configuration/nodejs-agent-configuration
+

package/api.js

@@ -125,7 +125,7 @@ API.prototype.getTransaction = function getTransaction() {
 
   transaction.handledExternally = true
 
-  return new TransactionHandle(transaction)
+  return new TransactionHandle(transaction, this.agent.metrics)
 }
 
 /**
@@ -163,7 +163,7 @@ API.prototype.getLinkingMetadata = function getLinkingMetadata(omitSupportabilit
   }
 
   if (config.distributed_tracing.enabled && segment) {
-    linkingMetadata['trace.id'] = segment.transaction.getTraceId()
+    linkingMetadata['trace.id'] = segment.transaction.traceId
     const spanId = segment.getSpanId()
     if (spanId) {
       linkingMetadata['span.id'] = spanId
@@ -340,6 +340,77 @@ API.prototype.addCustomAttributes = function addCustomAttributes(atts) {
   }
 }
 
+/**
+ * Add custom span attributes in an object to the current segment/span.
+ * 
+ * See documentation for newrelic.addCustomSpanAttribute for more information.
+ * 
+ * An example of setting a custom span attribute:
+ * 
+ *    newrelic.addCustomSpanAttribute({test: 'value', test2: 'value2'})
+ * 
+ * @param {object} [atts]
+ * @param {string} [atts.KEY] The name you want displayed in the RPM UI.API.
+ * @param {string} [atts.KEY.VALUE] The value you want displayed.  Must be serializable.
+ */
+API.prototype.addCustomSpanAttributes = function addCustomSpanAttributes(atts) {
+  const metric = this.agent.metrics.getOrCreateMetric(
+    NAMES.SUPPORTABILITY.API + '/addCustomSpanAttributes'
+  )
+  metric.incrementCallCount()
+
+  for (let key in atts) {
+    if (properties.hasOwn(atts, key)) {
+      this.addCustomSpanAttribute(key, atts[key])
+    }
+  }
+}
+
+/**
+ * Add a custom span attribute to the current transaction. Some attributes
+ * are reserved (see CUSTOM_DENYLIST for the current, very short list), and
+ * as with most API methods, this must be called in the context of an
+ * active segment/span. Most recently set value wins.
+ *
+ * @param {string} key  The key you want displayed in the RPM UI.
+ * @param {string} value The value you want displayed. Must be serializable.
+ */
+API.prototype.addCustomSpanAttribute = function addCustomSpanAttribute(key, value) {
+  const metric = this.agent.metrics.getOrCreateMetric(
+    NAMES.SUPPORTABILITY.API + '/addCustomSpanAttribute'
+  )
+  metric.incrementCallCount()
+
+  // If high security mode is on, custom attributes are disabled.
+  if (this.agent.config.high_security) {
+    logger.warnOnce(
+      'Custom span attributes',
+      'Custom span attributes are disabled by high security mode.'
+    )
+    return false
+  } else if (!this.agent.config.api.custom_attributes_enabled) {
+    logger.debug(
+      'Config.api.custom_attributes_enabled set to false, not collecting value'
+    )
+    return false
+  }
+
+  const segment = this.agent.tracer.getSegment()
+  
+  if (!segment) {
+    return logger.debug(
+      'Could not add attribute %s. No available span/segment.',
+      key
+    )
+  }
+
+  if (CUSTOM_DENYLIST.has(key)) {
+    return logger.warn('Not overwriting value of NR-only attribute %s.', key)
+  }
+
+  segment.addCustomSpanAttribute(key, value)
+}
+
 API.prototype.setIgnoreTransaction = util.deprecate(
   setIgnoreTransaction, [
     'API#setIgnoreTransaction is being deprecated!',
@@ -415,7 +486,6 @@ API.prototype.noticeError = function noticeError(error, customAttributes) {
   if (typeof error === 'string') {
     error = new Error(error)
   }
-  const transaction = this.agent.tracer.getTransaction()
 
   // Filter all object type valued attributes out
   let filteredAttributes = customAttributes
@@ -423,6 +493,7 @@ API.prototype.noticeError = function noticeError(error, customAttributes) {
     filteredAttributes = _filterAttributes(customAttributes, 'noticeError')
   }
 
+  const transaction = this.agent.tracer.getTransaction()
   this.agent.errors.addUserError(transaction, error, filteredAttributes)
 }
 
@@ -1397,7 +1468,7 @@ API.prototype.getTraceMetadata = function getTraceMetadata() {
   } else if (!this.agent.config.distributed_tracing.enabled) {
     logger.debug("Distributed tracing disabled when calling API#getTraceMetadata")
   } else {
-    metadata.traceId = segment.transaction.getTraceId()
+    metadata.traceId = segment.transaction.traceId
 
     const spanId = segment.getSpanId()
     if (spanId) {

package/bin/publish-docs.sh

@@ -5,7 +5,7 @@ PACKAGE_VERSION=$(node -e 'console.log(require("./package").version)')
 git checkout gh-pages
 git pull origin gh-pages
 git merge -
-make public-docs
+npm run public-docs
 git rm -r docs
 mv out docs
 git add docs

package/bin/travis-node.sh

@@ -33,7 +33,10 @@ if [ -z $NR_NODE_VERSION ]; then
     exit 1
 fi
 
-if [ $NR_NODE_VERSION -gt 11 ] && version_gt 2.17 $GLIBC_VERSION_CHECK;then
+version=$NR_NODE_VERSION
+major=${version/.*}
+echo $major
+if [ $major -gt 11 ] && version_gt 2.17 $GLIBC_VERSION_CHECK;then
   echo "Installing updated glibc\n"
   # can we get this from an actual repository?
   curl -LO 'http://launchpadlibrarian.net/130794928/libc6_2.17-0ubuntu4_amd64.deb'

package/index.js

@@ -43,10 +43,10 @@ function initialize() {
       preAgentTime
     )
 
-    // TODO: Update this check when Node v6 is deprecated.
-    if (psemver.satisfies('<6.0.0')) {
+    // TODO: Update this check when Node v8 is deprecated.
+    if (psemver.satisfies('<8.0.0')) {
       message = 'New Relic for Node.js requires a version of Node equal to or\n' +
-                'greater than 6.0.0. Not starting!'
+                'greater than 8.0.0. Not starting!'
 
       logger.error(message)
       throw new Error(message)

package/lib/aggregators/base-aggregator.js

@@ -88,7 +88,7 @@ class Aggregator extends EventEmitter {
   }
 
   send() {
-    logger.info(`${this.method} Aggregator data send.`)
+    logger.debug(`${this.method} Aggregator data send.`)
     this.emit(`starting ${this.method} data send.`)
 
     const data = this._getMergeData()

package/lib/attributes.js

@@ -6,6 +6,8 @@ const isValidType = require('./util/attribute-types')
 const byteUtils = require('./util/byte-limit')
 const properties = require('./util/properties')
 
+const MAXIMUM_CUSTOM_ATTRIBUTES = 64
+
 /**
  * @class
  * @private
@@ -23,6 +25,7 @@ class Attributes {
     this.filter = makeFilter(scope)
     this.limit = limit
     this.attributes = Object.create(null)
+    this.attributeCount = 0
   }
 
   /**
@@ -57,7 +60,6 @@ class Attributes {
    */
   get(dest) {
     const attrs = Object.create(null)
-    let attrCount = 0
     for (let key in this.attributes) { // eslint-disable-line guard-for-in
       const attr = this.attributes[key]
       if (!(attr.destinations & dest)) {
@@ -67,10 +69,6 @@ class Attributes {
       attrs[key] = typeof attr.value === 'string' && !attr.truncateExempt
         ? byteUtils.truncate(attr.value, 255)
         : attr.value
-
-      if (++attrCount >= this.limit) {
-        break
-      }
     }
 
     return attrs
@@ -103,6 +101,13 @@ class Attributes {
    * @param {boolean} [truncateExempt=false] - Flag marking value exempt from truncation
    */
   addAttribute(destinations, key, value, truncateExempt = false) {
+    if (this.attributeCount + 1 > this.limit) {
+      return logger.debug(
+        `Maximum number of custom attributes have been added.  
+        Dropping attribute ${key} with ${value} type.`
+      )
+    }
+
     if (!isValidType(value)) {
       return logger.debug(
         'Not adding attribute %s with %s value type. This is expected for undefined' +
@@ -123,6 +128,7 @@ class Attributes {
     // Only set the attribute if at least one destination passed
     const validDestinations = this.filter(destinations, key)
     if (validDestinations) {
+      this.attributeCount = this.attributeCount + 1
       this._set(validDestinations, key, value, truncateExempt)
     }
   }
@@ -159,4 +165,7 @@ function makeFilter(scope) {
   }
 }
 
-module.exports = Attributes
+module.exports = {
+  Attributes: Attributes,
+  MAXIMUM_CUSTOM_ATTRIBUTES: MAXIMUM_CUSTOM_ATTRIBUTES
+}

package/lib/config/default.js

@@ -851,7 +851,17 @@ exports.config = () => ({
      *
      * @env NEW_RELIC_DISTRIBUTED_TRACING_ENABLED
      */
-    enabled: false
+    enabled: false,
+
+    /**
+     * Exludes New Relic format distributed tracing header (`newrelic`) on
+     * outbound requests when set to `true`. By default (when false)
+     * both W3C TraceContext (`traceparent`, `tracecontext`) and
+     * New Relic formats will be sent.
+     *
+     * @env NEW_RELIC_DISTRIBUTED_TRACING_EXCLUDE_NEWRELIC_HEADER
+     */
+    exclude_newrelic_header: false
   },
 
   /**

package/lib/config/env.js

@@ -134,7 +134,8 @@ const ENV_MAPPING = {
     }
   },
   distributed_tracing: {
-    enabled: 'NEW_RELIC_DISTRIBUTED_TRACING_ENABLED'
+    enabled: 'NEW_RELIC_DISTRIBUTED_TRACING_ENABLED',
+    exclude_newrelic_header: 'NEW_RELIC_DISTRIBUTED_TRACING_EXCLUDE_NEWRELIC_HEADER'
   },
   message_tracer: {
     segment_parameters: {
@@ -215,6 +216,7 @@ const BOOLEAN_VARS = new Set([
   'NEW_RELIC_SPAN_EVENTS_ENABLED',
   'NEW_RELIC_SPAN_EVENTS_ATTRIBUTES_ENABLED',
   'NEW_RELIC_DISTRIBUTED_TRACING_ENABLED',
+  'NEW_RELIC_DISTRIBUTED_TRACING_EXCLUDE_NEWRELIC_HEADER',
   'NEW_RELIC_LOG_ENABLED',
   'NEW_RELIC_AUDIT_LOG_ENABLED',
   'NEW_RELIC_DATASTORE_DATABASE_NAME_REPORTING_ENABLED',

package/lib/config/hsm.js

@@ -51,7 +51,12 @@ const HIGH_SECURITY_SETTINGS = {
 const HIGH_SECURITY_KEYS = flatten.keys(HIGH_SECURITY_SETTINGS)
 
 // blank out these config values before sending to the collector
-const REDACT_BEFORE_SEND = new Set(['proxy_pass', 'proxy_user', 'proxy'])
+const REDACT_BEFORE_SEND = new Set([
+  'proxy_pass',
+  'proxy_user',
+  'proxy',
+  'certificates' // should be public but in case user mistake and also these are huge
+])
 
 // process.domain needs to be stripped befeore sending
 const REMOVE_BEFORE_SEND = new Set(['domain'])

package/lib/config/index.js

@@ -1152,15 +1152,15 @@ Config.prototype._loggingManuallySet = function _loggingManuallySet(inputConfig)
 /**
  * Returns true if native-metrics has been manually enabled via configuration
  * file or enveironment variable
- * 
+ *
  * @param {*} inputConfig configuration pass to the Config constructor
- * 
+ *
  * @returns {boolean}
  */
-Config.prototype._nativeMetricsManuallySet = 
+Config.prototype._nativeMetricsManuallySet =
   function _nativeMetricsManuallySet(inputConfig) {
-    const inputEnabled = inputConfig 
-      && inputConfig.plugins 
+    const inputEnabled = inputConfig
+      && inputConfig.plugins
       && inputConfig.plugins.native_metrics
       && inputConfig.plugins.native_metrics.enabled
     const envEnabled = process.env.NEW_RELIC_NATIVE_METRICS_ENABLED
@@ -1211,7 +1211,7 @@ Config.prototype._enforceServerless = function _enforceServerless(inputConfig) {
       )
     }
 
-    if (this._nativeMetricsManuallySet(inputConfig) && 
+    if (this._nativeMetricsManuallySet(inputConfig) &&
       this.plugins.native_metrics.enabled) {
       logger.info(
         'Enabling the native-metrics module when in serverless mode may greatly ' +
@@ -1458,8 +1458,12 @@ Config.prototype.applyLasp = function applyLasp(agent, policies) {
       }
       var valueName = splitConfigName[splitConfigName.length - 1]
       var localVal = settingBlock[valueName]
+
+      // Indexes into "allowed values" based on "enabled" setting
+      // to retreive proper mapping.
       var policyValues = localMapping.allowedValues
       var policyValue = policyValues[policy.enabled ? 1 : 0]
+
       // get the most secure setting between local config and the policy
       var finalValue = settingBlock[valueName] = config._getMostSecure(
         name,
@@ -1522,6 +1526,20 @@ Config.prototype.validateFlags = function validateFlags() {
   })
 }
 
+function redactValue(value) {
+  const REDACT_VALUE = '****'
+
+  let result = null
+  if (Array.isArray(value)) {
+    // Redact each value so we know if was configured and how many values
+    result = value.map(() => REDACT_VALUE)
+  } else {
+    result = REDACT_VALUE
+  }
+
+  return result
+}
+
 /**
  * Get a JSONifiable object containing all settings we want to report to the
  * collector and store in the environment_values table.
@@ -1532,9 +1550,10 @@ Config.prototype.publicSettings = function publicSettings() {
   var settings = Object.create(null)
 
   for (var key in this) {
-    if (this.hasOwnProperty(key)) {
+    if (this.hasOwnProperty(key) && !REMOVE_BEFORE_SEND.has(key)) {
       if (HSM.REDACT_BEFORE_SEND.has(key)) {
-        settings[key] = '****'
+        const value = this[key]
+        settings[key] = redactValue(value)
       } else if (!HSM.REMOVE_BEFORE_SEND.has(key)) {
         settings[key] = this[key]
       }
@@ -1695,6 +1714,8 @@ function createInstance(config) {
   return _configInstance
 }
 
+const REMOVE_BEFORE_SEND = new Set(['attributeFilter'])
+
 /**
  * Preserve the legacy initializer, but also allow consumers to manage their
  * own configuration if they choose.

package/lib/config/lasp.js

@@ -1,12 +1,25 @@
 'use strict'
 
+// TODO: would likely be easier to understand if the allowedValues mapping
+// just took the raw enabled/disabled and translated. This is not a hot path.
+
+/**
+ * path: Full nested path for the local configuration item.
+ * allowedValues:
+ *   Array of valid config values to map for incoming enabled/disabled.
+ *   policy.enabled: false uses index 0, policy.enabled: true uses index 1.
+ * filter: Allows for calculating most secure setting to use
+ * applyAdditionalSettings: Applies additional settings that are required
+ *   when the policy is disabled.
+ * clearData: Clears the relevant agent collection.
+ */
 const LASP_MAP = {
   // LASP key
   record_sql: {
     // full path to corresponding config key
     path: 'transaction_tracer.record_sql',
     // Mapping from policy enabled status to usable config value
-    // first element is policy is off, second is policy is on
+    // policy.enabled: false === off, policy.enabled: true === 'obfuscated'
     allowedValues: ['off', 'obfuscated'],
     // Tracks the precedent of settings controlled by LASP.
     filter: function mostSecureRecordSQL(first, second) {
@@ -45,6 +58,8 @@ const LASP_MAP = {
   // TODO: rename config key, because the names contradict each other's behavior
   allow_raw_exception_messages: {
     path: 'strip_exception_messages.enabled',
+    // if raw messages are allowed, then we should not strip them
+    // policy.enabled: false === true, policy.enabled: true === false
     allowedValues: [true, false],
     filter: function mostSecureStripException(first, second) {
       return first || second