lookout-zipkin-tracer 0.2.0 → 0.3.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    MjQyZjdhNDc0YTI0ZDE4ZTAxNDAyNjAwMDBiZTkwYzkzYzE5MWFiYg==
+    ODdmODRhZmY4N2E4OWZmNzc5MzliOGUzMjI2NmJlMDRjY2IwMDhhNw==
   data.tar.gz: !binary |-
-    YjQyMDE2OWNiODE2ZGI3NmE5ODQzZDRjYjYzYTI5ZWFjZWEzM2JhNA==
+    MTAxMDgzY2QzYTZmN2QxOGRmZjNjYzhiYTQ1NzZkYWI5NmZiZDY0NQ==
 SHA512:
   metadata.gz: !binary |-
-    MzUzNTk0OTRiYTNjNzhiODg0OThkNTIxNTZmM2FlYTZkYmJlZTcwYWEyZWEy
-    MzFjYzgwMDc1ZTc2MDBkYmI0ODAyN2U2MjdlOTRlMmQ2NzE3NmJiNmJmMTQx
-    M2IyMTM4ZGYxOTg0ZjBjYzNlYzkwNGMyZjNmZjFiODQyYTQ4NWY=
+    MzJhNTdiNDQ2OGE1MDhjZWMwMzQ4M2JmMDc0OTg3NTY5ZTg1YTIwYzJiZjdh
+    MDRkYWRlYWY0NzZlYTkyYjQ4M2I2N2ZkOTUzZTRkODcxNWFhNzJlYjMzOWM1
+    MjQ4NmY1MDg5NjA1ZmFkMzE0Njc0ZWUxMTI2YjA0OWYwZjY4Mzg=
   data.tar.gz: !binary |-
-    YWQ0MmU2ZWZlMWM5NjExODYyOTliNzk3YzAwMGEwYmM0YWI4ODJjYmRhYzNk
-    ZGU2N2U5YTVjZDI5ZTIzNDNhYjRkNGNmNjI2ZjkzMzYyNTY4OTg5YTk3Y2Yw
-    ZDc2NDQ1MGJmZDc1ZTU2Zjg5NWY2NTBlMDNjNmVlZGEwNjY3MDI=
+    NDAzNGU5ZGMwYTgyYzM2ZmIzZjIwODJkMTI3NTc5NDg1MjcxZGU4MTgwMjVh
+    MzgzZjNhYTlkZDc3MTkyYTQwYTIyYWRkNThjNmIxNWZmM2Y5NGMzMjNhYmY5
+    ZDc2YmUxYTgyZTNlYzU3NTYxYzU1ZTlkNmY5MjRmNjA1MGVhYzA=

data/lib/zipkin-tracer.rb

@@ -21,7 +21,7 @@ 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_HEADERS = B3_REQUIRED_HEADERS + %w[HTTP_X_B3_FLAGS]
+    B3_OPT_HEADERS = %w[HTTP_X_B3_FLAGS]
 
     def initialize(app, config=nil)
       @app = app
@@ -52,41 +52,65 @@ 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)
+      # 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)
-      id = get_or_create_trace_id(env) # note that this depends on the sample rate being set
-      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, default_flags = ::Trace::Flags::EMPTY)
+    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_HEADERS)
+                           env.values_at(*B3_REQUIRED_HEADERS)
                          else
                            new_id = Trace.generate_id
-                           [new_id, nil, new_id, ("true" if Trace.should_sample?), default_flags]
+                           [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)

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.2.0"
+  VERSION = "0.3.0"
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lookout-zipkin-tracer
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Ariel Salomon, Franklin Hu
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-10 00:00:00.000000000 Z
+date: 2014-11-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: finagle-thrift
@@ -38,6 +38,62 @@ dependencies:
     - - ~>
       - !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
+  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:
 - ariel@lookout.com, franklin@twitter.com