lhc 9.1.0 → 9.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1759668d50d0a7291b762b0553b00dc123f89f02
-  data.tar.gz: f5620c4d475ee6c5a0229b18391ac12f97af19fa
+  metadata.gz: f7fc2900acc370686fd4e81991eba4fa9cab42f9
+  data.tar.gz: b0e58a468ab2d7aebb40f19c7dd9b95be98d0bc3
 SHA512:
-  metadata.gz: 41fcea12918b753278d4d6062fbd5bdb104d435382187799962c417ec3bd3a94a12607fca3cb2626613cf68543bded472e774a2f9a706540eee0b63a0187e12b
-  data.tar.gz: e1a671c9f2a3f5d971a6195e8ed31f8bf72ba1b0aec690b3f7d8ae73d639adf8f68fb5f941d2ce8d960b3421518818050b1c265bdcd6c0771adaf6a91677e86a
+  metadata.gz: '089c956a35151c69a06dd0129e23c839e171a466f6142584f19eef0887b996e7741f416875c0082bac238079c901954f7049d77bf859090ee1b420d97bfb26a0'
+  data.tar.gz: 5504b40f3fd71c6f51c1c51b11052d216ba706dffff2ae9dfc1d67cad2e370399972afa5da6a2c7f1144ed462135479a4c379a80fd7360c318b8ae364ab10384

data/lib/lhc/interceptors/zipkin.rb

@@ -11,13 +11,16 @@ class LHC::Zipkin < LHC::Interceptor
   def before_request
     return unless dependencies?
     ZipkinTracer::TraceContainer.with_trace_id(trace_id) do
+      # add headers even if the current trace_id should not be sampled
       B3_HEADERS.each { |method, header| request.headers[header] = trace_id.send(method).to_s }
+      # only sample the current call if we're instructed to do so
       start_trace! if ::Trace.tracer && trace_id.sampled?
     end
   end
 
   def after_response
-    return unless dependencies?
+    # only sample the current call if we're instructed to do so
+    return unless dependencies? && trace_id.sampled?
     end_trace!
   end
 
@@ -39,6 +42,7 @@ class LHC::Zipkin < LHC::Interceptor
     @trace_id ||= ZipkinTracer::TraceGenerator.new.next_trace_id
   end
 
+  # register a new span with zipkin tracer
   def span
     @span ||= ::Trace.tracer.start_span(trace_id, url.path)
   end

data/lib/lhc/version.rb

@@ -1,3 +1,3 @@
 module LHC
-  VERSION ||= '9.1.0'
+  VERSION ||= '9.1.1'
 end

data/spec/interceptors/zipkin/distributed_tracing_spec.rb

@@ -13,7 +13,7 @@ describe LHC::Zipkin do
         trace_id: 'trace_id',
         parent_id: 'parent_id',
         span_id: 'span_id',
-        sampled: 'sampled',
+        sampled: true,
         flags: 'flags'
       )
     end
@@ -23,7 +23,7 @@ describe LHC::Zipkin do
       expect(headers['X-B3-TraceId']).to eq('trace_id')
       expect(headers['X-B3-ParentSpanId']).to eq('parent_id')
       expect(headers['X-B3-SpanId']).to eq('span_id')
-      expect(headers['X-B3-Sampled']).to eq('sampled')
+      expect(headers['X-B3-Sampled']).to eq('true')
       expect(headers['X-B3-Flags']).to eq('flags')
     end
   end
@@ -49,4 +49,60 @@ describe LHC::Zipkin do
       expect(headers['X-B3-Flags']).to be_nil
     end
   end
+
+  describe 'creating new spans' do
+    context 'sampled? is false' do
+      before(:all) do
+        ::ZipkinTracer::TraceContainer.setup_mock(
+          trace_id: 'trace_id',
+          parent_id: 'parent_id',
+          span_id: 'span_id',
+          sampled: false,
+          flags: 'flags'
+        )
+      end
+
+      it 'adds the proper X-B3 headers' do
+        headers = LHC.get(:local).request.headers
+        expect(headers['X-B3-TraceId']).to eq('trace_id')
+        expect(headers['X-B3-ParentSpanId']).to eq('parent_id')
+        expect(headers['X-B3-SpanId']).to eq('span_id')
+        expect(headers['X-B3-Sampled']).to eq('false')
+        expect(headers['X-B3-Flags']).to eq('flags')
+      end
+
+      it 'does not register a new span' do
+        # ensure no span was registered, by checking no call on span
+        expect_any_instance_of(described_class).not_to receive(:span).and_call_original
+        LHC.get(:local)
+      end
+    end
+
+    context 'sampled? is true' do
+      before(:all) do
+        ::ZipkinTracer::TraceContainer.setup_mock(
+          trace_id: 'trace_id',
+          parent_id: 'parent_id',
+          span_id: 'span_id',
+          sampled: true,
+          flags: 'flags'
+        )
+      end
+
+      it 'adds the proper X-B3 headers' do
+        headers = LHC.get(:local).request.headers
+        expect(headers['X-B3-TraceId']).to eq('trace_id')
+        expect(headers['X-B3-ParentSpanId']).to eq('parent_id')
+        expect(headers['X-B3-SpanId']).to eq('span_id')
+        expect(headers['X-B3-Sampled']).to eq('true')
+        expect(headers['X-B3-Flags']).to eq('flags')
+      end
+
+      it 'does register a new span' do
+        # ensure a span was registered, by checking call on span
+        expect_any_instance_of(described_class).to receive(:span).at_least(1).times.and_call_original
+        LHC.get(:local)
+      end
+    end
+  end
 end

data/spec/support/zipkin_mock.rb

@@ -42,7 +42,7 @@ module ZipkinTracer
     end
 
     def sampled
-      'sampled'
+      ZipkinTracer::TraceContainer.current.sampled
     end
 
     def flags
@@ -50,7 +50,7 @@ module ZipkinTracer
     end
 
     def sampled?
-      true
+      ZipkinTracer::TraceContainer.current.sampled
     end
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lhc
 version: !ruby/object:Gem::Version
-  version: 9.1.0
+  version: 9.1.1
 platform: ruby
 authors:
 - https://github.com/local-ch/lhc/contributors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-15 00:00:00.000000000 Z
+date: 2018-03-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -368,7 +368,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements:
 - Ruby >= 2.0.0
 rubyforge_project: 
-rubygems_version: 2.6.12
+rubygems_version: 2.6.14
 signing_key: 
 specification_version: 4
 summary: LocalHttpClient