zipkin-tracer 0.30.0 → 0.31.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b3baf1dff1d2fa511cec7a66a040c4e817bb100d4e8984834d0471f8a1118d51
-  data.tar.gz: b2047d302ad9d4c50f265c33f640a03d02a6223379707c8146995667812dc023
+  metadata.gz: 831effb5b1041bf625d6aa6ef01d759245674ed4973b2bfd8c989ee4dd4e5fcd
+  data.tar.gz: f90164cd91b0e4e4190d5d15e4e6084cf941e6334e22be7f4aada18600e0844a
 SHA512:
-  metadata.gz: 9bfaaf722dcdad67fcb795db85cbaac6ab5b6234e76569d17982098ec38059e9d7f9fb5167ed0c0e177ff9857d987dbe68ab780e8dbfef0fc18e220dbb784664
-  data.tar.gz: 8ddb0aba5a360756b11015aea6d13949a14d4653de0123664f7e7264c8e67655544cea722002d098358bef67e476be7ecdc6747a214b93886fdab9a76828997d
+  metadata.gz: 10b1de8bb1d255f6b85438b99b4a049423ebef3fb57c3489197a73d153d2b0ef7c9d72f2e4993813d425d7c911870519e2f4f88870eb87d0bd9a8ab261e069fd
+  data.tar.gz: c481a2312408e698c0b4fc5ca22692e7cccf2539806dc72615d2d8dc4f20d96fb8c5846b5bf0aa1cbd3239e4544a2eb7f22a17a241705d253fb5ec5f70a404a2

data/lib/zipkin-tracer.rb

@@ -1,5 +1,3 @@
-require 'finagle-thrift'
-require 'base64' #Bug in finagle. They should be requiring this: finagle-thrift-1.4.1/lib/finagle-thrift/tracer.rb:115
 require 'zipkin-tracer/trace'
 require 'zipkin-tracer/rack/zipkin-tracer'
 require 'zipkin-tracer/sidekiq/middleware'

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

@@ -1,5 +1,3 @@
-require 'finagle-thrift/trace'
-require 'finagle-thrift/tracer'
 require 'uri'
 require 'excon'
 

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

@@ -1,6 +1,4 @@
 require 'faraday'
-require 'finagle-thrift/trace'
-require 'finagle-thrift/tracer'
 require 'uri'
 
 module ZipkinTracer

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

@@ -1,6 +1,4 @@
 require 'rack'
-require 'finagle-thrift/trace'
-require 'finagle-thrift/tracer'
 require 'zipkin-tracer/config'
 require 'zipkin-tracer/tracer_factory'
 require 'zipkin-tracer/rack/zipkin_env'

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

@@ -34,7 +34,7 @@ module ZipkinTracer
         trace_id, span_id = @env.values_at(*B3_REQUIRED_HEADERS)
         parent_span_id = @env['HTTP_X_B3_PARENTSPANID']
       else
-        span_id = Trace.generate_id
+        span_id = TraceGenerator.new.generate_id
         trace_id = TraceGenerator.new.generate_id_from_span_id(span_id)
         parent_span_id = nil
       end

data/lib/zipkin-tracer/trace.rb

@@ -1,21 +1,134 @@
-require 'finagle-thrift/trace'
 require 'zipkin-tracer/zipkin_tracer_base'
-# Module with a mix of functions and overwrites from the finagle implementation:
+# Most of this code is copied from Finagle
 # https://github.com/twitter/finagle/blob/finagle-6.39.0/finagle-thrift/src/main/ruby/lib/finagle-thrift/trace.rb
+# But moved and improved here.
 module Trace
+  # These methods and attr_accessor below are used as global configuration of this gem
+  # Most of these are set by the config class and then used around.
+  # TODO: Move this out of the Trace module , take out that extend self and be happier
+  extend self
   attr_accessor :trace_id_128bit
 
-  # We need this to access the tracer from the Faraday middleware.
   def self.tracer
     @tracer
   end
 
-  def sample_rate
+  def self.sample_rate
     @sample_rate
   end
 
