rubyzipkin 0.3.10

data/lib/rubyzipkin/headers.rb

@@ -0,0 +1,11 @@
+# Tracing HTTP header types
+module RubyZipkin
+  module ZipkinTraceHeader
+    TRACE_ID        = "X-ZK-TID"
+    SPAN_ID         = "X-ZK-SID"
+    PARENT_SPAN_ID  = "X-ZK-PSID"
+    TRACE_SAMPLED   = "X-ZK-SMP"
+    TRACE_FLAGS     = "X-ZK-FLG"
+    FORCE_SAMPLE    = "X-FORCE-SAMPLE"
+  end
+end

data/lib/rubyzipkin/metadata_logger.rb

@@ -0,0 +1,27 @@
+require 'finagle-thrift'
+require 'finagle-thrift/trace'
+
+
+#writes properties and request headers as metadata into a trace
+module RubyZipkin
+  class MetadataLogger
+
+    # log a key value pair into a zipkin trace as a KV span value
+    def self.log(key, value)
+      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)
+      if headers
+        headers.each do |header, value|
+            MetadataLogger.log("HEADER_#{header}", value)
+        end
+      end
+    end
+  end
+end

data/lib/rubyzipkin/scriber.rb

@@ -0,0 +1,37 @@
+require 'scribe'
+
+# Scribe Writer
+# Based on the original zipkin tracer game
+#
+# 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.
+module RubyZipkin
+  class Scriber
+    def initialize(scribe)
+      @scribe = scribe
+    end
+
+    def log(*args)
+      @scribe.log(*args)
+    rescue ThriftClient::NoServersAvailable, Thrift::Exception
+    end
+
+    def batch(&block)
+      @scribe.batch(&block)
+    rescue ThriftClient::NoServersAvailable, Thrift::Exception
+    end
+
+    def method_missing(name, *args)
+      @scribe.send(name, *args)
+    end
+  end
+end

data/lib/rubyzipkin/trace_filter.rb

@@ -0,0 +1,35 @@
+#Filters to decide wheter a request should be traced.
+module RubyZipkin
+  class TraceFilter
+
+    # 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.to_s.match(/.*(\.svg)|(\.ttf)|(\.ott)|(\.woff)/)
+        return true
+      end
+
+      keyword_blacklist.each do |key|
+        if uri.to_s.match key
+          return true
+        end
+      end
+
+      return false
+    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}).*/)
+          return true
+        end
+      end
+      false
+    end
+  end
+end

data/lib/rubyzipkin/tracesampler.rb

@@ -0,0 +1,16 @@
+#Decides wheter a collected trace should be sampled or not.
+module RubyZipkin
+  class TraceSampler
+
+    def self.request_sample_rate(request)
+
+      if request[RubyZipkin::ZipkinTraceHeader::FORCE_SAMPLE]
+        #filter is matched in the request, thus ensure not fitereed by returning 100% tracing (unsampled)
+        if request.body.matches(filter)
+          return 1
+        end
+      end
+      return 0.01
+    end
+  end
+end

data/lib/rubyzipkin/version.rb

@@ -0,0 +1,3 @@
+module RubyZipkin
+  VERSION = "0.3.10"
+end

data/lib/rubyzipkin.rb

