zipkin 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4226e47ea8224eeffa7ed8cd4e48e61cc26da790
-  data.tar.gz: f7ab917023ea03c1660d3f218b1e6f56147da8be
+  metadata.gz: 57c74dfca283ccf9531225d1765bd897a53dd527
+  data.tar.gz: e3ac03480369442405e7ffdbb7988e9fa7e32f16
 SHA512:
-  metadata.gz: 7ad6f2ce25802dfd4fca0191a52ef6653887894571f2571663c6ccfa559a9f7241581acd7ceae158040e8056cf95c4016db83883b880077956e45caee9fca109
-  data.tar.gz: 5165e5c4d02358d9a8a996baa398450975fb04d542e961464730cb1c58ec287fcf2a66676a1661311f4b4190f50d52f2f0df0dc6b4933fcab0642d79ab777132
+  metadata.gz: 981f0408f902b0a88f856eeefea27bee2032ab4712a63e499c2ebc001e286b351dd3d4209e2eb6ad176eeb880f4dac4d0e48010fbe135425a59bbc9e53d59644
+  data.tar.gz: 69e2ec0aa4e2c385c9e8944c8154714b2aa1f6744fef02a2b36ca5a391a8f55508a310680bad702c73bb86ed7633e192b877c9cd4ba84b68055917e248a9cb68

data/.rubocop.yml

@@ -24,8 +24,20 @@ Metrics/MethodLength:
 Metrics/AbcSize:
   Enabled: no
 
+Metrics/ClassLength:
+  Enabled: no
+
+Metrics/ParameterLists:
+  Enabled: no
+
 Lint/UnusedMethodArgument:
   Enabled: no
 
+Style/FrozenStringLiteralComment:
+  Enabled: yes
+  EnforcedStyle: always
+  Include:
+    - 'lib/**/*'
+
 Metrics/LineLength:
   Max: 120

data/README.md

@@ -20,10 +20,17 @@ gem 'zipkin'
 require 'zipkin/tracer'
 OpenTracing.global_tracer = Zipkin::Tracer.build(url: 'http://localhost:9411', service_name: 'echo')
 
-span = OpenTracing.start_span('span name')
-span.finish
+OpenTracing.start_active_span('span name') do
+  # do something
+
+  OpenTracing.start_active_span('inner span name') do
+    # do something else
+  end
+end
 ```
 
+See [opentracing-ruby](https://github.com/opentracing/opentracing-ruby) for more examples.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/zipkin.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative './zipkin/tracer'
 
 module Zipkin

data/lib/zipkin/carrier.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Zipkin
   # Carriers are used for inject and extract operations. A carrier should be a
   # Hash or hash-like object. At a minimum, it should implement `[]`, `[]=`, and

data/lib/zipkin/collector.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'thread'
 
 require_relative './collector/timestamp'
@@ -5,6 +7,13 @@ require_relative './collector/log_annotations'
 
 module Zipkin
   class Collector
+    OT_KIND_TO_ZIPKIN_KIND = {
+      'server' => 'SERVER',
+      'client' => 'CLIENT',
+      'producer' => 'PRODUCER',
+      'consumer' => 'CONSUMER'
+    }.freeze
+
     def initialize(local_endpoint)
       @buffer = Buffer.new
       @local_endpoint = local_endpoint
@@ -18,13 +27,14 @@ module Zipkin
       finish_ts = Timestamp.create(end_time)
       start_ts = Timestamp.create(span.start_time)
       duration = finish_ts - start_ts
+      return unless span.context.sampled?
 
       @buffer << {
         traceId: span.context.trace_id,
         id: span.context.span_id,
         parentId: span.context.parent_id,
         name: span.operation_name,
-        kind: (span.tags['span.kind'] || 'SERVER').upcase,
+        kind: OT_KIND_TO_ZIPKIN_KIND[span.tags[:'span.kind'] || 'server'],
         timestamp: start_ts,
         duration: duration,
         debug: false,
@@ -32,16 +42,10 @@ module Zipkin
         localEndpoint: @local_endpoint,
         remoteEndpoint: Endpoint.remote_endpoint(span),
         annotations: LogAnnotations.build(span),
-        tags: build_tags(span)
+        tags: span.tags
       }
     end
 
-    private
-
-    def build_tags(span)
-      span.tags.map { |key, value| [key.to_s, value.to_s] }.to_h
-    end
-
     class Buffer
       def initialize
         @buffer = []

data/lib/zipkin/collector/log_annotations.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Zipkin
   class Collector
     module LogAnnotations

data/lib/zipkin/collector/timestamp.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Zipkin
   class Collector
     module Timestamp

data/lib/zipkin/endpoint.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'socket'
 
 module Zipkin
@@ -15,10 +17,10 @@ module Zipkin
     end
 
     module PeerInfo
-      SERVICE = 'peer.service'.freeze
-      IPV4 = 'peer.ipv4'.freeze
-      IPV6 = 'peer.ipv6'.freeze
-      PORT = 'peer.port'.freeze
+      SERVICE = :'peer.service'
+      IPV4 = :'peer.ipv4'
+      IPV6 = :'peer.ipv6'
+      PORT = :'peer.port'
 
       def self.keys
         [SERVICE, IPV4, IPV6, PORT]
@@ -34,7 +36,7 @@ module Zipkin
 
     def self.remote_endpoint(span)
       tags = span.tags
-      kind = tags['span.kind'] || SpanKind::SERVER
+      kind = tags[:'span.kind'] || SpanKind::SERVER
 
       case kind
       when SpanKind::SERVER, SpanKind::CLIENT

data/lib/zipkin/json_client.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'net/http'
 require 'uri'
 require 'json'

data/lib/zipkin/scope.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Zipkin
+  # Scope represents an OpenTracing Scope
+  #
+  # See http://www.opentracing.io for more information.
+  class Scope
+    def initialize(span, scope_stack, finish_on_close:)
+      @span = span
+      @scope_stack = scope_stack
+      @finish_on_close = finish_on_close
+      @closed = false
+    end
+
+    # Return the Span scoped by this Scope
+    #
+    # @return [Span]
+    attr_reader :span
+
+    # Close scope
+    #
+    # Mark the end of the active period for the current thread and Scope,
+    # updating the ScopeManager#active in the process.
+    def close
+      raise "Tried to close already closed span: #{inspect}" if @closed
+      @closed = true
+
+      @span.finish if @finish_on_close
+      removed_scope = @scope_stack.pop
+
+      if removed_scope != self # rubocop:disable Style/GuardClause
+        raise 'Removed non-active scope, ' \
+          "removed: #{removed_scope.inspect}, "\
+          "expected: #{inspect}"
+      end
+    end
+  end
+end

data/lib/zipkin/scope_manager.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require_relative 'scope_manager/scope_stack'
+require_relative 'scope_manager/scope_identifier'
+
+module Zipkin
+  # ScopeManager represents an OpenTracing ScopeManager
+  #
+  # See http://www.opentracing.io for more information.
+  #
+  # The ScopeManager interface abstracts both the activation of Span instances
+  # via ScopeManager#activate and access to an active Span/Scope via
+  # ScopeManager#active
+  #
+  class ScopeManager
+    def initialize
+      @scope_stack = ScopeStack.new
+    end
+
+    # Make a span instance active
+    #
+    # @param span [Span] the Span that should become active
+    # @param finish_on_close [Boolean] whether the Span should automatically be
+    #   finished when Scope#close is called
+    # @return [Scope] instance to control the end of the active period for the
+    #  Span. It is a programming error to neglect to call Scope#close on the
+    #  returned instance.
+    def activate(span, finish_on_close: true)
+      return active if active && active.span == span
+      scope = Scope.new(span, @scope_stack, finish_on_close: finish_on_close)
+      @scope_stack.push(scope)
+      scope
+    end
+
+    # Return active scope
+    #
+    # If there is a non-null Scope, its wrapped Span becomes an implicit parent
+    # (as Reference#CHILD_OF) of any newly-created Span at
+    # Tracer#start_active_span or Tracer#start_span time.
+    #
+    # @return [Scope] the currently active Scope which can be used to access the
+    #   currently active Span.
+    def active
+      @scope_stack.peek
+    end
+  end
+end

data/lib/zipkin/scope_manager/scope_identifier.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Zipkin
+  class ScopeManager
+    # @api private
+    class ScopeIdentifier
+      def self.generate
+        # 65..90.chr are characters between A and Z
+        "opentracing_#{(0...8).map { rand(65..90).chr }.join}".to_sym
+      end
+    end
+  end
+end

data/lib/zipkin/scope_manager/scope_stack.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Zipkin
+  class ScopeManager
+    # @api private
+    class ScopeStack
+      def initialize
+        # Generate a random identifier to use as the Thread.current key. This is
+        # needed so that it would be possible to create multiple tracers in one
+        # thread (mostly useful for testing purposes)
+        @scope_identifier = ScopeIdentifier.generate
+      end
+
+      def push(scope)
+        store << scope
+      end
+
+      def pop
+        store.pop
+      end
+
+      def peek
+        store.last
+      end
+
+      private
+
+      def store
+        Thread.current[@scope_identifier] ||= []
+      end
+    end
+  end
+end

data/lib/zipkin/span.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Zipkin
   class Span
     attr_accessor :operation_name
@@ -26,7 +28,8 @@ module Zipkin
     # @param value [String, Numeric, Boolean] the value of the tag. If it's not
     # a String, Numeric, or Boolean it will be encoded with to_s
     def set_tag(key, value)
-      @tags = @tags.merge(key => value)
+      sanitized_value = valid_tag_value?(value) ? value : value.to_s
+      @tags = @tags.merge(key.to_sym => sanitized_value)
     end
 
     # Set a baggage item on the span
@@ -69,5 +72,14 @@ module Zipkin
     def finish(end_time: Time.now)
       @collector.send_span(self, end_time)
     end
+
+    private
+
+    def valid_tag_value?(value)
+      value.is_a?(String) ||
+        value.is_a?(Numeric) ||
+        value.is_a?(TrueClass) ||
+        value.is_a?(FalseClass)
+    end
   end
 end

data/lib/zipkin/span_context.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Zipkin
   # SpanContext holds the data for a span that gets inherited to child spans
   class SpanContext

data/lib/zipkin/trace_id.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Zipkin
   module TraceId
     TRACE_ID_UPPER_BOUND = 2**64

data/lib/zipkin/tracer.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'opentracing'
 require 'logger'
 
@@ -8,6 +10,8 @@ require_relative 'trace_id'
 require_relative 'json_client'
 require_relative 'endpoint'
 require_relative 'collector'
+require_relative 'scope_manager'
+require_relative 'scope'
 
 module Zipkin
   class Tracer
@@ -29,30 +33,50 @@ module Zipkin
       @collector = collector
       @sender = sender
       @logger = logger
+      @scope_manager = ScopeManager.new
     end
 
     def stop
       @sender.stop
     end
 
-    # Starts a new span.
+    # @return [ScopeManager] the current ScopeManager, which may be a no-op but
+    #   may not be nil.
+    attr_reader :scope_manager
+
+    # @return [Span, nil] the active span. This is a shorthand for
+    #   `scope_manager.active.span`, and nil will be returned if
+    #   Scope#active is nil.
+    def active_span
+      scope = scope_manager.active
+      scope.span if scope
+    end
+
+    # Starts a new span
+    #
+    # This is similar to #start_active_span, but the returned Span will not be
+    # registered via the ScopeManager.
     #
     # @param operation_name [String] The operation name for the Span
     # @param child_of [SpanContext, Span] SpanContext that acts as a parent to
-    #        the newly-started Span. If a Span instance is provided, its
-    #        context is automatically substituted.
+    #   the newly-started Span. If a Span instance is provided, its
+    #   context is automatically substituted.
     # @param start_time [Time] When the Span started, if not now
     # @param tags [Hash] Tags to assign to the Span at start time
+    # @param ignore_active_scope [Boolean] whether to create an implicit
+    #   References#CHILD_OF reference to the ScopeManager#active.
     #
     # @return [Span] The newly-started Span
-    def start_span(operation_name, child_of: nil, start_time: Time.now, tags: {}, **)
-      context =
-        if child_of
-          parent_context = child_of.respond_to?(:context) ? child_of.context : child_of
-          SpanContext.create_from_parent_context(parent_context)
-        else
-          SpanContext.create_parent_context
-        end
+    def start_span(operation_name,
+                   child_of: nil,
+                   start_time: Time.now,
+                   tags: {},
+                   ignore_active_scope: false,
+                   **)
+      context = prepare_span_context(
+        child_of: child_of,
+        ignore_active_scope: ignore_active_scope
+      )
       Span.new(
         context,
         operation_name,
@@ -62,6 +86,61 @@ module Zipkin
       )
     end
 
+    # Creates a newly started and activated Scope
+    #
+    # If the Tracer's ScopeManager#active is not nil, no explicit references
+    # are provided, and `ignore_active_scope` is false, then an inferred
+    # References#CHILD_OF reference is created to the ScopeManager#active's
+    # SpanContext when start_active is invoked.
+    #
+    # @param operation_name [String] The operation name for the Span
+    # @param child_of [SpanContext, Span] SpanContext that acts as a parent to
+    #   the newly-started Span. If a Span instance is provided, its
+    #   context is automatically substituted. See [Reference] for more
+    #   information.
+    #
+    #   If specified, the `references` parameter must be omitted.
+    # @param references [Array<Reference>] An array of reference
+    #   objects that identify one or more parent SpanContexts.
+    # @param start_time [Time] When the Span started, if not now
+    # @param tags [Hash] Tags to assign to the Span at start time
+    # @param ignore_active_scope [Boolean] whether to create an implicit
+    #   References#CHILD_OF reference to the ScopeManager#active.
+    # @param finish_on_close [Boolean] whether span should automatically be
+    #   finished when Scope#close is called
+    # @yield [Scope] If an optional block is passed to start_active it will
+    #   yield the newly-started Scope. If `finish_on_close` is true then the
+    #   Span will be finished automatically after the block is executed.
+    # @return [Scope] The newly-started and activated Scope
+    def start_active_span(operation_name,
+                          child_of: nil,
+                          references: nil,
+                          start_time: Time.now,
+                          tags: nil,
+                          ignore_active_scope: false,
+                          finish_on_close: true,
+                          **)
+      span = start_span(
+        operation_name,
+        child_of: child_of,
+        references: references,
+        start_time: start_time,
+        tags: tags,
+        ignore_active_scope: ignore_active_scope
+      )
+      scope = @scope_manager.activate(span, finish_on_close: finish_on_close)
+
+      if block_given?
+        begin
+          yield scope
+        ensure
+          scope.close
+        end
+      end
+
+      scope
+    end
+
     # Inject a SpanContext into the given carrier
     #
     # @param span_context [SpanContext]
@@ -123,5 +202,21 @@ module Zipkin
         sampled: sampled
       )
     end
+
+    def prepare_span_context(child_of:, ignore_active_scope:)
+      if child_of
+        parent_context = child_of.respond_to?(:context) ? child_of.context : child_of
+        return SpanContext.create_from_parent_context(parent_context)
+      end
+
+      unless ignore_active_scope
+        active_scope = @scope_manager.active
+        if active_scope
+          return SpanContext.create_from_parent_context(active_scope.span.context)
+        end
+      end
+
+      SpanContext.create_parent_context
+    end
   end
 end

data/zipkin.gemspec

@@ -3,7 +3,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = 'zipkin'
-  spec.version       = '1.3.0'
+  spec.version       = '1.4.0'
   spec.authors       = ['SaleMove TechMovers']
   spec.email         = ['techmovers@salemove.com']
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zipkin
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.0
 platform: ruby
 authors:
 - SaleMove TechMovers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-09 00:00:00.000000000 Z
+date: 2018-07-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -132,6 +132,10 @@ files:
 - lib/zipkin/collector/timestamp.rb
 - lib/zipkin/endpoint.rb
 - lib/zipkin/json_client.rb
+- lib/zipkin/scope.rb
+- lib/zipkin/scope_manager.rb
+- lib/zipkin/scope_manager/scope_identifier.rb
+- lib/zipkin/scope_manager/scope_stack.rb
 - lib/zipkin/span.rb
 - lib/zipkin/span_context.rb
 - lib/zipkin/trace_id.rb