rubyzipkin 0.3.12 → 0.4.1

data/lib/rubyzipkin/headers.rb

@@ -1,11 +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"
+    TRACE_ID        = "X-B3-TRACEID"
+    SPAN_ID         = "X-B3-SPANID"
+    PARENT_SPAN_ID  = "X-B3-PARENTSPANID"
+    TRACE_SAMPLED   = "X-B3-SAMPLED"
+    TRACE_FLAGS     = "X-B3-FLAGS"
+    FORCE_SAMPLE    = "X-B3-FORCE-SAMPLE"
   end
 end

data/lib/rubyzipkin/metadata_logger.rb

@@ -6,11 +6,12 @@ module RubyZipkin
   class MetadataLogger
 
     # log a key value pair into a zipkin trace as a KV span value
-    def self.log(key, value)
+    # since logging can ve quite extensive, we set a cap for the max size in bytes for a trace header
+    def self.log(key, value, max_size_bytes = 512)
       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))
+        ::Trace.record(::Trace::BinaryAnnotation.new(key, value.as_json.to_s[0..max_size_bytes], "STRING", ::Trace.default_endpoint))
       else
-        ::Trace.record(::Trace::BinaryAnnotation.new(key, value.to_s, "STRING", ::Trace.default_endpoint))
+        ::Trace.record(::Trace::BinaryAnnotation.new(key, value.to_s[0..max_size_bytes], "STRING", ::Trace.default_endpoint))
       end
     end
 
@@ -22,5 +23,6 @@ module RubyZipkin
         end
       end
     end
+
   end
 end

data/lib/rubyzipkin/permanent_header_filter.rb

@@ -0,0 +1,18 @@
+# There's certain HTTP which just shouldn't be logged and we know about them
+# Reasons are either security, or size
+# Specifically session data, cookies, exception rescues.
+#
+# This was we don't need each client to black list them and having to set this up on their Initial config.
+module RubyZipkin
+  module PermanentFilter
+    HEADERS =
+    [
+      "rack.session",
+      "rack.session.record",
+      "rack.session.options",
+      "rack.request.cookie_hash",
+      "rack.request.cookie_string",
+      "rack.request.form_vars"
+    ]
+  end
+end

data/lib/rubyzipkin/trace_filter.rb

@@ -12,7 +12,7 @@ module RubyZipkin
       end
 
       keyword_blacklist.each do |key|
-        if uri.to_s.match key
+        if uri.to_s.match key or uri.to
           return true
         end
       end
@@ -42,6 +42,13 @@ module RubyZipkin
           return true
         end
       end
+
+      PermanentFilter::HEADERS.each do |blacklisted|
+        if keyword.to_s.match(/.*(#{blacklisted}).*/)
+          return true
+        end
+      end
+
       false
     end
   end

data/lib/rubyzipkin/tracesampler.rb

@@ -10,7 +10,7 @@ module RubyZipkin
           return 1
         end
       end
-      return 0.01
+      return 0.0001
     end
   end
 end

data/lib/rubyzipkin/version.rb

@@ -1,3 +1,3 @@
 module RubyZipkin
-  VERSION = "0.3.12"
+  VERSION = "0.4.1"
 end

data/lib/rubyzipkin.rb

@@ -14,7 +14,7 @@ module RubyZipkin extend self
 
   class RackHandler
 
-    def initialize(app, service_name, scribe_server, scribe_port, uri_filter_list = [], http_header_filter_list = [], uri_sample_filter_list = {}, sampling_rate = 0.01, scribe_max_buffer = 10 )
+    def initialize(app, service_name, scribe_server, scribe_port, uri_filter_list = [], http_header_filter_list = [], uri_sample_filter_list = {}, sampling_rate = 0.0001, scribe_max_buffer = 50 )
       @app = app
       @lock = Mutex.new
 
@@ -33,15 +33,15 @@ module RubyZipkin extend self
         ::Trace.default_endpoint = ::Trace.default_endpoint.with_service_name(@service_name + "_#{normalized_uri(env['PATH_INFO'])}")
 
         set_sample_rate(env)
-
+        trace_id = get_or_create_trace_id(env)
         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)
+
+        tracing_filter(trace_id, 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
@@ -99,7 +99,8 @@ module RubyZipkin extend self
     end
 
     def trace_post_data(content)
-      MetadataLogger.log('HTTP_REQUEST INPUT', content.to_s)
+      # Slightly large size cap to the request input to accomodate larger JSON bodies.
+      MetadataLogger.log('HTTP_REQUEST INPUT', content.to_s, 2048)
     end
 
     def trace_hash(content)
@@ -113,23 +114,28 @@ module RubyZipkin extend self
     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]
+      end
 
-        if !env[ZipkinTraceHeader::SPAN_ID].nil? and !env[ZipkinTraceHeader::SPAN_ID].to_s.empty?
+      if env[ZipkinTraceHeader::SPAN_ID].nil? or env[ZipkinTraceHeader::SPAN_ID].to_s.empty?
+          @parentspan = nil
+      else
           @parentspan = env[ZipkinTraceHeader::SPAN_ID]
-        end
       end
 
       @spanid = Trace.generate_id
+
+      # Save into headers
+      env[ZipkinTraceHeader::TRACE_ID] = @trace_id
       env[ZipkinTraceHeader::SPAN_ID] = @spanid
+      env[ZipkinTraceHeader::PARENT_SPAN_ID] = @parentspan
 
-      Trace::TraceId.new @tid, @parentspan, @spanid, true
+      Trace::TraceId.new(@tid, @parentspan, @spanid, true)
     end
 
     def get_or_create_trace_id2(env)

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: rubyzipkin
 version: !ruby/object:Gem::Version 
-  hash: 11
+  hash: 13
   prerelease: 
   segments: 
   - 0
-  - 3
-  - 12
-  version: 0.3.12
+  - 4
+  - 1
+  version: 0.4.1
 platform: ruby
 authors: 
 - Ivan Marcin
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2013-11-18 00:00:00 Z
+date: 2013-12-16 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: scribe
@@ -77,6 +77,7 @@ extra_rdoc_files: []
 files: 
 - lib/rubyzipkin/headers.rb
 - lib/rubyzipkin/metadata_logger.rb
+- lib/rubyzipkin/permanent_header_filter.rb
 - lib/rubyzipkin/scriber.rb
 - lib/rubyzipkin/trace_filter.rb
 - lib/rubyzipkin/tracesampler.rb