zipkin 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 253ec789b0311c2a35709b958e1f5fd3e026b043
-  data.tar.gz: 0367fc35f6be4d5da713bc72bddd425ee0fefca4
+  metadata.gz: 4226e47ea8224eeffa7ed8cd4e48e61cc26da790
+  data.tar.gz: f7ab917023ea03c1660d3f218b1e6f56147da8be
 SHA512:
-  metadata.gz: 3a2a52800b14c3976e9e8ca384fc697fc153d6f1ded256fc698ae22c39d7f2bf991400c518440286c72836743b6db6f42b707e2ba20e364c1a3bb0e7ab7b6da6
-  data.tar.gz: 5c2afbb1f91211202b65b4be3f0ca5a228a0180669a442d376a527c63d62a008d9a776cdbc085013068331ba6de4fc9425d51bfeaf9efd1d16c6080b4751fea7
+  metadata.gz: 7ad6f2ce25802dfd4fca0191a52ef6653887894571f2571663c6ccfa559a9f7241581acd7ceae158040e8056cf95c4016db83883b880077956e45caee9fca109
+  data.tar.gz: 5165e5c4d02358d9a8a996baa398450975fb04d542e961464730cb1c58ec287fcf2a66676a1661311f4b4190f50d52f2f0df0dc6b4933fcab0642d79ab777132

data/README.md

@@ -2,6 +2,10 @@
 
 OpenTracing Tracer implementation for Zipkin in Ruby
 
+## Requirements
+
+Zipkin version >= 2.0.0
+
 ## Installation
 
 Add this line to your application's Gemfile:

data/lib/zipkin/collector.rb

@@ -18,37 +18,28 @@ module Zipkin
       finish_ts = Timestamp.create(end_time)
       start_ts = Timestamp.create(span.start_time)
       duration = finish_ts - start_ts
-      is_server = %w[server consumer].include?(span.tags['span.kind'] || 'server')
 
       @buffer << {
         traceId: span.context.trace_id,
         id: span.context.span_id,
         parentId: span.context.parent_id,
         name: span.operation_name,
+        kind: (span.tags['span.kind'] || 'SERVER').upcase,
         timestamp: start_ts,
         duration: duration,
-        annotations: LogAnnotations.build(span, @local_endpoint) + [
-          {
-            timestamp: start_ts,
-            value: is_server ? 'sr' : 'cs',
-            endpoint: @local_endpoint
-          },
-          {
-            timestamp: finish_ts,
-            value: is_server ? 'ss' : 'cr',
-            endpoint: @local_endpoint
-          }
-        ],
-        binaryAnnotations: build_binary_annotations(span)
+        debug: false,
+        shared: false,
+        localEndpoint: @local_endpoint,
+        remoteEndpoint: Endpoint.remote_endpoint(span),
+        annotations: LogAnnotations.build(span),
+        tags: build_tags(span)
       }
     end
 
     private
 
-    def build_binary_annotations(span)
-      span.tags.map do |name, value|
-        { key: name, value: value.to_s }
-      end
+    def build_tags(span)
+      span.tags.map { |key, value| [key.to_s, value.to_s] }.to_h
     end
 
     class Buffer

data/lib/zipkin/collector/log_annotations.rb

@@ -1,12 +1,11 @@
 module Zipkin
   class Collector
     module LogAnnotations
-      def self.build(span, endpoint)
+      def self.build(span)
         span.logs.map do |log|
           {
             timestamp: Timestamp.create(log.fetch(:timestamp)),
-            value: format_log_value(log),
-            endpoint: endpoint
+            value: format_log_value(log)
           }
         end
       end

data/lib/zipkin/endpoint.rb

@@ -7,11 +7,53 @@ module Zipkin
       Socket.ip_address_list.reverse.detect(&:ipv4?)
     ).ip_address
 
+    module SpanKind
+      SERVER = 'server'.freeze
+      CLIENT = 'client'.freeze
+      PRODUCER = 'producer'.freeze
+      CONSUMER = 'consumer'.freeze
+    end
+
+    module PeerInfo
+      SERVICE = 'peer.service'.freeze
+      IPV4 = 'peer.ipv4'.freeze
+      IPV6 = 'peer.ipv6'.freeze
+      PORT = 'peer.port'.freeze
+
+      def self.keys
+        [SERVICE, IPV4, IPV6, PORT]
+      end
+    end
+
     def self.local_endpoint(service_name)
       {
         serviceName: service_name,
         ipv4: LOCAL_IP
       }
     end
+
+    def self.remote_endpoint(span)
+      tags = span.tags
+      kind = tags['span.kind'] || SpanKind::SERVER
+
+      case kind
+      when SpanKind::SERVER, SpanKind::CLIENT
+        return nil if (tags.keys & PeerInfo.keys).empty?
+
+        {
+          serviceName: tags[PeerInfo::SERVICE],
+          ipv4: tags[PeerInfo::IPV4],
+          ipv6: tags[PeerInfo::IPV6],
+          port: tags[PeerInfo::PORT]
+        }
+      when SpanKind::PRODUCER, SpanKind::CONSUMER
+        {
+          serviceName: 'broker'
+        }
+      else
+        warn "Unkown span kind: #{kind}"
+        nil
+      end
+    end
   end
 end

data/lib/zipkin/json_client.rb

@@ -7,7 +7,7 @@ module Zipkin
     def initialize(url:, collector:, flush_interval:, logger: Logger.new(STDOUT))
       @collector = collector
       @flush_interval = flush_interval
-      @spans_uri = URI.parse("#{url}/api/v1/spans")
+      @spans_uri = URI.parse("#{url}/api/v2/spans")
       @logger = logger
     end
 

data/lib/zipkin/span_context.rb

@@ -28,5 +28,16 @@ module Zipkin
     def sampled?
       @sampled
     end
+
+    # NOTE: This method is not defined in OpenTracing Ruby spec. Use with
+    # caution.
+    def to_h
+      {
+        span_id: @span_id,
+        parent_id: @parent_id,
+        trace_id: @trace_id,
+        sampled: @sampled
+      }
+    end
   end
 end

data/script/create_trace

@@ -12,7 +12,9 @@ tracer2 = Zipkin::Tracer.build(url: url, service_name: 'downstream-service')
 
 outer_span = tracer1.start_span(
   'receive request',
-  tags: { 'span.kind' => 'server' }
+  tags: {
+    'span.kind' => 'server'
+  }
 )
 sleep 1
 

data/zipkin.gemspec

@@ -3,7 +3,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = 'zipkin'
-  spec.version       = '1.2.0'
+  spec.version       = '1.3.0'
   spec.authors       = ['SaleMove TechMovers']
   spec.email         = ['techmovers@salemove.com']
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zipkin
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - SaleMove TechMovers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-13 00:00:00.000000000 Z
+date: 2018-05-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler