finagle-thrift 1.2.0 → 1.3.1

data/lib/finagle-thrift/client.rb

@@ -21,7 +21,7 @@ module FinagleThrift
         header.parent_span_id = Trace.id.parent_id.to_i
         header.span_id = Trace.id.span_id.to_i
         header.sampled = Trace.id.sampled?
-        header.debug = false
+        header.flags = Trace.id.flags.to_i
 
         header.client_id = client_id if client_id
 

data/lib/finagle-thrift/thrift/tracing_types.rb

@@ -43,11 +43,13 @@ module FinagleThrift
       TIMESTAMP = 1
       VALUE = 2
       HOST = 3
+      DURATION = 4
 
       FIELDS = {
         TIMESTAMP => {:type => ::Thrift::Types::I64, :name => 'timestamp'},
         VALUE => {:type => ::Thrift::Types::STRING, :name => 'value'},
-        HOST => {:type => ::Thrift::Types::STRUCT, :name => 'host', :class => FinagleThrift::Endpoint, :optional => true}
+        HOST => {:type => ::Thrift::Types::STRUCT, :name => 'host', :class => FinagleThrift::Endpoint, :optional => true},
+        DURATION => {:type => ::Thrift::Types::I32, :name => 'duration', :optional => true}
       }
 
       def struct_fields; FIELDS; end
@@ -91,6 +93,7 @@ module FinagleThrift
       PARENT_ID = 5
       ANNOTATIONS = 6
       BINARY_ANNOTATIONS = 8
+      DEBUG = 9
 
       FIELDS = {
         TRACE_ID => {:type => ::Thrift::Types::I64, :name => 'trace_id'},
@@ -98,7 +101,8 @@ module FinagleThrift
         ID => {:type => ::Thrift::Types::I64, :name => 'id'},
         PARENT_ID => {:type => ::Thrift::Types::I64, :name => 'parent_id', :optional => true},
         ANNOTATIONS => {:type => ::Thrift::Types::LIST, :name => 'annotations', :element => {:type => ::Thrift::Types::STRUCT, :class => FinagleThrift::Annotation}},
-        BINARY_ANNOTATIONS => {:type => ::Thrift::Types::LIST, :name => 'binary_annotations', :element => {:type => ::Thrift::Types::STRUCT, :class => FinagleThrift::BinaryAnnotation}}
+        BINARY_ANNOTATIONS => {:type => ::Thrift::Types::LIST, :name => 'binary_annotations', :element => {:type => ::Thrift::Types::STRUCT, :class => FinagleThrift::BinaryAnnotation}},
+        DEBUG => {:type => ::Thrift::Types::BOOL, :name => 'debug'}
       }
 
       def struct_fields; FIELDS; end
@@ -134,17 +138,17 @@ module FinagleThrift
       TRACE_ID = 1
       SPAN_ID = 2
       PARENT_SPAN_ID = 3
-      DEBUG = 4
       SAMPLED = 5
       CLIENT_ID = 6
+      FLAGS = 7
 
       FIELDS = {
         TRACE_ID => {:type => ::Thrift::Types::I64, :name => 'trace_id'},
         SPAN_ID => {:type => ::Thrift::Types::I64, :name => 'span_id'},
         PARENT_SPAN_ID => {:type => ::Thrift::Types::I64, :name => 'parent_span_id', :optional => true},
-        DEBUG => {:type => ::Thrift::Types::BOOL, :name => 'debug'},
         SAMPLED => {:type => ::Thrift::Types::BOOL, :name => 'sampled', :optional => true},
-        CLIENT_ID => {:type => ::Thrift::Types::STRUCT, :name => 'client_id', :class => FinagleThrift::ClientId, :optional => true}
+        CLIENT_ID => {:type => ::Thrift::Types::STRUCT, :name => 'client_id', :class => FinagleThrift::ClientId, :optional => true},
+        FLAGS => {:type => ::Thrift::Types::I64, :name => 'flags', :optional => true}
       }
 
       def struct_fields; FIELDS; end

data/lib/finagle-thrift/trace.rb

@@ -6,7 +6,7 @@ module Trace
   def id
     if stack.empty?
       span_id = generate_id
-      trace_id = TraceId.new(span_id, nil, span_id, should_sample?)
+      trace_id = TraceId.new(span_id, nil, span_id, should_sample?, Flags::EMPTY)
       stack.push(trace_id)
     end
     stack.last
