zipkin-tracer 0.4.0 → 0.5.1

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    ODAyNWNhMDMzYmJjY2RiODkyNGIwNjY1Y2FiYTZhZmRiN2E3NmJlYw==
-  data.tar.gz: !binary |-
-    MmZlNDUwMDI5ZmY5N2E0YjlmNWY0NGFhNDU4MWQ4OWNkYTA5YzE3MA==
+SHA1:
+  metadata.gz: cc36cf36304c766a560916c48018e38589f70ddf
+  data.tar.gz: 284ef99f881958de1282d5132a52c46441fdba7f
 SHA512:
-  metadata.gz: !binary |-
-    OWQzOWFjYTBkYmExZTgwYzRmOWI2M2ZiZTEyMWY4ZDdmOGE0M2Q3ODVkZmYy
-    N2MwMWFjNjg4NzM4N2RhNDJjYTAzNDFiNDA1YzgxMjIxODhiYjIxMzk3ZjFm
-    ZDNlYjE4YzgyZjQyZTU2Mzk1ZDM0ZDc5ZTI5ZDUwZjMyMjJiZDA=
-  data.tar.gz: !binary |-
-    MWM4NDY3MGZhMzI4NDhlOGU1YmIxNTNiODdjM2U4M2FiNmM4ZDI1ODA2ODM4
-    MDI1NjExYjM2NzY5M2JlN2E4ZmYxODQ3OGVmZTQ1MWEzZWVmNTM4NWYzNjFh
-    Mjk5ZTVlOGNmZDliYjM3YzIyMWU3MDZhZTljZDQ4OWE3OWE3MjA=
+  metadata.gz: b092180723094e71621a49226c49af1f053d9576c48555c9212081278a3e67692b3d35678f1b5795605d1bc8aa00e9ebe091d810cec6f75a909ccefd4dd96bd9
+  data.tar.gz: 4f466e1962b76d1cf60bedb49648c43c233a6fe3a98db000026d2798371dcac289e558c4f13274caf956b6cbca7198cdd916e256398ed9d6517bc45d128c8746

data/lib/zipkin-tracer/config.rb

@@ -0,0 +1,43 @@
+module ZipkinTracer
+
+  class Config
+    attr_reader :service_name, :service_port, :scribe_server, :zookeeper, :sample_rate,
+      :scribe_max_buffer, :annotate_plugin, :filter_plugin, :whitelist_plugin
+
+    def initialize(app, config_hash)
+      config = config_hash || app_config(app)
+      @service_name      = config[:service_name]
+      @service_port      = config[:service_port]
+      @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
+    end
+
+    def using_scribe?
+      !!(@scribe_server && defined?(::Scribe))
+    end
+
+    def using_kafka?
+      !!(@zookeeper && RUBY_PLATFORM == 'java' && defined?(::Hermann))
+    end
+
+    private
+
+    DEFAULTS = {
+      scribe_max_buffer: 10,
+      sample_rate: 0.1
+    }
+
+    def app_config(app)
+      if app.respond_to?(:config) && app.config.respond_to?(:zipkin_tracer)
+        app.config.zipkin_tracer
+      else
+        {}
+      end
+    end
+  end
+end

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

@@ -0,0 +1,56 @@
+require 'faraday'
+require 'finagle-thrift'
+require 'finagle-thrift/trace'
+require 'uri'
+
+module ZipkinTracer
+  class FaradayHandler < ::Faraday::Middleware
+    B3_HEADERS = {
+      :trace_id => "X-B3-TraceId",
+      :parent_id => "X-B3-ParentSpanId",
+      :span_id => "X-B3-SpanId",
+      :sampled => "X-B3-Sampled",
+      :flags => "X-B3-Flags"
+    }.freeze
+
+    def initialize(app, service_name=nil)
+      @app = app
+      @service_name = service_name
+    end
+
+    def call(env)
+      # handle either a URI object (passed by Faraday v0.8.x in testing), or something string-izable
+      url = env[:url].respond_to?(:host) ? env[:url] : URI.parse(env[:url].to_s)
+      service_name = @service_name || url.host.split('.').first # default to url-derived service name
+      endpoint = ::Trace::Endpoint.new(host_ip_for(url.host), url.port, service_name)
+
+      ::Trace.unwind do
+        trace_id = ::Trace.id
+        ::Trace.push(trace_id.next_id)
+        B3_HEADERS.each do |method, header|
+          env[:request_headers][header] = ::Trace.id.send(method).to_s
+        end
+
+        # annotate with method (GET/POST/etc.) and uri path
+        ::Trace.set_rpc_name(env[:method].to_s.upcase)
+        ::Trace.record(::Trace::BinaryAnnotation.new("http.uri", url.path, "STRING", endpoint))
+        ::Trace.record(::Trace::Annotation.new(::Trace::Annotation::CLIENT_SEND, endpoint))
+        result = @app.call(env).on_complete do |renv|
+          # record HTTP status code on response
+          ::Trace.record(::Trace::BinaryAnnotation.new("http.status", [renv[:status]].pack('n'), "I16", endpoint))
+        end
+        ::Trace.record(::Trace::Annotation.new(::Trace::Annotation::CLIENT_RECV, endpoint))
+        result
+      end
+    end
+
+    # get host IP for specified hostname, catching exceptions
+    def host_ip_for(hostname)
+      ::Trace::Endpoint.host_to_i32(hostname)
+    rescue
+      # default to 0.0.0.0 if lookup fails
+      0x00000000
+    end
+    private :host_ip_for
+  end
+end

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