+  def self.tracer=(tracer)
+    @tracer = tracer
+  end
+
+  def self.sample_rate=(sample_rate)
+    if sample_rate > 1 || sample_rate < 0
+      raise ArgumentError.new("sample rate must be [0,1]")
+    end
+    @sample_rate = sample_rate
+  end
+
+  def default_endpoint=(endpoint)
+    @default_endpoint = endpoint
+  end
+
+  def default_endpoint
+    @default_endpoint
+  end
+
+  # These classes all come from Finagle-thrift + some needed modifications (.to_h)
+  # Moved here as a first step, eventually move them out of the Trace module
+
+  class Annotation
+    CLIENT_SEND = "cs"
+    CLIENT_RECV = "cr"
+    SERVER_SEND = "ss"
+    SERVER_RECV = "sr"
+
+    attr_reader :value, :host, :timestamp
+    def initialize(value, host)
+      @timestamp = (Time.now.to_f * 1000 * 1000).to_i # micros
+      @value = value
+      @host = host
+    end
+
+    def to_h
+      {
+        value: @value,
+        timestamp: @timestamp,
+        endpoint: host.to_h
+      }
+    end
+  end
+
+  class BinaryAnnotation
+    SERVER_ADDRESS = 'sa'.freeze
+    URI = 'http.url'.freeze
+    METHOD = 'http.method'.freeze
+    PATH = 'http.path'.freeze
+    STATUS = 'http.status'.freeze
+    LOCAL_COMPONENT = 'lc'.freeze
+    ERROR = 'error'.freeze
+
+    module Type
+      BOOL = "BOOL"
+      STRING = "STRING"
+    end
+    attr_reader :key, :value, :host
+
+    def initialize(key, value, annotation_type, host)
+      @key = key
+      @value = value
+      @annotation_type = annotation_type
+      @host = host
+    end
+
+    def to_h
+      {
+        key: @key,
+        value: @value,
+        endpoint: host.to_h
+      }
+    end
+  end
+
+  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,32}$/i
+    MAX_SIGNED_I64 = 9223372036854775807
+    MASK = (2 ** 64) - 1
+
+    def self.from_value(v)
+      if v.is_a?(String) && v =~ HEX_REGEX
+        # drops any bits higher than 64 by selecting right-most 16 characters
+        new(v.length > 16 ? v[v.length - 16, 16].hex : v.hex)
+      elsif v.is_a?(Numeric)
+        new(v)
+      elsif v.is_a?(SpanId)
+        v
+      end
+    end
+
+    def initialize(value)
+      @value = value
+      @i64 = if @value > MAX_SIGNED_I64
+        -1 * ((@value ^ MASK) + 1)
+      else
+        @value
+      end
+    end
+
+    def to_s; "%016x" % @value; end
+    def to_i; @i64; end
+  end
+
   # A TraceId contains all the information of a given trace id
-  # This class is defined in finagle-thrift. We are overwriting it here
   class TraceId
     attr_reader :trace_id, :parent_id, :span_id, :sampled, :flags
 
@@ -27,8 +140,8 @@ module Trace
       @flags = flags
     end
 
-    def next_id
-      TraceId.new(@trace_id, @span_id, Trace.generate_id, @sampled, @flags)
+    def next_id(next_span_id)
+      TraceId.new(@trace_id, @span_id, next_span_id, @sampled, @flags)
     end
 
     # the debug flag is used to ensure the trace passes ALL samplers
@@ -45,8 +158,6 @@ module Trace
     end
   end
 
-  # This class is the 128-bit version of the SpanId class:
-  # https://github.com/twitter/finagle/blob/finagle-6.39.0/finagle-thrift/src/main/ruby/lib/finagle-thrift/trace.rb#L102
   class TraceId128Bit < SpanId
     HEX_REGEX_16 = /^[a-f0-9]{16}$/i
     HEX_REGEX_32 = /^[a-f0-9]{32}$/i
@@ -79,8 +190,8 @@ module Trace
   end
 
   # A span may contain many annotations
-  # This class is defined in finagle-thrift. We are adding extra methods here
   class Span
+    attr_accessor :name, :annotations, :binary_annotations, :debug
     def initialize(name, span_id)
       @name = name
       @span_id = span_id
@@ -136,51 +247,33 @@ module Trace
     end
   end
 
-  # This class is defined in finagle-thrift. We are adding extra methods here
-  class Annotation
-    def to_h
-      {
-        value: @value,
-        timestamp: @timestamp,
-        endpoint: host.to_h
-      }
-    end
-  end
-
-  # This class is defined in finagle-thrift. We are adding extra methods here
-  class BinaryAnnotation
-    SERVER_ADDRESS = 'sa'.freeze
-    URI = 'http.uri'.freeze
-    METHOD = 'http.method'.freeze
-    PATH = 'http.path'.freeze
-    STATUS = 'http.status'.freeze
-    LOCAL_COMPONENT = 'lc'.freeze
-    ERROR = 'error'.freeze
+  class Endpoint < Struct.new(:ipv4, :port, :service_name, :ip_format)
+    MAX_I32 = ((2 ** 31) - 1)
+    MASK = (2 ** 32) - 1
+    UNKNOWN_URL = 'unknown'.freeze
 
