faraday-zipkin 0.1.1 → 0.2.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    MjJkNWExZDIwMmE4NDZlYzY4YmViNWFmNDIyZTJiYTVhMThkZWVlMw==
+    OGYxYzAzNzAzZTQ3OTVhMjcyOWUyZWFlOTQ2OWE2YjgzOTlmNzBjYQ==
   data.tar.gz: !binary |-
-    Yzg0MTAyNDU0YmQ0NGJkMGI5NzUxMWFiZjQ3NzdhNWFjNGRiYzk0Nw==
+    YmRlM2VkNzIyNmQyYWNhMzQ5M2M2N2RkN2ZlMjI0YTM5YWVhYTdmOQ==
 SHA512:
   metadata.gz: !binary |-
-    ODQ3ZDI4ZDM4NjQwMTQ0NWViOGNlOGJjZGMxZTFlYmMzMjI2NWI1YmQxNjlk
-    OGQ4NTE3Y2JlMmI2Y2ExODU4YzAwZGM5YWFjMjNjYzcyYjA4MThlMmE3YjRk
-    YzgwYjZkZDQ2ZDM2NGY3NWUyMWI3MzI2YmVhOTkwNmFiMmZkMjI=
+    OTdkMzY3MmJiNTQyOWVkNjZhZDA5ZGI0MDkyNWJlMGQxZTg2N2RhZmMxMDkx
+    MTJlOWUzNTlhMWIzMGFlNTcwYjJjMGQyODQ2YzM2MjRiM2RmYWFhNGNiY2Zm
+    ODg1ZjgwZmU5YmVmODU0ZWE1ZjJiMzcyYjQ3MWVhOWE5ZDIwOGQ=
   data.tar.gz: !binary |-
-    NmRhZGRlN2U4OGVmMTM2NDEyYWZiOTA3NGUyMzFkNGUzZTQ3OWRmZGYxYWMy
-    ODU0ODllNjhhMjM0NGNlM2VmNjZkZjkwMzUyNDMxZTEyOTI5YWU1ZDA3OGE2
-    ZGYwYTI1NWZmMTU0MmE5MjBjYWRiMDQ4NTRmYjZhNjJhMTdjZDQ=
+    ZTZkZGQwZmU4NTRhYmRiYjdhOTJlMmQ2Nzg4MjU2ZWJhMGUyMWQ0NjI5ZjE1
+    NjYwZjhlYmM2ZjU2MmY5Mzk2YzcyMGNlMTIwYTcwN2ZjMTRmNDkwODVmNjU3
+    MGExOWI3NjcwYzkxYzkxMmMwZWRjNzhiMWVkNDNkODFmODIxZjA=

data/README.md

@@ -24,12 +24,17 @@ Include Faraday::Zipkin::TraceHeaders as a Faraday middleware:
     require 'faraday/zipkin'
     
     conn = Faraday.new(:url => 'http://localhost:9292/') do |faraday|
-      faraday.use Faraday::Zipkin::TraceHeaders
+      faraday.use Faraday::Zipkin::TraceHeaders [, 'service_name']
       # default Faraday stack
       faraday.request :url_encoded
       faraday.adapter Faraday.default_adapter
     end
- 
+
+Note that supplying the service name for the destination service is
+optional; the tracing will default to a service name derived from the
+first section of the destination URL (e.g. 'service.example.com' =>
+'service').
+
 ## Contributing
 
 1. Fork it ( https://github.com/Oscil8/faraday-zipkin/fork )

data/lib/faraday/zipkin/version.rb

@@ -1,5 +1,5 @@
 module Faraday
   module Zipkin
-    VERSION = "0.1.1"
+    VERSION = "0.2.0"
   end
 end

data/lib/faraday/zipkin.rb

@@ -15,23 +15,26 @@ module Faraday
         :sampled => "X-B3-Sampled"
       }.freeze
 
-      def initialize(app)
+      def initialize(app, service_name=nil)
         @app = app
+        @service_name = service_name
       end
 
       def call(env)
         trace_id = ::Trace.id
 
         # handle either a URI object (passed by Faraday v0.8.x in testing), or something string-izable
