Set defaults for sameProcessAsParentSpan (#153)

The first span defaults to false (from an external process).
Subsequent spans default to true (running in the same PHP process).

Author: chingor13

ext/opencensus_trace_span.c

@@ -320,6 +320,28 @@ static PHP_METHOD(OpenCensusTraceSpan, kind) {
     RETURN_ZVAL(val, 1, 0);
 }
 
+/**
+ * Fetch the sameProcessAsParentSpan attribute of the span.
+ *
+ * @return bool
+ */
+static PHP_METHOD(OpenCensusTraceSpan, sameProcessAsParentSpan) {
+    zval *val, rv;
+
+    if (zend_parse_parameters_none() == FAILURE) {
+        return;
+    }
+
+    val = zend_read_property(opencensus_trace_span_ce, getThis(), "sameProcessAsParentSpan", sizeof("sameProcessAsParentSpan") - 1, 1, &rv);
+    switch (Z_TYPE_P(val)) {
+        case IS_FALSE:
+            RETURN_FALSE;
+        case IS_TRUE:
+        default:
+            RETURN_TRUE
+    }
+}
+
 /* Declare method entries for the OpenCensus\Trace\Span class */
 static zend_function_entry opencensus_trace_span_methods[] = {
     PHP_ME(OpenCensusTraceSpan, __construct, arginfo_OpenCensusTraceSpan_construct, ZEND_ACC_PUBLIC | ZEND_ACC_CTOR)
@@ -334,6 +356,7 @@ static zend_function_entry opencensus_trace_span_methods[] = {
     PHP_ME(OpenCensusTraceSpan, links, NULL, ZEND_ACC_PUBLIC)
     PHP_ME(OpenCensusTraceSpan, timeEvents, NULL, ZEND_ACC_PUBLIC)
     PHP_ME(OpenCensusTraceSpan, kind, NULL, ZEND_ACC_PUBLIC)
+    PHP_ME(OpenCensusTraceSpan, sameProcessAsParentSpan, NULL, ZEND_ACC_PUBLIC)
     PHP_FE_END
 };
 
@@ -356,6 +379,7 @@ int opencensus_trace_span_minit(INIT_FUNC_ARGS) {
     zend_declare_property_null(opencensus_trace_span_ce, "links", sizeof("links") - 1, ZEND_ACC_PROTECTED TSRMLS_CC);
     zend_declare_property_null(opencensus_trace_span_ce, "timeEvents", sizeof("timeEvents") - 1, ZEND_ACC_PROTECTED TSRMLS_CC);
     zend_declare_property_null(opencensus_trace_span_ce, "kind", sizeof("kind") - 1, ZEND_ACC_PROTECTED TSRMLS_CC);
+    zend_declare_property_null(opencensus_trace_span_ce, "sameProcessAsParentSpan", sizeof("sameProcessAsParentSpan") - 1, ZEND_ACC_PROTECTED TSRMLS_CC);
 
     return SUCCESS;
 }
@@ -412,6 +436,7 @@ opencensus_trace_span_t *opencensus_trace_span_alloc()
     );
     span->start = 0;
     span->stop = 0;
+    span->same_process_as_parent_span = 1;
     ALLOC_HASHTABLE(span->attributes);
     zend_hash_init(span->attributes, 4, NULL, ZVAL_PTR_DTOR, 0);
 
@@ -540,6 +565,10 @@ int opencensus_trace_span_apply_span_options(opencensus_trace_span_t *span, zval
                 zend_string_release(span->kind);
             }
             span->kind = zend_string_copy(Z_STR_P(v));
+        } else if (strcmp(ZSTR_VAL(k), "sameProcessAsParentSpan") == 0) {
+            if (Z_TYPE_P(v) == IS_FALSE) {
+                span->same_process_as_parent_span = 0;
+            }
         }
     } ZEND_HASH_FOREACH_END();
     return SUCCESS;
@@ -611,6 +640,7 @@ int opencensus_trace_span_to_zval(opencensus_trace_span_t *trace_span, zval *spa
     if (trace_span->kind) {
         zend_update_property_str(opencensus_trace_span_ce, span, "kind", sizeof("kind") - 1, trace_span->kind);
     }
+    zend_update_property_bool(opencensus_trace_span_ce, span, "sameProcessAsParentSpan", sizeof("sameProcessAsParentSpan") - 1, trace_span->same_process_as_parent_span);
 
     return SUCCESS;
 }

ext/opencensus_trace_span.h

@@ -32,6 +32,7 @@ typedef struct opencensus_trace_span_t {
     double stop;
     struct opencensus_trace_span_t *parent;
     zval stackTrace;
+    zend_long same_process_as_parent_span;
 
     // zend_string* => zval*
     HashTable *attributes;

ext/tests/manual_spans_default_options.phpt

@@ -45,6 +45,7 @@ Array
                 )
 
             [kind:protected] => SPAN_KIND_UNSPECIFIED
+            [sameProcessAsParentSpan:protected] => 1
         )
 
     [1] => OpenCensus\Trace\Ext\Span Object
@@ -71,6 +72,7 @@ Array
                 )
 
             [kind:protected] => SPAN_KIND_UNSPECIFIED
+            [sameProcessAsParentSpan:protected] => 1
         )
 
 )

ext/tests/span_same_process_as_parent_span.phpt

@@ -0,0 +1,22 @@
+--TEST--
+OpenCensus Trace: Set span sameProcessAsParentSpan
+--FILE--
+<?php
+opencensus_trace_begin('/', [
+    'startTime' => 0.1,
+    'sameProcessAsParentSpan' => true
+]);
+opencensus_trace_begin('inner-1', [
+    'sameProcessAsParentSpan' => false
+]);
+opencensus_trace_finish();
+opencensus_trace_finish();
+$traces = opencensus_trace_list();
+echo "Number of traces: " . count($traces) . "\n";
+var_dump($traces[0]->sameProcessAsParentSpan());
+var_dump($traces[1]->sameProcessAsParentSpan());
+?>
+--EXPECT--
+Number of traces: 2
+bool(true)
+bool(false)

