zipkin-tracer 0.6.3 → 0.7

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    MzRlNmRmNWM4ZDlhMGVkNTZhZmUzMDQwNjA5MGZkODI2NTlhZmM3Yw==
+    YzJiNzAzYmI1YTJkNzc2YTViYzdhZjM5YzZjMmZkZTJiYjEyNWNhYQ==
   data.tar.gz: !binary |-
-    Yzc4ZGJmOWQ3YjdmZDFjMDJlMGZlM2QxZTU5NzFiZDMxNDgyNTU5ZQ==
+    ZGQzMDkwYTdiODdlYTRhNjFkYWRjYmU4OTU4MWFiNjViNTRkYTI0Ng==
 SHA512:
   metadata.gz: !binary |-
-    MDk0OTBhZjg2ZmZhZDY2YmE5MDE2YWViNDI5MDkxZjQzOWJlOGU3YmNjZmJj
-    YTc4M2QyMzIyZTI4NTJhZmZkNDgyNDBjYTI1ODBkYzFjYTVhMDU5NjQ5NzZj
-    ZjExYzVjMTFhNDdkZjVjNjIxZTBkZWRiOWM3N2JiZWUzZTEwNWI=
+    ODQ5NWQ0YzA1OTI2MjMyNWM3NGIwNTNlODZkOGVhY2I3OWMzOTJhOWFlZmMw
+    MTgzZjU3ODBlNTViNmMwMzYyOTE2ODYxNjY5ZjdjN2IwMTA3ZDk0NjRjZGIw
+    MjYzNjBhZWY4YzNjMmQyNjY1MWVjZTdiODdkYmFjMjRiNmUyNzU=
   data.tar.gz: !binary |-
-    ZmZkMDIwMjcxMGQwNDRkZTZhNjczNzA0OGFiNzliZjUxZjRiMDM5NTkwM2Fj
-    YmQzNDc3YzFhOTEwZDZkZGVmMjJiNGYzMmMwMGIyNDcxMGE2OTRkMmEyMDEz
-    NWE3N2UyNjIwM2ZhMzQzYjQ1OTBhOTVlMGM2MzA4Y2VlYTY0ZWE=
+    Zjc4MzJmYTg1ODEzYWVmM2YyODA1ZTRjZGNiNWRmODA2MTlhYWY1MTc0OGQw
+    MDk3NzcxYTRjZTAwOTAyOTM1NDdmYjEwOWZkZGNkOGM5NTVmZmRjZTZlODQx
+    NmE3Y2ZiOGMxOTBmMGZhMDg4ODk4YjU0NTU4ODhkNTQwZDNjOTM=

data/lib/zipkin-tracer/careless_scribe.rb

@@ -1,35 +1,70 @@
 # Copyright 2012 Twitter Inc.
-# 
+#
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
 # You may obtain a copy of the License at
-# 
+#
 #      http://www.apache.org/licenses/LICENSE-2.0
-# 
+#
 # Unless required by applicable law or agreed to in writing, software
 # distributed under the License is distributed on an "AS IS" BASIS,
 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-class CarelessScribe
-  def initialize(scribe)
-    @scribe = scribe
+require 'sucker_punch'
+
+
+module ScribeThrift
+  # This is here just for the monkey partching
+  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
+    # Receiving logs may take even several seconds, depending on the buffering of the collector.
+    # We are just sending and forgetting here, we do not really care about the result
+    def Log(messages)
+      send_Log(messages)
+      0 # 0 means success , the original code called recv_Log()
+    end
   end
+end
 
-  def log(*args)
-    @scribe.log(*args)
+# SuckerPunch creates a queue and a thread pool to work on jobs on the queue
+# calling perform adds the code to the queue
+class AsyncScribe
+  include SuckerPunch::Job
+
+  PROTOCOL_TIMEOUT = 10  # If the timeout is low, the protocol will lose spans when collector is not fast enough
+  CATEGORY = 'ruby'       # Thrift-client already uses this as default, seems to not affect anything
+  ADD_NEWLINES_TO_MESSAGES = true  # True is the default in Thrift-client, seems a necessary internal hack
+
+  def perform(server_address, *args)
+    # May seem wasteful to open a new connection per each span but the way the scribe is done
+    # it is difficult to ensure there will be no threading issues unless we create here the connection
+    scribe = Scribe.new(server_address, CATEGORY, ADD_NEWLINES_TO_MESSAGES, timeout: PROTOCOL_TIMEOUT)
+    scribe.log(*args)
   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
