zipkin-tracer 0.12.1 → 0.13.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    MzEzZmRjNmE5ZjhhMGRiY2EyOWFiNzIxZjczZjE0MDlkOWJkY2MyNQ==
+    MDAzYzIxYWEzM2Y5NTM1OWJiMWQ5ODkwODVjY2U3YmFjMjkxNjY0Nw==
   data.tar.gz: !binary |-
-    ZDg5N2IyOGViYTVhODc3OWNlM2FjNGZmOTg3YjI5NjE0OGVlN2IwOA==
+    NTJlNzYxMzZiZGJkOGU5Y2FhM2Y4OWMzNjIxNzU4NjBjYWVhMjFkNQ==
 SHA512:
   metadata.gz: !binary |-
-    YjBlMDNiNzE3Y2EzYWZmNjU1MGY5Yzg2N2RjZTA1YmFiZWIzYjEzZDU0MDdh
-    MjExNGJkZjBiZjU3MjlhYzQwMTc4YWY1YjZhMWI5ZTc0Y2ViYjQxMzgwYWJk
-    NjIzN2Y0YzQ5ZDQ4MWY3ZjA4OTFlM2M5MzQxYzk5YzdiMzZmNjg=
+    NTg1MGVmMTJjM2NlMWE0YTlmZmNjYjEyOWJkOWU0MWYyMjdhNjU3MWEwOTcx
+    YzU5N2ZlNzQyOTE4Yjg1MjAzOTJmN2Q2NWY1YTA4OTZmOTZmNzZlNjA5MzRk
+    NDgyMjFjNDJhNWFiMDc4ZmM2OWIxNTVhNGRiZDA1NDE5NWJlYTI=
   data.tar.gz: !binary |-
-    OTFlZDAwZGZjNDE2ZGM1NmZmOGJlM2ZkNTQ1N2M2YTc5MzIwZjM4MDUxYjgz
-    YWY1MGZiYjY1OWVjNjcyNWJjNzE2ODM5MjhkNTYwMjhmYjgwNjcxNDI2YjYw
-    ZmQ4MTQ3MTIxYTMxNTA3Mzg2MzQ5ZTczYWUwMjBmMWRiNWUxZjE=
+    OGJjZDQwNmQwOTgwZDJlZDUzMjFmMTdjNDI1ZGIzNWRlYzA4YzE3NTUzZTg5
+    ZDE0Y2RmNGFmMjMwYzZkZjBmMzI4M2NlZmIwNGNlM2VmOTNlYWY3MTdkMGZh
+    NTIwM2EwMjQwYmU4OTQ1YmZkYjBmYWI5YTkyOTFjNTEwMjBhYmU=

data/lib/zipkin-tracer/config.rb

@@ -4,8 +4,8 @@ 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,
+    attr_reader :service_name, :service_port, :json_api_host,
+      :scribe_server, :zookeeper, :sample_rate, :annotate_plugin,
       :filter_plugin, :whitelist_plugin, :logger
 
     def initialize(app, config_hash)
@@ -13,11 +13,9 @@ module ZipkinTracer
       @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]
-      @scribe_max_buffer = config[:scribe_max_buffer] || DEFAULTS[:scribe_max_buffer]
       @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
@@ -39,8 +37,6 @@ module ZipkinTracer
     private
 
     DEFAULTS = {
-      traces_buffer: 100,
-      scribe_max_buffer: 10,
       sample_rate: 0.1,
       service_port: 80
     }

data/lib/zipkin-tracer/trace.rb

@@ -18,19 +18,28 @@ module Trace
   # 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
+    def initialize(name, span_id)
+      @name = name
+      @span_id = span_id
+      @annotations = []
+      @binary_annotations = []
+      @debug = span_id.debug?
+      @timestamp = to_microseconds(Time.now)
+      @duration = UNKNOWN_DURATION
+    end
+
+    def close
+      @duration = to_microseconds(Time.now) - @timestamp
+    end
 
     # 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
@@ -41,11 +50,19 @@ 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,
+        timestamp: @timestamp,
+        duration: @duration,
         debug: @debug
       }
     end
+
+    private
+
+    UNKNOWN_DURATION = 0 # mark duration was not set
+
+    def to_microseconds(time)
+      (time.to_f * 1_000_000).to_i
+    end
   end
 
   # This class is defined in finagle-thrift. We are adding extra methods here

data/lib/zipkin-tracer/trace_client.rb

@@ -4,20 +4,23 @@ module ZipkinTracer
     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
+      client = self.new
+      client.trace(local_component_value, &block)
     end
 
-    def initialize(name, &block)
+    def trace(local_component_value, &block)
+      raise ArgumentError, "no block given" unless block
+
       @trace_id = Trace.id.next_id
+      result = nil
       Trace.with_trace_id(@trace_id) do
-        Trace.tracer.with_new_span(@trace_id, name) do |span|
+        Trace.tracer.with_new_span(@trace_id, LOCAL_COMPONENT) do |span|
           @span = span
-          block.call(self)
+          result = block.call(self)
+          record_local_component local_component_value
         end
       end
+      result
     end
 
     def record(key)

data/lib/zipkin-tracer/tracer_factory.rb

@@ -6,11 +6,11 @@ module ZipkinTracer
       tracer = case adapter
         when :json
           require 'zipkin-tracer/zipkin_json_tracer'
-          options = { json_api_host: config.json_api_host, traces_buffer: config.traces_buffer, logger: config.logger }
+          options = { json_api_host: config.json_api_host, logger: config.logger }
           Trace::ZipkinJsonTracer.new(options)
         when :scribe
           require 'zipkin-tracer/zipkin_scribe_tracer'
-          Trace::ScribeTracer.new(scribe_server: config.scribe_server, traces_buffer: config.scribe_max_buffer)
+          Trace::ScribeTracer.new(scribe_server: config.scribe_server)
         when :kafka
           require 'zipkin-tracer/zipkin_kafka_tracer'
           Trace::ZipkinKafkaTracer.new(zookeepers: config.zookeeper)

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.12.1"
+  VERSION = "0.13.0"
 end

data/lib/zipkin-tracer/zipkin_kafka_tracer.rb

@@ -12,7 +12,6 @@ module Trace
       @topic  = options[:topic] || DEFAULT_KAFKA_TOPIC
       broker_ids = Hermann::Discovery::Zookeeper.new(options[:zookeepers]).get_brokers
       @producer  = Hermann::Producer.new(nil, broker_ids)
-      options[:traces_buffer] ||= 1  # Default in Kafka is sending as soon as possible. No buffer.
       super(options)
     end
 

data/lib/zipkin-tracer/zipkin_tracer_base.rb

@@ -11,31 +11,27 @@ module Trace
 
     def initialize(options={})
       @options = options
-      @traces_buffer = options[:traces_buffer] || raise(ArgumentError, 'A proper buffer must be setup for the Zipkin tracer')
       reset
     end
 
     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)
+      end_span(span)
       result
     end
 
-    def may_flush(span)
-      size = spans.values.map(&:size).map(&:to_i).inject(:+) || 0
-      if size >= @traces_buffer || span.annotations.any?{ |ann| ann.value == Annotation::SERVER_SEND }
+    def end_span(span)
+      span.close
+      if span.annotations.any?{ |ann| ann.value == Annotation::SERVER_SEND }
         flush!
         reset
       end
     end
 
     def start_span(trace_id, name)
-      span = get_span_for_id(trace_id)
-      span.name = name
+      span = Span.new(name, trace_id)
+      store_span(trace_id, span)
       span
     end
 
@@ -45,21 +41,19 @@ module Trace
 
     private
 
+    THREAD_KEY = :zipkin_spans
+
     def spans
-      Thread.current[:zipkin_spans] ||= {}
+      Thread.current[THREAD_KEY] ||= {}
     end
 
-    def get_span_for_id(id)
-      key = id.span_id.to_s
-      spans[key] ||= Span.new("", id)
+    def store_span(id, span)
+      spans[id.span_id.to_s] = span
     end
 
     def reset
-      Thread.current[:zipkin_spans] = {}
+      Thread.current[THREAD_KEY] = {}
     end
 
-    def to_microseconds(time)
-      (time.to_f * 1_000_000).to_i
-    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zipkin-tracer
 version: !ruby/object:Gem::Version
-  version: 0.12.1
+  version: 0.13.0
 platform: ruby
 authors:
 - Franklin Hu
@@ -13,7 +13,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-03 00:00:00.000000000 Z
+date: 2016-02-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday