zipkin-tracer 0.8.0 → 0.9.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ZmU3ZjM4OTBmOGM0NWRmMjkwNjkzZWY1MmE1ZWM5MWY4OTQ5OGQ3Yw==
+    NGI0MTlmZDJhZWVmMzRjYzA5NjRiZTJiMDljODdiNjg0MjNiZTI4Mg==
   data.tar.gz: !binary |-
-    MzI1NmFiNTEzOGYwYTVlMzk4MDljZDIxYzE5ZGQxY2RmZTc3ZjdiMA==
+    Mjk4ZTcyZWYzNmRhMTE3MTc2OTk4YTYxMDExNTc5M2ZlMWJlNjZjZA==
 SHA512:
   metadata.gz: !binary |-
-    YjNlYTFjZDcyY2IwZDMxMjUwMjNhNzZhZGJmNjk4ODA0ZGIwNWQ2N2NlZDZm
-    ODViMmM1MmM5OWNhNmFlZjIwNzgxOTY4MDhiNjFkMTkxMGVjN2Q0OTQ1MjAx
-    YWM1YzY4Zjg0YjRhODI0NTUxZTdhZDdiMDY3YmRlZmE2MmU0MjU=
+    YzkzZWUwZjY1N2QwM2E3MGNhMjI5MTE2MTRjYzA5ZGI5MWFmOWQzMzliNjRj
+    MmRhMDlhOWFiNTU4ZTVkODI5NmI1ZTU0ZWE4MThmNTA3M2NmNDdjZjgyYTg0
+    MTczMWE4N2E1YzYyOTM5ODY0YjQ3NGRhNmQxYjg2NjZiNDVjOGQ=
   data.tar.gz: !binary |-
-    NDEzMGRmNTBhZWRmYTc0YTc3NDllODkxMDExMWYzODQzMTgwZjg2MTAyNWQz
-    ZjFjYjVjMDAyNGI5NDM3NmNmZTQ4YWUyYmZkYTllYWMwZGNjZjBjZjdhYjgw
-    Nzc1MjM4MjkyY2RmNGFjOGE0OGRhMmFlODhjZmQ4ZGYwNzczYTg=
+    NWVjNjJhMzljZDRkODVkNjc5NjU2MDU0ODRhZmQ0Yjg0OTZiZTIzMTFiNGUz
+    MTYwNTkwMzhkNzU3N2MwZGExZGI4YzNjYzdiNTdkYzI0NzBlNTUwYzAzY2Nj
+    OGFhNzliMGExYWQyZWJhYTFjMzgxODMzMDA3MTNlYWMwMTVhZDk=

data/lib/zipkin-tracer.rb

@@ -1,8 +1,9 @@
 require 'base64' #Bug in finagle. They should be requiring this: finagle-thrift-1.4.1/lib/finagle-thrift/tracer.rb:115
+require 'zipkin-tracer/trace'
 require 'zipkin-tracer/rack/zipkin-tracer'
 
 begin
   require 'faraday'
   require 'zipkin-tracer/faraday/zipkin-tracer'
 rescue LoadError #Faraday is not available, we do not load our code.
-end
+end

data/lib/zipkin-tracer/careless_scribe.rb

@@ -16,7 +16,7 @@ require 'sucker_punch'
 
 
 module ScribeThrift
-  # This is here just for the monkey partching
+  # This is here just for the monkey patching
   class Client
     # This method in the original class was both sending and receiving logs.
     # The original class: https://github.com/twitter/scribe/blob/master/vendor/gen-rb/scribe.rb
@@ -46,12 +46,10 @@ class AsyncScribe
   rescue ThriftClient::NoServersAvailable, Thrift::Exception
     # I couldn't care less
   end
-
 end
 
 # Scribe which rescue thrift errors to avoid them to raise to the client
 class CarelessScribe
-
   def initialize(scribe_server_address)
     @server_address = scribe_server_address
   end
@@ -66,5 +64,4 @@ class CarelessScribe
   rescue ThriftClient::NoServersAvailable, Thrift::Exception
     # I couldn't care less
   end
-
 end

data/lib/zipkin-tracer/config.rb