src/Trace/RequestHandler.php

@@ -116,7 +116,8 @@ public function __construct(
             'startTime' => $this->startTimeFromHeaders($this->headers),
             'name' => $this->nameFromHeaders($this->headers),
             'attributes' => [],
-            'kind' => Span::KIND_SERVER
+            'kind' => Span::KIND_SERVER,
+            'sameProcessAsParentSpan' => false
         ];
         $this->rootSpan = $this->tracer->startSpan($spanOptions);
         $this->scope = $this->tracer->withSpan($this->rootSpan);

src/Trace/Span.php

@@ -174,7 +174,7 @@ public function __construct($options = [])
             'links' => [],
             'parentSpanId' => null,
             'status' => null,
-            'sameProcessAsParentSpan' => null,
+            'sameProcessAsParentSpan' => true,
             'kind' => self::KIND_UNSPECIFIED
         ];
 

src/Trace/Tracer/ContextTracer.php

@@ -60,7 +60,9 @@ public function __construct(SpanContext $initialContext = null)
      */
     public function inSpan(array $spanOptions, callable $callable, array $arguments = [])
     {
-        $span = $this->startSpan($spanOptions);
+        $span = $this->startSpan($spanOptions + [
+            'sameProcessAsParentSpan' => !empty($this->spans)
+        ]);
         $scope = $this->withSpan($span);
         try {
             return call_user_func_array($callable, $arguments);

src/Trace/Tracer/ExtensionTracer.php

@@ -31,6 +31,11 @@
  */
 class ExtensionTracer implements TracerInterface
 {
+    /**
+     * @var bool
+     */
+    private $hasSpans = false;
+
     public function __construct(SpanContext $initialContext = null)
     {
         if ($initialContext) {
@@ -49,7 +54,9 @@ public function __construct(SpanContext $initialContext = null)
      */
     public function inSpan(array $spanOptions, callable $callable, array $arguments = [])
     {
-        $span = $this->startSpan($spanOptions);
+        $span = $this->startSpan($spanOptions + [
+            'sameProcessAsParentSpan' => $this->hasSpans
+        ]);
         $scope = $this->withSpan($span);
         try {
             return call_user_func_array($callable, $arguments);
@@ -91,9 +98,11 @@ public function withSpan(Span $span)
             'startTime' => $startTime,
             'attributes' => $spanData->attributes(),
             'stackTrace' => $spanData->stackTrace(),
-            'kind' => $spanData->kind()
+            'kind' => $spanData->kind(),
+            'sameProcessAsParentSpan' => $spanData->sameProcessAsParentSpan()
         ];
         opencensus_trace_begin($spanData->name(), $info);
+        $this->hasSpans = true;
         return new Scope(function () {
             opencensus_trace_finish();
         });
@@ -249,7 +258,8 @@ private function mapSpan($span)
             'stackTrace' => $span->stackTrace(),
             'links' => array_map([$this, 'mapLink'], $span->links()),
             'timeEvents' => array_map([$this, 'mapTimeEvent'], $span->timeEvents()),
-            'kind' => $this->getKind($span)
+            'kind' => $this->getKind($span),
+            'sameProcessAsParentSpan' => $this->getSameProcessAsParentSpan($span)
         ]);
     }
 
@@ -261,6 +271,14 @@ private function getKind($span)
         return Span::KIND_UNSPECIFIED;
     }
 
+    private function getSameProcessAsParentSpan($span)
+    {
+        if (method_exists($span, 'sameProcessAsParentSpan')) {
+            return $span->sameProcessAsParentSpan();
+        }
+        return true;
+    }
+
     private function mapLink($link)
     {
         return new Link($link->traceId(), $link->spanId(), $link->options());

tests/unit/Trace/Tracer/AbstractTracerTest.php

@@ -359,6 +359,38 @@ public function testSetSpanKind()
         $this->assertEquals(Span::KIND_SERVER, $spanData->kind());
     }
 
+    public function testDefaultSameProcessAsParentSpan()
+    {
+        $class = $this->getTracerClass();
+        $tracer = new $class();
+        $tracer->inSpan(['name' => 'main'], function () use ($tracer) {
+            $tracer->inSpan(['name' => 'inner'], function () {
+                // do nothing
+            });
+        });
+
+        $spans = $tracer->spans();
+        $this->assertCount(2, $spans);
+        $this->assertFalse($spans[0]->spanData()->sameProcessAsParentSpan());
+        $this->assertTrue($spans[1]->spanData()->sameProcessAsParentSpan());
+    }
+
+    public function testSameProcessAsParentSpan()
+    {
+        $class = $this->getTracerClass();
+        $tracer = new $class();
+        $tracer->inSpan(['name' => 'main', 'sameProcessAsParentSpan' => true], function () use ($tracer) {
+            $tracer->inSpan(['name' => 'inner', 'sameProcessAsParentSpan' => false], function () {
+                // do nothing
+            });
+        });
+
+        $spans = $tracer->spans();
+        $this->assertCount(2, $spans);
+        $this->assertTrue($spans[0]->spanData()->sameProcessAsParentSpan());
+        $this->assertFalse($spans[1]->spanData()->sameProcessAsParentSpan());
+    }
+
     private function assertEquivalentTimestamps($expected, $value)
     {
         $this->assertEquals((float)($expected->format('U.u')), (float)($value->format('U.u')), '', 0.000001);