dd-trace/packages/dd-trace/src/plugins/outbound.js

Datadog APM tracing client for JavaScript

'use strict'

const {
  CLIENT_PORT_KEY,
  PEER_SERVICE_KEY,
  PEER_SERVICE_SOURCE_KEY,
  PEER_SERVICE_REMAP_KEY,
} = require('../constants')
const { exitTags } = require('../../../datadog-code-origin')
const { storage } = require('../../../datadog-core')
const { IS_SERVERLESS } = require('../serverless')
const TracingPlugin = require('./tracing')

const COMMON_PEER_SVC_SOURCE_TAGS = [
  'net.peer.name',
  'out.host',
]

// TODO: Exit span on finish when AsyncResource instances are removed.
class OutboundPlugin extends TracingPlugin {
  /**
   *
   * @type {string[]}
   */
  static peerServicePrecursors = []

  constructor (...args) {
    super(...args)

    this.addTraceSub('connect', ctx => {
      this.connect(ctx)
    })
  }

  /**
   * @param {{ parentStore?: { span: import('../../../..').Span } }} ctx
   */
  bindFinish (ctx) {
    return ctx.parentStore
  }

  startSpan (name, options, enterOrCtx) {
    const span = super.startSpan(name, options, enterOrCtx)
    if (
      this._tracerConfig.codeOriginForSpans.enabled &&
      this._tracerConfig.codeOriginForSpans.experimental.exit_spans.enabled
    ) {
      span.addTags(exitTags(this.startSpan))
    }
    return span
  }

  /**
   * @param {Record<string, string>} tags
   */
  getPeerService (tags) {
    /**
     * Compute `peer.service` and associated metadata from available tags, based
     * on defined precursor tags names.
     *
     * - The `peer.service` tag is set from the first precursor available (based on list ordering)
     * - The `_dd.peer.service.source` tag is set from the precursor's name
     * - If `peer.service` was defined _before_ we compute it (for example in custom instrumentation),
     *   `_dd.peer.service.source`'s value is `peer.service`
     */
    if (tags[PEER_SERVICE_KEY] !== undefined) {
      return {
        [PEER_SERVICE_KEY]: tags[PEER_SERVICE_KEY],
        [PEER_SERVICE_SOURCE_KEY]: PEER_SERVICE_KEY,
      }
    }

    const sourceTags = [
      ...this.constructor.peerServicePrecursors,
      ...COMMON_PEER_SVC_SOURCE_TAGS,
    ]

    for (const sourceTag of sourceTags) {
      if (tags[sourceTag]) {
        return {
          [PEER_SERVICE_KEY]: tags[sourceTag],
          [PEER_SERVICE_SOURCE_KEY]: sourceTag,
        }
      }
    }
  }

  /**
   * @param {Record<string, string>} peerData
   */
  getPeerServiceRemap (peerData) {
    /**
     * If DD_TRACE_PEER_SERVICE_MAPPING is matched, we need to override the existing
     * peer service and add the value we overrode.
     */
    const peerService = peerData[PEER_SERVICE_KEY]
    const mappedService = this._tracerConfig.peerServiceMapping?.[peerService]
    if (peerService && mappedService) {
      return {
        ...peerData,
        [PEER_SERVICE_KEY]: mappedService,
        [PEER_SERVICE_REMAP_KEY]: peerService,
      }
    }
    return peerData
  }

  /**
   * @param {{ currentStore?: { span: import('../../../..').Span } }} ctx
   */
  finish (ctx) {
    const span = ctx?.currentStore?.span || this.activeSpan
    this.tagPeerService(span)

    if (IS_SERVERLESS) {
      const peerHostname = storage('peerServerless').getStore()?.peerHostname
      if (peerHostname) span.setTag('peer.service', peerHostname)
    }

    super.finish(...arguments)
  }

  /**
   * @param {import('../../../..').Span} span
   */
  tagPeerService (span) {
    if (this._tracerConfig.spanComputePeerService) {
      const peerData = this.getPeerService(span.context()._tags)
      if (peerData !== undefined) {
        span.addTags(this.getPeerServiceRemap(peerData))
      }
    }
  }

  /**
   * @param {object} ctx
   */
  connect (ctx) {
    this.addHost(ctx)
  }

  /**
   * @param {{ hostname: string, port: number, currentStore?: { span: import('../../../..').Span } }} ctx
   */
  addHost (ctx) {
    const { hostname, port } = ctx

    const span = ctx?.currentStore?.span || this.activeSpan

    if (!span) return

    span.addTags({
      'out.host': hostname,
      [CLIENT_PORT_KEY]: port,
    })
  }
}

module.exports = OutboundPlugin