Add span kind to extension and Span (#151)

* Add span kind to extension and Span

* Add span kind extension test and fix memory leak

* Dump out extension test failures

* ZipkinExporter respects span kind

* Set span kind for known integrations

Author: chingor13

Dockerfile

@@ -38,7 +38,7 @@ RUN phpize && \
     ./configure --enable-opencensus && \
     make clean && \
     make && \
-    make test && \
+    make test || ((find . -name '*.diff' | xargs cat) && false) && \
     make install
 
 WORKDIR /build

ext/opencensus_trace_span.c

@@ -30,6 +30,7 @@
  *   protected $stackTrace;
  *   protected $links;
  *   protected $timeEvents;
+ *   protected $kind;
  *
  *   public function __construct(array $spanOptions)
  *   {
@@ -82,6 +83,11 @@
  *   {
  *     return $this->timeEvents;
  *   }
+ *
+ *   public function kind()
+ *   {
+ *     return $this->kind;
+ *   }
  * }
  */
 
@@ -297,6 +303,23 @@ static PHP_METHOD(OpenCensusTraceSpan, stackTrace) {
     RETURN_ZVAL(val, 1, 0);
 }
 
+/**
+ * Fetch the span kind
+ *
+ * @return string
+ */
+static PHP_METHOD(OpenCensusTraceSpan, kind) {
+    zval *val, rv;
+
+    if (zend_parse_parameters_none() == FAILURE) {
+        return;
+    }
+
+    val = zend_read_property(opencensus_trace_span_ce, getThis(), "kind", sizeof("kind") - 1, 1, &rv);
+
+    RETURN_ZVAL(val, 1, 0);
+}
+
 /* 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)
@@ -310,6 +333,7 @@ static zend_function_entry opencensus_trace_span_methods[] = {
     PHP_ME(OpenCensusTraceSpan, stackTrace, NULL, ZEND_ACC_PUBLIC)
     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_FE_END
 };
 
@@ -331,6 +355,7 @@ int opencensus_trace_span_minit(INIT_FUNC_ARGS) {
     zend_declare_property_null(opencensus_trace_span_ce, "stackTrace", sizeof("stackTrace") - 1, ZEND_ACC_PROTECTED TSRMLS_CC);
     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);
 
     return SUCCESS;
 }
@@ -380,6 +405,11 @@ opencensus_trace_span_t *opencensus_trace_span_alloc()
     span->name = NULL;
     span->parent = NULL;
     span->span_id = NULL;
+    span->kind = zend_string_init(
+        OPENCENSUS_TRACE_SPAN_KIND_UNSPECIFIED,
+        strlen(OPENCENSUS_TRACE_SPAN_KIND_UNSPECIFIED),
+        0
+    );
     span->start = 0;
     span->stop = 0;
     ALLOC_HASHTABLE(span->attributes);
@@ -413,6 +443,9 @@ void opencensus_trace_span_free(opencensus_trace_span_t *span)
     if (span->span_id) {
         zend_string_release(span->span_id);
     }
+    if (span->kind) {
+        zend_string_release(span->kind);
+    }
 
     ZVAL_DESTRUCTOR(&span->stackTrace);
 
@@ -502,6 +535,11 @@ int opencensus_trace_span_apply_span_options(opencensus_trace_span_t *span, zval
                 zend_string_release(span->span_id);
             }
             span->span_id = zend_string_copy(Z_STR_P(v));
+        } else if (strcmp(ZSTR_VAL(k), "kind") == 0) {
+            if (span->kind) {
+                zend_string_release(span->kind);
+            }
+            span->kind = zend_string_copy(Z_STR_P(v));
         }
     } ZEND_HASH_FOREACH_END();
     return SUCCESS;
@@ -570,5 +608,9 @@ int opencensus_trace_span_to_zval(opencensus_trace_span_t *trace_span, zval *spa
     opencensus_trace_update_time_events(trace_span, &time_events);
     zend_update_property(opencensus_trace_span_ce, span, "timeEvents", sizeof("timeEvents") - 1, &time_events);
 
+    if (trace_span->kind) {
+        zend_update_property_str(opencensus_trace_span_ce, span, "kind", sizeof("kind") - 1, trace_span->kind);
+    }
+
     return SUCCESS;
 }

ext/opencensus_trace_span.h

@@ -21,10 +21,13 @@
 
 extern zend_class_entry* opencensus_trace_span_ce;
 
+#define OPENCENSUS_TRACE_SPAN_KIND_UNSPECIFIED "SPAN_KIND_UNSPECIFIED"
+
 // TraceSpan struct
 typedef struct opencensus_trace_span_t {
     zend_string *name;
     zend_string *span_id;
+    zend_string *kind;
     double start;
     double stop;
     struct opencensus_trace_span_t *parent;

ext/span.php

@@ -30,6 +30,7 @@ class Span {
     protected $stackTrace;
     protected $links;
     protected $timeEvents;
+    protected $kind;
 
     public function __construct(array $spanOptions)
     {
@@ -82,4 +83,9 @@ public function timeEvents()
     {
         return $this->timeEvents;
     }
+
+    public function kind()
+    {
+        return $this->kind;
+    }
 }

ext/tests/manual_spans.phpt

@@ -30,6 +30,8 @@ echo "Span startTime is: '{$span->startTime()}'\n";
 $test = gettype($span->endTime()) == 'double';
 echo "Span endTime is a double: $test\n";
 
+echo "Span kind is: " . $span->kind() . PHP_EOL;
+
 print_r($span->attributes());
 
 $span = $traces[1];
@@ -45,6 +47,8 @@ echo "Span startTime is a double: $test\n";
 $test = gettype($span->endTime()) == 'double';
 echo "Span endTime is a double: $test\n";
 
+echo "Span kind is: " . $span->kind() . PHP_EOL;
+
 print_r($span->attributes());
 ?>
 --EXPECT--
@@ -54,6 +58,7 @@ Span name is: '/'
 Span startTime is a double: 1
 Span startTime is: '0.1'
 Span endTime is a double: 1
+Span kind is: SPAN_KIND_UNSPECIFIED
 Array
 (
     [asdf] => qwer
@@ -62,6 +67,7 @@ Span id is a string
 Span name is: 'inner-1'
 Span startTime is a double: 1
 Span endTime is a double: 1
+Span kind is: SPAN_KIND_UNSPECIFIED
 Array
 (
     [foo] => bar

ext/tests/manual_spans_default_options.phpt

@@ -44,6 +44,7 @@ Array
                 (
                 )
 
+            [kind:protected] => SPAN_KIND_UNSPECIFIED
         )
 
     [1] => OpenCensus\Trace\Ext\Span Object
@@ -69,6 +70,7 @@ Array
                 (
                 )
 
+            [kind:protected] => SPAN_KIND_UNSPECIFIED
         )
 
 )

ext/tests/span_kind.phpt

@@ -0,0 +1,30 @@
+--TEST--
+OpenCensus Trace: Set span kind
+--FILE--
+<?php
+
+require_once(__DIR__ . '/common.php');
+
+opencensus_trace_begin('/', [
+    'startTime' => 0.1,
+    'kind' => 'SERVER'
+]);
+
+opencensus_trace_begin('inner-1', [
+    'kind' => 'CLIENT'
+]);
+
+opencensus_trace_finish();
+
+opencensus_trace_finish();
+
+$traces = opencensus_trace_list();
+echo "Number of traces: " . count($traces) . "\n";
+echo "Span kind is " . $traces[0]->kind() . PHP_EOL;
+echo "Span kind is " . $traces[1]->kind() . PHP_EOL;
+
+?>
+--EXPECT--
+Number of traces: 2
+Span kind is SERVER
+Span kind is CLIENT

src/Trace/Exporter/ZipkinExporter.php

@@ -18,6 +18,7 @@
 namespace OpenCensus\Trace\Exporter;
 
 use OpenCensus\Trace\MessageEvent;
+use OpenCensus\Trace\Span;
 use OpenCensus\Trace\SpanData;
 
 /**
@@ -38,6 +39,11 @@ class ZipkinExporter implements ExporterInterface
     const KIND_SERVER = 'SERVER';
     const KIND_CLIENT = 'CLIENT';
     const DEFAULT_ENDPOINT = 'http://localhost:9411/api/v2/spans';
+    const KIND_MAP = [
+        Span::KIND_UNSPECIFIED => null,
+        Span::KIND_SERVER => self::KIND_SERVER,
+        Span::KIND_CLIENT => self::KIND_CLIENT
+    ];
 
     /**
      * @var string
@@ -184,6 +190,11 @@ public function convertSpans(array $spans, $headers = null)
 
     private function spanKind(SpanData $span)
     {
+        $kind = self::KIND_MAP[$span->kind()];
+        if ($kind !== null) {
+            return $kind;
+        }
+
         if (strpos($span->name(), 'Sent.') === 0) {
             return self::KIND_CLIENT;
         }

src/Trace/Integrations/Curl.php

@@ -17,6 +17,8 @@
 
 namespace OpenCensus\Trace\Integrations;
 
+use OpenCensus\Trace\Span;
+
 /**
  * This class handles instrumenting curl requests using the opencensus extension.
  *
@@ -56,7 +58,8 @@ public static function handleCurlResource($resource)
         return [
             'attributes' => [
                 'uri' => curl_getinfo($resource, CURLINFO_EFFECTIVE_URL)
-            ]
+            ],
+            'kind' => Span::KIND_CLIENT
         ];
     }
 }

src/Trace/Integrations/Doctrine.php

@@ -18,6 +18,7 @@
 namespace OpenCensus\Trace\Integrations;
 
 use Doctrine\ORM\Version;
+use OpenCensus\Trace\Span;
 
 /**
  * This class handles instrumenting the Doctrine ORM queries using the opencensus extension.
@@ -52,23 +53,26 @@ public static function load()
         opencensus_trace_method($persisterClass, 'load', function ($bep) {
             return [
                 'name' => 'doctrine/load',
-                'attributes' => ['entity' => $bep->getClassMetadata()->name]
+                'attributes' => ['entity' => $bep->getClassMetadata()->name],
+                'kind' => Span::KIND_CLIENT
             ];
         });
 
         // public function loadAll(array $criteria = array(), array $orderBy = null, $limit = null, $offset = null)
         opencensus_trace_method($persisterClass, 'loadAll', function ($bep) {
             return [
                 'name' => 'doctrine/loadAll',
-                'attributes' => ['entity' => $bep->getClassMetadata()->name]
+                'attributes' => ['entity' => $bep->getClassMetadata()->name],
+                'kind' => Span::KIND_CLIENT
             ];
         });
 
         // public int PDOConnection::exec(string $query)
         opencensus_trace_method(PDOConnection::class, 'exec', function ($scope, $query) {
             return [
                 'name' => 'doctrine/exec',
-                'attributes' => ['query' => $query]
+                'attributes' => ['query' => $query],
+                'kind' => Span::KIND_CLIENT
             ];
         });
     }