zipkin-tracer 0.14.1 → 0.15.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ZjE3ZmE0ZGY1MGU1MDM0MjQ5Y2M2NTdjYjQ4ZTE3ODkzODNhN2IzMQ==
+    YmU1ZjgyYTNmNWYzZDQ3N2VjMTFiMGYwZDA1ZmRkZWY5NWE1YTc3Ng==
   data.tar.gz: !binary |-
-    ZGQwMzJlOTQwYWU3ZjQ0Nzk0MjA1MWMzZGYzZGMxOTVlMjNlNmU1Zg==
+    ZTNhNDM3NTU0ZTAzMTgxZGFhN2I3NmIzODYyZThkYTFmNGEzMmE4Nw==
 SHA512:
   metadata.gz: !binary |-
-    YmQ4NjI1ODIzYzYwYmI5ZjdlNjNkNTQ3NDE5MDRkMzBmOWVlMDM3ZGRhMzJi
-    YjMzYTI4ZDQxOWMyMDg3NWZmYTA5OTBkZjlmNWQ5M2JlNDZkN2IwMDBhMzk5
-    MjkwOGU1YzE4MzZjMzUyMDE1MDAwZDhiYjY0MTk3ZGFmOWQzOTE=
+    OTFmOTc1NDAxZGM3NWE0MDUxNWVmZjVmNzlkZDY2N2FlMTU0ZWIwOGZkMzFl
+    NzJiODJiNGNkMWFkNDJjN2YzZDJkODUyZTA0MDQ1MDYxNjdjMDA4MTFhZWNl
+    NjgxYjRiYjc3YzZkODRlZDJiNThkZTFlODE3MTIxMWFmOGY1NGQ=
   data.tar.gz: !binary |-
-    MTNiYmY4ZGRhNGVjNzA3MDkzNGE3OTBiZTJmZDhjOWRmN2FlYzM1N2RkZGZl
-    ZmI1MjBiNGQ0ZWExYmVlODllZTg2NzIyZGE2YjU3MDlhOTIwNGQwZTg2NGE3
-    ZDJlN2JkZGNmNDk5OTI1NjhkYTBiM2U3NzhjM2YxZDE0YTJlZjc=
+    OGI0NjFkODBiMzRhZDBmMTc2M2ViYzBmOWFkMGEyNmE1YTU4MTU2MDA2MGU0
+    Njc4NjRmMDNjMTBhNGMwZWRiMmI2NmIxNzcwMjAxMGU3YWYzNGZjYmFiOTZi
+    ZDQzYjRkMjQ3ZTU3Nzc0OGVmNzUxY2ViZTIyZDE3NGRjYTRhYmU=

data/lib/zipkin-tracer/hostname_resolver.rb

@@ -0,0 +1,63 @@
+module ZipkinTracer
+  # Resolves hostnames in the endpoints of the annotations.
+  # Resolving hostnames is a very expensive operation. We want to store them raw in the main thread
+  # and resolve them in a different thread where we do not affect execution times.
+  class HostnameResolver
+    def spans_with_ips(spans)
+      host_to_ip = hosts_to_ipv4(spans)
+
+      each_annotation(spans) do |annotation|
+        hostname = annotation.host.ipv4
+        if hostname.to_s =~ /\A[a-zA-Z]/ # hostnames start with letters, else we already have an IP
+          annotation.host.ipv4 = host_to_ip[hostname]
+        end
+      end
+    end
+
+    private
+    LOCALHOST = '127.0.0.1'.freeze
+    LOCALHOST_I32 = 0x7f000001.freeze
+    IP_FIELD = 3
+
+    def each_annotation(spans, &block)
+      spans.each do |span|
+        span.annotations.each do |annotation|
+          yield annotation
+        end
+        span.binary_annotations.each do |annotation|
+          yield annotation
+        end
+      end
+    end
+
+    # Annotations come in pairs like CS/CR, SS/SR.
+    # Each annnotation has a hostname so we, for sure, will have the same host multiple times.
+    # Using this to resolve only once per host
+    def hosts_to_ipv4(spans)
+      hosts = []
+      each_annotation(spans) do |annotation|
+        hosts.push(annotation.host)
+      end
+      hosts.uniq!
+      resolve(hosts)
+    end
+
+    def resolve(hosts)
+      hosts.inject({}) do |host_map, host|
+        hostname = host.ipv4  # This field has been temporarly used to store the hostname.
+        ip_format = host.ip_format
+        host_map[hostname]  = host_to_ip(hostname, ip_format)
+        host_map
+      end
+    end
+
+    def host_to_ip(hostname, ip_format)
+      ipv4 = begin
+        ip_format == :string ? Socket.getaddrinfo(hostname, nil, :INET).first[IP_FIELD] : Trace::Endpoint.host_to_i32(hostname)
+      rescue
+        ip_format == :string ? LOCALHOST : LOCALHOST_I32
+      end
+    end
+  end
+
+end

data/lib/zipkin-tracer/rack/zipkin-tracer.rb

@@ -26,7 +26,6 @@ module ZipkinTracer
 
     def initialize(app, config = nil)
       @app = app
-      @lock = Mutex.new
       @config = Config.new(app, config).freeze
       @tracer = TracerFactory.new.tracer(@config)
     end
@@ -52,32 +51,20 @@ module ZipkinTracer
     end
 
     def trace!(span, zipkin_env, &block)
-      synchronize do
-        #if called by a service, the caller already added the information
-        trace_request_information(span, zipkin_env.env) unless zipkin_env.called_with_zipkin_headers?
-        span.record(Trace::Annotation::SERVER_RECV)
-        span.record('whitelisted') if zipkin_env.force_sample?
-      end
+      #if called by a service, the caller already added the information
+      trace_request_information(span, zipkin_env.env) unless zipkin_env.called_with_zipkin_headers?
+      span.record(Trace::Annotation::SERVER_RECV)
+      span.record('whitelisted') if zipkin_env.force_sample?
       status, headers, body = yield
     ensure
-      synchronize do
-        annotate_plugin(zipkin_env.env, status, headers, body)
-        span.record(Trace::Annotation::SERVER_SEND)
-      end
+      annotate_plugin(zipkin_env.env, status, headers, body)
+      span.record(Trace::Annotation::SERVER_SEND)
     end
 
     def trace_request_information(span, env)
       span.record_tag(Trace::BinaryAnnotation::URI, env['PATH_INFO'])
     end
 
-    def synchronize(&block)
-      @lock.synchronize do
-        yield
-      end
-    rescue => e
-      @config.logger.error("Exception #{e.message} while sending Zipkin traces. #{e.backtrace}")
-    end
-
     # Environment with Zipkin information in it
     class ZipkinEnv
       attr_reader :env

data/lib/zipkin-tracer/trace.rb

@@ -38,8 +38,8 @@ module Trace
         traceId: @span_id.trace_id.to_s,
         id: @span_id.span_id.to_s,
         parentId: @span_id.parent_id.nil? ? nil : @span_id.parent_id.to_s,
-        annotations: @annotations.map!(&:to_h),
-        binaryAnnotations: @binary_annotations.map!(&:to_h),
+        annotations: @annotations.map(&:to_h),
+        binaryAnnotations: @binary_annotations.map(&:to_h),
         timestamp: @timestamp,
         duration: @duration,
         debug: @debug
@@ -97,8 +97,6 @@ module Trace
 
   # This class is defined in finagle-thrift. We are adding extra methods here
   class Endpoint
-    LOCALHOST = '127.0.0.1'.freeze
-    LOCALHOST_I32 = 0x7f000001.freeze
     UNKNOWN_URL = 'unknown'.freeze
 
     # we cannot override the initializer to add an extra parameter so use a factory
@@ -124,13 +122,7 @@ module Trace
 
     private
     def self.make_endpoint(hostname, service_port, service_name, ip_format)
-      ipv4 = begin
-        ip_format == :string ? Socket.getaddrinfo(hostname, nil, :INET)[0][3] : host_to_i32(hostname)
-      rescue
-        ip_format == :string ? LOCALHOST : LOCALHOST_I32
-      end
-
-      ep = Endpoint.new(ipv4, service_port, service_name)
+      ep = Endpoint.new(hostname, service_port, service_name)
       ep.ip_format = ip_format
       ep
     end

data/lib/zipkin-tracer/version.rb

@@ -12,5 +12,5 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 module ZipkinTracer
-  VERSION = "0.14.1"
+  VERSION = '0.15.0'.freeze
 end

data/lib/zipkin-tracer/zipkin_json_tracer.rb

@@ -1,16 +1,18 @@
 require 'json'
 require 'sucker_punch'
 require 'zipkin-tracer/zipkin_tracer_base'
+require 'zipkin-tracer/hostname_resolver'
 
 class AsyncJsonApiClient
   include SuckerPunch::Job
   SPANS_PATH = '/api/v1/spans'
 
   def perform(json_api_host, spans)
+    spans_with_ips = ::ZipkinTracer::HostnameResolver.new.spans_with_ips(spans).map(&:to_h)
     resp = Faraday.new(json_api_host).post do |req|
       req.url SPANS_PATH
       req.headers['Content-Type'] = 'application/json'
-      req.body = JSON.generate(spans.map!(&:to_h))
+      req.body = JSON.generate(spans_with_ips)
     end
   rescue => e
     SuckerPunch.logger.error(e)

data/lib/zipkin-tracer/zipkin_kafka_tracer.rb

@@ -1,6 +1,7 @@
 require 'hermann/producer'
 require 'hermann/discovery/zookeeper'
 require 'zipkin-tracer/zipkin_tracer_base'
+require 'zipkin-tracer/hostname_resolver'
 
 module Trace
   # This class sends information to Zipkin through Kafka.
@@ -16,7 +17,8 @@ module Trace
     end
 
     def flush!
-      spans.each do |span|
+      resolved_spans = ::ZipkinTracer::HostnameResolver.new.spans_with_ips(spans)
+      resolved_spans.each do |span|
         buf = ''
         trans = Thrift::MemoryBufferTransport.new(buf)
         oprot = Thrift::BinaryProtocol.new(trans)

data/lib/zipkin-tracer/zipkin_logger_tracer.rb

@@ -1,4 +1,5 @@
 require 'zipkin-tracer/zipkin_tracer_base'
+require 'zipkin-tracer/hostname_resolver'
 
 module Trace
   class ZipkinLoggerTracer < ZipkinTracerBase
@@ -9,7 +10,8 @@ module Trace
     end
 
     def flush!
-      @logger.info("ZIPKIN SPANS: #{spans.map(&:to_h)}")
+      formatted_spans = ::ZipkinTracer::HostnameResolver.new.spans_with_ips(spans).map(&:to_h)
+      @logger.info "ZIPKIN SPANS: #{formatted_spans}"
     end
   end
 end

data/lib/zipkin-tracer/zipkin_scribe_tracer.rb

@@ -1,5 +1,7 @@
 require 'zipkin-tracer/zipkin_tracer_base'
 require 'zipkin-tracer/careless_scribe'
+require 'zipkin-tracer/hostname_resolver'
+
 
 module Trace
   class ScribeTracer < ZipkinTracerBase
@@ -11,8 +13,9 @@ module Trace
     end
 
     def flush!
+      resolved_spans = ::ZipkinTracer::HostnameResolver.new.spans_with_ips(spans)
       @scribe.batch do
-        messages = spans.map do |span|
+        messages = resolved_spans.map do |span|
           buf = ''
           trans = Thrift::MemoryBufferTransport.new(buf)
           oprot = Thrift::BinaryProtocol.new(trans)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zipkin-tracer
 version: !ruby/object:Gem::Version
-  version: 0.14.1
+  version: 0.15.0
 platform: ruby
 authors:
 - Franklin Hu
@@ -13,7 +13,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-12 00:00:00.000000000 Z
+date: 2016-02-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -63,14 +63,14 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.6'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -186,6 +186,7 @@ files:
 - lib/zipkin-tracer/careless_scribe.rb
 - lib/zipkin-tracer/config.rb
 - lib/zipkin-tracer/faraday/zipkin-tracer.rb
+- lib/zipkin-tracer/hostname_resolver.rb
 - lib/zipkin-tracer/rack/zipkin-tracer.rb
 - lib/zipkin-tracer/trace.rb
 - lib/zipkin-tracer/trace_client.rb