zipkin 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8361e78533130479672a85ad8d5273035cdd261d
-  data.tar.gz: 21ec14ab24345d5f4a320efa33570df8bee51b4a
+  metadata.gz: 504536eebfe1f9f6ce03dd1c9bb1ef0d2c0d870f
+  data.tar.gz: 9e7638f5c9b6cfc0a1061955f3475ad1c5f352d8
 SHA512:
-  metadata.gz: b63f0b37631dea5cd999f24c83ce688946244bd6b5e5aebf1201d75ea3e3d050a3f1daa0d46d8253ed2c4e314c9c1aa98707e32b03b26bf0a17cf4fe903c477f
-  data.tar.gz: ca8ae8cfff2d1b302967652e57c7c1d0039d035c3e006a8e004e30eef3505c4409407c224af3c9f992567106b147570eea2a7b092e0ef8855edf8817a1ee6198
+  metadata.gz: 0fff4fc9878ad37a878968c8805a755f110ac98418dcd88f4229fca5ceb41642c3f66df02a2aad9a0d1903e9dfbd824a359dff77d870a33b5de936b53fe04bfe
+  data.tar.gz: 31b4d916668c882181a08aeb1026557e42051a5ea6b7c91074085ff83ade66153ea3df616ca001ef67a48e804f114cedc45faacffa02441621c58fe477b36135

data/README.md

@@ -1,8 +1,6 @@
 # Zipkin
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/zipkin`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+OpenTracing Tracer implementation for Zipkin in Ruby
 
 ## Installation
 
@@ -12,17 +10,15 @@ Add this line to your application's Gemfile:
 gem 'zipkin'
 ```
 
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install zipkin
-
 ## Usage
 
-TODO: Write usage instructions here
+```ruby
+require 'zipkin/tracer'
+OpenTracing.global_tracer = Zipkin::Tracer.build(url: 'http://localhost:9411', service_name: 'echo')
+
+span = OpenTracing.start_span('span name')
+span.finish
+```
 
 ## Development
 
@@ -32,7 +28,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/Indrek Juhkam/zipkin.
+Bug reports and pull requests are welcome on GitHub at https://github.com/salemove/zipkin-ruby-opentracing
 
 
 ## License

data/lib/zipkin/endpoint.rb

@@ -0,0 +1,12 @@
+module Zipkin
+  class Endpoint
+    LOCAL_IP = Socket.ip_address_list.detect(&:ipv4_private?).ip_address
+
+    def self.local_endpoint(service_name)
+      {
+        serviceName: service_name,
+        ipv4: LOCAL_IP
+      }
+    end
+  end
+end

data/lib/zipkin/json_client.rb

@@ -0,0 +1,34 @@
+require 'faraday'
+require 'faraday_middleware'
+require 'sucker_punch'
+
+module Zipkin
+  class JsonClient
+    def initialize(url)
+      @faraday = Faraday.new(url: url) do |faraday|
+        faraday.request :json
+        faraday.request :retry, max: 3, interval: 10, backoff_factor: 2
+        faraday.adapter Faraday.default_adapter
+      end
+    end
+
+    def send_span(payload)
+      SpanSender.perform_async(payload: payload, faraday: @faraday)
+    end
+
+    class SpanSender
+      include SuckerPunch::Job
+      workers 4
+
+      def perform(payload:, faraday:)
+        response = faraday.post '/api/v1/spans' do |req|
+          req.body = [payload]
+        end
+
+        if response.status != 202
+          STDERR.puts(response.body)
+        end
+      end
+    end
+  end
+end

data/lib/zipkin/span.rb

@@ -6,13 +6,18 @@ module Zipkin
 
     # Creates a new {Span}
     #
-    # @param tracer [Tracer] the tracer that created this span
     # @param context [SpanContext] the context of the span
+    # @param context [String] the operation name
+    # @param client [Faraday] faraday instace for making http requests
     #
     # @return [Span] a new Span
-    def initialize(tracer, context)
-      @tracer = tracer
+    def initialize(context, operation_name, client, start_time: Time.now, tags: {}, local_endpoint:)
       @context = context
+      @operation_name = operation_name
+      @client = client
+      @start_time = start_time
+      @tags = tags
+      @local_endpoint = local_endpoint
     end
 
     # Set a tag value on this span
@@ -21,7 +26,7 @@ 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)
-      self
+      @tags = @tags.merge(key => value)
     end
 
     # Set a baggage item on the span
@@ -54,7 +59,40 @@ module Zipkin
     #
     # @param end_time [Time] custom end time, if not now
     def finish(end_time: Time.now)
-      nil
+      finish_ts = (end_time.to_f * 1_000_000).to_i
+      start_ts = (@start_time.to_f * 1_000_000).to_i
+      duration = finish_ts - start_ts
+      is_server = ['server', 'consumer'].include?(@tags['span.kind'] || 'server')
+
+      @client.send_span(
+        traceId: @context.trace_id,
+        id: @context.span_id,
+        parentId: @context.parent_id,
+        name: @operation_name,
+        timestamp: start_ts,
+        duration: duration,
+        annotations: [
+          {
+            timestamp: start_ts,
+            value: is_server ? 'sr' : 'cs',
+            endpoint: @local_endpoint
+          },
+          {
+            timestamp: finish_ts,
+            value: is_server ? 'ss': 'cr',
+            endpoint: @local_endpoint
+          }
+        ],
+        binaryAnnotations: build_binary_annotations
+      )
+    end
+
+    private
+
+    def build_binary_annotations
+      @tags.map do |name, value|
+        {key: name, value: value.to_s}
+      end
     end
   end
 end

data/lib/zipkin/span_context.rb

@@ -2,14 +2,14 @@ module Zipkin
   # SpanContext holds the data for a span that gets inherited to child spans
   class SpanContext
     def self.create_parent_context
+      trace_id = TraceId.generate
       span_id = TraceId.generate
-      trace_id = span_id
-      new(span_id: span_id, trace_id: trace_id)
+      new(trace_id: trace_id, span_id: span_id)
     end
 
-    def self.create_from_parent(parent_span)
-      trace_id = parent_span.context.trace_id
-      parent_id = parent_span.context.span_id
+    def self.create_from_parent_context(span_context)
+      trace_id = span_context.trace_id
+      parent_id = span_context.span_id
       span_id = TraceId.generate
       new(span_id: span_id, parent_id: parent_id, trace_id: trace_id)
     end

data/lib/zipkin/trace_id.rb

@@ -3,7 +3,7 @@ module Zipkin
     TRACE_ID_UPPER_BOUND = 2 ** 64
 
     def self.generate
-      rand(TRACE_ID_UPPER_BOUND)
+      rand(TRACE_ID_UPPER_BOUND).to_s(16)
     end
   end
 end

data/lib/zipkin/tracer.rb

@@ -1,71 +1,96 @@
+require 'opentracing'
+
+require_relative 'span'
+require_relative 'span_context'
+require_relative 'carrier'
+require_relative 'trace_id'
+require_relative 'json_client'
+require_relative 'endpoint'
+
 module Zipkin
   class Tracer
-    def self.build(host:, port:, service_name:)
+    def self.build(url:, service_name:)
+      client = JsonClient.new(url)
+      new(client, service_name)
     end
 
-    def initialize(client)
+    def initialize(client, service_name)
       @client = client
+      @local_endpoint = Endpoint.local_endpoint(service_name)
     end
 
-    # Start a new span
+    # Starts a new span.
     #
-    # @param operation_name [String]
-    #   The operation name for the Span
-    # @param child_of [SpanContext]
-    #   SpanContext that acts as a parent to the newly-started Span. If a Span
-    #   instance is provided, its #context is automatically substituted.
-    # @param start_time [Time]
-    #   The time when the Span started, if not now
-    # @param tags [Hash]
-    #   Tags to assign to the Span at start time
+    # @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.
+    # @param start_time [Time] When the Span started, if not now
+    # @param tags [Hash] Tags to assign to the Span at start time
     #
-    # @return [Span]
-    #   The newly-started Span
-    def start_span(operation_name, child_of: nil, start_time: Time.now, tags: nil)
+    # @return [Span] The newly-started Span
+    def start_span(operation_name, child_of: nil, start_time: Time.now, tags: {}, **)
       context =
         if child_of