@@ -33,7 +33,7 @@ module Trace
         saved_stack = stack.dup
         yield
       ensure
-        @stack = saved
+        @stack = saved_stack
       end
     end
   end
@@ -58,23 +58,45 @@ module Trace
   end
 
   class TraceId
-    attr_reader :trace_id, :parent_id, :span_id, :sampled
-    alias :sampled? :sampled
-    def initialize(trace_id, parent_id, span_id, sampled)
+    attr_reader :trace_id, :parent_id, :span_id, :sampled, :flags
+
+    def initialize(trace_id, parent_id, span_id, sampled, flags)
       @trace_id = SpanId.from_value(trace_id)
       @parent_id = parent_id.nil? ? nil : SpanId.from_value(parent_id)
       @span_id = SpanId.from_value(span_id)
       @sampled = !!sampled
+      @flags = flags
     end
 
     def next_id
-      TraceId.new(@trace_id, @span_id, Trace.generate_id, @sampled)
+      TraceId.new(@trace_id, @span_id, Trace.generate_id, @sampled, @flags)
+    end
+
+    # the debug flag is used to ensure the trace passes ALL samplers
+    def debug?
+      @flags & Flags::DEBUG == Flags::DEBUG
+    end
+
+    def sampled?
+      debug? || @sampled
     end
 
     def to_s
-      "TraceId(trace_id = #{@trace_id.to_s}, parent_id = #{@parent_id.to_s}, span_id = #{@span_id.to_s}, sampled = #{@sampled.to_s})"
+      "TraceId(trace_id = #{@trace_id.to_s}, parent_id = #{@parent_id.to_s}, span_id = #{@span_id.to_s}, sampled = #{@sampled.to_s}, flags = #{@flags.to_s})"
     end
   end
+  
+  # there are a total of 64 flags that can be passed down with the various tracing headers
+  # at the time of writing only one is used (debug).
+  #
+  # Note that using the 64th bit in Ruby requires some sign conversion since Thrift i64s are signed 
+  # but Ruby won't do the right thing if you try to set 1 << 64
+  class Flags
+    # no flags set
+    EMPTY = 0
+    # the debug flag is used to ensure we pass all the sampling layers and that the trace is stored
+    DEBUG = 1
+  end
 
   class SpanId
     HEX_REGEX = /^[a-f0-9]{16}$/i

data/lib/finagle-thrift/tracer.rb

@@ -121,12 +121,13 @@ module Trace
   end
 
   class Span
-    attr_accessor :name, :annotations, :binary_annotations
+    attr_accessor :name, :annotations, :binary_annotations, :debug
     def initialize(name, span_id)
       @name = name
       @span_id = span_id
       @annotations = []
       @binary_annotations = []
+      @debug = span_id.debug?
     end
 
     def to_thrift
@@ -136,7 +137,8 @@ module Trace
         :id => @span_id.span_id.to_i,
         :parent_id => @span_id.parent_id.nil? ? nil : @span_id.parent_id.to_i,
         :annotations => @annotations.map { |a| a.to_thrift },
-        :binary_annotations => @binary_annotations.map { |a| a.to_thrift }
+        :binary_annotations => @binary_annotations.map { |a| a.to_thrift },
+        :debug => @debug
       )
     end
   end
@@ -147,7 +149,8 @@ module Trace
     SERVER_SEND = "ss"
     SERVER_RECV = "sr"
 
-    attr_reader :value, :host, :timestamp
+    # write access for tests
+    attr_accessor :value, :host, :timestamp
     def initialize(value, host)
       @timestamp = (Time.now.to_f * 1000 * 1000).to_i # micros
       @value = value

data/lib/finagle-thrift/version.rb

@@ -1,3 +1,3 @@
 module FinagleThrift
-  VERSION = "1.2.0"
-end
+  VERSION = "1.3.1"
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: finagle-thrift
 version: !ruby/object:Gem::Version 
-  hash: 31
+  hash: 25
   prerelease: 
   segments: 
   - 1
-  - 2
-  - 0
-  version: 1.2.0
+  - 3
+  - 1
+  version: 1.3.1
 platform: ruby
 authors: 
 - Arya Asemanfar
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-05-25 00:00:00 Z
+date: 2013-06-13 00:00:00 Z
 dependencies: []
 
 description: A Ruby client library for integrating into finagle's thrift tracing protocol