dd-trace 6.12.0 → 6.14.0

package/packages/dd-trace/src/debugger/devtools_client/request-options.js

@@ -0,0 +1,33 @@
+'use strict'
+
+const { getHttpsProxyAgent } = require('../../evp_proxy/direct')
+
+/**
+ * @param {ReturnType<import('../config')>} config - Debugger configuration
+ * @param {string} path - Request path
+ * @param {Record<string, string>} headers - Payload headers
+ * @returns {{
+ *   method: 'POST',
+ *   url: string | URL,
+ *   path: string,
+ *   headers: Record<string, string>,
+ *   agent?: import('node:https').Agent
+ * }}
+ */
+module.exports = function getRequestOptions (config, path, headers) {
+  const options = {
+    method: 'POST',
+    url: config.url,
+    path,
+    headers,
+  }
+
+  if (config.agentless) {
+    if (config.apiKey !== undefined) headers['DD-API-KEY'] = config.apiKey
+    headers['DD-EVP-ORIGIN'] = 'agent-debugger'
+    const agent = getHttpsProxyAgent(config.url.href)
+    if (agent !== undefined) options.agent = agent
+  }
+
+  return options
+}

package/packages/dd-trace/src/debugger/devtools_client/send.js

@@ -5,12 +5,13 @@ const { stringify } = require('querystring')
 
 const { version } = require('../../../../../package.json')
 const request = require('../../exporters/common/request')
-const { GIT_COMMIT_SHA, GIT_REPOSITORY_URL } = require('../../plugins/util/tags')
 const { DEBUGGER_DIAGNOSTICS_V1, DEBUGGER_INPUT_V2 } = require('../constants')
 const log = require('./log')
 const JSONBuffer = require('./json-buffer')
 const config = require('./config')
+const getRequestOptions = require('./request-options')
 const { pruneSnapshot } = require('./snapshot-pruner')
+const buildTags = require('./tags')
 
 module.exports = send
 
@@ -22,14 +23,7 @@ const ddsource = 'dd_debugger'
 const hostname = getHostname()
 const service = config.service
 
-const ddtags = buildTags([
-  ['env', config.env],
-  ['version', config.version],
-  ['debugger_version', version],
-  ['host_name', hostname],
-  [GIT_COMMIT_SHA, config.commitSHA],
-  [GIT_REPOSITORY_URL, config.repositoryUrl],
-])
+const ddtags = buildTags(config, hostname, version, log)
 
 let path
 setInputPath(config.inputPath)
@@ -85,7 +79,7 @@ function send (message, logger, dd, snapshot, processTags) {
 function onFlush (payload) {
   log.debug('[debugger:devtools_client] Flushing probe payload buffer')
 
-  request(payload, buildRequestOpts(), (err, res, statusCode) => {
+  request(payload, buildRequestOptions(), (err, res, statusCode) => {
     if (!handleV2FallbackIfNeeded(statusCode, payload) && err) {
       log.error('[debugger:devtools_client] Error sending probe payload', err)
     }
@@ -108,7 +102,7 @@ function handleV2FallbackIfNeeded (statusCode, payload) {
 
   setInputPath(DEBUGGER_DIAGNOSTICS_V1)
 
-  request(payload, buildRequestOpts(), (err) => {
+  request(payload, buildRequestOptions(), (err) => {
     if (err) {
       log.error('[debugger:devtools_client] Error sending probe payload after fallback to %s',
         DEBUGGER_DIAGNOSTICS_V1,
@@ -119,13 +113,8 @@ function handleV2FallbackIfNeeded (statusCode, payload) {
   return true
 }
 
-function buildRequestOpts () {
-  return {
-    method: 'POST',
-    url: config.url,
-    path,
-    headers: { 'Content-Type': 'application/json; charset=utf-8' },
-  }
+function buildRequestOptions () {
+  return getRequestOptions(config, path, { 'Content-Type': 'application/json; charset=utf-8' })
 }
 
 /**
@@ -135,24 +124,3 @@ function setInputPath (newPath) {
   config.inputPath = newPath
   path = `${newPath}?${stringify({ ddtags })}`
 }
-
-/**
- * @param {Array<[string, unknown]>} tags - The tags to serialize.
- * @returns {string} The serialized tags.
- */
-function buildTags (tags) {
-  const serializedTags = []
-
-  for (const [key, rawValue] of tags) {
-    if (rawValue === undefined) continue
-
-    if (String(rawValue).includes(',')) {
-      log.warn('[debugger:devtools_client] Skipping invalid tag value for %s', key)
-      continue
-    }
-
-    serializedTags.push(`${key}:${rawValue}`)
-  }
-
-  return serializedTags.join(',')
-}

package/packages/dd-trace/src/debugger/devtools_client/status.js

@@ -1,5 +1,9 @@
 'use strict'
 
+const { hostname: getHostname } = require('node:os')
+const { stringify } = require('node:querystring')
+
+const { version } = require('../../../../../package.json')
 const TTLSet = require('../../../../../vendor/dist/ttl-set')
 const request = require('../../exporters/common/request')
 const FormData = require('../../exporters/common/form-data')
@@ -7,6 +11,8 @@ const { DEBUGGER_DIAGNOSTICS_V1 } = require('../constants')
 const config = require('./config')
 const JSONBuffer = require('./json-buffer')
 const log = require('./log')
+const getRequestOptions = require('./request-options')
+const buildTags = require('./tags')
 
 module.exports = {
   ackReceived,
@@ -18,6 +24,7 @@ module.exports = {
 const ddsource = 'dd_debugger'
 const service = config.service
 const runtimeId = config.runtimeId
+const ddtags = buildTags(config, getHostname(), version, log)
 
 const cache = new TTLSet(60 * 60 * 1000) // 1 hour
 
@@ -93,12 +100,10 @@ function onFlush (payload) {
     { filename: 'event.json', contentType: 'application/json; charset=utf-8' }
   )
 
-  const options = {
-    method: 'POST',
-    url: config.url,
-    path: DEBUGGER_DIAGNOSTICS_V1,
-    headers: form.getHeaders(),
-  }
+  const path = config.agentless
+    ? `${config.inputPath}?${stringify({ ddtags })}`
+    : DEBUGGER_DIAGNOSTICS_V1
+  const options = getRequestOptions(config, path, form.getHeaders())
 
   request(form, options, (err) => {
     if (err) log.error('[debugger:devtools_client] Error sending diagnostics payload', err)

package/packages/dd-trace/src/debugger/devtools_client/tags.js

@@ -0,0 +1,41 @@
+'use strict'
+
+const { GIT_COMMIT_SHA, GIT_REPOSITORY_URL } = require('../../plugins/util/tags')
+
+/**
+ * @param {ReturnType<import('../config')>} config - Debugger configuration
+ * @param {string} hostname - Host name
+ * @param {string} debuggerVersion - Debugger version
+ * @param {typeof import('./log')} log - Debugger logger
+ */
+module.exports = function buildTags (config, hostname, debuggerVersion, log) {
+  let tags = ''
+
+  if (isValidTag('env', config.env, log)) tags += `,env:${config.env}`
+  if (isValidTag('version', config.version, log)) tags += `,version:${config.version}`
+  if (isValidTag('debugger_version', debuggerVersion, log)) tags += `,debugger_version:${debuggerVersion}`
+  if (config.agentless && isValidTag('runtime_id', config.runtimeId, log)) tags += `,runtime_id:${config.runtimeId}`
+  if (isValidTag('host_name', hostname, log)) tags += `,host_name:${hostname}`
+  if (isValidTag(GIT_COMMIT_SHA, config.commitSHA, log)) tags += `,${GIT_COMMIT_SHA}:${config.commitSHA}`
+  if (isValidTag(GIT_REPOSITORY_URL, config.repositoryUrl, log)) {
+    tags += `,${GIT_REPOSITORY_URL}:${config.repositoryUrl}`
+  }
+
+  return tags.slice(1)
+}
+
+/**
+ * @param {string} key
+ * @param {string | number | undefined} value
+ * @param {typeof import('./log')} log
+ */
+function isValidTag (key, value, log) {
+  if (value === undefined) return false
+
+  if (String(value).includes(',')) {
+    log.warn('[debugger:devtools_client] Skipping invalid tag value for %s', key)
+    return false
+  }
+
+  return true
+}

package/packages/dd-trace/src/debugger/index.js

@@ -7,7 +7,12 @@ const { Worker, MessageChannel, threadId: parentThreadId } = require('worker_thr
 const log = require('../log')
 const { fetchAgentInfo } = require('../agent/info')
 const getDebuggerConfig = require('./config')
-const { DEBUGGER_DIAGNOSTICS_V1, DEBUGGER_INPUT_V2, INSPECT_SEGMENT_GLOBAL_PROPERTY } = require('./constants')
+const {
+  DEBUGGER_DIAGNOSTICS_V1,
+  DEBUGGER_INPUT_DIRECT,
+  DEBUGGER_INPUT_V2,
+  INSPECT_SEGMENT_GLOBAL_PROPERTY,
+} = require('./constants')
 const { installProbeSampler, uninstallProbeSampler } = require('./probe_sampler')
 
 /**
@@ -55,6 +60,10 @@ function isStarted () {
  */
 function start (config, rcInstance) {
   if (worker !== null) return
+  if (config.DD_AGENTLESS_ENABLED && getDebuggerConfig(config) === undefined) {
+    log.error('[debugger] Invalid DD_SITE for agentless Dynamic Instrumentation: %s', config.site)
+    return
+  }
 
   log.debug('[debugger] Starting Dynamic Instrumentation client...')
 
@@ -156,7 +165,12 @@ function start (config, rcInstance) {
  */
 function configure (config) {
   if (configChannel === null) return
-  configChannel.port2.postMessage(getDebuggerConfig(config, inputPath))
+  const debuggerConfig = getDebuggerConfig(config, inputPath)
+  if (debuggerConfig === undefined) {
+    log.error('[debugger] Invalid DD_SITE for agentless Dynamic Instrumentation: %s', config.site)
+    return
+  }
+  configChannel.port2.postMessage(debuggerConfig)
 }
 
 /**
@@ -201,7 +215,8 @@ function cleanup (error) {
   // Pass error for unexpected exits, or undefined for graceful shutdown
   if (rcAckCallbacks) {
     for (const ackId of rcAckCallbacks.keys()) {
-      rcAckCallbacks.get(ackId)(error)
+      const acknowledge = rcAckCallbacks.get(ackId)
+      acknowledge(error)
       rcAckCallbacks.delete(ackId)
     }
     rcAckCallbacks = null
@@ -215,6 +230,11 @@ function cleanup (error) {
  * @param {(endpointPath: string) => void} cb - Callback with the detected endpoint path
  */
 function detectDebuggerEndpoint (config, cb) {
+  if (config.DD_AGENTLESS_ENABLED) {
+    cb(DEBUGGER_INPUT_DIRECT)
+    return
+  }
+
   log.debug('[debugger] Detecting available debugger endpoints...')
 
   fetchAgentInfo(config.url, (err, agentInfo) => {