@@ -0,0 +1,116 @@
+# 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.
+require 'finagle-thrift'
+require 'finagle-thrift/trace'
+require 'scribe'
+
+require 'zipkin-tracer/config'
+require 'zipkin-tracer/careless_scribe'
+
+if RUBY_PLATFORM == 'java'
+  require 'hermann/producer'
+  require 'zipkin-tracer/zipkin_kafka_tracer'
+end
+
+module ZipkinTracer extend self
+
+  class RackHandler
+    B3_REQUIRED_HEADERS = %w[HTTP_X_B3_TRACEID HTTP_X_B3_PARENTSPANID HTTP_X_B3_SPANID HTTP_X_B3_SAMPLED]
+    B3_OPT_HEADERS = %w[HTTP_X_B3_FLAGS]
+
+    def initialize(app, config=nil)
+      @app = app
+      @lock = Mutex.new
+
+      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)
+      elsif config.using_kafka?
+        kafkaTracer = ::Trace::ZipkinKafkaTracer.new
+        kafkaTracer.connect(config.zookeeper)
+        kafkaTracer
+      end
+      @config = config
+
+    end
+
+    def call(env)
+      # skip certain requests
+      return @app.call(env) if filtered?(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) }
+    end
+
+    private
+    def annotate(env, status, response_headers, response_body)
+      @config.annotate_plugin.call(env, status, response_headers, response_body) if @config.annotate_plugin
+    end
+
+    def filtered?(env)
+      @config.filter_plugin && !@config.filter_plugin.call(env)
+    end
+
+    def force_sample?(env)
+      @config.whitelist_plugin && @config.whitelist_plugin.call(env)
+    end
+
+    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))
+        ::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.pop
+      end
+    end
+
+    private
+
+    def synchronize(&block)
+      @lock.synchronize do
+        yield
+      end
+    rescue# Nothing wonky that the tracer does should stop us from using the app!!!
+    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) }
+                           env.values_at(*B3_REQUIRED_HEADERS)
+                         else
+                           new_id = Trace.generate_id
+                           [new_id, nil, new_id, ("true" if whitelisted || Trace.should_sample?)]
+                         end
+      trace_parameters[3] = (trace_parameters[3] == "true")
+
+      trace_parameters += env.values_at(*B3_OPT_HEADERS) # always check flags
+      trace_parameters[4] = (trace_parameters[4] || default_flags).to_i
+
+      Trace::TraceId.new(*trace_parameters)
+    end
+  end
+
+end

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.4.0"
+  VERSION = "0.5.1"
 end
 

data/lib/zipkin-tracer.rb

@@ -1,113 +1,7 @@
-# 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.
-require 'finagle-thrift'
-require 'finagle-thrift/trace'
-require 'scribe'
+require 'zipkin-tracer/rack/zipkin-tracer'
 
