zipkin 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: aeadc7212236b56f7c043a9843f9d2aababefd59
-  data.tar.gz: d9dd7f5f7f360c45b14f3005c7df7b400ae165e4
+  metadata.gz: f7dab2beecf1b862caceca696f39c800ed9a337a
+  data.tar.gz: d5047d7b504e42a2d4357f991e651e9dc70fd9f3
 SHA512:
-  metadata.gz: c1cb34590a8188c6a604e2fc82f62fd74f7e4858adb7b6d4077e0903dced0d1b273f820a9027884195ede22224cbf001b77769207489e86a95ce516d3168a1bd
-  data.tar.gz: f015323bcb10ee83346c7a09384bd560f301c3453ff0b70d4ce604bdea47d84dad7167a2e9c4b452b733d601899952cad1504fdebc51000fe3538409d3a3d0f0
+  metadata.gz: 42534373a551f427b6be03b32ca2709e7fae389b36a9d93c224ab7e3b4b1db04459a2ad5046a12dcf5e1cf7d3a3e0dbb8c2fbc8d61d72d9d2181cf61a7011e16
+  data.tar.gz: cd4a6a54266e0972a6ab0af9314bb929de8624bb9af13db6f2a25d433ad4cb89d1c282c0aed41378fa89b6a27c763508c3b49763376302df5d8792ce3203cedd

data/.rubocop.yml

@@ -0,0 +1,25 @@
+require: rubocop-rspec
+
+Style/Documentation:
+  Enabled: no
+
+Style/IfUnlessModifier:
+  Enabled: no
+
+RSpec/NestedGroups:
+  Max: 4
+
+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 '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,14 +1,14 @@
 #!/usr/bin/env ruby
 
-require "bundler/setup"
-require "zipkin"
+require 'bundler/setup'
+require 'zipkin'
 
 # 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.
 
 # (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
+# require 'pry'
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start(__FILE__)

data/lib/zipkin/carrier.rb

@@ -6,20 +6,17 @@ module Zipkin
     # [] 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

data/lib/zipkin/collector.rb

@@ -15,7 +15,7 @@ module Zipkin
       finish_ts = (end_time.to_f * 1_000_000).to_i
       start_ts = (span.start_time.to_f * 1_000_000).to_i
       duration = finish_ts - start_ts
-      is_server = ['server', 'consumer'].include?(span.tags['span.kind'] || 'server')
+      is_server = %w[server consumer].include?(span.tags['span.kind'] || 'server')
 
       @buffer << {
         traceId: span.context.trace_id,
@@ -32,7 +32,7 @@ module Zipkin
           },
           {
             timestamp: finish_ts,
-            value: is_server ? 'ss': 'cr',
+            value: is_server ? 'ss' : 'cr',
             endpoint: @local_endpoint
           }
         ],
@@ -44,7 +44,7 @@ module Zipkin
 
     def build_binary_annotations(span)
       span.tags.map do |name, value|
-        {key: name, value: value.to_s}
+        { key: name, value: value.to_s }
       end
     end
 

data/lib/zipkin/json_client.rb

@@ -4,10 +4,11 @@ require 'json'
 
 module Zipkin
   class JsonClient
-    def initialize(url:, collector:, flush_interval:)
+    def initialize(url:, collector:, flush_interval:, logger: Logger.new(STDOUT))
       @collector = collector
       @flush_interval = flush_interval
       @spans_uri = URI.parse("#{url}/api/v1/spans")
+      @logger = logger
     end
 
     def start
@@ -31,17 +32,18 @@ module Zipkin
 
       http = Net::HTTP.new(@spans_uri.host, @spans_uri.port)
       http.use_ssl = @spans_uri.scheme == 'https'
-      request = Net::HTTP::Post.new(@spans_uri.request_uri, {
+      request = Net::HTTP::Post.new(
+        @spans_uri.request_uri,
         'Content-Type' => 'application/json'
-      })
+      )
       request.body = JSON.dump(spans)
       response = http.request(request)
 
-      if response.code != 202
-        STDERR.puts(response.body)
+      if response.code != '202'
+        @logger.error("Received bad response from Zipkin. status: #{response.code}, body: #{response.body.inspect}")
       end
-    rescue => e
-      STDERR.puts("Error emitting spans batch: #{e.message}\n#{e.backtrace.join("\n")}")
+    rescue StandardError => e
+      @logger.error("Error emitting spans batch: #{e.message}\n#{e.backtrace.join("\n")}")
     end
   end
 end

data/lib/zipkin/span.rb

@@ -50,7 +50,18 @@ module Zipkin
     # @param event [String] event name for the log
     # @param timestamp [Time] time of the log
     # @param fields [Hash] Additional information to log
+    #
+    # @deprecated Use {#log_kv} instead.
     def log(event: nil, timestamp: Time.now, **fields)
+      warn 'Span#log is deprecated. Please use Span#log_kv instead.'
+      nil
+    end
+
+    # Add a log entry to this span
+    #
+    # @param timestamp [Time] time of the log
+    # @param fields [Hash] Additional information to log
+    def log_kv(timestamp: Time.now, **fields)
       nil
     end
 

