zipkin-tracer 0.10.3 → 0.11.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    MmJiM2JiYjE0ZTJjZTJhOGZkNGExYjUwODMyZjlmMWI1NGYyMTA2ZQ==
+    MmU0MDJhYzQxZGM5ODVkZmI0NzliYzI3MGQ0MmRhYjUyNmRhNjE2MQ==
   data.tar.gz: !binary |-
-    MTRhZjBkZjY0MDM1MGM4ZGJjYWQwZjZhMzUxOTdhMzVhYjYxODJiMQ==
+    YWQ3ZDNhMmY4YjhkMmUxZDgwOTY5NzIyZGU0NzJkYjNmNGFkZGM0Zg==
 SHA512:
   metadata.gz: !binary |-
-    YzEwYTYxYzE0N2QyOWIwNTE5YTFmZmU3MDc3YWY3YTJkMjc3OTc1OTg1ZGI3
-    OWYzMDI0YzE4ZDc3ZWJlNTE4OWE0MTQzNmU2ZTIwZDk5YTllYzE0OGIzYTU4
-    YjIxMWIyYmZjN2EwNTFhMWE1NTVmZDZlNzg1NjA0MzNmMmY4OWM=
+    NmRlMTEzYmEzYzM5YmQ4MzllNTViZDdjOWY0ZmU1YzMzYjYxZjZlZWM5MGFl
+    NWU3OGVmMDA1MGJiZTA0Y2I5M2M4ZTRiOGZkMTJiYWI2ZmU1NTY5NTM4MWU2
+    NWY3MWFjZDEzNzY0N2UwMmJkZDBiNWM4NTcxNjU5YzhiYzA0YmY=
   data.tar.gz: !binary |-
-    NzQxYjI5YTBmMzM2NjcwNTc2MTU5NzFmYjJlNTI4MmJkMjZhNDk3ZTc4ZTgx
-    ZjEyOGY1NjdjZDk3YWQ0NGRiMGQzYzUzOWJmNjBjNTYxMmU5YjBlZmYyNTc4
-    MzkxMzdlYmU5MTY5MzEwYzA1OGYyODJmZTczZmNiMTBjZDBiNGY=
+    NmNjMzA2OWQzYmE5ZGVkNDNjOWM5ODkyZjYxZjZiN2FmMWM5MjljMTdjODdh
+    ZGQ4YjVlOWFmOWMzODgyMWEyNWZlNzdjODk4YjA5ODk0YTU0ZjM1NjBjNTRh
+    MzVjZmFmZmY2YmIzMDRhYjU1MWIxOGRlMTRhY2M1NzBjMTBlMzI=

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

@@ -49,16 +49,17 @@ module ZipkinTracer
       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.
-      # annotate with method (GET/POST/etc.) and uri path
-      @tracer.set_rpc_name(trace_id, env[:method].to_s.downcase)
-      @tracer.record(trace_id, Trace::BinaryAnnotation.new(URI_KEY, url.path, STRING_TYPE, local_endpoint))
-      @tracer.record(trace_id, Trace::BinaryAnnotation.new(SERVER_ADDRESS, SERVER_ADDRESS_SPECIAL_VALUE, BOOLEAN_TYPE, remote_endpoint))
-      @tracer.record(trace_id, Trace::Annotation.new(Trace::Annotation::CLIENT_SEND, local_endpoint))
-      response = @app.call(env).on_complete do |renv|
-        # record HTTP status code on response
-        @tracer.record(trace_id, Trace::BinaryAnnotation.new(STATUS_KEY, renv[:status].to_s, STRING_TYPE, local_endpoint))
+      @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))
+        span.record(Trace::BinaryAnnotation.new(SERVER_ADDRESS, SERVER_ADDRESS_SPECIAL_VALUE, BOOLEAN_TYPE, remote_endpoint))
+        span.record(Trace::Annotation.new(Trace::Annotation::CLIENT_SEND, local_endpoint))
+        response = @app.call(env).on_complete do |renv|
+          # record HTTP status code on response
+          span.record(Trace::BinaryAnnotation.new(STATUS_KEY, renv[:status].to_s, STRING_TYPE, local_endpoint))
+        end
+        span.record(Trace::Annotation.new(Trace::Annotation::CLIENT_RECV, local_endpoint))
       end
-      @tracer.record(trace_id, Trace::Annotation.new(Trace::Annotation::CLIENT_RECV, local_endpoint))
       response
     end
 

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

@@ -38,7 +38,9 @@ module ZipkinTracer
         if !trace_id.sampled? || !routable_request?(env)
           @app.call(env)
         else
-          trace!(trace_id, zipkin_env) { @app.call(env) }
+          @tracer.with_new_span(trace_id, zipkin_env.env['REQUEST_METHOD'].to_s.downcase) do |span|
+            trace!(span, zipkin_env) { @app.call(env) }
+          end
         end
       end
     end
@@ -52,10 +54,6 @@ module ZipkinTracer
       Trace.pop
     end
 
-    def record(annotation)
-      @tracer.record(@trace_id, annotation)
-    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
@@ -69,24 +67,23 @@ module ZipkinTracer
       @config.annotate_plugin.call(env, status, response_headers, response_body) if @config.annotate_plugin
     end
 
-    def trace!(trace_id, zipkin_env, &block)
+    def trace!(span, zipkin_env, &block)
       synchronize do
         #if called by a service, the caller already added the information
-        trace_request_information(trace_id, zipkin_env.env) unless zipkin_env.called_with_zipkin_headers?
-        @tracer.record(trace_id, Trace::Annotation.new(Trace::Annotation::SERVER_RECV, Trace.default_endpoint))
-        @tracer.record(trace_id, Trace::Annotation.new('whitelisted', Trace.default_endpoint)) if zipkin_env.force_sample?
+        trace_request_information(span, zipkin_env.env) unless zipkin_env.called_with_zipkin_headers?
+        span.record(Trace::Annotation.new(Trace::Annotation::SERVER_RECV, Trace.default_endpoint))
+        span.record(Trace::Annotation.new('whitelisted', Trace.default_endpoint)) if zipkin_env.force_sample?
       end
       status, headers, body = yield
     ensure
       synchronize do
         annotate_plugin(zipkin_env.env, status, headers, body)
-        @tracer.record(trace_id, Trace::Annotation.new(Trace::Annotation::SERVER_SEND, Trace.default_endpoint))
+        span.record(Trace::Annotation.new(Trace::Annotation::SERVER_SEND, Trace.default_endpoint))
       end
     end
 
-    def trace_request_information(trace_id, env)
-      @tracer.set_rpc_name(trace_id, env['REQUEST_METHOD'].to_s.downcase) # get/post and all that jazz
-      @tracer.record(trace_id, Trace::BinaryAnnotation.new('http.uri', env['PATH_INFO'], 'STRING', Trace.default_endpoint))
+    def trace_request_information(span, env)
+      span.record(Trace::BinaryAnnotation.new('http.uri', env['PATH_INFO'], 'STRING', Trace.default_endpoint))
     end
 
     def synchronize(&block)

data/lib/zipkin-tracer/trace.rb

@@ -9,6 +9,20 @@ module Trace
   end
 
   class Span
+    attr_reader :size
+
+    # We record information into spans, then we send these spans to zipkin
+    def record(annotation)
+      @size ||= 0
+      case annotation
+      when BinaryAnnotation
+        binary_annotations << annotation
+      when Annotation
+        annotations << annotation
+      end
+      @size = @size + 1
+    end
+
     def to_h
       {
         name: @name,

data/lib/zipkin-tracer/tracer_factory.rb

@@ -1,4 +1,3 @@
-
 module ZipkinTracer
   class TracerFactory
     def tracer(config)
@@ -10,12 +9,13 @@ module ZipkinTracer
           options = { json_api_host: config.json_api_host, traces_buffer: config.traces_buffer, logger: config.logger }
           Trace::ZipkinJsonTracer.new(options)
         when :scribe
-          require 'zipkin-tracer/careless_scribe'
-          Trace::ZipkinTracer.new(CarelessScribe.new(config.scribe_server), config.scribe_max_buffer)
+          require 'zipkin-tracer/zipkin_scribe_tracer'
+          Trace::ScribeTracer.new(scribe_server: config.scribe_server, traces_buffer: config.scribe_max_buffer)
         when :kafka
           require 'zipkin-tracer/zipkin_kafka_tracer'
           Trace::ZipkinKafkaTracer.new(zookeepers: config.zookeeper)
         else
+          require 'zipkin-tracer/zipkin_null_tracer'
           Trace::NullTracer.new
       end
       Trace.tracer = tracer

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.10.3"
+  VERSION = "0.11.0"
 end

data/lib/zipkin-tracer/zipkin_null_tracer.rb

@@ -0,0 +1,11 @@
+module Trace
+  # Monkey patching Nulltracer from thrift.
+  # All our tracers have a start_span method, adding it to
+  # the NullTracer also.
+  class NullTracer
+    def with_new_span(trace_id, name)
+      span = Span.new(name, trace_id)
+      yield span
+    end
+  end
+end

data/lib/zipkin-tracer/zipkin_scribe_tracer.rb

@@ -0,0 +1,27 @@
+require 'zipkin-tracer/zipkin_tracer_base'
+require 'zipkin-tracer/careless_scribe'
+
+module Trace
+  class ScribeTracer < ZipkinTracerBase
+    TRACER_CATEGORY = "zipkin".freeze
+
+    def initialize(options)
+      @scribe = CarelessScribe.new(options[:scribe_server])
+      super(options)
+    end
+
+    def flush!
+      @scribe.batch do
+        messages = spans.values.map do |span|
+          buf = ''
+          trans = Thrift::MemoryBufferTransport.new(buf)
+          oprot = Thrift::BinaryProtocol.new(trans)
+          span.to_thrift.write(oprot)
+          Base64.encode64(buf).gsub("\n", "")
+        end
+        @scribe.log(messages, TRACER_CATEGORY)
+      end
+      reset
+    end
+  end
+end

data/lib/zipkin-tracer/zipkin_tracer_base.rb

@@ -8,7 +8,6 @@ module Trace
   # Traces dealing with zipkin should inherit from this class and implement the
   # flush! method which actually sends the information
   class ZipkinTracerBase < Tracer
-    TRACER_CATEGORY = "zipkin".freeze
 
     def initialize(options={})
       @options = options
@@ -16,27 +15,25 @@ module Trace
       reset
     end
 
-    def record(id, annotation)
-      span = get_span_for_id(id)
-
-      case annotation
-      when BinaryAnnotation
-        span.binary_annotations << annotation
-      when Annotation
-        span.annotations << annotation
-      end
-      count = current_count
-      set_current_count(count + 1)
+    def with_new_span(trace_id, name)
+      span = start_span(trace_id, name)
+      result = yield span
+      may_flush(span)
+      result
+    end
 
-      if current_count >= @traces_buffer || (annotation.is_a?(Annotation) && annotation.value == Annotation::SERVER_SEND)
+    def may_flush(span)
+      size = spans.values.map(&:size).inject(:+) || 0
+      if size >= @traces_buffer || span.annotations.any?{ |ann| ann == Annotation::SERVER_SEND }
         flush!
         reset
       end
     end
 
-    def set_rpc_name(id, name)
-      span = get_span_for_id(id)
-      span.name = name.to_s
+    def start_span(trace_id, name)
+      span = get_span_for_id(trace_id)
+      span.name = name
+      span
     end
 
     def flush!
@@ -49,14 +46,6 @@ module Trace
       Thread.current[:zipkin_spans] ||= {}
     end
 
-    def current_count
-      Thread.current[:zipkin_spans_count] ||= 0
-    end
-
-    def set_current_count(count)
-      Thread.current[:zipkin_spans_count] = count
-    end
-
     def get_span_for_id(id)
       key = id.span_id.to_s
       spans[key] ||= Span.new("", id)
@@ -64,7 +53,6 @@ module Trace
 
     def reset
       Thread.current[:zipkin_spans] = {}
-      set_current_count(0)
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zipkin-tracer
 version: !ruby/object:Gem::Version
-  version: 0.10.3
+  version: 0.11.0
 platform: ruby
 authors:
 - Franklin Hu
@@ -13,7 +13,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-14 00:00:00.000000000 Z
+date: 2016-01-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -191,6 +191,8 @@ files:
 - lib/zipkin-tracer/version.rb
 - lib/zipkin-tracer/zipkin_json_tracer.rb
 - lib/zipkin-tracer/zipkin_kafka_tracer.rb
+- lib/zipkin-tracer/zipkin_null_tracer.rb
+- lib/zipkin-tracer/zipkin_scribe_tracer.rb
 - lib/zipkin-tracer/zipkin_tracer_base.rb
 homepage: https://github.com/openzipkin/zipkin-tracer
 licenses: []