newrelic 6.3.0 → 6.5.0

package/lib/serverless/event-sources.json

@@ -0,0 +1,128 @@
+{
+    "alb": {
+        "attributes": {},
+        "name": "alb",
+        "required_keys": [
+            "httpMethod",
+            "requestContext.elb"
+        ]
+    },
+    "apiGateway": {
+        "attributes": {
+            "aws.lambda.eventSource.accountId": "requestContext.accountId",
+            "aws.lambda.eventSource.apiId": "requestContext.apiId",
+            "aws.lambda.eventSource.resourceId": "requestContext.resourceId",
+            "aws.lambda.eventSource.resourcePath": "requestContext.resourcePath",
+            "aws.lambda.eventSource.stage": "requestContext.stage"
+        },
+        "name": "apiGateway",
+        "required_keys": [
+            "headers",
+            "httpMethod",
+            "path",
+            "requestContext",
+            "resource"
+        ]
+    },
+    "cloudFront": {
+        "attributes": {},
+        "name": "cloudFront",
+        "required_keys": [
+            "Records[0].cf"
+        ]
+    },
+    "cloudWatchScheduled": {
+        "attributes": {
+            "aws.lambda.eventSource.account": "account",
+            "aws.lambda.eventSource.id": "id",
+            "aws.lambda.eventSource.region": "region",
+            "aws.lambda.eventSource.resource": "resources[0]",
+            "aws.lambda.eventSource.time": "time"
+        },
+        "name": "cloudWatch_scheduled",
+        "required_keys": [
+            "detail-type",
+            "source"
+        ]
+    },
+    "dynamoStreams": {
+        "attributes": {
+            "aws.lambda.eventSource.length": "Records.length"
+        },
+        "name": "dynamo_streams",
+        "required_keys": [
+            "Records[0].dynamodb"
+        ]
+    },
+    "firehose": {
+        "attributes": {
+            "aws.lambda.eventSource.length": "records.length",
+            "aws.lambda.eventSource.region": "region"
+        },
+        "name": "firehose",
+        "required_keys": [
+            "deliveryStreamArn",
+            "records[0].kinesisRecordMetadata"
+        ]
+    },
+    "kinesis": {
+        "attributes": {
+            "aws.lambda.eventSource.length": "Records.length",
+            "aws.lambda.eventSource.region": "Records[0].awsRegion"
+        },
+        "name": "kinesis",
+        "required_keys": [
+            "Records[0].kinesis"
+        ]
+    },
+    "s3": {
+        "attributes": {
+            "aws.lambda.eventSource.bucketName": "Records[0].s3.bucket.name",
+            "aws.lambda.eventSource.eventName": "Records[0].eventName",
+            "aws.lambda.eventSource.eventTime": "Records[0].eventTime",
+            "aws.lambda.eventSource.length": "Records.length",
+            "aws.lambda.eventSource.objectKey": "Records[0].s3.object.key",
+            "aws.lambda.eventSource.objectSequencer": "Records[0].s3.object.sequencer",
+            "aws.lambda.eventSource.objectSize": "Records[0].s3.object.size",
+            "aws.lambda.eventSource.region": "Records[0].awsRegion"
+        },
+        "name": "s3",
+        "required_keys": [
+            "Records[0].s3"
+        ]
+    },
+    "ses": {
+        "attributes": {
+            "aws.lambda.eventSource.date": "Records[0].ses.mail.commonHeaders.date",
+            "aws.lambda.eventSource.length": "Records.length",
+            "aws.lambda.eventSource.messageId": "Records[0].ses.mail.commonHeaders.messageId",
+            "aws.lambda.eventSource.returnPath": "Records[0].ses.mail.commonHeaders.returnPath"
+        },
+        "name": "ses",
+        "required_keys": [
+            "Records[0].ses"
+        ]
+    },
+    "sns": {
+        "attributes": {
+            "aws.lambda.eventSource.length": "Records.length",
+            "aws.lambda.eventSource.messageId": "Records[0].Sns.MessageId",
+            "aws.lambda.eventSource.timestamp": "Records[0].Sns.Timestamp",
+            "aws.lambda.eventSource.topicArn": "Records[0].Sns.TopicArn",
+            "aws.lambda.eventSource.type": "Records[0].Sns.Type"
+        },
+        "name": "sns",
+        "required_keys": [
+            "Records[0].Sns"
+        ]
+    },
+    "sqs": {
+        "attributes": {
+            "aws.lambda.eventSource.length": "Records.length"
+        },
+        "name": "sqs",
+        "required_keys": [
+            "Records[0].receiptHandle"
+        ]
+    }
+}

