feat(tracing): add DD_TRACE_PROPAGATION_BEHAVIOR_EXTRACT

.gitlab/generate-package.php

@@ -1547,7 +1547,8 @@
   rules:
     - if: $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH
       when: never
-    - when: on_success
+    - when: always
+  allow_failure: true
   variables:
     GIT_STRATEGY: none
   script:
@@ -1567,7 +1568,7 @@
   rules:
     - if: $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH
       when: never
-    - when: on_success
+    - when: always
   needs:
     - job: "publish docker image for system tests (token)"
       artifacts: true
@@ -1579,8 +1580,7 @@
       artifacts: true
   variables:
     GIT_STRATEGY: none
-  allow_failure:
-    exit_codes: 3
+  allow_failure: true
   script: |
     set -e
     IMAGE="ghcr.io/datadog/dd-trace-php/dd-library-php:${CI_COMMIT_REF_SLUG}"

metadata/supported-configurations.json

@@ -1995,6 +1995,13 @@
         "default": "false"
       }
     ],
+    "DD_TRACE_PROPAGATION_BEHAVIOR_EXTRACT": [
+      {
+        "implementation": "B",
+        "type": "string",
+        "default": "continue"
+      }
+    ],
     "DD_TRACE_PROPAGATION_STYLE": [
       {
         "implementation": "D",

src/DDTrace/OpenTelemetry/SpanBuilder.php

@@ -184,8 +184,13 @@ public function startSpan(): SpanInterface
         $parentSpan = Span::fromContext($parentContext);
         $parentSpanContext = $parentSpan->getContext();
 
-        $span = $parentSpanContext->isValid() ? null : \DDTrace\start_trace_span($this->startEpochNanos);
-        $traceId = $parentSpanContext->isValid() ? $parentSpanContext->getTraceId() : \DDTrace\root_span()->traceId;
+        $behaviorExtract = \dd_trace_env_config('DD_TRACE_PROPAGATION_BEHAVIOR_EXTRACT');
+        $restartOrIgnore = $parentSpanContext->isValid() && ($behaviorExtract === 1 || $behaviorExtract === 2);
+
+        $span = ($parentSpanContext->isValid() && !$restartOrIgnore) ? null : \DDTrace\start_trace_span($this->startEpochNanos);
+        $traceId = ($parentSpanContext->isValid() && !$restartOrIgnore)
+            ? $parentSpanContext->getTraceId()
+            : \DDTrace\root_span()->traceId;
 
         $samplingResult = $this
             ->tracerSharedState
@@ -205,7 +210,7 @@ public function startSpan(): SpanInterface
         $sampled = SamplingResult::RECORD_AND_SAMPLE === $samplingDecision;
         $samplingResultTraceState = $samplingResult->getTraceState();
 
-        if ($parentSpanContext->isValid()) {
+        if ($parentSpanContext->isValid() && !$restartOrIgnore) {
             // Traceparent: {2:version}-{32:hex trace id}-{16:hex parent id}-{2:trace_flags}, version always being '00'
             // Since parentSpanContext is valid, the trace identifiers are guaranteed to be in hexadecimal format
             $parentId = $parentSpanContext->getSpanId();
@@ -215,6 +220,14 @@ public function startSpan(): SpanInterface
                 'traceparent' => $traceParent,
                 'tracestate' => (string) $samplingResultTraceState, // __toString() is implemented in TraceState
             ]);
+        } elseif ($parentSpanContext->isValid() && $behaviorExtract === 1) {
+            // RESTART: pass upstream W3C context so C code creates a span link and starts fresh trace
+            $parentId = $parentSpanContext->getSpanId();
+            $traceParent = "00-{$parentSpanContext->getTraceId()}-$parentId-01";
+            \DDTrace\consume_distributed_tracing_headers([
+                'traceparent' => $traceParent,
+                'tracestate' => (string) $samplingResultTraceState,
+            ]);
         } elseif ($samplingResultTraceState) {
             $samplingResultTraceState = $samplingResultTraceState->without('dd');
             \DDTrace\root_span()->tracestate = (string) $samplingResultTraceState;
@@ -234,10 +247,13 @@ public function startSpan(): SpanInterface
             $this->attributes[$key] = $value;
         }
 
-        $parentSpanContextBaggage = $parentContext->get(ContextKeys::baggage());
-        if ($parentSpanContextBaggage) {
-            foreach($parentSpanContextBaggage->getAll() as $baggageKey => $baggageEntry) {
-                $span->baggage[$baggageKey] = $baggageEntry->getValue();
+        if ($behaviorExtract !== 2) {
+            // `restart` or `continue` : propagate baggage
+            $parentSpanContextBaggage = $parentContext->get(ContextKeys::baggage());
+            if ($parentSpanContextBaggage) {
+                foreach ($parentSpanContextBaggage->getAll() as $baggageKey => $baggageEntry) {
+                    $span->baggage[$baggageKey] = $baggageEntry->getValue();
+                }
             }
         }
 
@@ -249,7 +265,7 @@ public function startSpan(): SpanInterface
             $parentSpan,
             $parentContext,
             $this->tracerSharedState->getSpanProcessor(),
-            $parentSpanContext->isValid() ? ResourceInfoFactory::emptyResource() : $this->tracerSharedState->getResource(),
+            ($parentSpanContext->isValid() && !$restartOrIgnore) ? ResourceInfoFactory::emptyResource() : $this->tracerSharedState->getResource(),
             $this->attributes,
             $this->links,
             $this->totalNumberOfLinksAdded,

tests/OpenTelemetry/Integration/InteroperabilityTest.php

@@ -609,6 +609,76 @@ public function testMixingMultipleTraces()
         ], true, false);
     }
 