-        host = env[:url].respond_to?(:host) ? env[:url].host : URI.parse(env[:url].to_s).host
+        url = env[:url].respond_to?(:host) ? env[:url] : URI.parse(env[:url].to_s)
+        service_name = @service_name || url.host.split('.').first # default to url-derived service name
+        endpoint = ::Trace::Endpoint.new(::Trace::Endpoint.host_to_i32(url.host), url.port, service_name)
 
         ::Trace.push(trace_id.next_id) do
-          ::Trace.record(::Trace::Annotation.new(::Trace::Annotation::CLIENT_SEND, host))
+          ::Trace.record(::Trace::Annotation.new(::Trace::Annotation::CLIENT_SEND, endpoint))
           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))
+          ::Trace.record(::Trace::Annotation.new(::Trace::Annotation::CLIENT_RECV, endpoint))
           result
         end
       end

data/spec/zipkin_trace_headers_spec.rb

@@ -1,6 +1,8 @@
 describe Faraday::Zipkin::TraceHeaders do
-  let(:middleware) { described_class.new(lambda{|env| env}) }
+  let(:wrapped_app) { lambda{|env| env} }
+
   let(:hostname) { 'service.example.com' }
+  let(:host_ip) { 0x11223344 }
 
   def process(body, url, headers={})
     env = {
@@ -11,19 +13,29 @@ describe Faraday::Zipkin::TraceHeaders do
     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 }
+  # custom matchers for trace annotation
+  RSpec::Matchers.define :have_value do |v|
+    match { |actual| actual.value == v }
+  end
+
+  RSpec::Matchers.define :have_endpoint do |ip, svc|
+    match { |actual| actual.host.kind_of?(::Trace::Endpoint) &&
+                     actual.host.ipv4 == ip &&
+                     actual.host.service_name == svc }
   end
 
+  before(:each) {
+    allow(::Trace::Endpoint).to receive(:host_to_i32).with(hostname).and_return(host_ip)
+  }
+
   shared_examples 'can make requests' do
     context 'with tracing id' do
       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
+        expect(::Trace).to receive(:record).with(have_value(::Trace::Annotation::CLIENT_SEND).and(have_endpoint(host_ip, service_name))).ordered
+        expect(::Trace).to receive(:record).with(have_value(::Trace::Annotation::CLIENT_RECV).and(have_endpoint(host_ip, service_name))).ordered
 
         result = nil
         ::Trace.push(trace_id) do
@@ -48,16 +60,33 @@ describe Faraday::Zipkin::TraceHeaders do
     end
   end
 
-  context 'request with string URL' do
-    let(:url) { "https://#{hostname}/some/path/here" }
+  context 'middleware configured (without service_name)' do
+    let(:middleware) { described_class.new(wrapped_app) }
+    let(:service_name) { 'service' }
+
+    context 'request with string URL' do
+      let(:url) { "https://#{hostname}/some/path/here" }
 
-    include_examples 'can make requests'
+      include_examples 'can make requests'
+    end
+
+    # in testing, Faraday v0.8.x passes a URI object rather than a string
+    context 'request with pre-parsed URL' do
+      let(:url) { URI.parse("https://#{hostname}/some/path/here") }
+
+      include_examples 'can make requests'
+    end
   end
 
-  # in testing, Faraday v0.8.x passes a URI object rather than a string
-  context 'request with pre-parsed URL' do
-    let(:url) { URI.parse("https://#{hostname}/some/path/here") }
+  context 'configured with service_name "foo"' do
+    let(:middleware) { described_class.new(wrapped_app, 'foo') }
+    let(:service_name) { 'foo' }
 
-    include_examples 'can make requests'
+    # in testing, Faraday v0.8.x passes a URI object rather than a string
+    context 'request with pre-parsed URL' do
+      let(:url) { URI.parse("https://#{hostname}/some/path/here") }
+
+      include_examples 'can make requests'
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: faraday-zipkin
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Ariel Salomon
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-26 00:00:00.000000000 Z
+date: 2014-10-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday