WIP: feat(tracer): align C span code with v1-compatible stub API (v2 groundwork)

Cargo.toml

@@ -39,7 +39,8 @@ inherits = "release"
 # inheritance against this manifest when built as path dependencies. Keep this
 # list in sync with libdatadog's own `[workspace.dependencies]`; libdatadog
 # #2253 consolidated `anyhow`, `serde`, `tokio` and `tracing` to the workspace
-# level, so they are mirrored here too.
+# level, and later work moved the rest of libdatadog's shared deps there too, so
+# the full list is mirrored here.
 [workspace.dependencies]
 allocator-api2 = { version = "0.2.21", default-features = false }
 anyhow = { version = "1.0", default-features = false }

components-rs/agent_info.rs

@@ -10,7 +10,7 @@
 
 use crate::stats::apply_concentrator_config;
 use datadog_sidecar::service::agent_info::AgentInfoReader;
-use libdd_common_ffi::slice::CharSlice;
+use libdd_common_ffi::slice::{AsBytes, CharSlice};
 use libdd_data_pipeline::agent_info::schema::AgentInfoStruct;
 use std::ffi::c_char;
 use std::ffi::CString;
@@ -96,6 +96,30 @@ pub extern "C" fn ddog_agent_info_json_free(ptr: *mut c_char) {
     }
 }
 
+/// Returns whether the agent /info `endpoints` list advertises `endpoint` (e.g. `/v1.0/traces`);
+/// false when no info has been received yet ("unknown" == "not advertised").
+///
+/// # Safety
+/// `reader` must be a valid pointer to an `AgentInfoReader`.
+#[no_mangle]
+pub unsafe extern "C" fn ddog_agent_info_has_endpoint(
+    reader: &mut AgentInfoReader,
+    endpoint: CharSlice,
+) -> bool {
+    let (changed, info) = reader.read();
+    if let Some(info) = info {
+        if changed {
+            info_to_concentrator_config(info);
+        }
+        let endpoint = endpoint.as_bytes();
+        return info
+            .endpoints
+            .as_deref()
+            .map_or(false, |eps| eps.iter().any(|e| e.as_bytes() == endpoint));
+    }
+    false
+}
+
 /// Apply concentrator config changes from the agent /info SHM.
 ///
 /// Cheap no-op when the SHM has not changed (`changed == false`).  Only applies when

components-rs/common.h

