Support Zipkin v2 Span format

examples/grpc_greeter/greeter_server.cc

@@ -77,7 +77,7 @@ struct GreeterServiceImpl final : public Greeter::Service
 };
 
 DEFINE_string(grpc_addr, "localhost:50051", "GRPC server address");
-DEFINE_string(collector_uri, "", "Collector URI for tracing");
+DEFINE_string(collector_uri, "http://localhost:9411/zipkin/api/v1", "Collector URI for tracing");
 
 void RunServer(std::shared_ptr<zipkin::Collector> collector)
 {

examples/simple_proxy/main.c

@@ -192,6 +192,7 @@ void forward_http_request(struct mg_connection *nc, struct http_message *hm, zip
     else if (0 == mg_vcmp(hn, ZIPKIN_X_SPAN_ID))
     {
       zipkin_span_set_parent_id(span, strtoull(hv->p, NULL, 16));
+      zipkin_span_set_shared(span, 1);
     }
     else
     {
@@ -273,6 +274,7 @@ void reply_json_response(struct mg_connection *nc, struct http_message *hm, zipk
     else if (0 == mg_vcmp(hn, ZIPKIN_X_SPAN_ID))
     {
       zipkin_span_set_parent_id(span, strtoull(hv->p, NULL, 16));
+      zipkin_span_set_shared(span, 1);
     }
     else if (0 == mg_vcmp(hn, ZIPKIN_X_SAMPLED))
     {
@@ -573,4 +575,4 @@ int main(int argc, char **argv)
   }
 
   return 0;
-}
+}

include/zipkin.h

@@ -124,6 +124,9 @@ zipkin_span_t zipkin_span_parse_trace_id(zipkin_span_t span, const char *str, si
 int zipkin_span_debug(zipkin_span_t span);
 zipkin_span_t zipkin_span_set_debug(zipkin_span_t span, int debug);
 
+int zipkin_span_shared(zipkin_span_t span);
+zipkin_span_t zipkin_span_set_shared(zipkin_span_t span, int shared);
+
 int zipkin_span_sampled(zipkin_span_t span);
 zipkin_span_t zipkin_span_set_sampled(zipkin_span_t span, int sampled);
 
@@ -297,4 +300,4 @@ struct curl_slist *zipkin_propagation_inject_curl_headers(struct curl_slist *hea
 
 #ifdef __cplusplus
 }
-#endif
+#endif

src/CApi.cpp

@@ -154,6 +154,17 @@ zipkin_span_t zipkin_span_set_debug(zipkin_span_t span, int debug)
 
     return span;
 }
+int zipkin_span_shared(zipkin_span_t span)
+{
+    return span ? static_cast<zipkin::Span *>(span)->shared() : false;
+}
+zipkin_span_t zipkin_span_set_shared(zipkin_span_t span, int shared)
+{
+    if (span)
+        static_cast<zipkin::Span *>(span)->with_shared(shared);
+
+    return span;
+}
 int zipkin_span_sampled(zipkin_span_t span)
 {
     return span ? static_cast<zipkin::Span *>(span)->sampled() : false;
@@ -568,4 +579,4 @@ struct curl_slist *zipkin_propagation_inject_curl_headers(struct curl_slist *hea
 
 #ifdef __cplusplus
 }
-#endif
+#endif

src/Collector.cpp

@@ -21,6 +21,8 @@ namespace zipkin
 std::shared_ptr<BinaryCodec> MessageCodec::binary(new BinaryCodec());
 std::shared_ptr<JsonCodec> MessageCodec::json(new JsonCodec());
 std::shared_ptr<PrettyJsonCodec> MessageCodec::pretty_json(new PrettyJsonCodec());
+std::shared_ptr<JsonCodec> MessageCodec::json_v2(new JsonCodec(2));
+std::shared_ptr<PrettyJsonCodec> MessageCodec::pretty_json_v2(new PrettyJsonCodec(2));
 
 CompressionCodec parse_compression_codec(const std::string &codec)
 {
@@ -57,7 +59,10 @@ std::shared_ptr<MessageCodec> MessageCodec::parse(const std::string &codec)
         return json;
     if (codec == "pretty_json")
         return pretty_json;
-
+    if (codec == "json_v2")
+        return json_v2;
+    if (codec == "pretty_json_v2")
+        return pretty_json_v2;
     return nullptr;
 }
 
@@ -85,7 +90,13 @@ size_t JsonCodec::encode(boost::shared_ptr<apache::thrift::transport::TMemoryBuf
 
     for (auto &span : spans)
     {
-        span->serialize_json(writer);
+        if (m_format_version > 1) {
+            for (auto &span2: __impl::Span2::from_span(span)) {
+                span2.serialize_json(writer);
+            }
+        } else {
+            span->serialize_json(writer);
+        }
     }
 
     writer.EndArray();
@@ -105,7 +116,13 @@ size_t PrettyJsonCodec::encode(boost::shared_ptr<apache::thrift::transport::TMem
 
     for (auto &span : spans)
     {
-        span->serialize_json(writer);
+        if (m_format_version > 1) {
+            for (auto &span2: __impl::Span2::from_span(span)) {
+                span2.serialize_json(writer);
+            }
+        } else {
+            span->serialize_json(writer);
+        }
     }
 
     writer.EndArray();

src/Collector.h

@@ -4,6 +4,7 @@
 #include <atomic>
 #include <thread>
 #include <mutex>
+
 #include <condition_variable>
 
 #include <boost/lockfree/queue.hpp>
@@ -54,6 +55,8 @@ class MessageCodec
   static std::shared_ptr<BinaryCodec> binary;
   static std::shared_ptr<JsonCodec> json;
   static std::shared_ptr<PrettyJsonCodec> pretty_json;
+  static std::shared_ptr<JsonCodec> json_v2;
+  static std::shared_ptr<PrettyJsonCodec> pretty_json_v2;
 };
 
 /**
@@ -74,8 +77,13 @@ class BinaryCodec : public MessageCodec
 */
 class JsonCodec : public MessageCodec
 {
+  int m_format_version;
 public:
-  virtual const std::string name(void) const override { return "json"; }
+  JsonCodec(int format_version = 1) : m_format_version(format_version) {}
+
+  virtual const std::string name(void) const override {
+    return m_format_version > 1 ? "json_v2" : "json";
+  }
 
   virtual const std::string mime_type(void) const override { return "application/json"; }
 
@@ -87,8 +95,13 @@ class JsonCodec : public MessageCodec
 */
 class PrettyJsonCodec : public MessageCodec
 {
+  int m_format_version;
 public:
-  virtual const std::string name(void) const override { return "pretty_json"; }
+  PrettyJsonCodec(int format_version = 1) : m_format_version(format_version) {}
+
+  virtual const std::string name(void) const override {
+    return m_format_version > 1 ? "pretty_json_v2" : "pretty_json";
+  }
 
   virtual const std::string mime_type(void) const override { return "application/json"; }
 

src/Propagation.cpp

@@ -112,7 +112,8 @@ void Propagation::extract(grpc::ServerContext &context, Span &span)
         }
         else if (item.first == ZIPKIN_X_SPAN_ID_LOWERCASE)
         {
-            span.with_parent_id(folly::to<uint64_t>(value));
+            span.with_parent_id(folly::to<uint64_t>(value))
+                .with_shared(true);
         }
         else if (item.first == ZIPKIN_X_SAMPLED_LOWERCASE)
         {
@@ -127,4 +128,4 @@ void Propagation::extract(grpc::ServerContext &context, Span &span)
 
 #endif // WITH_GRPC
 
-} // namespace zipkin
+} // namespace zipkin