chore: Added consumer attribute reconciliation (#2957)

Author: jsumners-nr

lib/otel/segments/consumer.js

@@ -14,30 +14,26 @@ module.exports = createConsumerSegment
 
 const Transaction = require('../../transaction/')
 const recorder = require('../../metrics/recorders/message-transaction')
-const { DESTINATIONS, TYPES } = Transaction
+const { TYPES } = Transaction
 
 const {
   ATTR_MESSAGING_DESTINATION,
   ATTR_MESSAGING_DESTINATION_KIND,
+  ATTR_MESSAGING_DESTINATION_NAME,
   ATTR_MESSAGING_SYSTEM
 } = require('../constants')
 
 function createConsumerSegment(agent, otelSpan) {
+  const attrs = otelSpan.attributes
   const transaction = new Transaction(agent)
   transaction.type = TYPES.MESSAGE
 
-  const system = otelSpan.attributes[ATTR_MESSAGING_SYSTEM] ?? 'unknown'
-  const destination = otelSpan.attributes[ATTR_MESSAGING_DESTINATION] ?? 'unknown'
-  const destKind = otelSpan.attributes[ATTR_MESSAGING_DESTINATION_KIND] ?? 'unknown'
+  const system = attrs[ATTR_MESSAGING_SYSTEM] ?? 'unknown'
+  // _NAME is the current preferred attribute with semantic conventions >=1.3.0.
+  const destination = attrs[ATTR_MESSAGING_DESTINATION_NAME] ?? attrs[ATTR_MESSAGING_DESTINATION] ?? 'unknown'
+  const destKind = attrs[ATTR_MESSAGING_DESTINATION_KIND] ?? 'unknown'
   const segmentName = `${system}/${destKind}/Named/${destination}`
 
-  const txAttrs = transaction.trace.attributes
-  txAttrs.addAttribute(DESTINATIONS.TRANS_SCOPE, 'message.queueName', destination)
-  // txAttrs.addAttribute(
-  //   DESTINATIONS.TRANS_SCOPE,
-  //   'host',
-  //
-  // )
   transaction.setPartialName(segmentName)
 
   const segment = agent.tracer.createSegment({

lib/otel/span-processor.js

@@ -17,6 +17,8 @@ const {
   ATTR_HTTP_ROUTE,
   ATTR_HTTP_STATUS_CODE,
   ATTR_HTTP_STATUS_TEXT,
+  ATTR_MESSAGING_DESTINATION,
+  ATTR_MESSAGING_DESTINATION_NAME,
   ATTR_MESSAGING_MESSAGE_CONVERSATION_ID,
   ATTR_MESSAGING_RABBITMQ_DESTINATION_ROUTING_KEY,
   ATTR_NET_PEER_NAME,
@@ -38,7 +40,7 @@ module.exports = class NrSpanProcessor {
 
   /**
    * Synthesize segment at start of span and assign to a symbol
-   * that will be removed in `onEnd` once the correspondig
+   * that will be removed in `onEnd` once the corresponding
    * segment is read.
    * @param {object} span otel span getting tested
    */
@@ -71,12 +73,72 @@ module.exports = class NrSpanProcessor {
       this.reconcileServerAttributes({ segment, span, transaction })
     } else if (span.kind === SpanKind.CLIENT && span.attributes[ATTR_DB_SYSTEM]) {
       this.reconcileDbAttributes({ segment, span })
+    } else if (span.kind === SpanKind.CONSUMER) {
+      this.reconcileConsumerAttributes({ segment, span, transaction })
     } else if (span.kind === SpanKind.PRODUCER) {
       this.reconcileProducerAttributes({ segment, span })
     }
     // TODO: add http external checks
   }
 
+  /**
+   * Detect messaging consumer attributes in the OTEL span and add them
+   * to the New Relic transaction. Note: this method ends the current
+   * transaction.
+   *
+   * @param {object} params
+   * @param {object} params.span The OTEL span entity that possibly contains
+   * desired attributes.
+   * @param {Transaction} params.transaction The NR transaction to attach
+   * the found attributes to.
+   */
+  reconcileConsumerAttributes({ span, transaction }) { // eslint-disable-line sonarjs/cognitive-complexity
+    const baseSegment = transaction.baseSegment
+    const trace = transaction.trace
+    const isHighSecurity = this.agent.config.high_security ?? false
+
+    for (const [key, value] of Object.entries(span.attributes)) {
+      switch (key) {
+        case ATTR_SERVER_ADDRESS: {
+          if (value) {
+            let serverAddress = value
+            if (urltils.isLocalhost(value)) {
+              serverAddress = this.agent.config.getHostnameSafe(value)
+            }
+            baseSegment.addAttribute('host', serverAddress)
+          }
+          break
+        }
+
+        case ATTR_SERVER_PORT: {
+          baseSegment.addAttribute('port', value)
+          break
+        }
+
+        case ATTR_MESSAGING_RABBITMQ_DESTINATION_ROUTING_KEY: {
+          if (isHighSecurity === true || !value) break
+          trace.attributes.addAttribute(DESTINATIONS.TRANS_COMMON, 'message.routingKey', value)
+          baseSegment.addAttribute('message.routingKey', value)
+          break
+        }
+
+        case ATTR_MESSAGING_DESTINATION_NAME:
+        case ATTR_MESSAGING_DESTINATION: {
+          if (isHighSecurity === true || !value) break
+          trace.attributes.addAttribute(DESTINATIONS.TRANS_COMMON, 'message.queueName', value)
+          baseSegment.addAttribute('message.queueName', value)
+          break
+        }
+
+        default: {
+          baseSegment.addAttribute(key, value)
+        }
+      }
+    }
+
+    transaction.end()
+  }
+
   reconcileServerAttributes({ segment, span, transaction }) {
     if (span.attributes[ATTR_RPC_SYSTEM]) {
       this.reconcileRpcAttributes({ segment, span, transaction })
@@ -86,7 +148,7 @@ module.exports = class NrSpanProcessor {
 
     // End the corresponding transaction for the entry point server span.
     // We do then when the span ends to ensure all data has been processed
-    // for the correspondig server span.
+    // for the corresponding server span.
     transaction.end()
   }
 

lib/spans/span-event.js

@@ -225,7 +225,7 @@ class HttpSpanEvent extends SpanEvent {
  * Span event class for datastore operations and queries.
  *
  * @private
- * @class.
+ * @class
  */
 class DatastoreSpanEvent extends SpanEvent {
   constructor(attributes, customAttributes) {

test/unit/lib/otel/consumer.test.js

@@ -18,7 +18,6 @@ const {
   ATTR_MESSAGING_SYSTEM,
 } = require('#agentlib/otel/constants.js')
 
-const { DESTINATIONS } = require('../../../../lib/transaction')
 const helper = require('../../../lib/agent_helper')
 const createSpan = require('./fixtures/span')
 const SegmentSynthesizer = require('../../../../lib/otel/segment-synthesis')
@@ -63,8 +62,4 @@ test('should create consumer segment from otel span', (t) => {
   assert.equal(transaction.name, expectedName)
   assert.equal(transaction.type, 'message')
   assert.equal(transaction.baseSegment, segment)
-  assert.equal(
-    transaction.trace.attributes.get(DESTINATIONS.TRANS_SCOPE)['message.queueName'],
-    'dest1'
-  )
 })

test/versioned/otel-bridge/span.test.js

@@ -13,6 +13,7 @@ const { hrTimeToMilliseconds } = require('@opentelemetry/core')
 const helper = require('../../lib/agent_helper')
 const { otelSynthesis } = require('../../../lib/symbols')
 
+const { DESTINATIONS } = require('../../../lib/transaction')
 const {
   ATTR_DB_NAME,
   ATTR_DB_STATEMENT,
@@ -26,6 +27,7 @@ const {
   ATTR_HTTP_URL,
   ATTR_MESSAGING_DESTINATION,
   ATTR_MESSAGING_DESTINATION_KIND,
+  ATTR_MESSAGING_DESTINATION_NAME,
   ATTR_MESSAGING_MESSAGE_CONVERSATION_ID,
   ATTR_MESSAGING_OPERATION,
   ATTR_MESSAGING_RABBITMQ_DESTINATION_ROUTING_KEY,
@@ -414,12 +416,15 @@ test('Otel producer span test', (t, end) => {
 
 test('messaging consumer metrics are bridged correctly', (t, end) => {
   const { agent, tracer } = t.nr
+  const expectedHost = agent.config.getHostnameSafe('localhost')
   const attributes = {
     [ATTR_MESSAGING_SYSTEM]: 'kafka',
     [ATTR_MESSAGING_OPERATION]: 'getMessage',
     [ATTR_SERVER_ADDRESS]: '127.0.0.1',
+    [ATTR_SERVER_PORT]: '1234',
     [ATTR_MESSAGING_DESTINATION]: 'work-queue',
-    [ATTR_MESSAGING_DESTINATION_KIND]: 'queue'
+    [ATTR_MESSAGING_DESTINATION_KIND]: 'queue',
+    [ATTR_MESSAGING_RABBITMQ_DESTINATION_ROUTING_KEY]: 'test-key'
   }
 
   tracer.startActiveSpan('consumer-test', { kind: otel.SpanKind.CONSUMER, attributes }, (span) => {
@@ -444,6 +449,44 @@ test('messaging consumer metrics are bridged correctly', (t, end) => {
       assert.equal(unscopedMetrics[expectedMetric].callCount, 1, `${expectedMetric}.callCount`)
     }
 
+    // Verify that required reconciled attributes are present:
+    let attrs = tx.baseSegment.getAttributes()
+    assert.equal(attrs.host, expectedHost)
+    assert.equal(attrs.port, '1234')
+    attrs = tx.trace.attributes.get(DESTINATIONS.TRANS_COMMON)
+    assert.equal(attrs['message.queueName'], 'work-queue')
+    assert.equal(attrs['message.routingKey'], 'test-key')
+
+    end()
+  })
+})
+
+test('messaging consumer skips high security attributes', (t, end) => {
+  const { agent, tracer } = t.nr
+  const expectedHost = agent.config.getHostnameSafe('localhost')
+  const attributes = {
+    [ATTR_MESSAGING_SYSTEM]: 'kafka',
+    [ATTR_MESSAGING_OPERATION]: 'getMessage',
+    [ATTR_SERVER_ADDRESS]: '127.0.0.1',
+    [ATTR_SERVER_PORT]: '1234',
+    [ATTR_MESSAGING_DESTINATION_KIND]: 'queue',
+    [ATTR_MESSAGING_DESTINATION_NAME]: 'test-queue',
+    [ATTR_MESSAGING_RABBITMQ_DESTINATION_ROUTING_KEY]: 'test-key'
+  }
+  agent.config.high_security = true
+
+  tracer.startActiveSpan('consumer-test', { kind: otel.SpanKind.CONSUMER, attributes }, (span) => {
+    const tx = agent.getTransaction()
+    span.end()
+
+    // Verify that required reconciled attributes are present:
+    let attrs = tx.baseSegment.getAttributes()
+    assert.equal(attrs.host, expectedHost)
+    assert.equal(attrs.port, '1234')
+    attrs = tx.trace.attributes.get(DESTINATIONS.TRANS_COMMON)
+    assert.equal(attrs['message.queueName'], undefined)
+    assert.equal(attrs['message.routingKey'], undefined)
+
     end()
   })
 })