newrelic 6.1.0 → 6.2.0

package/NEWS.md

@@ -1,3 +1,25 @@
+### 6.2.0 (2019-11-25):
+
+* Upgraded `tap` to resolve `handlebars` audit warnings.
+
+* Added `getLinkingMetadata()` method to the API.
+
+  This new method can be used to retrieve the identifying information for the
+  agent and current active span and trace. Please consult [the documentation](https://docs.newrelic.com/docs/agents/nodejs-agent/api-guides/nodejs-agent-api#getLinkingMetadata)
+  for more information.
+
+* Added `getTraceMetadata()` to the agent API.
+
+  This new method can be used to retrieve the current active Distributed Tracing
+  span and trace ids. Please consult [the documentation](https://docs.newrelic.com/docs/agents/nodejs-agent/api-guides/nodejs-agent-api#getTraceMetadata)
+  for more information.
+
+* Added an `isSampled()` method to `Transaction` and `TransactionHandle`.
+
+  This new method can be used to retrieve the sampling decision made for a given
+  transaction. Please consult [the documentation](https://docs.newrelic.com/docs/agents/nodejs-agent/api-guides/nodejs-agent-api#transaction-handle-isSampled)
+  for more information.
+
 ### 6.1.0 (2019-11-05):
 
 * `@newrelic/native-metrics` module is defaulted to disabled in serverless mode.

package/api.js

@@ -128,6 +128,57 @@ API.prototype.getTransaction = function getTransaction() {
   return new TransactionHandle(transaction)
 }
 
+/**
+ * This method returns an object with the following keys/data:
+ * - `trace.id`: The current trace ID
+ * - `span.id`: The current span ID
+ * - `entity.name`: The application name specified in the connect request as
+ *   app_name. If multiple application names are specified this will only be
+ *   the first name
+ * - `entity.type`: The string "SERVICE"
+ * - `entity.guid`: The entity ID returned in the connect reply as entity_guid
+ * - `hostname`: The hostname as specified in the connect request as
+ *   utilization.full_hostname. If utilization.full_hostname is null or empty,
+ *   this will be the hostname specified in the connect request as host.
+ *
+ * @returns {LinkingMetadata} The linking object with the data above
+ */
+API.prototype.getLinkingMetadata = function getLinkingMetadata(omitSupportability) {
+  if (omitSupportability !== true) {
+    const metric = this.agent.metrics.getOrCreateMetric(
+      NAMES.SUPPORTABILITY.API + '/getLinkingMetadata'
+    )
+    metric.incrementCallCount()
+  }
+
+  const agent = this.agent
+
+  const segment = agent.tracer.getSegment()
+  const config = agent.config
+
+  const linkingMetadata = {
+    'entity.name': config.applications()[0],
+    'entity.type': 'SERVICE',
+    'hostname': config.getHostnameSafe()
+  }
+
+  if (config.distributed_tracing.enabled && segment) {
+    linkingMetadata['trace.id'] = segment.transaction.getTraceId()
+    const spanId = segment.getSpanId()
+    if (spanId) {
+      linkingMetadata['span.id'] = spanId
+    }
+  } else {
+    logger.debug('getLinkingMetadata with no active transaction')
+  }
+
+  if (config.entity_guid) {
+    linkingMetadata['entity.guid'] = config.entity_guid
+  }
+
+  return linkingMetadata
+}
+
 /**
  * Specify the `Dispatcher` and `Dispatcher Version` environment values.
  * A dispatcher is typically the service responsible for brokering
@@ -1327,6 +1378,36 @@ function instrumentMessages(moduleName, onRequire, onError) {
   shimmer.registerInstrumentation(opts)
 }
 
+/**
+ * Returns the current trace and span id.
+ *
+ * @returns {*} The object containing the current trace and span ids
+ */
+API.prototype.getTraceMetadata = function getTraceMetadata() {
+  var metric = this.agent.metrics.getOrCreateMetric(
+    NAMES.SUPPORTABILITY.API + '/getTraceMetadata'
+  )
+  metric.incrementCallCount()
+
+  const metadata = {}
+
+  const segment = this.agent.tracer.getSegment()
+  if (!segment) {
+    logger.debug("No transaction found when calling API#getTraceMetadata")
+  } else if (!this.agent.config.distributed_tracing.enabled) {
+    logger.debug("Distributed tracing disabled when calling API#getTraceMetadata")
+  } else {
+    metadata.traceId = segment.transaction.getTraceId()
+
+    const spanId = segment.getSpanId()
+    if (spanId) {
+      metadata.spanId = spanId
+    }
+  }
+
+  return metadata
+}
+
 /**
  * Shuts down the agent.
  *

package/lib/config/index.js

@@ -138,6 +138,8 @@ function Config(config) {
   // this value is arbitrary
   this.max_trace_segments = 900
 
+  this.entity_guid = null
+
   // feature level of this account
   this.product_level = 0
   // product-level related
@@ -547,6 +549,11 @@ Config.prototype._fromServer = function _fromServer(params, key) {
       )
       break
 
+    // Entity GUID
+    case 'entity_guid':
+      this.entity_guid = params[key]
+      break
+
     // These settings aren't supported by the agent (yet).
     case 'sampling_rate':
     case 'episodes_file':

package/lib/spans/span-event.js

@@ -88,7 +88,7 @@ class SpanEvent {
 
     const tx = segment.transaction
 
-    span.intrinsics.traceId = tx.traceId || tx.id
+    span.intrinsics.traceId = tx.getTraceId()
     span.intrinsics.guid = segment.id
     span.intrinsics.parentId = parentId
     span.intrinsics.transactionId = tx.id

package/lib/transaction/handle.js

@@ -35,6 +35,13 @@ module.exports = class TransactionHandle {
     this._transaction.setForceIgnore(true)
   }
 
+  /**
+  * Return whether this Transaction is being sampled
+  */
+  isSampled() {
+    return this._transaction.isSampled()
+  }
+
   /**
   *
   * Proxy method for Transaction#createDistrubtedTracePayload.
@@ -70,6 +77,10 @@ module.exports.Stub = class TransactionHandleStub {
     logger.debug("No transaction found when calling Transaction.ignore")
   }
 
+  isSampled() {
+    logger.debug("No transaction found when calling Transaction.isSampled")
+  }
+
   createDistributedTracePayload() {
     logger.debug(
       "No transaction found when calling Transaction.createDistributedTracePayload"

package/lib/transaction/index.js

@@ -971,7 +971,7 @@ function createDistributedTracePayload() {
     ac: accountId,
     ap: appId,
     tx: this.id,
-    tr: this.traceId || this.id,
+    tr: this.getTraceId(),
     pr: this.priority,
     sa: this.sampled,
     ti: Date.now()
@@ -999,7 +999,7 @@ function addDistributedTraceIntrinsics(attrs) {
   this._calculatePriority()
 
   // *always* add these if DT flag is enabled.
-  attrs.traceId = this.traceId || this.id
+  attrs.traceId = this.getTraceId()
   attrs.guid = this.id
   attrs.priority = this.priority
 
@@ -1027,6 +1027,11 @@ function addDistributedTraceIntrinsics(attrs) {
   }
 }
 
+Transaction.prototype.isSampled = function isSampled() {
+  this._calculatePriority()
+  return this.sampled
+}
+
 /**
  * Generates a priority for the transaction if it does not have one already.
  */
@@ -1073,4 +1078,11 @@ function addRequestParameters(requestParameters) {
   }
 }
 
+/**
+ * Gets the current distributed trace traceId
+ */
+Transaction.prototype.getTraceId = function getTraceId() {
+  return this.traceId || this.id
+}
+
 module.exports = Transaction

package/lib/transaction/trace/segment.js

@@ -90,6 +90,16 @@ TraceSegment.prototype.getAttributes = function getAttributes() {
   return this.attributes.get(DESTINATIONS.TRANS_SEGMENT)
 }
 
+TraceSegment.prototype.getSpanId = function getSpanId() {
+  const conf = this.transaction.agent.config
+  const enabled = conf.span_events.enabled && conf.distributed_tracing.enabled
+  if (enabled) {
+    return this.id
+  }
+
+  return null
+}
+
 /**
  * @param {string} host
  *  The name of the host of the database. This will be normalized if the string

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "newrelic",
-  "version": "6.1.0",
+  "version": "6.2.0",
   "author": "New Relic Node.js agent team <nodejs@newrelic.com>",
   "license": "SEE LICENSE IN LICENSE",
   "contributors": [
@@ -173,7 +173,7 @@
     "rimraf": "^2.6.3",
     "should": "*",
     "sinon": "^4.5.0",
-    "tap": "^14.6.9",
+    "tap": "^14.10.1",
     "temp": "^0.8.1",
     "through": "^2.3.6",
     "when": "*"

package/stub_api.js

@@ -36,6 +36,7 @@ Stub.prototype.getTransaction = getTransaction
 Stub.prototype.getBrowserTimingHeader = getBrowserTimingHeader
 Stub.prototype.shutdown = shutdown
 Stub.prototype.setLambdaHandler = setLambdaHandler
+Stub.prototype.getTraceMetadata = getTraceMetadata
 
 // This code gets injected into HTML templates
 // and we don't want it to return undefined/null.
@@ -61,6 +62,13 @@ function startSegment(name, record, handler, callback) {
   return null
 }
 
+function getTraceMetadata() {
+  return {
+    traceId: '',
+    spanId: ''
+  }
+}
+
 function startWebTransaction(url, callback) {
   logger.debug('Not calling startWebTransaction because New Relic is disabled.')
   if (typeof callback === 'function') {