faraday-zipkin 0.0.1 → 0.1.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ZDY4YWE5Y2M1NTA1Mzg3ZDUzN2U1MmJkNDU3ZDQ1YjNiYjBiZGFjOQ==
+    YzUwZDc2ZDFjODFlODBmNjA1ZjZmMWQ0ODdlMDYyNWFhN2U2NGUwMw==
   data.tar.gz: !binary |-
-    MWFmOTVjMWIyOGEwZjRkODc2MDQ5YTY0ZWNiMWVmZTFmMDRlMDZhNA==
+    MDcxYTc2ODYwMTMzZDg5NzJiYzBjM2MzOTQzN2M0NGE2MDQzNTA1Mw==
 SHA512:
   metadata.gz: !binary |-
-    NjhiMzE5YWRlNzE3ZWVjODU3ZWYzZTI0ZTg4ZjIwMzQ0NDZmODI1YzVmMzVj
-    NWY2MmYyZTJjMDM4NDI4MmZmNjMzN2I2YjZiMmU5OWI2ODRkMGJiY2QxYTkx
-    NmEwN2ViNzQwM2I2OGVkOTQ5ZGZmNzZkOWJjYzNhMmVjMjUwZTQ=
+    YTc4YTMxNDM0ZjQ3YWUzYmQ5ZGM2NmM2ZTA1NjEwMjZjMjEyZGZiMmM1ZDMy
+    MDFkZjY5OTcwMDBiOGMwMTQwZTRhYjU0MDM2NTJmZGZjMjQzYzRiNjliOTM1
+    YjZiN2YxNDFiOTAzOGE4MjFlNGJkZmZhMzVhMjY0YjQyYWZjMTY=
   data.tar.gz: !binary |-
-    MTAxZTc4NDEzNzgyZTVjNmM4NWVlZWUzYTBmNzQ1ZTI5YjZhNjhhNjIyOWJm
-    MTBiZjI0Y2FlODE5Y2U3NzViNDE1M2Y2MDE2NTZhM2ZmZWUzM2FjOWZkNDA0
-    YjM4MjQ2MzhkYjM1ZDkyNDU3ZTViZGU5ZDU5OTcyZWFkNmMzNGU=
+    NWFkNjUyZjc0MzFhMGQxNDQ1MGM3OWMyNjE5ZmRiYTEyMGJiMzk3MzgwMmM5
+    ZWZmZjE5NDAzMmI0ZGYyYWMwMTM4YzI5NTUyNzY2NTBlYmQ4NGNkMTM1OGI0
+    YzJlNTA1NjQyMDg1MDY4NzdiMmU4ZTk5NjE4ZGYxZWI2ODczMGY=

data/README.md

@@ -2,13 +2,20 @@
 
 Faraday middleware to generate Zipkin tracing headers.
 
+For more information about Zipkin, go to
+http://twitter.github.io/zipkin
+http://github.com/twitter/zipkin
+
+This gem implements the client side described at
+http://twitter.github.io/zipkin/instrument.html
+
 Note that you should also be using the zipkin-tracer Rack middleware
 to generate trace IDs around your requests:
 https://github.com/twitter/zipkin/tree/master/zipkin-gems/zipkin-tracer
 
-Zipkin tracing headers are documented at
+Zipkin tracing headers for HTTP APIs are documented at
 https://github.com/twitter/zipkin/blob/master/doc/collector-api.md
- 
+
 ## Usage
 
 Include Faraday::Zipkin::TraceHeaders as a Faraday middleware:
@@ -25,7 +32,7 @@ Include Faraday::Zipkin::TraceHeaders as a Faraday middleware:
  
 ## Contributing
 
-1. Fork it ( https://github.com/[my-github-username]/faraday-zipkin/fork )
+1. Fork it ( https://github.com/Oscil8/faraday-zipkin/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)

data/faraday-zipkin.gemspec

@@ -20,7 +20,7 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "faraday", ">= 0.8"
   spec.add_dependency "thrift", "~> 0.9.0"
-  spec.add_dependency "finagle-thrift", "~> 1.3.0"
+  spec.add_dependency "finagle-thrift", "~> 1.2.0"
 
   spec.add_development_dependency "bundler", "~> 1.6"
   spec.add_development_dependency "rake", "~> 10.0"

data/lib/faraday/zipkin/version.rb

@@ -1,5 +1,5 @@
 module Faraday
   module Zipkin
-    VERSION = "0.0.1"
+    VERSION = "0.1.0"
   end
 end

data/lib/faraday/zipkin.rb

@@ -1,8 +1,9 @@
 require 'faraday'
 require 'finagle-thrift'
 require 'finagle-thrift/trace'
+require 'uri'
 
-require "faraday/zipkin/version"
+require 'faraday/zipkin/version'
 
 module Faraday
   module Zipkin
@@ -11,8 +12,7 @@ module Faraday
         :trace_id => "X-B3-TraceId",
         :parent_id => "X-B3-ParentSpanId",
         :span_id => "X-B3-SpanId",
-        :sampled => "X-B3-Sampled",
-        :flags => "X-B3-Flags"
+        :sampled => "X-B3-Sampled"
       }.freeze
 
       def initialize(app)
@@ -21,10 +21,16 @@ module Faraday
 
       def call(env)
         trace_id = ::Trace.id
-        B3_HEADERS.each do |method, header|
-          env[:request_headers][header] = trace_id.send(method).to_s
+        host = URI.parse(env[:url]).host
+        ::Trace.push(trace_id.next_id) do
+          ::Trace.record(::Trace::Annotation.new(::Trace::Annotation::CLIENT_SEND, host))
+          B3_HEADERS.each do |method, header|
+            env[:request_headers][header] = ::Trace.id.send(method).to_s
+          end
+          result = @app.call(env)
+          ::Trace.record(::Trace::Annotation.new(::Trace::Annotation::CLIENT_RECV, host))
+          result
         end
-        @app.call(env)
       end
     end
   end

data/spec/zipkin_trace_headers_spec.rb

@@ -1,28 +1,49 @@
 describe Faraday::Zipkin::TraceHeaders do
   let(:middleware) { described_class.new(lambda{|env| env}) }
+  let(:hostname) { 'service.example.com' }
 
   def process(body, headers={})
     env = {
+      :url => "https://#{hostname}/some/path/here",
       :body => body,
       :request_headers => Faraday::Utils::Headers.new(headers),
     }
     middleware.call(env)
   end
 
+  # custom matcher for trace annotation
+  RSpec::Matchers.define :have_value_and_host do |v, h|
+    match { |actual| actual.value == v && actual.host == h }
+  end
+
   context 'request' do
     context 'with tracing id' do
-      let(:trace_id) { ::Trace::TraceId.new(1, 2, 3, true, ::Trace::Flags::EMPTY) }
+      let(:trace_id) { ::Trace::TraceId.new(1, 2, 3, true) }
 
       it 'sets the X-B3 request headers' do
+        # expect SEND then RECV
+        expect(::Trace).to receive(:record).with(have_value_and_host(::Trace::Annotation::CLIENT_SEND, hostname)).ordered
+        expect(::Trace).to receive(:record).with(have_value_and_host(::Trace::Annotation::CLIENT_RECV, hostname)).ordered
+
         result = nil
         ::Trace.push(trace_id) do
           result = process('')
         end
         expect(result[:request_headers]['X-B3-TraceId']).to eq('0000000000000001')
-        expect(result[:request_headers]['X-B3-ParentSpanId']).to eq('0000000000000002')
-        expect(result[:request_headers]['X-B3-SpanId']).to eq('0000000000000003')
+        expect(result[:request_headers]['X-B3-ParentSpanId']).to eq('0000000000000003')
+        expect(result[:request_headers]['X-B3-SpanId']).not_to eq('0000000000000003')
+        expect(result[:request_headers]['X-B3-SpanId']).to match(/^\h{16}$/)
         expect(result[:request_headers]['X-B3-Sampled']).to eq('true')
-        expect(result[:request_headers]['X-B3-Flags']).to eq('0')
+      end
+    end
+
+    context 'without tracing id' do
+      it 'generates a new ID, and sets the X-B3 request headers' do
+        result = process('')
+        expect(result[:request_headers]['X-B3-TraceId']).to match(/^\h{16}$/)
+        expect(result[:request_headers]['X-B3-ParentSpanId']).to match(/^\h{16}$/)
+        expect(result[:request_headers]['X-B3-SpanId']).to match(/^\h{16}$/)
+        expect(result[:request_headers]['X-B3-Sampled']).to match(/(true|false)/)
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: faraday-zipkin
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Ariel Salomon
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-22 00:00:00.000000000 Z
+date: 2014-09-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.3.0
+        version: 1.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.3.0
+        version: 1.2.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement