zipkin 1.4.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 57c74dfca283ccf9531225d1765bd897a53dd527
-  data.tar.gz: e3ac03480369442405e7ffdbb7988e9fa7e32f16
+  metadata.gz: '08c97e0494e2aada96486d717d1cd8b645da89c2'
+  data.tar.gz: dc7681e5f0a7c4efe293f22ad496f9c352675137
 SHA512:
-  metadata.gz: 981f0408f902b0a88f856eeefea27bee2032ab4712a63e499c2ebc001e286b351dd3d4209e2eb6ad176eeb880f4dac4d0e48010fbe135425a59bbc9e53d59644
-  data.tar.gz: 69e2ec0aa4e2c385c9e8944c8154714b2aa1f6744fef02a2b36ca5a391a8f55508a310680bad702c73bb86ed7633e192b877c9cd4ba84b68055917e248a9cb68
+  metadata.gz: 3f80229eec38c0f34c83276264b90073195b80e74f5389569ff5458957e9f90e85a02856684a169a116239cb5c804a9eef69161b32851ac38222545090a26306
+  data.tar.gz: b2ee56339a6e2eb7aa615becf7fd163fd86d66e165fb065a3f50e9cc89fd217a3be3628f7484491f90c866b8460b4f4eea0c487575de29693da928895307d059

data/lib/zipkin/span.rb

@@ -4,7 +4,7 @@ module Zipkin
   class Span
     attr_accessor :operation_name
 
-    attr_reader :context, :start_time, :tags, :logs
+    attr_reader :context, :start_time, :tags, :logs, :references
 
     # Creates a new {Span}
     #
@@ -13,13 +13,21 @@ module Zipkin
     # @param collector [Collector] the span collector
     #
     # @return [Span] a new Span
-    def initialize(context, operation_name, collector, start_time: Time.now, tags: {})
+    def initialize(
+      context,
+      operation_name,
+      collector,
+      start_time: Time.now,
+      tags: {},
+      references: nil
+    )
       @context = context
       @operation_name = operation_name
       @collector = collector
       @start_time = start_time
       @tags = tags
       @logs = []
+      @references = references
     end
 
     # Set a tag value on this span

data/lib/zipkin/tracer.rb

@@ -60,7 +60,12 @@ module Zipkin
     # @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.
+    #   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.<Paste>
     # @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
@@ -71,10 +76,12 @@ module Zipkin
                    child_of: nil,
                    start_time: Time.now,
                    tags: {},
+                   references: nil,
                    ignore_active_scope: false,
                    **)
       context = prepare_span_context(
         child_of: child_of,
+        references: references,
         ignore_active_scope: ignore_active_scope
       )
       Span.new(
@@ -82,6 +89,7 @@ module Zipkin
         operation_name,
         @collector,
         start_time: start_time,
+        references: references,
         tags: tags
       )
     end
@@ -203,20 +211,39 @@ module Zipkin
       )
     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)
+    def prepare_span_context(child_of:, references:, ignore_active_scope:)
+      context =
+        context_from_child_of(child_of) ||
+        context_from_references(references) ||
+        context_from_active_scope(ignore_active_scope)
+
+      if context
+        SpanContext.create_from_parent_context(context)
+      else
+        SpanContext.create_parent_context
       end
+    end
 
-      unless ignore_active_scope
-        active_scope = @scope_manager.active
-        if active_scope
-          return SpanContext.create_from_parent_context(active_scope.span.context)
-        end
+    def context_from_child_of(child_of)
+      return nil unless child_of
+      child_of.respond_to?(:context) ? child_of.context : child_of
+    end
+
+    def context_from_references(references)
+      return nil if !references || references.none?
+
+      # Prefer CHILD_OF reference if present
+      ref = references.detect do |reference|
+        reference.type == OpenTracing::Reference::CHILD_OF
       end
+      (ref || references[0]).context
+    end
+
+    def context_from_active_scope(ignore_active_scope)
+      return if ignore_active_scope
 
-      SpanContext.create_parent_context
+      active_scope = @scope_manager.active
+      active_scope.span.context if active_scope
     end
   end
 end

data/script/create_follows_from_trace

@@ -0,0 +1,51 @@
+#!/usr/bin/env ruby
+
+require 'bundler'
+Bundler.setup
+
+require 'zipkin/tracer'
+
+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')
+
+rpc_span = tracer1.start_span(
+  'receive request',
+  tags: { 'span.kind' => 'server' }
+)
+sleep 0.1
+rpc_span.log_kv(event: 'woop di doop', count: 5)
+sleep 1
+
+async_request_span = tracer1.start_span(
+  'request async action',
+  references: [
+    OpenTracing::Reference.child_of(rpc_span.context)
+  ],
+  tags: { 'span.kind' => 'producer' }
+)
+sleep 0.1
+
+async_request_span.finish
+rpc_span.finish
+
+sleep 0.5
+
+async_span = tracer2.start_span(
+  'async span started after rpc span',
+  references: [
+    OpenTracing::Reference.follows_from(async_request_span.context)
+  ],
+  tags: {
+    'span.kind' => 'consumer',
+    'peer.service' => 'downstream-service'
+  }
+)
+sleep 0.3 # emulate network delay
+async_span.finish
+
+tracer1.stop
+tracer2.stop
+
+puts 'Finished'

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.4.0'
+  spec.version       = '1.5.0'
   spec.authors       = ['SaleMove TechMovers']
   spec.email         = ['techmovers@salemove.com']
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zipkin
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.5.0
 platform: ruby
 authors:
 - SaleMove TechMovers
@@ -140,6 +140,7 @@ files:
 - lib/zipkin/span_context.rb
 - lib/zipkin/trace_id.rb
 - lib/zipkin/tracer.rb
+- script/create_follows_from_trace
 - script/create_trace
 - zipkin.gemspec
 homepage: ''