ruby-zipkin 0.2.0

data/lib/ruby-zipkin.rb

@@ -0,0 +1,86 @@
+require 'finagle-thrift'
+require 'finagle-thrift/trace'
+require 'ruby-zipkin/scriber'
+require 'ruby-zipkin/headers'
+require 'ruby-zipkin/metadata_logger'
+require 'ruby-zipkin/tracesampler'
+require "awesome_print"
+
+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 )
+      @app = app
+      @lock = Mutex.new
+      @service_name = service_name
+      @scribe_port = scribe_port
+      @sample_rate = 0.1
+      @scribe = Scribe.new("#{scribe_server}:#{scribe_port}")
+      ::Trace.tracer = ::Trace::ZipkinTracer.new(Scriber.new(@scribe), scribe_max_buffer)
+    end
+
+    def call(env)
+      ::Trace.default_endpoint = ::Trace.default_endpoint.with_service_name(@service_name).with_port(@service_port)
+      ::Trace.sample_rate = 0.1
+
+      tracing_filter(get_or_create_trace_id(env), env)
+      env[ZipkinTraceHeader::PARENT_SPAN_ID] = @spanid
+      env[ZipkinTraceHeader::TRACE_ID] = @tid
+      @status, @headers, @response = @app.call(env)
+
+      [@status, @headers, @response]
+    end
+
+    private
+    def tracing_filter(trace_id, env)
+      @lock.synchronize do
+        ::Trace.push(trace_id)
+        ::Trace.set_rpc_name(env["PATH_INFO"])
+        ::Trace.record(::Trace::BinaryAnnotation.new("http.uri", env["PATH_INFO"], "STRING", ::Trace.default_endpoint))
+        ::Trace.record(::Trace::Annotation.new(::Trace::Annotation::SERVER_RECV, ::Trace.default_endpoint))
+        ::Trace.record(::Trace::Annotation.new(@service_name, ::Trace.default_endpoint))
+        trace_rack_request(env)
+      end
+      yield if block_given?
+      ensure
+        @lock.synchronize do
+          ::Trace.record(::Trace::Annotation.new(::Trace::Annotation::SERVER_SEND, ::Trace.default_endpoint))
+          ::Trace.pop
+      end
+    end
+
+    def trace_rack_request(env)
+      env.each do |k,v|
+        MetadataLogger.log(k.to_s, v.to_s)
+      end
+    end
+
+    def get_or_create_trace_id(env)
+      if env.has_key?(ZipkinTraceHeader::TRACE_ID)
+        @tid = env[ZipkinTraceHeader::TRACE_ID]
+      else
+        @tid = Trace.generate_id
+      end
+
+      if env.has_key?(ZipkinTraceHeader::SPAN_ID)
+        @spanid = env[ZipkinTraceHeader::SPAN_ID]
+      else
+        @spanid = Trace.generate_id
+      end
+
+      if env.has_key?(ZipkinTraceHeader::PARENT_SPAN_ID)
+        @parentspan = env[ZipkinTraceHeader::PARENT_SPAN_ID]
+      else
+        @parentspan = nil
+      end
+
+      # from Finagle source: flags are 0 = none , 1 = debug
+      Trace::TraceId.new @tid, @parentspan, @spanid, true, 0
+    end
+
+    def get_or_create_trace_id2(env)
+      id = ::Trace::TraceId.new(::Trace.generate_id, nil, ::Trace.generate_id, true, ::Trace::Flags::EMPTY)
+    end
+  end
+end

data/lib/ruby-zipkin/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/ruby-zipkin/metadata_logger.rb

@@ -0,0 +1,26 @@
+require 'finagle-thrift'
+require 'finagle-thrift/trace'
+
+#writes properties and request headers as metadata into a trace
+module RubyZipkin
+  class MetadataLogger
+
+    def self.log(key, value)
+      ::Trace.record(::Trace::BinaryAnnotation.new(key, value, "STRING", ::Trace.default_endpoint))
+    end
+
+    # Do a full dump of a request header into zipkin.
+    def self.log_request(headers, service_name = "UNDEFINED")
+      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
+    end
+  end
+end

data/lib/ruby-zipkin/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/ruby-zipkin/trace_filter.rb

@@ -0,0 +1,11 @@
+#Filters to decide wheter a request should be traced.
+module RubyZipkin
+  class TraceFilter
+
+    def self.UriFilter(uri)
+      #exclude static content requests:
+      if(uri.include?(".ttf") )
+    end
+
+  end
+end

data/lib/ruby-zipkin/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/ruby-zipkin/version.rb

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

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification 
+name: ruby-zipkin
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: 
+  segments: 
+  - 0
+  - 2
+  - 0
+  version: 0.2.0
+platform: ruby
+authors: 
+- Ivan Marcin
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2013-09-24 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: finagle-thrift
+  prerelease: false
+  requirement: &id001 !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: *id001
+- !ruby/object:Gem::Dependency 
+  name: scribe
+  prerelease: false
+  requirement: &id002 !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: *id002
+- !ruby/object:Gem::Dependency 
+  name: awesome_print
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id003
+description: Track rack header requests on zipkin
+email: 
+- ivan.marcin@lookout.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/ruby-zipkin/headers.rb
+- lib/ruby-zipkin/metadata_logger.rb
+- lib/ruby-zipkin/scriber.rb
+- lib/ruby-zipkin/trace_filter.rb
+- lib/ruby-zipkin/tracesampler.rb
+- lib/ruby-zipkin/version.rb
+- lib/ruby-zipkin.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: []
+