@@ -0,0 +1,129 @@
+require 'finagle-thrift'
+require 'finagle-thrift/trace'
+require 'scribe'
+
+require 'rubyzipkin/version'
+require 'rubyzipkin/scriber'
+require 'rubyzipkin/headers'
+require 'rubyzipkin/metadata_logger'
+require 'rubyzipkin/tracesampler'
+require 'rubyzipkin/trace_filter'
+
+
+module RubyZipkin extend self
+
+  class RackHandler
+
+    def initialize(app, service_name, scribe_server, scribe_port, uri_filter_list = [], http_header_filter_list = [], scribe_max_buffer = 10, uri_sample_filter_list = {} , sampling_rate = 0.01)
+      @app = app
+      @lock = Mutex.new
+
+      puts "sampling rate = #{sampling_rate}"
+      puts "uri_sample_filter_list = #{uri_sample_filter_list}"
+
+      @service_name = service_name
+      @scribe_port = scribe_port
+      @sample_rate = sampling_rate
+      @uri_filter_list = uri_filter_list
+      @http_header_filter_list = http_header_filter_list
+      @scribe = Scribe.new("#{scribe_server}:#{scribe_port}")
+      ::Trace.tracer = ::Trace::ZipkinTracer.new(Scriber.new(@scribe), scribe_max_buffer)
+    end
+
+    def call(env)
+      begin
+        ::Trace.default_endpoint = ::Trace.default_endpoint.with_service_name(@service_name + "_#{normalized_uri(env['PATH_INFO'])}")
+        ::Trace.sample_rate = @sampling_rate
+        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}"
+        raise e
+      end
+      [@status, @headers, @response]
+    end
+
+    private
+    def tracing_filter(trace_id, env, headers=nil)
+      if RubyZipkin::TraceFilter.UriFilterMatches?(normalized_uri(env["PATH_INFO"]), @uri_filter_list)
+        return
+      end
+      @lock.synchronize do
+        ::Trace.push(trace_id)
+
+        set_trace_caption(env)
+        ::Trace.record(::Trace::BinaryAnnotation.new("http.uri", normalized_uri(env["PATH_INFO"]), "STRING", ::Trace.default_endpoint))
+        ::Trace.record(::Trace::BinaryAnnotation.new("http.status", @status.to_s, "STRING", ::Trace.default_endpoint))
+        ::Trace.record(::Trace::Annotation.new(::Trace::Annotation::SERVER_RECV, ::Trace.default_endpoint))
+
+        add_referer(env)
+        trace_hash(headers)
+        trace_hash(env)
+        trace_post_data(env["rack.input"].read)
+      end
+      yield if block_given?
+      ensure
+        @lock.synchronize do
+          ::Trace.record(::Trace::Annotation.new(::Trace::Annotation::SERVER_SEND, ::Trace.default_endpoint))
+          add_referer(env)
+          ::Trace.pop
+      end
+    end
+
+    def add_referer(env)
+      if env['HTTP_REFERER']
+        ::Trace.record(::Trace::BinaryAnnotation.new("http.referer", env['HTTP_REFERER'], "STRING", ::Trace.default_endpoint))
+      end
+    end
+
+    def normalized_uri(path)
+      path.gsub(/\/\d+/, '/:id')
+    end
+
+    def set_trace_caption(env)
+      ::Trace.set_rpc_name("#{env['REQUEST_METHOD']} - #{@status.to_s} - #{normalized_uri(env['PATH_INFO'])}")
+    end
+
+    def trace_post_data(content)
+      MetadataLogger.log('HTTP_REQUEST INPUT', content.to_s)
+    end
+
+    def trace_hash(content)
+      if content
+        content.sort.map do |k,v|
+          unless RubyZipkin::TraceFilter.KeywordFilterMatches?(k.to_s, @http_header_filter_list)
+            MetadataLogger.log(k.to_s, v)
+          end
+        end
+      end
+    end
+
+    def get_or_create_trace_id(env)
+      if env[ZipkinTraceHeader::TRACE_ID].nil? or env[ZipkinTraceHeader::TRACE_ID].to_s.empty?
+        @tid = Trace.generate_id
+        @parentspan = nil
+
+        env[ZipkinTraceHeader::TRACE_ID] = @tid
+      else
+        @tid = env[ZipkinTraceHeader::TRACE_ID]
+
+        if !env[ZipkinTraceHeader::SPAN_ID].nil? and !env[ZipkinTraceHeader::SPAN_ID].to_s.empty?
+          @parentspan = env[ZipkinTraceHeader::SPAN_ID]
+        end
+      end
+
+      @spanid = Trace.generate_id
+      env[ZipkinTraceHeader::SPAN_ID] = @spanid
+
+      # from Finagle source: flags are 0 = none , 1 = debug
+      Trace::TraceId.new @tid, @parentspan, @spanid, true, ::TRACE::Flags::DEBUG
+    end
+
+    def get_or_create_trace_id2(env)
+      ::Trace::TraceId.new(::Trace.generate_id, nil, ::Trace.generate_id, true, ::Trace::Flags::DEBUG)
+    end
+  end
+end

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification 
+name: rubyzipkin
+version: !ruby/object:Gem::Version 
+  hash: 7
+  prerelease: 
+  segments: 
+  - 0
+  - 3
+  - 10
+  version: 0.3.10
+platform: ruby
+authors: 
+- Ivan Marcin
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2013-11-05 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: scribe
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 31
+        segments: 
+        - 0
+        - 2
+        - 4
+        version: 0.2.4
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: finagle-thrift
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 27
+        segments: 
+        - 1
+        - 3
+        - 0
+        version: 1.3.0
+  type: :runtime
+  version_requirements: *id002
+description: Track rack header requests on zipkin
+email: 
+- ivan.marcin@lookout.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/rubyzipkin/headers.rb
+- lib/rubyzipkin/metadata_logger.rb
+- lib/rubyzipkin/scriber.rb
+- lib/rubyzipkin/trace_filter.rb
+- lib/rubyzipkin/tracesampler.rb
+- lib/rubyzipkin/version.rb
+- lib/rubyzipkin.rb
+homepage: https://github.com/twitter/zipkin
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 17
+      segments: 
+      - 1
+      - 3
+      - 5
+      version: 1.3.5
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Ruby tracing via Zipkin
+test_files: []
+