-require 'zipkin-tracer/careless_scribe'
-
-if RUBY_PLATFORM == 'java'
-  require 'hermann/producer'
-  require 'zipkin-tracer/zipkin_kafka_tracer'
-end
-
-module ZipkinTracer extend self
-
-  class RackHandler
-    B3_REQUIRED_HEADERS = %w[HTTP_X_B3_TRACEID HTTP_X_B3_PARENTSPANID HTTP_X_B3_SPANID HTTP_X_B3_SAMPLED]
-    B3_OPT_HEADERS = %w[HTTP_X_B3_FLAGS]
-
-    def initialize(app, config=nil)
-      @app = app
-      @lock = Mutex.new
-
-      config ||= app.config.zipkin_tracer # if not specified, try on app (e.g. Rails 3+)
-      @service_name = config[:service_name]
-      @service_port = config[:service_port]
-
-      ::Trace.tracer = if config[:scribe_server] && defined?(::Scribe)
-        scribe = config[:scribe_server] ? Scribe.new(config[:scribe_server]) : Scribe.new()
-        scribe_max_buffer = config[:scribe_max_buffer] ? config[:scribe_max_buffer] : 10
-        ::Trace::ZipkinTracer.new(CarelessScribe.new(scribe), scribe_max_buffer)
-      elsif config[:zookeeper] && RUBY_PLATFORM == 'java' && defined?(::Hermann)
-        kafkaTracer = ::Trace::ZipkinKafkaTracer.new
-        kafkaTracer.connect(config[:zookeeper])
-        kafkaTracer
-      end
-
-      @sample_rate = config[:sample_rate] ? config[:sample_rate] : 0.1
-      @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
-    end
-
-    def call(env)
-      # skip certain requests
-      return @app.call(env) if filtered?(env)
-
-      ::Trace.default_endpoint = ::Trace.default_endpoint.with_service_name(@service_name).with_port(@service_port)
-      ::Trace.sample_rate=(@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) }
-    end
-
-    private
-    def annotate(env, status, response_headers, response_body)
-      @annotate_plugin.call(env, status, response_headers, response_body) if @annotate_plugin
-    end
-
-    def filtered?(env)
-      @filter_plugin && !@filter_plugin.call(env)
-    end
-
-    def force_sample?(env)
-      @whitelist_plugin && @whitelist_plugin.call(env)
-    end
-
-    def tracing_filter(trace_id, env, whitelisted=false)
-      @lock.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))
-        ::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
-      @lock.synchronize do
-        ::Trace.record(::Trace::Annotation.new(::Trace::Annotation::SERVER_SEND, ::Trace.default_endpoint))
-        annotate(env, status, headers, body)
-        ::Trace.pop
-      end
-    end
-
-    private
-    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) }
-                           env.values_at(*B3_REQUIRED_HEADERS)
-                         else
-                           new_id = Trace.generate_id
-                           [new_id, nil, new_id, ("true" if whitelisted || Trace.should_sample?)]
-                         end
-      trace_parameters[3] = (trace_parameters[3] == "true")
-
-      trace_parameters += env.values_at(*B3_OPT_HEADERS) # always check flags
-      trace_parameters[4] = (trace_parameters[4] || default_flags).to_i
-
-      Trace::TraceId.new(*trace_parameters)
-    end
-  end
-
-end
+begin
+  require 'faraday'
+  require 'zipkin-tracer/faraday/zipkin-tracer'
+rescue LoadError #Faraday is not available, we do not load our code.
+end

metadata

@@ -1,129 +1,143 @@
 --- !ruby/object:Gem::Specification
 name: zipkin-tracer
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.1
 platform: ruby
 authors:
 - Franklin Hu
 - R Tyler Croy
 - James Way
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
 date: 2015-09-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: finagle-thrift
-  requirement: !ruby/object:Gem::Requirement
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: 1.4.1
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: 1.4.1
+  prerelease: false
+  type: :runtime
 - !ruby/object:Gem::Dependency
   name: scribe
-  requirement: !ruby/object:Gem::Requirement
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: 0.2.4
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: 0.2.4
+  prerelease: false
+  type: :runtime
 - !ruby/object:Gem::Dependency
   name: rack
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
+        version: '1.6'
   prerelease: false
+  type: :runtime
+- !ruby/object:Gem::Dependency
+  name: rspec
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rspec
+        version: '3.3'
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 3.0.0
-  type: :development
+        version: '3.3'
   prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency
+  name: rack-test
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 3.0.0
-- !ruby/object:Gem::Dependency
-  name: rack-test
+        version: '0.6'
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
+        version: '0.6'
   prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency
+  name: rake
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rake
+        version: '10.0'
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
+        version: '10.0'
   prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency
+  name: pry
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: pry
+        version: '0.10'
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
+        version: '0.10'
   prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency
+  name: faraday
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: hermann
+        version: '0.8'
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '0.25'
-  type: :development
+        version: '0.8'
   prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency
+  name: hermann
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '0.25'
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.25'
+  prerelease: false
+  type: :development
 description: Adds tracing instrumentation for ruby applications
 email:
 - franklin@twitter.com
@@ -133,31 +147,34 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- lib/zipkin-tracer.rb
 - lib/zipkin-tracer/careless_scribe.rb
+- lib/zipkin-tracer/config.rb
 - lib/zipkin-tracer/version.rb
 - lib/zipkin-tracer/zipkin_kafka_tracer.rb
-- lib/zipkin-tracer.rb
+- lib/zipkin-tracer/faraday/zipkin-tracer.rb
+- lib/zipkin-tracer/rack/zipkin-tracer.rb
 homepage: https://github.com/openzipkin/zipkin-tracer
 licenses: []
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: 1.3.5
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.1.11
-signing_key: 
+rubyforge_project:
+rubygems_version: 2.1.9
+signing_key:
 specification_version: 4
 summary: Ruby tracing via Zipkin
 test_files: []