@@ -437,6 +437,7 @@ typedef enum ddog_RemoteConfigProduct {
   DDOG_REMOTE_CONFIG_PRODUCT_FFE_FLAGS,
   DDOG_REMOTE_CONFIG_PRODUCT_LIVE_DEBUGGING,
   DDOG_REMOTE_CONFIG_PRODUCT_LIVE_DEBUGGING_SYMBOL_DB,
+  DDOG_REMOTE_CONFIG_PRODUCT_DEBUG,
 } ddog_RemoteConfigProduct;
 
 typedef enum ddog_SpanProbeTarget {
@@ -1352,6 +1353,24 @@ typedef struct ddog_SenderParameters {
   ddog_CharSlice url;
 } ddog_SenderParameters;
 
+/**
+ * Payload-level tracer metadata for the V1 msgpack encoder; mirrors `TracerMetadata`.
+ */
+typedef struct ddog_TracerMetadataV1 {
+  ddog_CharSlice hostname;
+  ddog_CharSlice env;
+  ddog_CharSlice app_version;
+  ddog_CharSlice runtime_id;
+  ddog_CharSlice service;
+  ddog_CharSlice tracer_version;
+  ddog_CharSlice language_name;
+  ddog_CharSlice language_version;
+  ddog_CharSlice language_interpreter;
+  ddog_CharSlice language_interpreter_vendor;
+  ddog_CharSlice git_commit_sha;
+  ddog_CharSlice process_tags;
+} ddog_TracerMetadataV1;
+
 typedef enum ddog_crasht_BuildIdType {
   DDOG_CRASHT_BUILD_ID_TYPE_GNU,
   DDOG_CRASHT_BUILD_ID_TYPE_GO,

components-rs/datadog.h

@@ -120,6 +120,15 @@ char *ddog_agent_info_as_json(struct ddog_AgentInfoReader *reader);
 
 void ddog_agent_info_json_free(char *ptr);
 
+/**
+ * Returns whether the agent /info `endpoints` list advertises `endpoint` (e.g. `/v1.0/traces`);
+ * false when no info has been received yet ("unknown" == "not advertised").
+ *
+ * # Safety
+ * `reader` must be a valid pointer to an `AgentInfoReader`.
+ */
+bool ddog_agent_info_has_endpoint(struct ddog_AgentInfoReader *reader, ddog_CharSlice endpoint);
+
 /**
  * Apply concentrator config changes from the agent /info SHM.
  *

components-rs/sidecar.h

@@ -307,6 +307,27 @@ ddog_MaybeError ddog_sidecar_send_trace_v04_bytes(struct ddog_SidecarTransport *
                                                   ddog_CharSlice data,
                                                   const struct ddog_TracerHeaderTags *tracer_header_tags);
 
+/**
+ * Sends a V1-encoded trace to the sidecar via shared memory. The sidecar decodes the V1
+ * `TracerPayload`, can inspect it, and re-encodes it as V1 msgpack on the way to the agent's
+ * `/v1.0/traces` endpoint.
+ */
+ddog_MaybeError ddog_sidecar_send_trace_v1_shm(struct ddog_SidecarTransport **transport,
+                                               const struct ddog_InstanceId *instance_id,
+                                               struct ddog_ShmHandle *shm_handle,
+                                               uintptr_t len,
+                                               const struct ddog_TracerHeaderTags *tracer_header_tags);
+
+/**
+ * Sends a V1-encoded trace as bytes to the sidecar. The sidecar decodes the V1 `TracerPayload`,
+ * can inspect it, and re-encodes it as V1 msgpack on the way to the agent's `/v1.0/traces`
+ * endpoint.
+ */
+ddog_MaybeError ddog_sidecar_send_trace_v1_bytes(struct ddog_SidecarTransport **transport,
+                                                 const struct ddog_InstanceId *instance_id,
+                                                 ddog_CharSlice data,
+                                                 const struct ddog_TracerHeaderTags *tracer_header_tags);
+
 ddog_MaybeError ddog_sidecar_send_debugger_data(struct ddog_SidecarTransport **transport,
                                                 const struct ddog_InstanceId *instance_id,
                                                 ddog_QueueId queue_id,
@@ -476,6 +497,14 @@ ddog_CharSlice ddog_get_agent_info_container_tags_hash(struct ddog_AgentInfoRead
 void ddog_send_traces_to_sidecar(ddog_TracesBytes *traces,
                                  struct ddog_SenderParameters *parameters);
 
+/**
+ * V1 counterpart of `ddog_send_traces_to_sidecar`: encodes `traces` as a V1 `TracerPayload`
+ * using `metadata`, then sends it to the sidecar for the agent's `/v1.0/traces` endpoint.
+ */
+void ddog_send_traces_to_sidecar_v1(ddog_TracesBytes *traces,
+                                    struct ddog_SenderParameters *parameters,
+                                    const struct ddog_TracerMetadataV1 *metadata);
+
 /**
  * Drops the agent info reader.
  */

metadata/supported-configurations.json

@@ -777,6 +777,13 @@
         "default": "8126"
       }
     ],
+    "DD_TRACE_AGENT_PROTOCOL_VERSION": [
+      {
+        "implementation": "A",
+        "type": "string",
+        "default": "0.4"
+      }
+    ],
     "DD_TRACE_AGENT_RETRIES": [
       {
         "implementation": "A",
@@ -2525,13 +2532,6 @@
         "default": "true"
       }
     ],
-    "DD_TRACE_WARN_LEGACY_DD_TRACE": [
-      {
-        "implementation": "A",
-        "type": "boolean",
-        "default": "true"
-      }
-    ],
     "DD_TRACE_WEBSOCKET_MESSAGES_ENABLED": [
       {
         "implementation": "A",

src/DDTrace/Integrations/CakePHP/CakePHPIntegration.php

@@ -18,14 +18,6 @@ class CakePHPIntegration extends Integration
     public static $setStatusCodeFn;
     public static $parseRouteFn;
 
-    /**
-     * {@inheritdoc}
-     */
-    public static function requiresExplicitTraceAnalyticsEnabling(): bool
-    {
-        return false;
-    }
-
     public static function init(): int
     {
         self::$setRootSpanInfoFn = static function () {
@@ -35,7 +27,6 @@ public static function init(): int
             }
 
             self::$appName = \ddtrace_config_app_name(CakePHPIntegration::NAME);
-            self::addTraceAnalyticsIfEnabled($rootSpan);
             $rootSpan->service = self::$appName;
             Integration::tagFrameworkServiceSource($rootSpan, CakePHPIntegration::NAME);
             if ('cli' === PHP_SAPI) {

src/DDTrace/Integrations/CodeIgniter/V2/CodeIgniterIntegration.php

@@ -39,7 +39,6 @@ public static function init($router = null): int
 
     public static function registerIntegration(\CI_Router $router, SpanData $rootSpan, $service)
     {
-        self::addTraceAnalyticsIfEnabled($rootSpan);
         $rootSpan->name = 'codeigniter.request';
         $rootSpan->service = $service;
         $rootSpan->type = Type::WEB_SERVLET;

src/DDTrace/Integrations/Curl/CurlIntegration.php

@@ -294,7 +294,6 @@ public static function setup_curl_span($span) {
         $span->type = Type::HTTP_CLIENT;
         $span->service = 'curl';
         Integration::handleInternalSpanServiceName($span, self::NAME);
-        self::addTraceAnalyticsIfEnabled($span);
         $span->meta[Tag::COMPONENT] = self::NAME;
         $span->meta[Tag::SPAN_KIND] = Tag::SPAN_KIND_VALUE_CLIENT;
     }

src/DDTrace/Integrations/Drupal/DrupalIntegration.php

@@ -20,14 +20,6 @@ class DrupalIntegration extends Integration
 {
     const NAME = 'drupal';
 
-    /**
-     * {@inheritdoc}
-     */
-    public static function requiresExplicitTraceAnalyticsEnabling(): bool
-    {
-        return false;
-    }
-
     public static function init(): int
     {
         ini_set('datadog.trace.spans_limit', max(1500, ini_get('datadog.trace.spans_limit')));
@@ -183,8 +175,6 @@ static function (HookData $fnHookData) use ($hook, $module, $functionName) {
             }
         );
 
-
-
         // View Metrics
         /*
         install_hook(

src/DDTrace/Integrations/ElasticSearch/V1/ElasticSearchIntegration.php

@@ -56,16 +56,16 @@ public static function init(): int
         self::traceClientMethod('existsScource');
         self::traceClientMethod('explain');
         self::traceClientMethod('fieldCaps');
-        self::traceClientMethod('get', true);
+        self::traceClientMethod('get');
         self::traceClientMethod('getScript');
         self::traceClientMethod('getScriptContext');
         self::traceClientMethod('getScriptLanguages');
         self::traceClientMethod('getSource');
         self::traceClientMethod('index');
-        self::traceClientMethod('knnSearch', true);
-        self::traceClientMethod('mget', true);
-        self::traceClientMethod('msearch', true);
-        self::traceClientMethod('msearchTemplate', true);
+        self::traceClientMethod('knnSearch');
+        self::traceClientMethod('mget');
+        self::traceClientMethod('msearch');
+        self::traceClientMethod('msearchTemplate');
         self::traceClientMethod('mtermvectors');
         self::traceClientMethod('openPointInTime');
         self::traceClientMethod('ping');
@@ -76,11 +76,11 @@ public static function init(): int
         self::traceClientMethod('renderSearchTemplate');
         self::traceClientMethod('scriptsPainlessExecute');
         self::traceClientMethod('scroll');
-        self::traceClientMethod('search', true);
-        self::traceClientMethod('searchMvt', true);
-        self::traceClientMethod('searchShards', true);
-        self::traceClientMethod('searchTemplate', true);
-        self::traceClientMethod('termsEnum', true);
+        self::traceClientMethod('search');
+        self::traceClientMethod('searchMvt');
+        self::traceClientMethod('searchShards');
+        self::traceClientMethod('searchTemplate');
+        self::traceClientMethod('termsEnum');
         self::traceClientMethod('termvectors');
         self::traceClientMethod('update');
         self::traceClientMethod('updateByQuery');
@@ -136,9 +136,8 @@ public static function init(): int
     }
     /**
      * @param string $name
-     * @param bool $isTraceAnalyticsCandidate
      */
-    public static function traceClientMethod($name, $isTraceAnalyticsCandidate = false)
+    public static function traceClientMethod($name)
     {
         $class = 'Elasticsearch\Client';
 
@@ -152,13 +151,9 @@ public static function traceClientMethod($name, $isTraceAnalyticsCandidate = fal
             $class,
             $name,
             [
-                'prehook' => static function (SpanData $span, $args) use ($name, $isTraceAnalyticsCandidate) {
+                'prehook' => static function (SpanData $span, $args) use ($name) {
                     $span->name = "Elasticsearch.Client.$name";
 
-                    if ($isTraceAnalyticsCandidate) {
-                        self::addTraceAnalyticsIfEnabled($span);
-                    }
-
                     $span->meta[Tag::SPAN_KIND] = 'client';
                     Integration::handleInternalSpanServiceName($span, self::NAME);
                     $span->type = Type::ELASTICSEARCH;

src/DDTrace/Integrations/ElasticSearch/V8/ElasticSearchIntegration.php

@@ -132,7 +132,6 @@ public static function traceClientMethod($name, $isTraceAnalyticsCandidate = fal
                     $span->name = "Elasticsearch.Client.$name";
 
                     if ($isTraceAnalyticsCandidate) {
-                        self::addTraceAnalyticsIfEnabled($span);
                         self::$logNextBody = true;
                     }