@@ -2,13 +2,16 @@ require 'logger'
 module ZipkinTracer
 
   class Config
-    attr_reader :service_name, :service_port, :scribe_server, :zookeeper, :sample_rate,
-      :scribe_max_buffer, :annotate_plugin, :filter_plugin, :whitelist_plugin, :logger
+    attr_reader :service_name, :service_port, :json_api_host, :traces_buffer,
+      :scribe_server, :zookeeper, :sample_rate, :scribe_max_buffer, :annotate_plugin,
+      :filter_plugin, :whitelist_plugin, :logger
 
     def initialize(app, config_hash)
       config = config_hash || app_config(app)
       @service_name      = config[:service_name]
       @service_port      = config[:service_port]      || DEFAULTS[:service_port]
+      @json_api_host     = config[:json_api_host]
+      @traces_buffer     = config[:traces_buffer]     || DEFAULTS[:traces_buffer]
       @scribe_server     = config[:scribe_server]
       @zookeeper         = config[:zookeeper]
       @sample_rate       = config[:sample_rate]       || DEFAULTS[:sample_rate]
@@ -19,12 +22,16 @@ module ZipkinTracer
       @logger            = config[:logger]            || fallback_logger
     end
 
-    def using_scribe?
-      !!(@scribe_server && defined?(::Scribe))
-    end
-
-    def using_kafka?
-      !!(@zookeeper && RUBY_PLATFORM == 'java' && defined?(::Hermann))
+    def adapter
+      if !!@json_api_host
+        :json
+      elsif !!(@scribe_server && defined?(::Scribe))
+        :scribe
+      elsif !!(@zookeeper && RUBY_PLATFORM == 'java' && defined?(::Hermann))
+        :kafka
+      else
+        nil
+      end
     end
 
     private
@@ -38,6 +45,7 @@ module ZipkinTracer
     end
 
     DEFAULTS = {
+      traces_buffer: 100,
       scribe_max_buffer: 10,
       sample_rate: 0.1,
       service_port: 80

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

@@ -6,14 +6,14 @@ require 'uri'
 module ZipkinTracer
   class FaradayHandler < ::Faraday::Middleware
     B3_HEADERS = {
-      :trace_id => "X-B3-TraceId",
-      :parent_id => "X-B3-ParentSpanId",
-      :span_id => "X-B3-SpanId",
-      :sampled => "X-B3-Sampled",
-      :flags => "X-B3-Flags"
+      trace_id: 'X-B3-TraceId',
+      parent_id: 'X-B3-ParentSpanId',
+      span_id: 'X-B3-SpanId',
+      sampled: 'X-B3-Sampled',
+      flags: 'X-B3-Flags'
     }.freeze
 
-    def initialize(app, service_name=nil)
+    def initialize(app, service_name = nil)
       @app = app
       @service_name = service_name
     end
@@ -22,7 +22,7 @@ module ZipkinTracer
       # handle either a URI object (passed by Faraday v0.8.x in testing), or something string-izable
       url = env[:url].respond_to?(:host) ? env[:url] : URI.parse(env[:url].to_s)
       local_endpoint = ::Trace.default_endpoint # The rack middleware set this up for us.
-      remote_endpoint = callee_endpoint(url)  # The endpoint we are calling.
+      remote_endpoint = callee_endpoint(url, local_endpoint.ip_format) # The endpoint we are calling.
 
       response = nil
       begin
@@ -33,12 +33,12 @@ module ZipkinTracer
         end
         # annotate with method (GET/POST/etc.) and uri path
         ::Trace.set_rpc_name(env[:method].to_s.downcase)
-        record(::Trace::BinaryAnnotation.new("http.uri", url.path, "STRING", local_endpoint))
-        record(::Trace::BinaryAnnotation.new("sa", "1", "BOOL", remote_endpoint))
+        record(::Trace::BinaryAnnotation.new('http.uri', url.path, 'STRING', local_endpoint))
+        record(::Trace::BinaryAnnotation.new('sa', '1', 'BOOL', remote_endpoint))
         record(::Trace::Annotation.new(::Trace::Annotation::CLIENT_SEND, local_endpoint))
         response = @app.call(env).on_complete do |renv|
           # record HTTP status code on response
-          record(::Trace::BinaryAnnotation.new("http.status", renv[:status].to_s, "STRING", local_endpoint))
+          record(::Trace::BinaryAnnotation.new('http.status', renv[:status].to_s, 'STRING', local_endpoint))
         end
         record(::Trace::Annotation.new(::Trace::Annotation::CLIENT_RECV, local_endpoint))
       ensure
@@ -55,18 +55,9 @@ module ZipkinTracer
       #TODO: if this class some day accepts a config hash, add a logger
     end
 
-    def callee_endpoint(url)
+    def callee_endpoint(url, ip_format)
       service_name = @service_name || url.host.split('.').first || 'unknown' # default to url-derived service name
-      ::Trace::Endpoint.new(host_ip_for(url.host), url.port, service_name)
+      ::Trace::Endpoint.make_endpoint(url.host, url.port, service_name, ip_format)
     end
-
-    # get host IP for specified hostname, catching exceptions
-    def host_ip_for(hostname)
-      ::Trace::Endpoint.host_to_i32(hostname)
-    rescue
-      # default to 0.0.0.0 if lookup fails
-      0x00000000
-    end
-
   end
 end

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

@@ -17,35 +17,49 @@ require 'scribe'
 
 require 'zipkin-tracer/config'
 require 'zipkin-tracer/careless_scribe'
+require 'zipkin-tracer/zipkin_json_tracer'
 
 if RUBY_PLATFORM == 'java'
   require 'hermann/producer'
   require 'zipkin-tracer/zipkin_kafka_tracer'
 end
 
+
 module ZipkinTracer extend self
 
   class RackHandler
     B3_REQUIRED_HEADERS = %w[HTTP_X_B3_TRACEID HTTP_X_B3_PARENTSPANID HTTP_X_B3_SPANID HTTP_X_B3_SAMPLED]
     B3_OPT_HEADERS = %w[HTTP_X_B3_FLAGS]
 
-    def initialize(app, config=nil)
+    def initialize(app, config = nil)
       @app = app
       @lock = Mutex.new
 
       config = Config.new(app, config)
-
-      ::Trace.tracer = if config.using_scribe?
-        ::Trace::ZipkinTracer.new(CarelessScribe.new(config.scribe_server), config.scribe_max_buffer)
-      elsif config.using_kafka?
-        kafkaTracer = ::Trace::ZipkinKafkaTracer.new
-        kafkaTracer.connect(config.zookeeper)
-        kafkaTracer
-      else
-        ::Trace::NullTracer.new
+      SuckerPunch.logger = config.logger
+      adapter = config.adapter
+
+      ::Trace.tracer = case adapter
+        when :json
+          ::Trace::ZipkinJsonTracer.new(config.json_api_host, config.traces_buffer)
+        when :scribe
+          ::Trace::ZipkinTracer.new(CarelessScribe.new(config.scribe_server), config.scribe_max_buffer)
+        when :kafka
+          kafkaTracer = ::Trace::ZipkinKafkaTracer.new
+          kafkaTracer.connect(config.zookeeper)
+          kafkaTracer
+        else
+          ::Trace::NullTracer.new
       end
-      ::Trace.default_endpoint = ::Trace::Endpoint.new( local_ip, config.service_port , config.service_name)
-      ::Trace.sample_rate=(config.sample_rate)
+
+      ip_format = config.adapter == :json ? :string : :i32
+      ::Trace.default_endpoint = ::Trace::Endpoint.make_endpoint(
+        nil, # auto detect hostname
+        config.service_port,
+        service_name(config.service_name),
+        ip_format
+      )
+      ::Trace.sample_rate = config.sample_rate
 
       @config = config
     end
@@ -53,6 +67,7 @@ module ZipkinTracer extend self
     def call(env)
       # skip certain requests
       return @app.call(env) if filtered?(env) || !routable_request?(env)
+
       whitelisted = force_sample?(env)
       id = get_or_create_trace_id(env, whitelisted) # note that this depends on the sample rate being set
       tracing_filter(id, env, whitelisted) { @app.call(env) }
@@ -60,10 +75,15 @@ module ZipkinTracer extend self
 
     private
 
+    # Use the Domain environment variable to extract the service name, otherwise use the default config name
+    def service_name(default_name)
+      ENV["DOMAIN"].to_s.empty? ? default_name : ENV["DOMAIN"].split('.').first
+    end
+
     # If the request is not valid for this service, we do not what to trace it.
     def routable_request?(env)
-      return true unless defined?(Rails) #If not running on a Rails app, we can't verify if it is invalid
-      Rails.application.routes.recognize_path(env["PATH_INFO"])
+      return true unless defined?(Rails) # If not running on a Rails app, we can't verify if it is invalid
+      Rails.application.routes.recognize_path(env['PATH_INFO'])
       true
     rescue ActionController::RoutingError
       false
@@ -81,7 +101,7 @@ module ZipkinTracer extend self
       @config.whitelist_plugin && @config.whitelist_plugin.call(env)
     end
 
-    def tracing_filter(trace_id, env, whitelisted=false)
+    def tracing_filter(trace_id, env, whitelisted = false)
       synchronize do
         ::Trace.push(trace_id)
         #if called by a service, the caller already added the information
@@ -99,11 +119,9 @@ module ZipkinTracer extend self
       [status, headers, body]
     end
 
-    private
-
     def add_request_information(env)
-      ::Trace.set_rpc_name(env["REQUEST_METHOD"].to_s.downcase) # get/post and all that jazz
-      ::Trace.record(::Trace::BinaryAnnotation.new("http.uri", env["PATH_INFO"], "STRING", ::Trace.default_endpoint))
+      ::Trace.set_rpc_name(env['REQUEST_METHOD'].to_s.downcase) # get/post and all that jazz
+      ::Trace.record(::Trace::BinaryAnnotation.new('http.uri', env['PATH_INFO'], 'STRING', ::Trace.default_endpoint))
     end
 
     def called_with_zipkin_headers?(env)
@@ -114,8 +132,8 @@ module ZipkinTracer extend self
       @lock.synchronize do
         yield
       end
-    # Nothing wonky that the tracer does should stop us from using the app!!!
-    # Usually is better to rescue StandardError but the socket layer can launch Errno kind of exceptions
+      # Nothing wonky that the tracer does should stop us from using the app!!!
+      # Usually is better to rescue StandardError but the socket layer can launch Errno kind of exceptions
     rescue Exception => e
       @config.logger.error("Exception #{e.message} while sending Zipkin traces. #{e.backtrace}")
     end
@@ -125,23 +143,14 @@ module ZipkinTracer extend self
                            env.values_at(*B3_REQUIRED_HEADERS)
                          else
                            new_id = Trace.generate_id
-                           [new_id, nil, new_id, ("true" if whitelisted || Trace.should_sample?)]
+                           [new_id, nil, new_id, ('true' if whitelisted || Trace.should_sample?)]
                          end
-      trace_parameters[3] = (trace_parameters[3] == "true")
+      trace_parameters[3] = (trace_parameters[3] == 'true')
 
       trace_parameters += env.values_at(*B3_OPT_HEADERS) # always check flags
       trace_parameters[4] = (trace_parameters[4] || default_flags).to_i
 
       Trace::TraceId.new(*trace_parameters)
     end
-
-    def local_ip
-      ::Trace::Endpoint.host_to_i32(Socket.gethostname)
-    rescue
-      # Default to local if lockup fails
-      ::Trace::Endpoint.host_to_i32('127.0.0.1')
-    end
-
   end
-
 end

data/lib/zipkin-tracer/trace.rb

@@ -0,0 +1,67 @@
+require 'finagle-thrift'
+require 'finagle-thrift/trace'
+
+module Trace
+  class Span
+    def to_h
+      {
+        name: @name,
+        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),
+        debug: @debug
+      }
+    end
+  end
+
+  class Annotation
+    def to_h
+      {
+        value: @value,
+        timestamp: @timestamp,
+        endpoint: host.to_h
+      }
+    end
+  end
+
+  class BinaryAnnotation
+    def to_h
+      {
+        key: @key,
+        value: @value,
+        endpoint: host.to_h
+      }
+    end
+  end
+
+  class Endpoint
+    LOCALHOST = '127.0.0.1'
+    LOCALHOST_I32 = 0x7f000001
+
+    attr_accessor :ip_format
+
+    # we cannot override the initializer to add an extra parameter so use a factory
+    def self.make_endpoint(hostname, service_port, service_name, ip_format)
+      ipv4 = begin
+        hostname ||= Socket.gethostname
+        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.ip_format = ip_format
+      ep
+    end
+
+    def to_h
+      {
+        ipv4: ipv4,
+        port: port,
+        serviceName: service_name
+      }
+    end
+  end
+end

data/lib/zipkin-tracer/version.rb

@@ -12,6 +12,6 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 module ZipkinTracer
-  VERSION = "0.8.0"
+  VERSION = "0.9.0"
 end
 

data/lib/zipkin-tracer/zipkin_json_tracer.rb

@@ -0,0 +1,73 @@
+require 'json'
+require 'faraday'
+require 'finagle-thrift'
+require 'finagle-thrift/tracer'
+
+class AsyncJsonApiClient
+  include SuckerPunch::Job
+  SPANS_PATH = '/api/v1/spans'
+
+  def perform(json_api_host, spans)
+    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))
+    end
+  rescue => e
+    SuckerPunch.logger.error(e)
+  end
+end
+
+module Trace
+  class ZipkinJsonTracer < Tracer
+    TRACER_CATEGORY = "zipkin".freeze
+
+    def initialize(json_api_host, traces_buffer)
+      @json_api_host = json_api_host
+      @traces_buffer = traces_buffer
+      reset
+    end
+
+    def record(id, annotation)
+      return unless id.sampled?
+      span = get_span_for_id(id)
+
+      case annotation
+      when BinaryAnnotation
+        span.binary_annotations << annotation
+      when Annotation
+        span.annotations << annotation
+      end
+
+      @count += 1
+      if @count >= @traces_buffer || (annotation.is_a?(Annotation) && annotation.value == Annotation::SERVER_SEND)
+        flush!
+      end
+    end
+
+    def set_rpc_name(id, name)
+      return unless id.sampled?
+      span = get_span_for_id(id)
+      span.name = name.to_s
+    end
+
+    private
+
+    def get_span_for_id(id)
+      key = id.span_id.to_s
+      @spans[key] ||= begin
+        Span.new("", id)
+      end
+    end
+
+    def reset
+      @count = 0
+      @spans = {}
+    end
+
+    def flush!
+      AsyncJsonApiClient.new.async.perform(@json_api_host, @spans.values.dup)
+      reset
+    end
+  end
+end

