Data model (#68)

* Make Span data model match the protos

* Remove kind handling

* Add test for Span/Status

* RequestHandler sets http status on root span as span status

* Rename stackTrace variable names to st

Author: chingor13

ext/opencensus_trace.c

@@ -273,7 +273,7 @@ static opencensus_trace_span_t *opencensus_trace_begin(zend_string *function_nam
 {
     opencensus_trace_span_t *span = opencensus_trace_span_alloc();
 
-    zend_fetch_debug_backtrace(&span->backtrace, 1, DEBUG_BACKTRACE_IGNORE_ARGS, 0);
+    zend_fetch_debug_backtrace(&span->stackTrace, 1, DEBUG_BACKTRACE_IGNORE_ARGS, 0);
 
     span->start = opencensus_now();
     span->name = zend_string_copy(function_name);
@@ -628,7 +628,7 @@ PHP_FUNCTION(opencensus_trace_list)
         ZVAL_ARR(&attribute, trace_span->attributes);
         zend_update_property(opencensus_trace_span_ce, &span, "attributes", sizeof("attributes") - 1, &attribute);
 
-        zend_update_property(opencensus_trace_span_ce, &span, "backtrace", sizeof("backtrace") - 1, &trace_span->backtrace);
+        zend_update_property(opencensus_trace_span_ce, &span, "stackTrace", sizeof("stackTrace") - 1, &trace_span->stackTrace);
 
         add_next_index_zval(return_value, &span);
     } ZEND_HASH_FOREACH_END();

ext/opencensus_trace_span.c

@@ -210,18 +210,18 @@ static PHP_METHOD(OpenCensusTraceSpan, endTime) {
 }
 
 /**
- * Fetch the backtrace from the moment the span was started
+ * Fetch the stackTrace from the moment the span was started
  *
  * @return array
  */
-static PHP_METHOD(OpenCensusTraceSpan, backtrace) {
+static PHP_METHOD(OpenCensusTraceSpan, stackTrace) {
     zval *val, rv;
 
     if (zend_parse_parameters_none() == FAILURE) {
         return;
     }
 
-    val = zend_read_property(opencensus_trace_span_ce, getThis(), "backtrace", sizeof("backtrace") - 1, 1, &rv);
+    val = zend_read_property(opencensus_trace_span_ce, getThis(), "stackTrace", sizeof("stackTrace") - 1, 1, &rv);
 
     RETURN_ZVAL(val, 1, 0);
 }
@@ -252,7 +252,7 @@ static zend_function_entry opencensus_trace_span_methods[] = {
     PHP_ME(OpenCensusTraceSpan, attributes, NULL, ZEND_ACC_PUBLIC)
     PHP_ME(OpenCensusTraceSpan, startTime, NULL, ZEND_ACC_PUBLIC)
     PHP_ME(OpenCensusTraceSpan, endTime, NULL, ZEND_ACC_PUBLIC)
-    PHP_ME(OpenCensusTraceSpan, backtrace, NULL, ZEND_ACC_PUBLIC)
+    PHP_ME(OpenCensusTraceSpan, stackTrace, NULL, ZEND_ACC_PUBLIC)
     PHP_ME(OpenCensusTraceSpan, kind, NULL, ZEND_ACC_PUBLIC)
     PHP_FE_END
 };
@@ -275,7 +275,7 @@ int opencensus_trace_span_minit(INIT_FUNC_ARGS) {
     zend_declare_property_null(opencensus_trace_span_ce, "endTime", sizeof("endTime") - 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, "attributes", sizeof("attributes") - 1, ZEND_ACC_PROTECTED TSRMLS_CC);
-    zend_declare_property_null(opencensus_trace_span_ce, "backtrace", sizeof("backtrace") - 1, ZEND_ACC_PROTECTED TSRMLS_CC);
+    zend_declare_property_null(opencensus_trace_span_ce, "stackTrace", sizeof("stackTrace") - 1, ZEND_ACC_PROTECTED TSRMLS_CC);
 
     REGISTER_TRACE_SPAN_CONSTANT(KIND_UNKNOWN);
     REGISTER_TRACE_SPAN_CONSTANT(KIND_CLIENT);

ext/opencensus_trace_span.h

@@ -34,7 +34,7 @@ typedef struct opencensus_trace_span_t {
     double start;
     double stop;
     struct opencensus_trace_span_t *parent;
-    zval backtrace;
+    zval stackTrace;
     zend_long kind;
 
     // zend_string* => zval*

ext/tests/backtrace_test.phpt

@@ -20,7 +20,7 @@ $traces = opencensus_trace_list();
 echo "Number of traces: " . count($traces) . "\n";
 
 foreach ($traces as $span) {
-    var_dump($span->backtrace());
+    var_dump($span->stackTrace());
 }
 ?>
 --EXPECTF--

ext/tests/manual_spans_default_options.phpt

@@ -33,7 +33,7 @@ Array
                 (
                 )
 
-            [backtrace:protected] => Array
+            [stackTrace:protected] => Array
                 (
                 )
 
@@ -51,7 +51,7 @@ Array
                 (
                 )
 
-            [backtrace:protected] => Array
+            [stackTrace:protected] => Array
                 (
                 )
 

src/Trace/Exporter/StackdriverExporter.php

@@ -202,35 +202,26 @@ public function processSpans(TracerInterface $tracer, $headers = null)
      */
     public function convertSpans(TracerInterface $tracer)
     {
-        $spanKindMap = [
-            Span::SPAN_KIND_CLIENT => TraceSpan::SPAN_KIND_RPC_CLIENT,
-            Span::SPAN_KIND_SERVER => TraceSpan::SPAN_KIND_RPC_SERVER
-        ];
-
         // transform OpenCensus Spans to Google\Cloud\Spans
-        return array_map(function ($span) use ($spanKindMap) {
-            $kind = array_key_exists($span->kind(), $spanKindMap)
-                ? $spanKindMap[$span->kind()]
-                :  TraceSpan::SPAN_KIND_UNSPECIFIED;
+        return array_map(function ($span) {
             $attributes = $span->attributes();
-            $attributes[self::STACKTRACE] = $this->formatBacktrace($span->backtrace());
+            $attributes[self::STACKTRACE] = $this->formatBacktrace($span->stackTrace());
             return new TraceSpan([
                 'name' => $span->name(),
                 'startTime' => $span->startTime(),
                 'endTime' => $span->endTime(),
                 'spanId' => hexdec($span->spanId()),
                 'parentSpanId' => $span->parentSpanId() ? hexdec($span->parentSpanId()) : null,
-                'labels' => $attributes,
-                'kind' => $kind,
+                'labels' => $attributes
             ]);
             $span->info();
         }, $tracer->spans());
     }
 
-    private function formatBacktrace($bt)
+    private function formatBacktrace($st)
     {
         return json_encode([
-            'stack_frame' => array_map([$this, 'mapStackframe'], $bt)
+            'stack_frame' => array_map([$this, 'mapStackframe'], $st)
         ]);
     }
 
@@ -272,18 +263,6 @@ private function addCommonAttributes(&$tracer, $headers = null)
     {
         $headers = $headers ?: $_SERVER;
 
-        // If a redirect, add the HTTP_REDIRECTED_URL attribute to the main span
-        $responseCode = http_response_code();
-        if ($responseCode == 301 || $responseCode == 302) {
-            foreach (headers_list() as $header) {
-                if (substr($header, 0, 9) == 'Location:') {
-                    $tracer->addRootAttribute(self::HTTP_REDIRECTED_URL, substr($header, 10));
-                    break;
-                }
-            }
-        }
-        $tracer->addRootAttribute(self::HTTP_STATUS_CODE, $responseCode);
-
         $attributeMap = [
             self::HTTP_URL => ['REQUEST_URI'],
             self::HTTP_METHOD => ['REQUEST_METHOD'],

src/Trace/Exporter/ZipkinExporter.php

@@ -109,13 +109,6 @@ public function convertSpans(TracerInterface $tracer, $headers = null)
         $rootSpan = $spans[0];
         $traceId = $tracer->spanContext()->traceId();
 
-        $kindMap = [
-            Span::SPAN_KIND_CLIENT => 'CLIENT',
-            Span::SPAN_KIND_SERVER => 'SERVER',
-            Span::SPAN_KIND_PRODUCER => 'PRODUCER',
-            Span::SPAN_KIND_CONSUMER => 'CONSUMER'
-        ];
-
         // True is a request to store this span even if it overrides sampling policy.
         // This is true when the X-B3-Flags header has a value of 1.
         $isDebug = array_key_exists('HTTP_X_B3_FLAGS', $headers) && $headers['HTTP_X_B3_FLAGS'] == '1';
@@ -150,9 +143,6 @@ public function convertSpans(TracerInterface $tracer, $headers = null)
                 'localEndpoint' => $localEndpoint,
                 'tags' => $span->attributes()
             ];
-            if (array_key_exists($span->kind(), $kindMap)) {
-                $zipkinSpan['kind'] = $kindMap[$span->kind()];
-            }
 
             $zipkinSpans[] = $zipkinSpan;
         }

src/Trace/RequestHandler.php

@@ -49,6 +49,11 @@ class RequestHandler
      */
     private $tracer;
 
+    /**
+     * @var Span The primary span for this request
+     */
+    private $rootSpan;
+
     /**
      * @var Scope
      */
@@ -104,8 +109,8 @@ public function __construct(
             'name' => $this->nameFromHeaders($headers),
             'attributes' => []
         ];
-        $span = $this->tracer->startSpan($spanOptions);
-        $this->scope = $this->tracer->withSpan($span);
+        $this->rootSpan = $this->tracer->startSpan($spanOptions);
+        $this->scope = $this->tracer->withSpan($this->rootSpan);
 
         register_shutdown_function([$this, 'onExit']);
     }
@@ -117,6 +122,17 @@ public function __construct(
      */
     public function onExit()
     {
+        $responseCode = http_response_code();
+        if ($responseCode == 301 || $responseCode == 302) {
+            foreach (headers_list() as $header) {
+                if (substr($header, 0, 9) == 'Location:') {
+                    $this->rootSpan->addAttribute(self::HTTP_REDIRECTED_URL, substr($header, 10));
+                    break;
+                }
+            }
+        }
+        $this->rootSpan->setStatus($responseCode, "HTTP status code: $responseCode");
+
         $this->scope->close();
         $this->reporter->report($this->tracer);
     }