jaeger-client 0.4.1 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5606aec21baf412bfe48e4c40291596abc074cd7
-  data.tar.gz: 23c1915aa787002021cc84e9392ad599032128f1
+  metadata.gz: 75c88fcea8c5fa02b502e8c2c6cb3838a246e714
+  data.tar.gz: 12d8f676f98d486d1b9db5e73c7dc757e46477a8
 SHA512:
-  metadata.gz: 21a5aebe28a5c1b4cfe8457ad5735c6e419edefed9d27651b0bbfbf22d3140a3fd958335ff759c569ea88552f02a619866bc6ab90de3b76100796cb4f6a599d7
-  data.tar.gz: 40dc4610c85b315c347d41a2ff3cd5645e3ea3ba688b14f4418828acb58ba8e90df92554809b430fdb978f122c1c65b59988a8198d700656ae35256392916adf
+  metadata.gz: 2eedd11ef42e96094a128fd32df3c3bf5a152d498dd09933a667930caa5af7f287c00bddf9524cc87429898ff78a7e3cc1d2da1b38f560be9f3731bfe0f42ac1
+  data.tar.gz: c478b9e68a708fd6a093d08b38c844136535a4b3723dd717392dd7ce5852ac01ba2a6b0948f954924cbe9a46daf6ea9e13f8d87242bb58a647fb44a0d0695d6f

data/.rubocop.yml

@@ -0,0 +1,32 @@
+require: rubocop-rspec
+
+AllCops:
+  Exclude:
+    - 'thrift/**/*'
+
+Style/Documentation:
+  Enabled: no
+
+Style/IfUnlessModifier:
+  Enabled: no
+
+RSpec/NestedGroups:
+  Max: 4
+
+RSpec/ExampleLength:
+  Enabled: no
+
+Metrics/BlockLength:
+  Enabled: no
+
+Metrics/MethodLength:
+  Enabled: no
+
+Metrics/AbcSize:
+  Enabled: no
+
+Lint/UnusedMethodArgument:
+  Enabled: no
+
+Metrics/LineLength:
+  Max: 120

data/Rakefile

@@ -1,6 +1,9 @@
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+RuboCop::RakeTask.new(:rubocop)
+
+task default: %i[rubocop spec]

data/bin/console

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
-require "bundler/setup"
-require "jaeger/client"
+require 'bundler/setup'
+require 'jaeger/client'
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
@@ -10,5 +10,5 @@ require "jaeger/client"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start(__FILE__)

data/jaeger-client.gemspec

@@ -1,15 +1,17 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
+require 'jaeger/client/version'
+
 Gem::Specification.new do |spec|
   spec.name          = 'jaeger-client'
-  spec.version       = '0.4.1'
+  spec.version       = Jaeger::Client::VERSION
   spec.authors       = ['SaleMove TechMovers']
   spec.email         = ['techmovers@salemove.com']
 
-  spec.summary       = %q{OpenTracing Tracer implementation for Jaeger in Ruby}
-  spec.description   = %q{}
+  spec.summary       = 'OpenTracing Tracer implementation for Jaeger in Ruby'
+  spec.description   = ''
   spec.homepage      = ''
   spec.license       = 'MIT'
 
@@ -22,6 +24,8 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'bundler', '~> 1.14'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop', '~> 0.54.0'
+  spec.add_development_dependency 'rubocop-rspec', '~> 1.24.0'
 
   spec.add_dependency 'opentracing', '~> 0.3'
   spec.add_dependency 'thrift'

data/lib/jaeger/client.rb

@@ -9,6 +9,7 @@ require_relative 'client/carrier'
 require_relative 'client/trace_id'
 require_relative 'client/udp_sender'
 require_relative 'client/collector'
+require_relative 'client/version'
 
 module Jaeger
   module Client

data/lib/jaeger/client/carrier.rb

@@ -7,21 +7,18 @@ module Jaeger
       # [] retrieves a value by the given key
       # @param key [String] key to retrieve the value
       # @return [String] the desired value
-      def [](key)
-      end
+      def [](key); end
 
       # []= sets the value for the given key
       # @param key [String] key to set
       # @param value [String] value to set
-      def []=(key, value)
-      end
+      def []=(key, value); end
 
       # each iterates over every key-value pair in the carrier
       # @yield [key, value]
       # @yieldparam key [String] the key of the tuple
       # @yieldparam value [String] the value of the tuple
-      def each(&block)
-      end
+      def each(&block); end
     end
   end
 end

data/lib/jaeger/client/collector.rb

@@ -33,14 +33,14 @@ module Jaeger
       private
 
       def build_tags(tags)
-        tags.map {|name, value| build_tag(name, value)}
+        tags.map { |name, value| build_tag(name, value) }
       end
 
       def build_logs(logs)
         logs.map do |timestamp:, fields:|
           Jaeger::Thrift::Log.new(
             'timestamp' => (timestamp.to_f * 1_000_000).to_i,
-            'fields' => fields.map {|name, value| build_tag(name, value)}
+            'fields' => fields.map { |name, value| build_tag(name, value) }
           )
         end
       end

data/lib/jaeger/client/span.rb

@@ -52,7 +52,7 @@ module Jaeger
       # @param timestamp [Time] time of the log
       # @param fields [Hash] Additional information to log
       def log(timestamp: Time.now, **fields)
-        @logs << {timestamp: timestamp, fields: fields}
+        @logs << { timestamp: timestamp, fields: fields }
       end
 
       # Finish the {Span}
@@ -66,7 +66,7 @@ module Jaeger
 
       def build_binary_annotations
         @tags.map do |name, value|
-          {key: name, value: value.to_s}
+          { key: name, value: value.to_s }
         end
       end
     end

data/lib/jaeger/client/span_context.rb

@@ -37,9 +37,9 @@ module Jaeger
       end
 
       def to_s
-        "#<SpanContext @span_id=#{span_id.to_s(16)} " +
-          "@parent_id=#{parent_id.to_s(16)} " +
-          "@trace_id=#{trace_id.to_s(16)} " +
+        "#<SpanContext @span_id=#{span_id.to_s(16)} " \
+          "@parent_id=#{parent_id.to_s(16)} " \
+          "@trace_id=#{trace_id.to_s(16)} " \
           "@flags=#{flags}>"
       end
     end

data/lib/jaeger/client/trace_id.rb

@@ -1,7 +1,7 @@
 module Jaeger
   module Client
     module TraceId
-      TRACE_ID_UPPER_BOUND = 2 ** 63 - 1
+      TRACE_ID_UPPER_BOUND = 2**63 - 1
 
       def self.generate
         rand(TRACE_ID_UPPER_BOUND)

data/lib/jaeger/client/tracer.rb

@@ -72,21 +72,24 @@ module Jaeger
       def parse_context(trace)
         return nil if !trace || trace == ''
 
-        trace_arguments = trace.split(':').map {|arg| arg.to_i(16)}
+        trace_arguments = trace.split(':').map { |arg| arg.to_i(16) }
         return nil if trace_arguments.size != 4
 
         trace_id, span_id, parent_id, flags = trace_arguments
+        return nil if trace_id.zero? || span_id.zero?
 
-        if trace_id != 0 && span_id != 0
-          SpanContext.new(
-            trace_id: trace_id,
-            parent_id: parent_id,
-            span_id: span_id,
-            flags: flags
-          )
-        else
-          nil
-        end
+        SpanContext.new(
+          trace_id: to_signed_int(trace_id, 64),
+          parent_id: to_signed_int(parent_id, 64),
+          span_id: to_signed_int(span_id, 64),
+          flags: flags
+        )
+      end
+
+      def to_signed_int(num, bits)
+        # Using two's complement
+        mask = 2**(bits - 1)
+        (num & ~mask) - (num & mask)
       end
     end
   end

data/lib/jaeger/client/udp_sender.rb

@@ -1,5 +1,6 @@
 require_relative './udp_sender/transport'
 require 'jaeger/thrift/agent'
+require 'socket'
 require 'thread'
 
 module Jaeger
@@ -10,6 +11,27 @@ module Jaeger
         @collector = collector
         @flush_interval = flush_interval
 
