zipkin-tracer 0.11.0 → 0.12.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    MmU0MDJhYzQxZGM5ODVkZmI0NzliYzI3MGQ0MmRhYjUyNmRhNjE2MQ==
+    MDU1NDhkYTRmYTdjMGI5ZDg0M2ZhZDRmZTY3ZWI3MjQ0ZjAyMGQwMQ==
   data.tar.gz: !binary |-
-    YWQ3ZDNhMmY4YjhkMmUxZDgwOTY5NzIyZGU0NzJkYjNmNGFkZGM0Zg==
+    OTcwOTZmNWYyYmIxNGIxMzY5NWVlYjM4ODVlMzQ2MGE0MTk1NjJiNg==
 SHA512:
   metadata.gz: !binary |-
-    NmRlMTEzYmEzYzM5YmQ4MzllNTViZDdjOWY0ZmU1YzMzYjYxZjZlZWM5MGFl
-    NWU3OGVmMDA1MGJiZTA0Y2I5M2M4ZTRiOGZkMTJiYWI2ZmU1NTY5NTM4MWU2
-    NWY3MWFjZDEzNzY0N2UwMmJkZDBiNWM4NTcxNjU5YzhiYzA0YmY=
+    ZTE4ZThiOTZjN2Y2MWUxNDBhMDRlMGZjYjI1NGUwZGIyNWQ0YThhNmFiN2I0
+    NzJjNzJiYmE0ZWJkNmFhZTI1YzYxNGFiYjk1NjM4NGZjNTZhMjQzZjMxODgx
+    ZTM3NmM1M2Y4OGFkNDc4ZTBkNDM3MTc4MjMyMWM5MWIyMjU0OTc=
   data.tar.gz: !binary |-
-    NmNjMzA2OWQzYmE5ZGVkNDNjOWM5ODkyZjYxZjZiN2FmMWM5MjljMTdjODdh
-    ZGQ4YjVlOWFmOWMzODgyMWEyNWZlNzdjODk4YjA5ODk0YTU0ZjM1NjBjNTRh
-    MzVjZmFmZmY2YmIzMDRhYjU1MWIxOGRlMTRhY2M1NzBjMTBlMzI=
+    YTU1YjJkZDU5NTU3MzY3OWFmNzE4Yjk4OTM0MGM5YTE3NjUyMzY1MzJmOGE0
+    MDNhYWNmNGI3NjEyMGQ3OGE4NDEyODRjZWQzNjUwYmEyMGIwMWFhNzU4ZDBi
+    MGRhMjM0YTRlNjE0ZTdhNjA0NTMzOTA4ZjYyYTNhNjg2Y2MxMWM=

data/lib/zipkin-tracer/application.rb

@@ -0,0 +1,30 @@
+module ZipkinTracer
+
+  # Useful methods on the Application we are instrumenting
+  class Application
+    # If the request is not valid for this service, we do not what to trace it.
+    def self.routable_request?(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(path_info)
+      true
+    rescue ActionController::RoutingError
+      false
+    end
+
+    def self.logger
+      if defined?(Rails) # If we happen to be inside a Rails app, use its logger
+        Rails.logger
+      else
+        Logger.new(STDOUT)
+      end
+    end
+
+    def self.config(app)
+      if app.respond_to?(:config) && app.config.respond_to?(:zipkin_tracer)
+        app.config.zipkin_tracer
+      else
+        {}
+      end
+    end
+  end
+end

data/lib/zipkin-tracer/config.rb

@@ -1,13 +1,15 @@
 require 'logger'
-module ZipkinTracer
+require 'zipkin-tracer/application'
 
+module ZipkinTracer
+  # Configuration of this gem. It reads the configuration and provides default values
   class Config
     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)
+      config = config_hash || Application.config(app)
       @service_name      = config[:service_name]
       @service_port      = config[:service_port]      || DEFAULTS[:service_port]
       @json_api_host     = config[:json_api_host]
@@ -19,7 +21,7 @@ module ZipkinTracer
       @annotate_plugin   = config[:annotate_plugin]   # call for trace annotation
       @filter_plugin     = config[:filter_plugin]     # skip tracing if returns false
       @whitelist_plugin  = config[:whitelist_plugin]  # force sampling if returns true
-      @logger            = config[:logger]            || fallback_logger
+      @logger            = config[:logger]            || Application.logger
     end
 
     def adapter
@@ -36,14 +38,6 @@ module ZipkinTracer
 
     private
 
-    def fallback_logger
-      if defined?(Rails) # If we happen to be inside a Rails app, use its logger
-        Rails.logger
-      else
-        Logger.new(STDOUT)
-      end
-    end
-
     DEFAULTS = {
       traces_buffer: 100,
       scribe_max_buffer: 10,
@@ -51,12 +45,5 @@ module ZipkinTracer
       service_port: 80
     }
 