-    def to_h
-      {
-        key: @key,
-        value: @value,
-        endpoint: host.to_h
-      }
-    end
-  end
+    def self.host_to_i32(host)
+      unsigned_i32 = Socket.getaddrinfo(host, nil)[0][3].split(".").map do |i|
+        i.to_i
+      end.inject(0) { |a,e| (a << 8) + e }
 
-  # This class is defined in finagle-thrift. We are adding extra methods here
-  class Endpoint
-    UNKNOWN_URL = 'unknown'.freeze
+      signed_i32 = if unsigned_i32 > MAX_I32
+        -1 * ((unsigned_i32 ^ MASK) + 1)
+      else
+        unsigned_i32
+      end
 
-    # we cannot override the initializer to add an extra parameter so use a factory
-    attr_accessor :ip_format
+      signed_i32
+    end
 
     def self.local_endpoint(service_port, service_name, ip_format)
       hostname = Socket.gethostname
-      Endpoint.make_endpoint(hostname, service_port, service_name, ip_format)
+      Endpoint.new(hostname, service_port, service_name, ip_format)
     end
 
     def self.remote_endpoint(url, remote_service_name, ip_format)
       service_name = remote_service_name || url.host.split('.').first || UNKNOWN_URL # default to url-derived service name
-      Endpoint.make_endpoint(url.host, url.port, service_name, ip_format)
+      Endpoint.new(url.host, url.port, service_name, ip_format)
     end
 
     def to_h
@@ -191,12 +284,5 @@ module Trace
       }
     end
 
-    private
-    def self.make_endpoint(hostname, service_port, service_name, ip_format)
-      ep = Endpoint.new(hostname, service_port, service_name)
-      ep.ip_format = ip_format
-      ep
-    end
-
   end
 end

data/lib/zipkin-tracer/trace_generator.rb

@@ -4,7 +4,7 @@ module ZipkinTracer
     # Next id, based on the current information in the container
     def next_trace_id
       if TraceContainer.tracing_information_set?
-        TraceContainer.current.next_id
+        TraceContainer.current.next_id(generate_id)
       else
         generate_trace_id
       end
@@ -23,12 +23,12 @@ module ZipkinTracer
       Trace.trace_id_128bit ? generate_id_128bit(span_id) : span_id
     end
 
-    private
-
     def generate_id
       rand(TRACE_ID_UPPER_BOUND)
     end
 
+    private
+
     def generate_id_128bit(span_id)
       trace_id_low_64bit = '%016x' % span_id
       "#{trace_id_epoch_seconds}#{trace_id_high_32bit}#{trace_id_low_64bit}".hex

data/lib/zipkin-tracer/version.rb

@@ -1,3 +1,3 @@
 module ZipkinTracer
-  VERSION = '0.30.0'.freeze
+  VERSION = '0.31.0'.freeze
 end

data/lib/zipkin-tracer/zipkin_kafka_tracer.rb

@@ -2,6 +2,7 @@
 begin
   require 'hermann/producer'
   require 'hermann/discovery/zookeeper'
+  require 'finagle-thrift'
 rescue LoadError => e
 end
 
@@ -26,7 +27,7 @@ module Trace
       end
       super(options)
     end
-    
+
     def flush!
       resolved_spans = ::ZipkinTracer::HostnameResolver.new.spans_with_ips(spans)
       resolved_spans.each do |span|

data/lib/zipkin-tracer/zipkin_tracer_base.rb

@@ -1,5 +1,4 @@
 require 'faraday'
-require 'finagle-thrift/tracer'
 
 module Trace
   # This class is a base for tracers sending information to Zipkin.
@@ -7,7 +6,7 @@ module Trace
   # is done with its request
   # Traces dealing with zipkin should inherit from this class and implement the
   # flush! method which actually sends the information
-  class ZipkinTracerBase < Tracer
+  class ZipkinTracerBase
 
     def initialize(options={})
       @options = options

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zipkin-tracer
 version: !ruby/object:Gem::Version
-  version: 0.30.0
+  version: 0.31.0
 platform: ruby
 authors:
 - Franklin Hu
@@ -13,7 +13,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-12-06 00:00:00.000000000 Z
+date: 2019-01-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -29,20 +29,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.8'
-- !ruby/object:Gem::Dependency
-  name: finagle-thrift
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.4.2
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.4.2
 - !ruby/object:Gem::Dependency
   name: rack
   requirement: !ruby/object:Gem::Requirement
@@ -91,28 +77,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.3'
+        version: '3.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.3'
+        version: '3.8'
 - !ruby/object:Gem::Dependency
   name: rack-test
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: '1.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -155,6 +141,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
 description: Adds tracing instrumentation for ruby applications
 email:
 - franklin@twitter.com
@@ -206,8 +206,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.5
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.8
+rubygems_version: 3.0.2
 signing_key: 
 specification_version: 4
 summary: Ruby tracing via Zipkin