Rename RequestTracer->Tracer, Label->Attribute (#67)

* Rename RequestTracer->Tracer

* label->attribute

* Fix extension README

* Fix test from mismerge

Author: chingor13

ext/README.md

@@ -3,7 +3,7 @@
 [OpenCensus](https://opencensus.io/) is a free, open-source distributed tracing
 implementation based on the [Dapper Paper](https://research.google.com/pubs/pub36356.html).
 This extension allows you to "watch" class method and function calls in order to
-automatically collect nested spans (labelled timing data).
+automatically collect nested spans (timing data).
 
 This library can optionally work in conjunction with the PHP library
 [opencensus/opencensus](https://packagist.org/packages/opencensus/opencensus) in order
@@ -103,7 +103,7 @@ If an array is provided, it should be an associative array with the following op
 * `name` - string - the name of the span to create. **Defaults to** the full method name (i.e. `Foobar::__construct`).
 * `startTime` - float - the start time of the span. **Defaults to** the time that the method was invoked.
 * `endTime` - float - the end time of the span. **Defaults to** the time that the method invocation completed.
-* `labels` - array - an associative array of string => string tags for this span.
+* `attributes` - array - an associative array of string => string tags for this span.
 
 If a callback is provided, it will be passed the instance of the class (scope) and a copy of each parameter
 provided to the watched method. The callback should return an array with the above options. If the callback does
@@ -113,15 +113,15 @@ not return an array, an `E_USER_WARNING` error is thrown.
 // Example: supply a static array of span options as the handler
 opencensus_trace_method('Foobar', '__construct', [
     'name' => 'Foobar::__construct',
-    'labels' => [
+    'attributes' => [
         'foo' => 'bar'
     ]
 ]);
 
 // Example: supply a closure
 opencensus_trace_method('Foobar', '__construct', function ($scope, $constructArg1, $constructArg2) {
     return [
-        'labels' => [
+        'attributes' => [
             'arg1' => $constructArg1
         ]
     ];
@@ -131,7 +131,7 @@ opencensus_trace_method('Foobar', '__construct', function ($scope, $constructArg
 function my_callback($scope, $constructArg1, $constructArg2)
 {
     return [
-        'labels' => [
+        'attributes' => [
             'arg1' => $constructArg1
         ]
     ];
@@ -164,7 +164,7 @@ not object scope available.
 opencensus_trace_function('var_dump', function ($value) {
     return [
         'name' => 'Foobar::__construct',
-        'labels' => [
+        'attributes' => [
           'value' => $value
         ]
     ];
@@ -244,24 +244,24 @@ You may also set the initial trace context. Note that doing this after spans hav
 function opencensus_trace_set_context($traceId, $parentSpanId = null);
 ```
 
-### Add labels to spans
+### Add attributes to spans
 
 ```php
 /**
- * Add a label to the current span
+ * Add a attribute to the current span
  *
  * @param string $key
  * @param string $value
  */
-function opencensus_trace_add_label($key, $value);
+function opencensus_trace_add_attribute($key, $value);
 
 /**
- * Add a label to the root current span
+ * Add a attribute to the root current span
  *
  * @param string $key
  * @param string $value
  */
-function opencensus_trace_add_root_label($key, $value);
+function opencensus_trace_add_root_attribute($key, $value);
 ```
 
 ## Versioning

ext/opencensus_trace.c

@@ -63,7 +63,7 @@ ZEND_BEGIN_ARG_INFO_EX(arginfo_opencensus_trace_set_context, 0, 0, 1)
     ZEND_ARG_TYPE_INFO(0, parentSpanId, IS_STRING, 1)
 ZEND_END_ARG_INFO()
 
-ZEND_BEGIN_ARG_INFO_EX(arginfo_opencensus_trace_add_label, 0, 0, 2)
+ZEND_BEGIN_ARG_INFO_EX(arginfo_opencensus_trace_add_attribute, 0, 0, 2)
     ZEND_ARG_TYPE_INFO(0, key, IS_STRING, 0)
     ZEND_ARG_TYPE_INFO(0, value, IS_STRING, 0)
 ZEND_END_ARG_INFO()
@@ -79,8 +79,8 @@ static zend_function_entry opencensus_functions[] = {
     PHP_FE(opencensus_trace_clear, NULL)
     PHP_FE(opencensus_trace_set_context, arginfo_opencensus_trace_set_context)
     PHP_FE(opencensus_trace_context, NULL)
-    PHP_FE(opencensus_trace_add_label, arginfo_opencensus_trace_add_label)
-    PHP_FE(opencensus_trace_add_root_label, arginfo_opencensus_trace_add_label)
+    PHP_FE(opencensus_trace_add_attribute, arginfo_opencensus_trace_add_attribute)
+    PHP_FE(opencensus_trace_add_root_attribute, arginfo_opencensus_trace_add_attribute)
     PHP_FE_END
 };
 
@@ -120,13 +120,13 @@ PHP_FUNCTION(opencensus_version)
 }
 
 /**
- * Add a label to the current trace span
+ * Add a attribute to the current trace span
  *
  * @param string $key
  * @param string $value
  * @return bool
  */
-PHP_FUNCTION(opencensus_trace_add_label)
+PHP_FUNCTION(opencensus_trace_add_attribute)
 {
     zend_string *k, *v;
     opencensus_trace_span_t *span;
@@ -139,21 +139,21 @@ PHP_FUNCTION(opencensus_trace_add_label)
         RETURN_FALSE;
     }
 
-    if (opencensus_trace_span_add_label(span, k, v) == SUCCESS) {
+    if (opencensus_trace_span_add_attribute(span, k, v) == SUCCESS) {
         RETURN_TRUE;
     }
 
     RETURN_FALSE;
 }
 
 /**
- * Add a label to the root trace span
+ * Add a attribute to the root trace span
  *
  * @param string $key
  * @param string $value
  * @return bool
  */
-PHP_FUNCTION(opencensus_trace_add_root_label)
+PHP_FUNCTION(opencensus_trace_add_root_attribute)
 {
     zend_string *k, *v;
     opencensus_trace_span_t *span;
@@ -169,7 +169,7 @@ PHP_FUNCTION(opencensus_trace_add_root_label)
     /* fetch the first span */
     span = Z_PTR(OPENCENSUS_TRACE_G(spans)->arData->val);
 
-    if (opencensus_trace_span_add_label(span, k, v) == SUCCESS) {
+    if (opencensus_trace_span_add_attribute(span, k, v) == SUCCESS) {
         RETURN_TRUE;
     }
 
@@ -608,7 +608,7 @@ PHP_FUNCTION(opencensus_trace_method)
 PHP_FUNCTION(opencensus_trace_list)
 {
     opencensus_trace_span_t *trace_span;
-    zval label, span;
+    zval attribute, span;
 
     array_init(return_value);
 
@@ -625,8 +625,8 @@ PHP_FUNCTION(opencensus_trace_list)
         zend_update_property_double(opencensus_trace_span_ce, &span, "endTime", sizeof("endTime") - 1, trace_span->stop);
         zend_update_property_long(opencensus_trace_span_ce, &span, "kind", sizeof("kind") - 1, trace_span->kind);
 
-        ZVAL_ARR(&label, trace_span->labels);
-        zend_update_property(opencensus_trace_span_ce, &span, "labels", sizeof("labels") - 1, &label);
+        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);
 

ext/opencensus_trace.h

@@ -29,8 +29,8 @@ PHP_FUNCTION(opencensus_trace_finish);
 PHP_FUNCTION(opencensus_trace_clear);
 PHP_FUNCTION(opencensus_trace_set_context);
 PHP_FUNCTION(opencensus_trace_context);
-PHP_FUNCTION(opencensus_trace_add_label);
-PHP_FUNCTION(opencensus_trace_add_root_label);
+PHP_FUNCTION(opencensus_trace_add_attribute);
+PHP_FUNCTION(opencensus_trace_add_root_attribute);
 
 // Extension lifecycle hooks
 int opencensus_minit(INIT_FUNC_ARGS);

ext/opencensus_trace_span.c

@@ -32,7 +32,7 @@
  *   protected $parentSpanId;
  *   protected $startTime;
  *   protected $endTime;
- *   protected $labels;
+ *   protected $attributes;
  *   protected $kind;
  *
  *   public function __construct(array $spanOptions)
@@ -67,9 +67,9 @@
  *     return $this->endTime;
  *   }
  *
- *   public function labels()
+ *   public function attributes()
  *   {
- *     return $this->labels;
+ *     return $this->attributes;
  *   }
  *
  *   public function kind()
@@ -159,18 +159,18 @@ static PHP_METHOD(OpenCensusTraceSpan, parentSpanId) {
 }
 
 /**
- * Fetch the labels for the span
+ * Fetch the attributes for the span
  *
  * @return array
  */
-static PHP_METHOD(OpenCensusTraceSpan, labels) {
+static PHP_METHOD(OpenCensusTraceSpan, attributes) {
     zval *val, rv;
 
     if (zend_parse_parameters_none() == FAILURE) {
         return;
     }
 
-    val = zend_read_property(opencensus_trace_span_ce, getThis(), "labels", sizeof("labels") - 1, 1, &rv);
+    val = zend_read_property(opencensus_trace_span_ce, getThis(), "attributes", sizeof("attributes") - 1, 1, &rv);
 
     RETURN_ZVAL(val, 1, 0);
 }
@@ -249,7 +249,7 @@ static zend_function_entry opencensus_trace_span_methods[] = {
     PHP_ME(OpenCensusTraceSpan, name, NULL, ZEND_ACC_PUBLIC)
     PHP_ME(OpenCensusTraceSpan, spanId, NULL, ZEND_ACC_PUBLIC)
     PHP_ME(OpenCensusTraceSpan, parentSpanId, NULL, ZEND_ACC_PUBLIC)
-    PHP_ME(OpenCensusTraceSpan, labels, NULL, ZEND_ACC_PUBLIC)
+    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)
@@ -274,7 +274,7 @@ int opencensus_trace_span_minit(INIT_FUNC_ARGS) {
     zend_declare_property_null(opencensus_trace_span_ce, "startTime", sizeof("startTime") - 1, ZEND_ACC_PROTECTED TSRMLS_CC);
     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, "labels", sizeof("labels") - 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);
 
     REGISTER_TRACE_SPAN_CONSTANT(KIND_UNKNOWN);
@@ -299,8 +299,8 @@ opencensus_trace_span_t *opencensus_trace_span_alloc()
     span->span_id = 0;
     span->start = 0;
     span->stop = 0;
-    ALLOC_HASHTABLE(span->labels);
-    zend_hash_init(span->labels, 4, NULL, ZVAL_PTR_DTOR, 0);
+    ALLOC_HASHTABLE(span->attributes);
+    zend_hash_init(span->attributes, 4, NULL, ZVAL_PTR_DTOR, 0);
     return span;
 }
 
@@ -311,8 +311,8 @@ opencensus_trace_span_t *opencensus_trace_span_alloc()
  */
 void opencensus_trace_span_free(opencensus_trace_span_t *span)
 {
-    /* clear any allocated labels */
-    FREE_HASHTABLE(span->labels);
+    /* clear any allocated attributes */
+    FREE_HASHTABLE(span->attributes);
     if (span->name) {
         zend_string_release(span->name);
     }
@@ -321,24 +321,24 @@ void opencensus_trace_span_free(opencensus_trace_span_t *span)
     efree(span);
 }
 
-/* Add a label to the trace span struct */
-int opencensus_trace_span_add_label(opencensus_trace_span_t *span, zend_string *k, zend_string *v)
+/* Add a attribute to the trace span struct */
+int opencensus_trace_span_add_attribute(opencensus_trace_span_t *span, zend_string *k, zend_string *v)
 {
     /* put the string value into a zval and save it in the HashTable */
     zval zv;
     ZVAL_STRING(&zv, ZSTR_VAL(v));
 
-    if (zend_hash_update(span->labels, zend_string_copy(k), &zv) == NULL) {
+    if (zend_hash_update(span->attributes, zend_string_copy(k), &zv) == NULL) {
         return FAILURE;
     } else {
         return SUCCESS;
     }
 }
 
-/* Add a single label to the provided trace span struct */
-int opencensus_trace_span_add_label_str(opencensus_trace_span_t *span, char *k, zend_string *v)
+/* Add a single attribute to the provided trace span struct */
+int opencensus_trace_span_add_attribute_str(opencensus_trace_span_t *span, char *k, zend_string *v)
 {
-    return opencensus_trace_span_add_label(span, zend_string_init(k, strlen(k), 0), v);
+    return opencensus_trace_span_add_attribute(span, zend_string_init(k, strlen(k), 0), v);
 }
 
 /* Update the provided span with the provided zval (array) of span options */
@@ -348,8 +348,8 @@ int opencensus_trace_span_apply_span_options(opencensus_trace_span_t *span, zval
     zval *v;
 
     ZEND_HASH_FOREACH_STR_KEY_VAL(Z_ARR_P(span_options), k, v) {
-        if (strcmp(ZSTR_VAL(k), "labels") == 0) {
-            zend_hash_merge(span->labels, Z_ARRVAL_P(v), zval_add_ref, 0);
+        if (strcmp(ZSTR_VAL(k), "attributes") == 0) {
+            zend_hash_merge(span->attributes, Z_ARRVAL_P(v), zval_add_ref, 0);
         } else if (strcmp(ZSTR_VAL(k), "startTime") == 0) {
             span->start = Z_DVAL_P(v);
         } else if (strcmp(ZSTR_VAL(k), "name") == 0) {

ext/opencensus_trace_span.h

@@ -38,11 +38,11 @@ typedef struct opencensus_trace_span_t {
     zend_long kind;
 
     // zend_string* => zval*
-    HashTable *labels;
+    HashTable *attributes;
 } opencensus_trace_span_t;
 
-int opencensus_trace_span_add_label(opencensus_trace_span_t *span, zend_string *k, zend_string *v);
-int opencensus_trace_span_add_label_str(opencensus_trace_span_t *span, char *k, zend_string *v);
+int opencensus_trace_span_add_attribute(opencensus_trace_span_t *span, zend_string *k, zend_string *v);
+int opencensus_trace_span_add_attribute_str(opencensus_trace_span_t *span, char *k, zend_string *v);
 int opencensus_trace_span_apply_span_options(opencensus_trace_span_t *span, zval *span_options);
 opencensus_trace_span_t *opencensus_trace_span_alloc();
 void opencensus_trace_span_free(opencensus_trace_span_t *span);

ext/package.xml

@@ -66,7 +66,7 @@ This extension allows you to easily gather latency and other metadata by watchin
     <file name="function_kind_default.phpt" role="test" />
     <file name="function_kind_specified.phpt" role="test" />
     <file name="inherit_context.phpt" role="test" />
-    <file name="labels.phpt" role="test" />
+    <file name="attributes.phpt" role="test" />
     <file name="manual_spans.phpt" role="test" />
     <file name="manual_spans_default_options.phpt" role="test" />
     <file name="many_spans_test.phpt" role="test" />
@@ -80,11 +80,11 @@ This extension allows you to easily gather latency and other metadata by watchin
     <file name="method_kind_specified.phpt" role="test" />
     <file name="module_callback_static_string.phpt" role="test" />
     <file name="nested_spans.phpt" role="test" />
-    <file name="non-string-labels-function-callback.phpt" role="test" />
-    <file name="non-string-labels-function.phpt" role="test" />
-    <file name="non-string-labels-method-callback.phpt" role="test" />
-    <file name="non-string-labels-method.phpt" role="test" />
-    <file name="non-string-labels.phpt" role="test" />
+    <file name="non-string-attributes-function-callback.phpt" role="test" />
+    <file name="non-string-attributes-function.phpt" role="test" />
+    <file name="non-string-attributes-method-callback.phpt" role="test" />
+    <file name="non-string-attributes-method.phpt" role="test" />
+    <file name="non-string-attributes.phpt" role="test" />
     <file name="span_class.phpt" role="test" />
     <file name="static_method_callback_scope.phpt" role="test" />
     <file name="static_method_test.phpt" role="test" />

ext/span.php

@@ -32,7 +32,7 @@ class Span {
     protected $parentSpanId;
     protected $startTime;
     protected $endTime;
-    protected $labels;
+    protected $attributes;
     protected $kind;
 
     public function __construct(array $spanOptions)
@@ -67,9 +67,9 @@ public function endTime()
         return $this->endTime;
     }
 
-    public function labels()
+    public function attributes()
     {
-        return $this->labels;
+        return $this->attributes;
     }
 
     public function kind()

ext/tests/basic_class_function.phpt

@@ -24,7 +24,7 @@ echo "Span startTime is a double: $test\n";
 $test = gettype($span->endTime()) == 'double';
 echo "Span endTime is a double: $test\n";
 
-var_dump($span->labels());
+var_dump($span->attributes());
 
 ?>
 --EXPECT--

ext/tests/basic_function.phpt

@@ -23,7 +23,7 @@ echo "Span startTime is a double: $test\n";
 $test = gettype($span->endTime()) == 'double';
 echo "Span endTime is a double: $test\n";
 
-var_dump($span->labels());
+var_dump($span->attributes());
 ?>
 --EXPECT--
 Number of traces: 1

ext/tests/closure_exeception.phpt

@@ -8,7 +8,7 @@ require_once(__DIR__ . '/common.php');
 opencensus_trace_function("foo", function ($x) {
     // should be an exception
     echo $x->bar();
-    return ['name' => 'foo', 'startTime' => 0.1, 'labels' => ['asdf' => 'qwer' . $x, 'zxcv' => 'jkl;']];
+    return ['name' => 'foo', 'startTime' => 0.1, 'attributes' => ['asdf' => 'qwer' . $x, 'zxcv' => 'jkl;']];
 });
 foo(3);
 ?>