-          SpanContext.create_from_parent(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
-      span = Span.new(self, context)
-      span.operation_name = operation_name
-      span
+      Span.new(context, operation_name, @client, start_time: start_time, tags: tags, local_endpoint: @local_endpoint)
     end
 
     # Inject a SpanContext into the given carrier
     #
     # @param span_context [SpanContext]
     # @param format [OpenTracing::FORMAT_TEXT_MAP, OpenTracing::FORMAT_BINARY, OpenTracing::FORMAT_RACK]
-    #
-    # @param carrier [Carrier]
-    #   A carrier object of the type dictated by the specified `format`
+    # @param carrier [Carrier] A carrier object of the type dictated by the specified `format`
     def inject(span_context, format, carrier)
       case format
-      when OpenTracing::FORMAT_TEXT_MAP, OpenTracing::FORMAT_BINARY, OpenTracing::FORMAT_RACK
-        return nil
+      when OpenTracing::FORMAT_TEXT_MAP
+        carrier['trace-id'] = span_context.trace_id
+        carrier['parent-id'] = span_context.parent_id
+        carrier['span-id'] = span_context.span_id
+      when OpenTracing::FORMAT_RACK
+        carrier['X-Trace-Id'] = span_context.trace_id
+        carrier['X-Trace-Parent-Id'] = span_context.parent_id
+        carrier['X-Trace-Span-Id'] = span_context.span_id
       else
-        warn 'Unknown inject format'
+        STDERR.puts "Logasm::Tracer with format #{format} is not supported yet"
       end
     end
 
     # Extract a SpanContext in the given format from the given carrier.
     #
     # @param format [OpenTracing::FORMAT_TEXT_MAP, OpenTracing::FORMAT_BINARY, OpenTracing::FORMAT_RACK]
-    # @param carrier [Carrier]
-    #   A carrier object of the type dictated by the specified `format`
-    #
-    # @return [SpanContext]
-    #   the extracted SpanContext or nil if none could be found
+    # @param carrier [Carrier] A carrier object of the type dictated by the specified `format`
+    # @return [SpanContext] the extracted SpanContext or nil if none could be found
     def extract(format, carrier)
       case format
-      when OpenTracing::FORMAT_TEXT_MAP, OpenTracing::FORMAT_BINARY, OpenTracing::FORMAT_RACK
-        return SpanContext::NOOP_INSTANCE
+      when OpenTracing::FORMAT_TEXT_MAP
+        trace_id = carrier['trace-id']
+        parent_id = carrier['parent-id']
+        span_id = carrier['span-id']
+
+        if trace_id && span_id
+          SpanContext.new(trace_id: trace_id, parent_id: parent_id, span_id: span_id)
+        else
+          nil
+        end
+      when OpenTracing::FORMAT_RACK
+        trace_id = carrier['HTTP_X_TRACE_ID']
+        parent_id = carrier['HTTP_X_TRACE_PARENT_ID']
+        span_id = carrier['HTTP_X_TRACE_SPAN_ID']
+
+        if trace_id && span_id
+          SpanContext.new(trace_id: trace_id, parent_id: parent_id, span_id: span_id)
+        else
+          nil
+        end
       else
-        warn 'Unknown extract format'
+        STDERR.puts "Logasm::Tracer with format #{format} is not supported yet"
         nil
       end
     end
-
   end
 end

data/lib/zipkin.rb

@@ -1,8 +1,4 @@
 require_relative './zipkin/tracer'
-require_relative './zipkin/span'
-require_relative './zipkin/span_context'
-require_relative './zipkin/carrier'
-require_relative './zipkin/trace_id'
 
 module Zipkin
 end

data/script/create_trace

@@ -0,0 +1,40 @@
+#!/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')
+
+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
+})
+sleep 0.3 # emulate network delay
+
+downstream_span = tracer2.start_span('downstream operation', child_of: inner_span, tags: {
+  'span.kind' => 'server'
+})
+sleep 0.5
+downstream_span.finish
+
+sleep 0.2 # emulate network delay
+
+inner_span.finish
+
+sleep 0.1 # doing something with fetched info
+outer_span.finish
+
+puts "Finishing..."
+sleep 3

data/zipkin.gemspec

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = 'zipkin'
-  spec.version       = '0.1.0'
+  spec.version       = '0.2.0'
   spec.authors       = ['SaleMove TechMovers']
   spec.email         = ['techmovers@salemove.com']
 
@@ -24,4 +24,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rspec', '~> 3.0'
 
   spec.add_dependency 'opentracing', '~> 0.3'
+  spec.add_dependency 'faraday'
+  spec.add_dependency 'faraday_middleware'
+  spec.add_dependency 'sucker_punch', '~> 2.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zipkin
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - SaleMove TechMovers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-04 00:00:00.000000000 Z
+date: 2017-04-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -66,6 +66,48 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sucker_punch
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
 description: ''
 email:
 - techmovers@salemove.com
@@ -84,10 +126,13 @@ files:
 - bin/setup
 - lib/zipkin.rb
 - lib/zipkin/carrier.rb
+- lib/zipkin/endpoint.rb
+- lib/zipkin/json_client.rb
 - lib/zipkin/span.rb
 - lib/zipkin/span_context.rb
 - lib/zipkin/trace_id.rb
 - lib/zipkin/tracer.rb
+- script/create_trace
 - zipkin.gemspec
 homepage: ''
 licenses: