ruby-zipkin 0.2.5 → 0.2.6

data/lib/ruby-zipkin.rb

@@ -4,36 +4,47 @@ require 'ruby-zipkin/scriber'
 require 'ruby-zipkin/headers'
 require 'ruby-zipkin/metadata_logger'
 require 'ruby-zipkin/tracesampler'
+require 'ruby-zipkin/trace_filter'
 
 module RubyZipkin extend self
 
   class RackHandler
 
-    def initialize(app, service_name ='flexd', scribe_server = "204.77.168.48", scribe_port = 9410, scribe_max_buffer = 10 )
+    def initialize(app, service_name, scribe_server, scribe_port, uri_filter_list =[], http_header_filter_list = [], scribe_max_buffer = 10)
       @app = app
       @lock = Mutex.new
       @service_name = service_name
       @scribe_port = scribe_port
       @sample_rate = 0.1
+      @uri_filter_list = uri_filter_list
+      @http_header_filter_list = http_header_filter_list
       @scribe = Scribe.new("#{scribe_server}:#{scribe_port}")
+      puts "using scribe server: #{@scribe.to_s}"
+      puts "#{scribe_server}:#{scribe_port}"
       ::Trace.tracer = ::Trace::ZipkinTracer.new(Scriber.new(@scribe), scribe_max_buffer)
-    end
+      end
 
     def call(env)
-
-      ::Trace.default_endpoint = ::Trace.default_endpoint.with_service_name(@service_name).with_port(@scribe_port)
-      ::Trace.sample_rate = 1
-
-      env[ZipkinTraceHeader::PARENT_SPAN_ID] = @spanid
-      env[ZipkinTraceHeader::TRACE_ID] = @tid
-
-      @status, @headers, @response = @app.call(env)
-      tracing_filter(get_or_create_trace_id(env), env, @headers)
+      begin
+        ::Trace.default_endpoint = ::Trace.default_endpoint.with_service_name(@service_name)
+        ::Trace.sample_rate = 0.1
+        env[ZipkinTraceHeader::PARENT_SPAN_ID] = @spanid
+        env[ZipkinTraceHeader::TRACE_ID] = @tid
+        @status, @headers, @response = @app.call(env)
+        tracing_filter(get_or_create_trace_id2(env), env, @headers)
+      rescue => e
+        #Tracing errors shouldn't block a request.
+        puts "Zipkin error: #{e} \n #{e.backtrace}"
+      end
       [@status, @headers, @response]
     end
 
     private
     def tracing_filter(trace_id, env, headers=nil)
+      if RubyZipkin::TraceFilter.UriFilterMatches?(env["PATH_INFO"], @uri_filter_list)
+        puts "ZIPKIN URI FILTER MATCHED. NOT LOGGING"
+        return
+      end
       @lock.synchronize do
         puts "zipkin trace id #{trace_id}"
         ::Trace.push(trace_id)
@@ -42,19 +53,23 @@ module RubyZipkin extend self
         ::Trace.record(::Trace::Annotation.new(::Trace::Annotation::SERVER_RECV, ::Trace.default_endpoint))
         trace_hash(env)
         trace_hash(headers)
+        puts 'zipkin traced in'
       end
       yield if block_given?
       ensure
         @lock.synchronize do
           ::Trace.record(::Trace::Annotation.new(::Trace::Annotation::SERVER_SEND, ::Trace.default_endpoint))
           ::Trace.pop
+          puts 'zipking trace out'
       end
     end
 
     def trace_hash(content)
       if content
         content.each do |k,v|
-          MetadataLogger.log(k.to_s, v.to_s)
+          unless RubyZipkin::TraceFilter.KeywordFilterMatches?(k.to_s, @http_header_filter_list)
+            MetadataLogger.log(k.to_s, v)
+          end
         end
       end
     end
@@ -77,11 +92,11 @@ module RubyZipkin extend self
       env[ZipkinTraceHeader::SPAN_ID] = @spanid
 
       # from Finagle source: flags are 0 = none , 1 = debug
-      Trace::TraceId.new @tid, @parentspan, @spanid, true, 0
+      Trace::TraceId.new @tid, @parentspan, @spanid, true, ::TRACE::Flags::empty
     end
 
     def get_or_create_trace_id2(env)
-      id = ::Trace::TraceId.new(::Trace.generate_id, nil, ::Trace.generate_id, true, ::Trace::Flags::EMPTY)
+      id = ::Trace::TraceId.new(::Trace.generate_id, nil, ::Trace.generate_id, true, ::Trace::Flags::DEBUG)
     end
   end
 end

data/lib/ruby-zipkin/metadata_logger.rb

@@ -5,19 +5,19 @@ require 'finagle-thrift/trace'
 module RubyZipkin
   class MetadataLogger
 
+    # log a key value pair into a zipkin trace as a KV span value
     def self.log(key, value)
-      ::Trace.record(::Trace::BinaryAnnotation.new(key, value, "STRING", ::Trace.default_endpoint))
+      if key.to_s == "action_controller.rescue.request" || key.to_s == "action_controller.rescue.response"
+        ::Trace.record(::Trace::BinaryAnnotation.new(key, value.as_json.to_s, "STRING", ::Trace.default_endpoint))
+      else
+        ::Trace.record(::Trace::BinaryAnnotation.new(key, value.to_s, "STRING", ::Trace.default_endpoint))
+      end
     end
 
     # Do a full dump of a request header into zipkin.
-    def self.log_request(headers, service_name = "UNDEFINED")
+    def self.log_request(headers)
       if headers
-
-        #request = Rack::Request.new(headers)
-        #  MetadataLogger.log("PARAMETERS", headers.params)
-
         headers.each do |header, value|
-            puts "logging on zipkin: #{header}, #{value}"
             MetadataLogger.log("HEADER_#{header}", value)
         end
       end

data/lib/ruby-zipkin/trace_filter.rb

@@ -2,13 +2,31 @@
 module RubyZipkin
   class TraceFilter
 
-    def self.UriFilter(uri)
+    # Filter uri's from being traced based on their type
+    # or a keyword listed in the blacklist
+    # Known static content requests like fonts are filtered as well
+    def self.UriFilterMatches?(uri, keyword_blacklist = [])
       #exclude static content requests
-      if uri.match /.*(\.svg)|(\.ttf)|(.woff)/
-        return false
+      if uri.to_s.match(/.*(\.svg)|(\.ttf)|(\.ott)|(\.woff)/)
+        puts "zipkin uri #{uri} matches!"
+        return true
       end
-      true
+
+      #check the uri against the blacklist
+      return KeywordFilterMatches?(uri, keyword_blacklist)
     end
 
+    # Filter a string based on a keyword blacklist
+    # Meant to define if a key should be traced or not.
+    def self.KeywordFilterMatches?(keyword, keyword_blacklist = [])
+      #exclude static content requests
+      keyword_blacklist.each do |blacklisted|
+        if keyword.to_s.match(/.*(#{blacklisted}).*/)
+          puts "zipkin keyword #{keyword} matches #{keyword}!"
+          return true
+        end
+      end
+      false
+    end
   end
 end

data/lib/ruby-zipkin/version.rb

@@ -1,3 +1,3 @@
 module RubyZipkin
-  VERSION = "0.2.5"
+  VERSION = "0.2.6"
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: ruby-zipkin
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 27
   prerelease: 
   segments: 
   - 0
   - 2
-  - 5
-  version: 0.2.5
+  - 6
+  version: 0.2.6
 platform: ruby
 authors: 
 - Ivan Marcin
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2013-09-27 00:00:00 Z
+date: 2013-10-02 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: finagle-thrift