+
+  def log(*args)
+    AsyncScribe.new.async.perform(@server_address, *args)
+  end
+
   def batch(&block)
-    @scribe.batch(&block)
+    yield   #We just yield here
+    # the block finagle-thrift-1.4.1/lib/finagle-thrift/tracer.rb flush! method will call log also.
   rescue ThriftClient::NoServersAvailable, Thrift::Exception
     # I couldn't care less
   end
 
-  def method_missing(name, *args)
-    @scribe.send(name, *args)
-  end
-end
+end

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

@@ -36,23 +36,23 @@ module ZipkinTracer extend self
       config = Config.new(app, config)
 
       ::Trace.tracer = if config.using_scribe?
-        scribe = config.scribe_server ? Scribe.new(config.scribe_server) : Scribe.new()
-        ::Trace::ZipkinTracer.new(CarelessScribe.new(scribe), config.scribe_max_buffer)
+        ::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
       end
-      @config = config
+      ::Trace.default_endpoint = ::Trace.default_endpoint.with_service_name(config.service_name).with_port(config.service_port)
+      ::Trace.sample_rate=(config.sample_rate)
 
+      @config = config
     end
 
     def call(env)
       # skip certain requests
       return @app.call(env) if filtered?(env) || !routable_request?(env)
-
-      ::Trace.default_endpoint = ::Trace.default_endpoint.with_service_name(@config.service_name).with_port(@config.service_port)
-      ::Trace.sample_rate=(@config.sample_rate)
       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) }
@@ -84,22 +84,32 @@ module ZipkinTracer extend self
     def tracing_filter(trace_id, env, whitelisted=false)
       synchronize do
         ::Trace.push(trace_id)
-        ::Trace.set_rpc_name(env["REQUEST_METHOD"]) # get/post and all that jazz
-        ::Trace.record(::Trace::BinaryAnnotation.new("http.uri", env["PATH_INFO"], "STRING", ::Trace.default_endpoint))
+        #if called by a service, the caller already added the information
+        add_request_information(env) unless called_with_zipkin_headers?(env)
         ::Trace.record(::Trace::Annotation.new(::Trace::Annotation::SERVER_RECV, ::Trace.default_endpoint))
         ::Trace.record(::Trace::Annotation.new('whitelisted', ::Trace.default_endpoint)) if whitelisted
       end
       status, headers, body = yield if block_given?
     ensure
       synchronize do
-        ::Trace.record(::Trace::Annotation.new(::Trace::Annotation::SERVER_SEND, ::Trace.default_endpoint))
         annotate(env, status, headers, body)
+        ::Trace.record(::Trace::Annotation.new(::Trace::Annotation::SERVER_SEND, ::Trace.default_endpoint))
         ::Trace.pop
       end
+      [status, headers, body]
     end
 
     private
 
+    def add_request_information(env)
+      ::Trace.set_rpc_name(env["REQUEST_METHOD"]) # 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)
+      B3_REQUIRED_HEADERS.all? { |key| env.has_key?(key) }
+    end
+
     def synchronize(&block)
       @lock.synchronize do
         yield
@@ -111,7 +121,7 @@ module ZipkinTracer extend self
     end
 
     def get_or_create_trace_id(env, whitelisted, default_flags = ::Trace::Flags::EMPTY)
-      trace_parameters = if B3_REQUIRED_HEADERS.all? { |key| env.has_key?(key) }
+      trace_parameters = if called_with_zipkin_headers?(env)
                            env.values_at(*B3_REQUIRED_HEADERS)
                          else
                            new_id = Trace.generate_id

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.6.3"
+  VERSION = "0.7"
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zipkin-tracer
 version: !ruby/object:Gem::Version
-  version: 0.6.3
+  version: '0.7'
 platform: ruby
 authors:
 - Franklin Hu
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-20 00:00:00.000000000 Z
+date: 2015-10-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: finagle-thrift
@@ -54,6 +54,20 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: sucker_punch
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement