PCBC-527: Initial tracing implementation

Change-Id: I43e5e9694f5da2c07f288e657fc772c52ccc7346
Reviewed-on: http://review.couchbase.org/90749
Tested-by: Build Bot <[email protected]>
Reviewed-by: Sergey Avseyev <[email protected]>

Author: avsej

couchbase.h

@@ -173,6 +173,7 @@ zval *bop_get_return_doc(zval *return_value, const char *key, int key_len, int i
 
 #define PCBC_DATE_FORMAT_RFC3339 "Y-m-d\\TH:i:sP"
 
+extern char *pcbc_client_string;
 extern zend_class_entry *pcbc_analytics_query_ce;
 extern zend_class_entry *pcbc_n1ql_query_ce;
 extern zend_class_entry *pcbc_cluster_ce;
@@ -983,6 +984,9 @@ typedef struct {
     int json_options;
     int is_cbas; // FIXME: convert to bit-flags
     PCBC_ZVAL exc;
+#ifdef LCB_TRACING
+    lcbtrace_SPAN *span;
+#endif
 } opcookie;
 
 opcookie *opcookie_init();

src/couchbase/bucket/get.c

@@ -56,6 +56,10 @@ static lcb_error_t proc_get_results(pcbc_bucket_t *bucket, zval *return_value, o
 {
     opcookie_get_res *res;
     lcb_error_t err = LCB_SUCCESS;
+#ifdef LCB_TRACING
+    lcbtrace_SPAN *parent = cookie->span;
+    lcbtrace_TRACER *tracer = lcb_get_tracer(bucket->conn->lcb);
+#endif
 
     // If we are not mapped, we need to throw any op errors
     if (is_mapped == 0) {
@@ -68,8 +72,23 @@ static lcb_error_t proc_get_results(pcbc_bucket_t *bucket, zval *return_value, o
             zval *doc = bop_get_return_doc(return_value, res->key, res->key_len, is_mapped TSRMLS_CC);
 
             if (res->header.err == LCB_SUCCESS) {
+#ifdef LCB_TRACING
+                lcbtrace_SPAN *span = NULL;
+                if (parent) {
+                    lcbtrace_REF ref;
+                    ref.type = LCBTRACE_REF_CHILD_OF;
+                    ref.span = parent;
+                    span = lcbtrace_span_start(tracer, LCBTRACE_OP_RESPONSE_DECODING, LCBTRACE_NOW, &ref);
+                    lcbtrace_span_add_tag_str(span, LCBTRACE_TAG_COMPONENT, pcbc_client_string);
+                }
+#endif
                 pcbc_document_init_decode(doc, bucket, res->bytes, res->bytes_len, res->flags, res->datatype, res->cas,
                                           NULL TSRMLS_CC);
+#ifdef LCB_TRACING
+                if (span) {
+                    lcbtrace_span_finish(span, LCBTRACE_NOW);
+                }
+#endif
             } else {
                 pcbc_document_init_error(doc, &res->header TSRMLS_CC);
             }
@@ -96,10 +115,21 @@ void pcbc_bucket_get(pcbc_bucket_t *obj, pcbc_pp_state *pp_state, pcbc_pp_id *id
     int ii, ncmds, nscheduled;
     opcookie *cookie;
     lcb_error_t err = LCB_SUCCESS;
+#ifdef LCB_TRACING
+    lcbtrace_TRACER *tracer = NULL;
+#endif
 
     ncmds = pcbc_pp_keycount(pp_state);
     cookie = opcookie_init();
 
+#ifdef LCB_TRACING
+    tracer = lcb_get_tracer(obj->conn->lcb);
+    if (tracer) {
+        cookie->span = lcbtrace_span_start(tracer, "get", 0, NULL);
+        lcbtrace_span_add_tag_str(cookie->span, LCBTRACE_TAG_COMPONENT, pcbc_client_string);
+    }
+#endif
+
     nscheduled = 0;
     for (ii = 0; pcbc_pp_next(pp_state); ++ii) {
         lcb_CMDGET cmd = {0};
@@ -115,6 +145,11 @@ void pcbc_bucket_get(pcbc_bucket_t *obj, pcbc_pp_state *pp_state, pcbc_pp_id *id
         }
 
         LCB_CMD_SET_KEY(&cmd, id->str, id->len);
+#ifdef LCB_TRACING
+        if (cookie->span) {
+            LCB_CMD_SET_TRACESPAN(&cmd, cookie->span);
+        }
+#endif
         if (expiry && *expiry) {
             cmd.lock = 0;
             cmd.exptime = Z_LVAL_P(*expiry);
@@ -139,6 +174,11 @@ void pcbc_bucket_get(pcbc_bucket_t *obj, pcbc_pp_state *pp_state, pcbc_pp_id *id
         err = proc_get_results(obj, return_value, cookie, pcbc_pp_ismapped(pp_state) TSRMLS_CC);
     }
 
+#ifdef LCB_TRACING
+    if (cookie->span) {
+        lcbtrace_span_finish(cookie->span, LCBTRACE_NOW);
+    }
+#endif
     opcookie_destroy(cookie);
 
     if (err != LCB_SUCCESS) {
@@ -208,6 +248,9 @@ PHP_METHOD(Bucket, getFromReplica)
     zval *zindex, *zgroupid;
     opcookie *cookie;
     lcb_error_t err = LCB_SUCCESS;
+#ifdef LCB_TRACING
+    lcbtrace_TRACER *tracer = NULL;
+#endif
 
     // Note that groupid is experimental here and should not be used.
     if (pcbc_pp_begin(ZEND_NUM_ARGS() TSRMLS_CC, &pp_state, "id||index,groupid", &id, &zindex, &zgroupid) != SUCCESS) {
@@ -217,6 +260,13 @@ PHP_METHOD(Bucket, getFromReplica)
 
     ncmds = pcbc_pp_keycount(&pp_state);
     cookie = opcookie_init();
+#ifdef LCB_TRACING
+    tracer = lcb_get_tracer(obj->conn->lcb);
+    if (tracer) {
+        cookie->span = lcbtrace_span_start(tracer, "get_from_replica", 0, NULL);
+        lcbtrace_span_add_tag_str(cookie->span, LCBTRACE_TAG_COMPONENT, pcbc_client_string);
+    }
+#endif
 
     nscheduled = 0;
     for (ii = 0; pcbc_pp_next(&pp_state); ++ii) {
@@ -226,6 +276,11 @@ PHP_METHOD(Bucket, getFromReplica)
         PCBC_CHECK_ZVAL_STRING(zgroupid, "groupid must be a string");
 
         LCB_CMD_SET_KEY(&cmd, id.str, id.len);
+#ifdef LCB_TRACING
+        if (cookie->span) {
+            LCB_CMD_SET_TRACESPAN(&cmd, cookie->span);
+        }
+#endif
         if (zindex) {
             cmd.index = Z_LVAL_P(zindex);
             if (cmd.index >= 0) {
@@ -252,6 +307,11 @@ PHP_METHOD(Bucket, getFromReplica)
         err = proc_get_results(obj, return_value, cookie, pcbc_pp_ismapped(&pp_state) TSRMLS_CC);
     }
 
+#ifdef LCB_TRACING
+    if (cookie->span) {
+        lcbtrace_span_finish(cookie->span, LCBTRACE_NOW);
+    }
+#endif
     opcookie_destroy(cookie);
 
     if (err != LCB_SUCCESS) {