+        @tags = [
+          Jaeger::Thrift::Tag.new(
+            'key' => 'jaeger.version',
+            'vType' => Jaeger::Thrift::TagType::STRING,
+            'vStr' => 'Ruby-' + Jaeger::Client::VERSION
+          ),
+          Jaeger::Thrift::Tag.new(
+            'key' => 'hostname',
+            'vType' => Jaeger::Thrift::TagType::STRING,
+            'vStr' => Socket.gethostname
+          )
+        ]
+        ipv4 = Socket.ip_address_list.find { |ai| ai.ipv4? && !ai.ipv4_loopback? }
+        unless ipv4.nil?
+          @tags << Jaeger::Thrift::Tag.new(
+            'key' => 'ip',
+            'vType' => Jaeger::Thrift::TagType::STRING,
+            'vStr' => ipv4.ip_address
+          )
+        end
+
         transport = Transport.new(host, port)
         protocol = ::Thrift::CompactProtocol.new(transport)
         @client = Jaeger::Thrift::Agent::Client.new(protocol)
@@ -38,7 +60,7 @@ module Jaeger
         batch = Jaeger::Thrift::Batch.new(
           'process' => Jaeger::Thrift::Process.new(
             'serviceName' => @service_name,
-            'tags' => [],
+            'tags' => @tags
           ),
           'spans' => thrift_spans
         )

data/lib/jaeger/client/udp_sender/transport.rb

@@ -20,6 +20,7 @@ module Jaeger
         end
 
         def open; end
+
         def close; end
 
         private
@@ -29,7 +30,7 @@ module Jaeger
           @socket.flush
         rescue Errno::ECONNREFUSED
           warn 'Unable to connect to Jaeger Agent'
-        rescue => e
+        rescue StandardError => e
           warn "Unable to send spans: #{e.message}"
         end
       end

data/lib/jaeger/client/version.rb

@@ -0,0 +1,5 @@
+module Jaeger
+  module Client
+    VERSION = '0.4.2'.freeze
+  end
+end

data/script/create_trace

@@ -11,24 +11,31 @@ port = ENV['JAEGER_HOST'] || 6831
 tracer1 = Jaeger::Client.build(host: host, port: port.to_i, service_name: 'test-service', flush_interval: 1)
 tracer2 = Jaeger::Client.build(host: host, port: port.to_i, service_name: 'downstream-service', flush_interval: 1)
 
-outer_span = tracer1.start_span('receive request', tags: {
-  'span.kind' => 'server'
-})
+outer_span = tracer1.start_span(
+  'receive request',
+  tags: { 'span.kind' => 'server' }
+)
 sleep 0.1
 outer_span.log(event: 'woop di doop', count: 5)
 sleep 1
 
-inner_span = tracer1.start_span('fetch info from downstream', child_of: outer_span, tags: {
-  'span.kind' => 'client',
-  'peer.service' => 'downstream-service',
-  'peer.ipv4' => '6.6.6.6',
-  'peer.port' => 443
-})
+inner_span = tracer1.start_span(
+  'fetch info from downstream',
+  child_of: outer_span,
+  tags: {
+    'span.kind' => 'client',
+    'peer.service' => 'downstream-service',
+    'peer.ipv4' => '6.6.6.6',
+    'peer.port' => 443
+  }
+)
 sleep 0.3 # emulate network delay
 
-downstream_span = tracer2.start_span('downstream operation', child_of: inner_span, tags: {
-  'span.kind' => 'server'
-})
+downstream_span = tracer2.start_span(
+  'downstream operation',
+  child_of: inner_span,
+  tags: { 'span.kind' => 'server' }
+)
 sleep 0.5
 downstream_span.finish
 
@@ -42,5 +49,4 @@ outer_span.finish
 tracer1.stop
 tracer2.stop
 
-puts "Finished"
-
+puts 'Finished'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jaeger-client
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.4.2
 platform: ruby
 authors:
 - SaleMove TechMovers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-27 00:00:00.000000000 Z
+date: 2018-04-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,6 +52,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.54.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.54.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.24.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.24.0
 - !ruby/object:Gem::Dependency
   name: opentracing
   requirement: !ruby/object:Gem::Requirement
@@ -89,6 +117,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - ".travis.yml"
 - Gemfile
 - LICENSE.txt
@@ -106,6 +135,7 @@ files:
 - lib/jaeger/client/tracer.rb
 - lib/jaeger/client/udp_sender.rb
 - lib/jaeger/client/udp_sender/transport.rb
+- lib/jaeger/client/version.rb
 - script/create_trace
 - thrift/agent.thrift
 - thrift/gen-rb/jaeger/thrift/agent.rb