package/lib/shim/transaction-shim.js

@@ -6,12 +6,7 @@ const logger = require('../logger').child({component: 'TransactionShim'})
 const Shim = require('./shim')
 const Transaction = require('../transaction')
 const util = require('util')
-const TRACE_CONTEXT_PARENT_HEADER
-  = require('../transaction/tracecontext').TRACE_CONTEXT_PARENT_HEADER
-const TRACE_CONTEXT_STATE_HEADER
-  = require('../transaction/tracecontext').TRACE_CONTEXT_STATE_HEADER
 
-const DISTRIBUTED_TRACE_HEADER = 'newrelic'
 const HTTP_CAT_ID_HEADER = 'X-NewRelic-Id'
 const MQ_CAT_ID_HEADER = 'NewRelicID'
 const MATCH_CAT_ID_HEADER = new RegExp(
@@ -32,7 +27,6 @@ const MATCH_CAT_APP_DATA_HEADER = new RegExp(
 )
 
 const TRANSACTION_TYPES_SET = Transaction.TYPES_SET
-const TRANSPORT_TYPES_SET = Transaction.TRANSPORT_TYPES_SET
 
 /**
  * Constructs a transaction managing shim.
@@ -282,26 +276,11 @@ function handleCATHeaders(headers, segment, transportType) {
     this.logger.trace('Not adding CAT reply header, not in an active transaction.')
     return
   }
-  var tx = segment.transaction
 
-  // Ensure this is a valid transport type.
-  transportType = transportType || Transaction.TRANSPORT_TYPES.UNKNOWN
-  if (!TRANSPORT_TYPES_SET[transportType]) {
-    this.logger.debug('Unknown transport type: %j', transportType)
-    transportType = Transaction.TRANSPORT_TYPES.UNKNOWN
-  }
-  if (this.agent.config.feature_flag.dt_format_w3c) {
-    const traceparent = headers[TRACE_CONTEXT_PARENT_HEADER]
-    const tracestate = headers[TRACE_CONTEXT_STATE_HEADER]
+  const transaction = segment.transaction
 
-    if (traceparent && tracestate) {
-      tx.traceContext.acceptTraceContextPayload(traceparent, tracestate)
-    }
-  } else if (this.agent.config.distributed_tracing.enabled) {
-    const payload = headers[DISTRIBUTED_TRACE_HEADER]
-    if (payload) {
-      tx.acceptDistributedTracePayload(payload, transportType)
-    }
+  if (this.agent.config.distributed_tracing.enabled) {
+    transaction.acceptDistributedTraceHeaders(transportType, headers)
     return
   }
 
@@ -323,12 +302,12 @@ function handleCATHeaders(headers, segment, transportType) {
   }
 
   if (catId && transactionData) {
-    cat.handleCatHeaders(catId, transactionData, this.agent.config.encoding_key, tx)
-    if (tx.incomingCatId) {
+    cat.handleCatHeaders(catId, transactionData, this.agent.config.encoding_key, transaction)
+    if (transaction.incomingCatId) {
       this.logger.trace(
         'Got inbound CAT headers in transaction %s from %s',
-        tx.id,
-        tx.incomingCatId
+        transaction.id,
+        transaction.incomingCatId
       )
     }
   }
@@ -378,11 +357,9 @@ function insertCATRequestHeaders(headers, useAlternateHeaderNames) {
   }
 
   if (distributedTracingEnabled) {
-    const dtPayload = tx.createDistributedTracePayload().httpSafe()
-    if (dtPayload) {
-      headers[DISTRIBUTED_TRACE_HEADER] = dtPayload
-      this.logger.trace('Added Distributed Tracing headers for transaction %s', tx.id)
-    }
+    // TODO: Should probably honor SHIM_SYMBOLS.DISABLE_DT.
+    // TODO: Official testing and support.
+    tx.insertDistributedTraceHeaders(headers)
   } else {
     if (!this.agent.config.encoding_key) {
       this.logger.warn('Missing encoding key, not adding CAT headers!')

package/lib/spans/span-event-aggregator.js

@@ -53,7 +53,7 @@ class SpanEventAggregator extends EventAggregator {
    *
    * @return {bool} True if the segment was added, or false if it was discarded.
    */
-  addSegment(segment, parentId) {
+  addSegment(segment, parentId, isRoot) {
     // Check if the priority would be accepted before creating the event object.
     const tx = segment.transaction
 
@@ -63,7 +63,7 @@ class SpanEventAggregator extends EventAggregator {
 
       return false
     }
-    const span = SpanEvent.fromSegment(segment, parentId || null)
+    const span = SpanEvent.fromSegment(segment, parentId || null, isRoot)
     return this.add(span, tx.priority)
   }
 }

package/lib/spans/span-event.js

@@ -12,6 +12,7 @@ const CATEGORIES = {
   DATASTORE: 'datastore',
   GENERIC: 'generic'
 }
+
 const EMPTY_USER_ATTRS = Object.freeze(Object.create(null))
 
 /**
@@ -33,6 +34,8 @@ class SpanIntrinsics {
     this.duration = null
     this['nr.entryPoint'] = null
     this['span.kind'] = null
+    this.trustedParentId = null
+    this.tracingVendors = null
   }
 }
 
@@ -46,7 +49,8 @@ class SpanIntrinsics {
  * @class
  */
 class SpanEvent {
-  constructor(attributes) {
+  constructor(attributes, customAttributes) {
+    this.customAttributes = customAttributes
     this.attributes = attributes
     this.intrinsics = new SpanIntrinsics()
   }
@@ -74,21 +78,22 @@ class SpanEvent {
    *
    * @return {SpanEvent} The constructed event.
    */
-  static fromSegment(segment, parentId = null) {
+  static fromSegment(segment, parentId = null, isRoot = false) {
     const attributes = segment.attributes.get(DESTINATIONS.SPAN_EVENT)
+    const customAttributes = segment.customAttributes.get(DESTINATIONS.SPAN_EVENT)
 
     let span = null
     if (HttpSpanEvent.testSegment(segment)) {
-      span = new HttpSpanEvent(attributes)
+      span = new HttpSpanEvent(attributes, customAttributes)
     } else if (DatastoreSpanEvent.testSegment(segment)) {
-      span = new DatastoreSpanEvent(attributes)
+      span = new DatastoreSpanEvent(attributes, customAttributes)
     } else {
-      span = new SpanEvent(attributes)
+      span = new SpanEvent(attributes, customAttributes)
     }
 
     const tx = segment.transaction
 
-    span.intrinsics.traceId = tx.getTraceId()
+    span.intrinsics.traceId = tx.traceId
     span.intrinsics.guid = segment.id
     span.intrinsics.parentId = parentId
     span.intrinsics.transactionId = tx.id
@@ -96,6 +101,13 @@ class SpanEvent {
     span.intrinsics.priority = tx.priority
     span.intrinsics.name = segment.name
 
+    if (isRoot) {
+      span.intrinsics.trustedParentId = tx.traceContext.trustedParentId
+      if (tx.traceContext.tracingVendors) {
+        span.intrinsics.tracingVendors = tx.traceContext.tracingVendors
+      }
+    }
+
     // Only set this if it will be `true`. Must be `null` otherwise.
     if (tx.baseSegment === segment) {
       span.intrinsics['nr.entryPoint'] = true
@@ -111,11 +123,21 @@ class SpanEvent {
   toJSON() {
     return [
       _filterNulls(this.intrinsics),
-      EMPTY_USER_ATTRS,
+      this.customAttributes ?
+        _filterNulls(this.customAttributes) :
+        EMPTY_USER_ATTRS,
       _filterNulls(this.attributes)
     ]
   }
 
+  addCustomAttribute(key, value, truncateExempt = false) {
+    const {attributeFilter} = Config.getInstance()
+    const dest = attributeFilter.filterSegment(DESTINATIONS.SPAN_EVENT, key)
+    if (dest & DESTINATIONS.SPAN_EVENT) {
+      this.customAttributes[key] = truncateExempt ? value : _truncate(value)
+    }
+  }
+
   addAttribute(key, value, truncateExempt = false) {
     const {attributeFilter} = Config.getInstance()
     const dest = attributeFilter.filterSegment(DESTINATIONS.SPAN_EVENT, key)
@@ -132,8 +154,8 @@ class SpanEvent {
  * @class
  */
 class HttpSpanEvent extends SpanEvent {
-  constructor(attributes) {
-    super(attributes)
+  constructor(attributes, customAttributes) {
+    super(attributes, customAttributes)
 
     this.intrinsics.category = CATEGORIES.HTTP
     this.intrinsics.component = attributes.library || HTTP_LIBRARY
@@ -166,8 +188,8 @@ class HttpSpanEvent extends SpanEvent {
  * @class.
  */
 class DatastoreSpanEvent extends SpanEvent {
-  constructor(attributes) {
-    super(attributes)
+  constructor(attributes, customAttributes) {
+    super(attributes, customAttributes)
 
     this.intrinsics.category = CATEGORIES.DATASTORE
     this.intrinsics['span.kind'] = CLIENT_KIND

package/lib/transaction/handle.js

@@ -1,16 +1,21 @@
 'use strict'
-var logger = require('../logger').child({component: 'transactionHandle'})
-var DistributedTracePayloadStub = require('./dt-payload').Stub
 
-module.exports = class TransactionHandle {
+const util = require('util')
+const logger = require('../logger').child({component: 'transactionHandle'})
+const DistributedTracePayloadStub = require('./dt-payload').Stub
+
+const NAMES = require('../../lib/metrics/names')
+
+class TransactionHandle {
   /**
   * A light representation of a transaction instance, returned by calling
   * {@link API#getTransaction}.
   *
   * @constructor
   */
-  constructor(transaction) {
+  constructor(transaction, metrics) {
     this._transaction = transaction
+    this._metrics = metrics
   }
 
   /**
@@ -42,6 +47,29 @@ module.exports = class TransactionHandle {
     return this._transaction.isSampled()
   }
 
+  /**
+   * Parsing incoming headers for use in a distributed trace.
+   * W3C TraceContext format is preferred over the NewRelic DT format.
+   * NewRelic DT format will be used if no `traceparent` header is found.
+   * @param @param {string} [transportType='Unknown'] - The transport type that delivered the trace.
+   * @param {object} headers - Headers to search for supported formats. Keys must be lowercase.
+   */
+  acceptDistributedTraceHeaders(transportType, headers) {
+    incrementApiSupportMetric(this._metrics, 'acceptDistributedTraceHeaders')
+
+    return this._transaction.acceptDistributedTraceHeaders(transportType, headers)
+  }
+
+  /**
+   * Inserts distributed trace headers into the provided headers map.
+   * @param {Object} headers
+   */
+  insertDistributedTraceHeaders(headers) {
+    incrementApiSupportMetric(this._metrics, 'insertDistributedTraceHeaders')
+
+    return this._transaction.insertDistributedTraceHeaders(headers)
+  }
+
   /**
   *
   * Proxy method for Transaction#createDistrubtedTracePayload.
@@ -65,6 +93,39 @@ module.exports = class TransactionHandle {
   }
 }
 
+// TODO: Fully remove functions in future Major release. v7.0.0?
+TransactionHandle.prototype.acceptDistributedTracePayload = util.deprecate(
+  TransactionHandle.prototype.acceptDistributedTracePayload,
+  'TransactionHandle#acceptDistributedTracePayload has been deprecated! ' +
+  'Please use TransactionHandle#acceptDistributedTraceHeaders ' +
+  'which supports multiple distributed trace formats.'
+)
+
+TransactionHandle.prototype.createDistributedTracePayload = util.deprecate(
+  TransactionHandle.prototype.createDistributedTracePayload,
+  'TransactionHandle#createDistributedTracePayload has been deprecated! ' +
+  'Please use TransactionHandle#insertDistributedTraceHeaders ' +
+  'which supports multiple distributed trace formats.'
+)
+
+module.exports = TransactionHandle
+
+function incrementApiSupportMetric(metrics, functionName) {
+  if (!metrics) {
+    logger.warnOnce(
+      'Cannot add TransactionHandle API support metric. The metrics collection is missing.'
+    )
+    return
+  }
+
+  const metric = metrics.getOrCreateMetric(
+    NAMES.SUPPORTABILITY.TRANSACTION_API + '/' + functionName
+  )
+
+  metric.incrementCallCount()
+  return metric
+}
+
 module.exports.Stub = class TransactionHandleStub {
   end(callback) {
     if (callback instanceof Function) {
@@ -93,4 +154,12 @@ module.exports.Stub = class TransactionHandleStub {
       "No transaction found when calling Transaction.acceptDistributedTracePayload"
     )
   }
+
+  acceptDistributedTraceHeaders() {
+    logger.debug("No transaction found when calling Transaction.acceptDistributedTraceHeaders")
+  }
+
+  insertDistributedTraceHeaders() {
+    logger.debug("No transaction found when calling Transaction.insertDistributedTraceHeaders")
+  }
 }