zipkin-tracer 0.0.1 → 0.2.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ODM0MDUyZmVmZTcyNjkwODQ1ZjMxOTdhYjQ1NWUzNzE3N2NiNTgwNg==
+  data.tar.gz: !binary |-
+    ZmI1NTA2NTk0YzdlZDdlYjlmNjZjYmRlYzFlOGJmOGVlY2U3ZTk5Ng==
+SHA512:
+  metadata.gz: !binary |-
+    M2YyMjk4MDU0MDk3ZDYxMjdmMGU4MGIwMzZhZmM4ZDM4NzM1MTUzMmU2OTFi
+    YjRiNmI1OWM0NTJlYmUwNDA5YThlODI0ZTI0MWFiNGI3OTQwMTFkYjA5MTk0
+    ZjAyYjBiMGJmYTNmNjkxMmI2YjczNjQ1ZGQ0YjQ4Y2VhMWZjOGI=
+  data.tar.gz: !binary |-
+    NGJlM2E0MDM2MzViMDVjMTMwYmU5ZjczMWY0ZmU1MTExNTYyOTIyOTRhODBj
+    YWQwMWU4ZTAwZmIyYmZhMzlhMjA4MzU5NDE5ODRkOWNiOTRhYzg1NTk4ZDU1
+    MGU5ZWE5ZjlkOTAxYTY5Yjg2ZDQ3ZDY3OTMxMWM1Y2Y5OWRlNGU=

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.0.1"
+  VERSION = "0.2.0"
 end
 

data/lib/zipkin-tracer.rb

@@ -20,11 +20,14 @@ require 'zipkin-tracer/careless_scribe'
 module ZipkinTracer extend self
 
   class RackHandler
-    def initialize(app)
+    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
+      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]
 
@@ -49,31 +52,69 @@ module ZipkinTracer extend self
           0.1
         end
 
+      @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
+
       ::Trace.tracer = ::Trace::ZipkinTracer.new(CarelessScribe.new(scribe), scribe_max_buffer)
     end
 
     def call(env)
-      id = ::Trace::TraceId.new(::Trace.generate_id, nil, ::Trace.generate_id, true)
+      # 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)
-      tracing_filter(id, env) { @app.call(env) }
+      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 tracing_filter(trace_id, env)
+    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
-      yield if block_given?
+      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

metadata

@@ -1,101 +1,130 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: zipkin-tracer
-version: !ruby/object:Gem::Version 
-  hash: 29
-  prerelease: 
-  segments: 
-  - 0
-  - 0
-  - 1
-  version: 0.0.1
+version: !ruby/object:Gem::Version
+  version: 0.2.0
 platform: ruby
-authors: 
+authors:
 - Franklin Hu
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-06-12 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2015-07-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: finagle-thrift
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 31
-        segments: 
-        - 1
-        - 2
-        - 0
-        version: 1.2.0
+      - !ruby/object:Gem::Version
+        version: 1.3.0
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+- !ruby/object:Gem::Dependency
   name: scribe
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.2.4
+  type: :runtime
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 31
-        segments: 
-        - 0
-        - 2
-        - 4
+      - !ruby/object:Gem::Version
         version: 0.2.4
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id002
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: thin
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Adds tracing instrumentation for ruby applications
-email: 
+email:
 - franklin@twitter.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - lib/zipkin-tracer/careless_scribe.rb
 - lib/zipkin-tracer/version.rb
 - lib/zipkin-tracer.rb
 homepage: https://github.com/twitter/zipkin
 licenses: []
-
+metadata: {}
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+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
+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: 1.8.15
+rubygems_version: 2.1.11
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Ruby tracing via Zipkin
 test_files: []
-