+    public function testW3CInteroperabilityWithPropagationBehaviorRestart()
+    {
+        self::putEnvAndReloadConfig(['DD_TRACE_PROPAGATION_BEHAVIOR_EXTRACT=restart']);
+        try {
+            $this->isolateTracer(function () {
+                $tracer = self::getTracer();
+                $propagator = TraceContextPropagator::getInstance();
+
+                $carrier = [
+                    TraceContextPropagator::TRACEPARENT => '00-ff0000000000051791e0000000000041-ff00051791e00041-01',
+                ];
+
+                $context = $propagator->extract($carrier);
+
+                $OTelRootSpan = $tracer->spanBuilder("otel.root.span")
+                    ->setParent($context)
+                    ->startSpan();
+
+                $root = \DDTrace\root_span();
+
+                // Fresh trace: different from upstream trace ID
+                $this->assertNotSame('ff0000000000051791e0000000000041', $root->traceId);
+
+                // Span link capturing the upstream context
+                $this->assertCount(1, $root->links);
+                $link = $root->links[0];
+                $this->assertSame('ff0000000000051791e0000000000041', $link->traceId);
+                $this->assertSame('ff00051791e00041', $link->spanId);
+                $this->assertSame('propagation_behavior_extract', $link->attributes['reason'] ?? null);
+
+                $OTelRootSpan->end();
+            });
+        } finally {
+            self::putEnvAndReloadConfig(['DD_TRACE_PROPAGATION_BEHAVIOR_EXTRACT=continue']);
+        }
+    }
+
+    public function testW3CInteroperabilityWithPropagationBehaviorIgnore()
+    {
+        self::putEnvAndReloadConfig(['DD_TRACE_PROPAGATION_BEHAVIOR_EXTRACT=ignore']);
+        try {
+            $this->isolateTracer(function () {
+                $tracer = self::getTracer();
+                $propagator = TraceContextPropagator::getInstance();
+
+                $carrier = [
+                    TraceContextPropagator::TRACEPARENT => '00-ff0000000000051791e0000000000041-ff00051791e00041-01',
+                ];
+
+                $context = $propagator->extract($carrier);
+
+                $OTelRootSpan = $tracer->spanBuilder("otel.root.span")
+                    ->setParent($context)
+                    ->startSpan();
+
+                $root = \DDTrace\root_span();
+
+                // Fresh trace: no parent ID
+                $this->assertSame(0, $root->parentId ?? 0);
+
+                // No span links
+                $this->assertCount(0, $root->links);
+
+                $OTelRootSpan->end();
+            });
+        } finally {
+            self::putEnvAndReloadConfig(['DD_TRACE_PROPAGATION_BEHAVIOR_EXTRACT=continue']);
+        }
+    }
+
     public function testW3CInteroperability()
     {
         $traces = $this->isolateTracer(function () {

tests/ext/distributed_tracing/propagation_behavior_extract_config_invalid_fallback.phpt

@@ -0,0 +1,23 @@
+--TEST--
+DD_TRACE_PROPAGATION_BEHAVIOR_EXTRACT: invalid value falls back to continue
+--ENV--
+DD_TRACE_GENERATE_ROOT_SPAN=0
+DD_TRACE_PROPAGATION_BEHAVIOR_EXTRACT=invalid_value
+--FILE--
+<?php
+
+DDTrace\consume_distributed_tracing_headers([
+    "x-datadog-trace-id" => 42,
+    "x-datadog-parent-id" => 10,
+]);
+
+$span = DDTrace\start_span();
+$root = DDTrace\root_span();
+
+// invalid value falls back to default (continue): inherits upstream trace id
+echo "same_as_upstream: " . ($root->traceId === "0000000000000000000000000000002a" ? "yes" : "no") . "\n";
+
+DDTrace\close_span();
+?>
+--EXPECT--
+same_as_upstream: yes

tests/ext/distributed_tracing/propagation_behavior_extract_config_mixedcase_ignore.phpt

@@ -0,0 +1,24 @@
+--TEST--
+DD_TRACE_PROPAGATION_BEHAVIOR_EXTRACT: Ignore (mixed case) is accepted
+--ENV--
+DD_TRACE_GENERATE_ROOT_SPAN=0
+DD_TRACE_PROPAGATION_BEHAVIOR_EXTRACT=Ignore
+--FILE--
+<?php
+
+DDTrace\consume_distributed_tracing_headers([
+    "x-datadog-trace-id" => 42,
+    "x-datadog-parent-id" => 10,
+]);
+
+$span = DDTrace\start_span();
+$root = DDTrace\root_span();
+
+echo "same_as_upstream: " . ($root->traceId === "0000000000000000000000000000002a" ? "yes" : "no") . "\n";
+echo "links_count: " . count($root->links) . "\n";
+
+DDTrace\close_span();
+?>
+--EXPECT--
+same_as_upstream: no
+links_count: 0

tests/ext/distributed_tracing/propagation_behavior_extract_config_uppercase_continue.phpt

@@ -0,0 +1,22 @@
+--TEST--
+DD_TRACE_PROPAGATION_BEHAVIOR_EXTRACT: CONTINUE (uppercase) is accepted
+--ENV--
+DD_TRACE_GENERATE_ROOT_SPAN=0
+DD_TRACE_PROPAGATION_BEHAVIOR_EXTRACT=CONTINUE
+--FILE--
+<?php
+
+DDTrace\consume_distributed_tracing_headers([
+    "x-datadog-trace-id" => 42,
+    "x-datadog-parent-id" => 10,
+]);
+
+$span = DDTrace\start_span();
+$root = DDTrace\root_span();
+
+echo "same_as_upstream: " . ($root->traceId === "0000000000000000000000000000002a" ? "yes" : "no") . "\n";
+
+DDTrace\close_span();
+?>
+--EXPECT--
+same_as_upstream: yes

tests/ext/distributed_tracing/propagation_behavior_extract_config_uppercase_restart.phpt

@@ -0,0 +1,24 @@
+--TEST--
+DD_TRACE_PROPAGATION_BEHAVIOR_EXTRACT: RESTART (uppercase) is accepted
+--ENV--
+DD_TRACE_GENERATE_ROOT_SPAN=0
+DD_TRACE_PROPAGATION_BEHAVIOR_EXTRACT=RESTART
+--FILE--
+<?php
+
+DDTrace\consume_distributed_tracing_headers([
+    "x-datadog-trace-id" => 42,
+    "x-datadog-parent-id" => 10,
+]);
+
+$span = DDTrace\start_span();
+$root = DDTrace\root_span();
+
+echo "same_as_upstream: " . ($root->traceId === "0000000000000000000000000000002a" ? "yes" : "no") . "\n";
+echo "links_count: " . count($root->links) . "\n";
+
+DDTrace\close_span();
+?>
+--EXPECT--
+same_as_upstream: no
+links_count: 1

tests/ext/distributed_tracing/propagation_behavior_extract_continue.phpt

@@ -0,0 +1,32 @@
+--TEST--
+DD_TRACE_PROPAGATION_BEHAVIOR_EXTRACT=continue inherits upstream context
+--ENV--
+DD_TRACE_GENERATE_ROOT_SPAN=0
+DD_TRACE_PROPAGATION_BEHAVIOR_EXTRACT=continue
+--FILE--
+<?php
+
+DDTrace\consume_distributed_tracing_headers([
+    "x-datadog-trace-id" => 42,
+    "x-datadog-parent-id" => 10,
+    "x-datadog-sampling-priority" => 1,
+    "baggage" => "user.id=123",
+]);
+
+$span = DDTrace\start_span();
+$root = DDTrace\root_span();
+
+echo "trace_id: " . $root->traceId . "\n";
+echo "parent_id: " . $root->parentId . "\n";
+echo "links_count: " . count($root->links) . "\n";
+
+$headers = DDTrace\generate_distributed_tracing_headers(['baggage']);
+echo "baggage: " . ($headers['baggage'] ?? 'none') . "\n";
+
+DDTrace\close_span();
+?>
+--EXPECT--
+trace_id: 0000000000000000000000000000002a
+parent_id: 10
+links_count: 0
+baggage: user.id=123

tests/ext/distributed_tracing/propagation_behavior_extract_ignore.phpt

@@ -0,0 +1,37 @@
+--TEST--
+DD_TRACE_PROPAGATION_BEHAVIOR_EXTRACT=ignore drops all incoming context including baggage
+--ENV--
+DD_TRACE_GENERATE_ROOT_SPAN=0
+DD_TRACE_PROPAGATION_BEHAVIOR_EXTRACT=ignore
+--FILE--
+<?php
+
+DDTrace\consume_distributed_tracing_headers([
+    "x-datadog-trace-id" => 42,
+    "x-datadog-parent-id" => 10,
+    "x-datadog-sampling-priority" => 2,
+    "x-datadog-tags" => "_dd.p.dm=-4",
+    "baggage" => "user.id=123",
+]);
+
+$span = DDTrace\start_span();
+$root = DDTrace\root_span();
+
+// fresh trace: not from upstream
+echo "same_as_upstream: " . ($root->traceId === "0000000000000000000000000000002a" ? "yes" : "no") . "\n";
+echo "parent_id: " . ($root->parentId ?? 0) . "\n";
+
+// no span link (context discarded entirely)
+echo "links_count: " . count($root->links) . "\n";
+
+// baggage dropped
+$headers = DDTrace\generate_distributed_tracing_headers(['baggage']);
+echo "baggage: " . ($headers['baggage'] ?? 'none') . "\n";
+
+DDTrace\close_span();
+?>
+--EXPECT--
+same_as_upstream: no
+parent_id: 0
+links_count: 0
+baggage: none