jaeger-client 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 180ed5153f692c630fd0e0006b3d6265c5839875
-  data.tar.gz: 98dea74437333796b07bf81afba0558652b51623
+  metadata.gz: 6c3b896f0a1516378cf00ee5a08bc86b9766842a
+  data.tar.gz: e7f411f2dd0850fd1d4267616c6e6cdda7766847
 SHA512:
-  metadata.gz: ef49bfeb6aee4d16534c256580efe859d6468f7f68c748db31166c10ba700416a8035d18c51d26d5b863dccae71c036f6e7a3645eb49c323d2a1ed80a9507f0f
-  data.tar.gz: 1965becd08d299d65067e503e64d926dfffe95b216b306334c562c3a9db703eba2bc4171e53586c4b180e262a3fda7bb9ceed38ec9b021ba475b680e5728ebe9
+  metadata.gz: 2f1d3b40879729e56de34b71bab0881d9c3d3afab4f11b523392a21392bfeb992e3a602c3cc7907d5f905eafd4f5130d27e4383602b8cc98e1053c2a49f12e5c
+  data.tar.gz: e757205635c33ff2e40630c07746f0993fd234c00742ac1257ab5a914659394b45d24f3d5896f72ab7b3c2a3840383fdeb8d6790a53eff1b67506e2577175bf5

data/lib/jaeger/client/collector.rb

@@ -20,7 +20,7 @@ module Jaeger
           'spanId' => context.span_id,
           'parentSpanId' => context.parent_id,
           'operationName' => span.operation_name,
-          'references' => [],
+          'references' => build_references(span.references || []),
           'flags' => context.flags,
           'startTime' => start_ts,
           'duration' => duration,
@@ -35,6 +35,17 @@ module Jaeger
 
       private
 
+      def build_references(references)
+        references.map do |ref|
+          Jaeger::Thrift::SpanRef.new(
+            'refType' => span_ref_type(ref.type),
+            'traceIdLow' => ref.context.trace_id,
+            'traceIdHigh' => 0,
+            'spanId' => ref.context.span_id
+          )
+        end
+      end
+
       def build_timestamps(span, end_time)
         start_ts = (span.start_time.to_f * 1_000_000).to_i
         end_ts = (end_time.to_f * 1_000_000).to_i
@@ -42,6 +53,18 @@ module Jaeger
         [start_ts, duration]
       end
 
+      def span_ref_type(type)
+        case type
+        when OpenTracing::Reference::CHILD_OF
+          Jaeger::Thrift::SpanRefType::CHILD_OF
+        when OpenTracing::Reference::FOLLOWS_FROM
+          Jaeger::Thrift::SpanRefType::FOLLOWS_FROM
+        else
+          warn "Jaeger::Client with format #{type} is not supported yet"
+          nil
+        end
+      end
+
       class Buffer
         def initialize
           @buffer = []

data/lib/jaeger/client/span.rb

@@ -8,20 +8,21 @@ module Jaeger
     class Span
       attr_accessor :operation_name
 
-      attr_reader :context, :start_time, :tags, :logs
+      attr_reader :context, :start_time, :references, :tags, :logs
 
       # Creates a new {Span}
       #
       # @param context [SpanContext] the context of the span
-      # @param context [String] the operation name
+      # @param operation_name [String] the operation name
       # @param collector [Collector] 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, references: [], tags: {})
         @context = context
         @operation_name = operation_name
         @collector = collector
         @start_time = start_time
+        @references = references
         @tags = tags.map { |key, value| ThriftTagBuilder.build(key, value) }
         @logs = []
       end

data/lib/jaeger/client/tracer.rb

@@ -34,7 +34,10 @@ module Jaeger
       # @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.
       # @param start_time [Time] When the Span started, if not now
@@ -52,6 +55,7 @@ module Jaeger
                      **)
         context = prepare_span_context(
           child_of: child_of,
+          references: references,
           ignore_active_scope: ignore_active_scope
         )
         Span.new(
@@ -59,6 +63,7 @@ module Jaeger
           operation_name,
           @collector,
           start_time: start_time,
+          references: references,
           tags: tags.merge(
             :'sampler.type' => @sampler.type,
             :'sampler.param' => @sampler.param
@@ -182,20 +187,39 @@ module Jaeger
         (num & ~mask) - (num & mask)
       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(@sampler)
         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(@sampler)
+        active_scope = @scope_manager.active
+        active_scope.span.context if active_scope
       end
     end
   end

data/lib/jaeger/client/version.rb

@@ -2,6 +2,6 @@
 
 module Jaeger
   module Client
-    VERSION = '0.5.0'.freeze
+    VERSION = '0.6.0'.freeze
   end
 end

data/script/create_follows_from_trace

@@ -0,0 +1,52 @@
+#!/usr/bin/env ruby
+
+require 'bundler'
+Bundler.setup
+
+require 'jaeger/client'
+
+host = ENV['JAEGER_HOST'] || '127.0.0.1'
+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)
+
+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'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jaeger-client
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - SaleMove TechMovers
@@ -145,6 +145,7 @@ files:
 - lib/jaeger/client/udp_sender.rb
 - lib/jaeger/client/udp_sender/transport.rb
 - lib/jaeger/client/version.rb
+- script/create_follows_from_trace
 - script/create_trace
 - thrift/agent.thrift
 - thrift/gen-rb/jaeger/thrift/agent.rb