data/lib/zipkin/trace_id.rb

@@ -1,6 +1,6 @@
 module Zipkin
   module TraceId
-    TRACE_ID_UPPER_BOUND = 2 ** 64
+    TRACE_ID_UPPER_BOUND = 2**64
 
     def self.generate
       rand(TRACE_ID_UPPER_BOUND).to_s(16)

data/lib/zipkin/tracer.rb

@@ -1,4 +1,5 @@
 require 'opentracing'
+require 'logger'
 
 require_relative 'span'
 require_relative 'span_context'
@@ -12,20 +13,22 @@ module Zipkin
   class Tracer
     DEFAULT_FLUSH_INTERVAL = 10
 
-    def self.build(url:, service_name:, flush_interval: DEFAULT_FLUSH_INTERVAL)
+    def self.build(url:, service_name:, flush_interval: DEFAULT_FLUSH_INTERVAL, logger: Logger.new(STDOUT))
       collector = Collector.new(Endpoint.local_endpoint(service_name))
       sender = JsonClient.new(
         url: url,
         collector: collector,
-        flush_interval: flush_interval
+        flush_interval: flush_interval,
+        logger: logger
       )
       sender.start
-      new(collector, sender)
+      new(collector, sender, logger: logger)
     end
 
-    def initialize(collector, sender)
+    def initialize(collector, sender, logger: Logger.new(STDOUT))
       @collector = collector
       @sender = sender
+      @logger = logger
     end
 
     def stop
@@ -50,10 +53,13 @@ module Zipkin
         else
           SpanContext.create_parent_context
         end
-      Span.new(context, operation_name, @collector, {
+      Span.new(
+        context,
+        operation_name,
+        @collector,
         start_time: start_time,
         tags: tags
-      })
+      )
     end
 
     # Inject a SpanContext into the given carrier
@@ -74,7 +80,7 @@ module Zipkin
         carrier['X-B3-SpanId'] = span_context.span_id
         carrier['X-B3-Sampled'] = span_context.sampled? ? '1' : '0'
       else
-        STDERR.puts "Logasm::Tracer with format #{format} is not supported yet"
+        @logger.error "Logasm::Tracer with format #{format} is not supported yet"
       end
     end
 
@@ -100,23 +106,22 @@ module Zipkin
 
         create_span_context(trace_id, span_id, parent_id, sampled)
       else
-        STDERR.puts "Logasm::Tracer with format #{format} is not supported yet"
+        @logger.error "Logasm::Tracer with format #{format} is not supported yet"
         nil
       end
     end
 
     private
+
     def create_span_context(trace_id, span_id, parent_id, sampled)
-      if trace_id && span_id
-        SpanContext.new(
-          trace_id: trace_id,
-          parent_id: parent_id,
-          span_id: span_id,
-          sampled: sampled
-        )
-      else
-        nil
-      end
+      return nil if !trace_id || !span_id
+
+      SpanContext.new(
+        trace_id: trace_id,
+        parent_id: parent_id,
+        span_id: span_id,
+        sampled: sampled
+      )
     end
   end
 end

data/script/create_trace

@@ -10,22 +10,29 @@ url = ENV['ZIPKIN_URL'] || 'http://localhost:9411'
 tracer1 = Zipkin::Tracer.build(url: url, service_name: 'test-service')
 tracer2 = Zipkin::Tracer.build(url: url, service_name: 'downstream-service')
 
-outer_span = tracer1.start_span('receive request', tags: {
-  'span.kind' => 'server'
-})
+outer_span = tracer1.start_span(
+  'receive request',
+  tags: { 'span.kind' => 'server' }
+)
 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
 
@@ -36,10 +43,10 @@ inner_span.finish
 sleep 0.1 # doing something with fetched info
 outer_span.finish
 
-puts "Finishing..."
+puts 'Finishing...'
 sleep 3
 
 tracer1.stop
 tracer2.stop
 
-puts "Finished"
+puts 'Finished'

data/zipkin.gemspec

@@ -1,15 +1,14 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = 'zipkin'
-  spec.version       = '1.0.0'
+  spec.version       = '1.1.0'
   spec.authors       = ['SaleMove TechMovers']
   spec.email         = ['techmovers@salemove.com']
 
-  spec.summary       = %q{OpenTracing Tracer implementation for Zipkin in Ruby}
-  spec.description   = %q{}
+  spec.summary       = 'OpenTracing Tracer implementation for Zipkin in Ruby'
+  spec.description   = ''
   spec.homepage      = ''
   spec.license       = 'MIT'
 
@@ -22,7 +21,9 @@ 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 'json'
+  spec.add_dependency 'opentracing', '~> 0.3'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zipkin
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - SaleMove TechMovers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-20 00:00:00.000000000 Z
+date: 2018-04-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -53,19 +53,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: opentracing
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.3'
-  type: :runtime
+        version: 0.54.0
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.3'
+        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: json
   requirement: !ruby/object:Gem::Requirement
@@ -80,6 +94,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: opentracing
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
 description: ''
 email:
 - techmovers@salemove.com
@@ -89,6 +117,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - ".travis.yml"
 - Gemfile
 - LICENSE.txt