metadata

@@ -1,16 +1,19 @@
 --- !ruby/object:Gem::Specification
 name: zipkin-tracer
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.9.0
 platform: ruby
 authors:
 - Franklin Hu
 - R Tyler Croy
 - James Way
+- Jordi Polo
+- Julien Feltesse
+- Scott Steeg
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-22 00:00:00.000000000 Z
+date: 2015-12-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: finagle-thrift
@@ -124,6 +127,34 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.22'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.22'
 - !ruby/object:Gem::Dependency
   name: hermann
   requirement: !ruby/object:Gem::Requirement
@@ -157,6 +188,9 @@ email:
 - franklin@twitter.com
 - tyler@monkeypox.org
 - jamescway@gmail.com
+- jcarres@mdsol.com
+- jfeltesse@mdsol.com
+- ssteeg@mdsol.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -166,7 +200,9 @@ files:
 - lib/zipkin-tracer/config.rb
 - lib/zipkin-tracer/faraday/zipkin-tracer.rb
 - lib/zipkin-tracer/rack/zipkin-tracer.rb
+- lib/zipkin-tracer/trace.rb
 - lib/zipkin-tracer/version.rb
+- lib/zipkin-tracer/zipkin_json_tracer.rb
 - lib/zipkin-tracer/zipkin_kafka_tracer.rb
 homepage: https://github.com/openzipkin/zipkin-tracer
 licenses: []