-    def app_config(app)
-      if app.respond_to?(:config) && app.config.respond_to?(:zipkin_tracer)
-        app.config.zipkin_tracer
-      else
-        {}
-      end
-    end
   end
 end

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

@@ -4,6 +4,7 @@ require 'finagle-thrift/tracer'
 require 'uri'
 
 module ZipkinTracer
+  # Faraday middleware. It will add CR/CS annotations to outgoing connections done by Faraday
   class FaradayHandler < ::Faraday::Middleware
     B3_HEADERS = {
       trace_id: 'X-B3-TraceId',
@@ -34,21 +35,19 @@ module ZipkinTracer
     end
 
     private
-    SERVER_ADDRESS = 'sa'
-    SERVER_ADDRESS_SPECIAL_VALUE = '1'
-    STRING_TYPE = 'STRING'
-    BOOLEAN_TYPE = 'BOOL'
-    URI_KEY = 'http.uri'
-    STATUS_KEY = 'http.status'
-    UNKNOWN_URL = 'unknown'
-
+    SERVER_ADDRESS = 'sa'.freeze
+    SERVER_ADDRESS_SPECIAL_VALUE = '1'.freeze
+    STRING_TYPE = 'STRING'.freeze
+    BOOLEAN_TYPE = 'BOOL'.freeze
+    URI_KEY = 'http.uri'.freeze
+    STATUS_KEY = 'http.status'.freeze
 
     def trace!(env, trace_id)
       response = nil
       # 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, local_endpoint.ip_format) # The endpoint we are calling.
+      remote_endpoint = Trace::Endpoint.remote_endpoint(url, @service_name, local_endpoint.ip_format) # The endpoint we are calling.
       @tracer.with_new_span(trace_id, env[:method].to_s.downcase) do |span|
         # annotate with method (GET/POST/etc.) and uri path
         span.record(Trace::BinaryAnnotation.new(URI_KEY, url.path, STRING_TYPE, local_endpoint))
@@ -70,9 +69,5 @@ module ZipkinTracer
       Trace.pop
     end
 
-    def callee_endpoint(url, ip_format)
-      service_name = @service_name || url.host.split('.').first || UNKNOWN_URL # default to url-derived service name
-      Trace::Endpoint.make_endpoint(url.host, url.port, service_name, ip_format)
-    end
   end
 end

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

@@ -21,8 +21,8 @@ module ZipkinTracer
   # This middleware reads Zipkin headers from the request and sets/creates a Trace.id usable by the rest of the app
   # It will also send the trace to the Zipkin service using one of the methods configured.
   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]
+    B3_REQUIRED_HEADERS = %w[HTTP_X_B3_TRACEID HTTP_X_B3_PARENTSPANID HTTP_X_B3_SPANID HTTP_X_B3_SAMPLED].freeze
+    B3_OPT_HEADERS = %w[HTTP_X_B3_FLAGS].freeze
 
     def initialize(app, config = nil)
       @app = app
@@ -35,7 +35,7 @@ module ZipkinTracer
       zipkin_env = ZipkinEnv.new(env, @config)
       trace_id = zipkin_env.trace_id
       with_trace_id(trace_id) do
-        if !trace_id.sampled? || !routable_request?(env)
+        if !trace_id.sampled? || !Application.routable_request?(env['PATH_INFO'])
           @app.call(env)
         else
           @tracer.with_new_span(trace_id, zipkin_env.env['REQUEST_METHOD'].to_s.downcase) do |span|
@@ -54,15 +54,6 @@ module ZipkinTracer
       Trace.pop
     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'])
-      true
-    rescue ActionController::RoutingError
-      false
-    end
-
     def annotate_plugin(env, status, response_headers, response_body)
       @config.annotate_plugin.call(env, status, response_headers, response_body) if @config.annotate_plugin
     end

data/lib/zipkin-tracer/trace.rb

@@ -8,8 +8,11 @@ module Trace
     @tracer
   end
 
+  # A span may contain many annotations
+  # This class is defined in finagle-thrift. We are adding extra methods here
   class Span
     attr_reader :size
+    attr_accessor :timestamp, :duration
 
     # We record information into spans, then we send these spans to zipkin
     def record(annotation)
@@ -31,11 +34,14 @@ module Trace
         parentId: @span_id.parent_id.nil? ? nil : @span_id.parent_id.to_s,
         annotations: @annotations.map!(&:to_h),
         binaryAnnotations: @binary_annotations.map!(&:to_h),
+        timestamp: timestamp,
+        duration: duration,
         debug: @debug
       }
     end
   end
 
+  # This class is defined in finagle-thrift. We are adding extra methods here
   class Annotation
     def to_h
       {
@@ -46,6 +52,7 @@ module Trace
     end
   end
 
+  # This class is defined in finagle-thrift. We are adding extra methods here
   class BinaryAnnotation
     def to_h
       {
@@ -56,16 +63,36 @@ module Trace
     end
   end
 
+  # This class is defined in finagle-thrift. We are adding extra methods here
   class Endpoint
-    LOCALHOST = '127.0.0.1'
-    LOCALHOST_I32 = 0x7f000001
+    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
     attr_accessor :ip_format
 
-    # we cannot override the initializer to add an extra parameter so use a factory
+    def self.local_endpoint(service_port, service_name, ip_format)
+      hostname = Socket.gethostname
+      Endpoint.make_endpoint(hostname, service_port, service_name, ip_format)
+    end
+
+    def self.remote_endpoint(url, remote_service_name, ip_format)
+      service_name = remote_service_name || url.host.split('.').first || UNKNOWN_URL # default to url-derived service name
+      Endpoint.make_endpoint(url.host, url.port, service_name, ip_format)
+    end
+
+    def to_h
+      {
+        ipv4: ipv4,
+        port: port,
+        serviceName: service_name
+      }
+    end
+
+    private
     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
@@ -76,12 +103,5 @@ module Trace
       ep
     end
 
-    def to_h
-      {
-        ipv4: ipv4,
-        port: port,
-        serviceName: service_name
-      }
-    end
   end
 end

data/lib/zipkin-tracer/trace_client.rb

@@ -0,0 +1,34 @@
+module ZipkinTracer
+  class TraceClient
+    LOCAL_COMPONENT = 'lc'.freeze
+    STRING_TYPE = 'STRING'.freeze
+
+    def self.local_component_span(local_component_value, &block)
+      if block_given?
+        client = self.new(LOCAL_COMPONENT, &block)
+        client.record_local_component local_component_value
+      end
+    end
+
+    def initialize(name, &block)
+      @trace_id = Trace.id.next_id
+      Trace.tracer.with_new_span(@trace_id, name) do |span|
+        @span = span
+        block.call(self)
+      end
+    end
+
+    def record(key)
+      @span.record(Trace::Annotation.new(key, Trace.default_endpoint)) if @trace_id.sampled?
+    end
+
+    def record_tag(key, value)
+      @span.record(Trace::BinaryAnnotation.new(key, value, STRING_TYPE, Trace.default_endpoint)) if @trace_id.sampled?
+    end
+
+    def record_local_component(value)
+      record_tag(LOCAL_COMPONENT, value)
+    end
+
+  end
+end

data/lib/zipkin-tracer/tracer_factory.rb

@@ -22,8 +22,7 @@ module ZipkinTracer
 
       # TODO: move this to the TracerBase and kill scribe tracer
       ip_format = config.adapter == :json ? :string : :i32
-      Trace.default_endpoint = Trace::Endpoint.make_endpoint(
-        nil, # auto detect hostname
+      Trace.default_endpoint = Trace::Endpoint.local_endpoint(
         config.service_port,
         service_name(config.service_name),
         ip_format

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.11.0"
+  VERSION = "0.12.0"
 end

data/lib/zipkin-tracer/zipkin_tracer_base.rb

@@ -17,14 +17,17 @@ module Trace
 
     def with_new_span(trace_id, name)
       span = start_span(trace_id, name)
+      start_time = Time.now
+      span.timestamp = to_microseconds(start_time)
       result = yield span
+      span.duration = to_microseconds(Time.now - start_time)
       may_flush(span)
       result
     end
 
     def may_flush(span)
       size = spans.values.map(&:size).inject(:+) || 0
-      if size >= @traces_buffer || span.annotations.any?{ |ann| ann == Annotation::SERVER_SEND }
+      if size >= @traces_buffer || span.annotations.any?{ |ann| ann.value == Annotation::SERVER_SEND }
         flush!
         reset
       end
@@ -54,5 +57,9 @@ module Trace
     def reset
       Thread.current[:zipkin_spans] = {}
     end
+
+    def to_microseconds(time)
+      (time.to_f * 1_000_000).to_i
+    end
   end
 end

data/lib/zipkin-tracer.rb

@@ -1,6 +1,7 @@
 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'
+require 'zipkin-tracer/trace_client'
 
 begin
   require 'faraday'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zipkin-tracer
 version: !ruby/object:Gem::Version
-  version: 0.11.0
+  version: 0.12.0
 platform: ruby
 authors:
 - Franklin Hu
@@ -13,7 +13,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-28 00:00:00.000000000 Z
+date: 2016-02-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -182,11 +182,13 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/zipkin-tracer.rb
+- lib/zipkin-tracer/application.rb
 - lib/zipkin-tracer/careless_scribe.rb
 - 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/trace_client.rb
 - lib/zipkin-tracer/tracer_factory.rb
 - lib/zipkin-tracer/version.rb
 - lib/zipkin-tracer/zipkin_json_tracer.rb