lhc 8.0.0 → 8.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8e896a6247a34efa8fb35b9ba8cdf51ad68b8a00
-  data.tar.gz: f5d30a0736bbb74ea0cb4b62e060c4edeb9cc48e
+  metadata.gz: '059dd1e79e371a3df375a6a565b4797c11bf71da'
+  data.tar.gz: b2a5925b099b34812d6cb1aef256290d0cace0e5
 SHA512:
-  metadata.gz: 06f42cbc9182070e2d89c325a261095ea66665aa27ae3b61f6e3206158b1f960f9939997001b9f8db087c5ff439c89b059548d54eaceb44ae7f106d73ae931a3
-  data.tar.gz: 663cfcbe61d6e9b220dc6073c1c1c9e4c576981984c304f60945fd30d01ca7c2c14e6aa040270439e15134b2178d8deba39d4c9141d65d214979e9382a47d99b
+  metadata.gz: aff5120baa514889103791b6681e4776bbf8e5055db5c8b126fae5580487f72da833d3a472fd15b8c930807a1500d58e4a1c3c7c7c332ed47b8f9d460d2ac36d
+  data.tar.gz: a9959d2b3c84fd4125fe682eb172d6e06b81c225758931a0b493a7dadfa6a6b0faf4460e6a5ae7424482351a4fc8596312b22d6cabffe74e3de5952d16472303

data/.rubocop.yml

@@ -41,3 +41,6 @@ Style/RedundantReturn:
 
 RSpec/InstanceVariable:
   Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Enabled: false

data/docs/interceptors.md

@@ -23,7 +23,7 @@ Interceptors
 ## Core Interceptors
 
 There are some interceptors that are part of LHC already, that cover some basic usecases:
-like [Caching](/docs/interceptors/caching.md), [Monitoring](/docs/interceptors/monitoring.md), [Authentication](/docs/interceptors/authentication.md), [Rollbar](/docs/interceptors/rollbar.md).
+like [Caching](/docs/interceptors/caching.md), [Monitoring](/docs/interceptors/monitoring.md), [Authentication](/docs/interceptors/authentication.md), [Rollbar](/docs/interceptors/rollbar.md), [Zipkin](/docs/interceptors/zipkin.md).
 
 ## Callbacks
 

data/docs/interceptors/zipkin.md

@@ -0,0 +1,23 @@
+# Zipkin
+
+Zipkin is a distributed tracing system. It helps gather timing data needed to troubleshoot latency problems in microservice architectures [Zipkin Distributed Tracing](https://zipkin.io/).
+
+Add the zipkin interceptor to your basic set of LHC interceptors.
+
+```ruby
+  LHC.config.interceptors = [LHC::Zipkin]
+```
+
+The following configuration needs to happen in the application that wants to run this interceptor:
+
+1. Add `gem 'zipkin-tracer'` to your Gemfile.
+2. Add the necessary Rack middleware and configuration
+
+```ruby
+config.middleware.use ZipkinTracer::RackHandler, {
+  service_name: 'service-name', # name your service will be known as in zipkin
+  service_port: 80, # the port information that is sent along the trace
+  json_api_host: 'http://zipkin-collector', # the zipkin endpoint
+  sample_rate: 1 # sample rate, where 1 = 100% of all requests, and 0.1 is 10% of all requests
+}
+```

data/lib/lhc.rb

@@ -1,5 +1,6 @@
 require 'typhoeus'
 require 'active_support/core_ext/object/blank'
+require 'active_support/core_ext/hash/keys'
 
 module LHC
   autoload :BasicMethodsConcern,
@@ -117,6 +118,8 @@ module LHC
     'lhc/response'
   autoload :Rollbar,
     'lhc/interceptors/rollbar'
+  autoload :Zipkin,
+    'lhc/interceptors/zipkin'
 
   require 'lhc/railtie' if defined?(Rails)
 end

data/lib/lhc/interceptors/zipkin.rb

@@ -0,0 +1,98 @@
+class LHC::Zipkin < LHC::Interceptor
+  B3_HEADERS = {
+    trace_id: 'X-B3-TraceId'.freeze,
+    parent_id: 'X-B3-ParentSpanId'.freeze,
+    span_id: 'X-B3-SpanId'.freeze,
+    sampled: 'X-B3-Sampled'.freeze,
+    flags: 'X-B3-Flags'.freeze
+  }.freeze
+  TRUE = '1'.freeze # true in binary annotation
+
+  def before_request
+    return unless dependencies?
+    ZipkinTracer::TraceContainer.with_trace_id(trace_id) do
+      B3_HEADERS.each { |method, header| request.headers[header] = trace_id.send(method).to_s }
+      start_trace! if ::Trace.tracer && trace_id.sampled?
+    end
+  end
+
+  def after_response
+    return unless dependencies?
+    end_trace!
+  end
+
+  private
+
+  def start_trace!
+    record_path
+    record_remote_endpoint
+    record_local_endpoint
+  end
+
+  def end_trace!
+    record_status
+    record_error if !response.success?
+    record_end
+  end
+
+  def trace_id
+    @trace_id ||= ZipkinTracer::TraceGenerator.new.next_trace_id
+  end
+
+  def span
+    @span ||= ::Trace.tracer.start_span(trace_id, url.path)
+  end
+
+  def url
+    @url ||= URI(request.raw.url)
+  end
+
+  def status
+    @status ||= response.code.to_s
+  end
+
+  def service_name
+    @service_name ||= url.host
+  end
+
+  def record_local_endpoint
+    span.record(::Trace::Annotation::CLIENT_SEND, local_endpoint)
+  end
+
+  def record_remote_endpoint
+    span.record_tag(::Trace::BinaryAnnotation::SERVER_ADDRESS, TRUE, ::Trace::BinaryAnnotation::Type::BOOL, remote_endpoint)
+  end
+
+  def record_path
+    span.record_tag(::Trace::BinaryAnnotation::PATH, url.path, ::Trace::BinaryAnnotation::Type::STRING, local_endpoint)
+  end
+
+  def record_end
+    span.record(::Trace::Annotation::CLIENT_RECV, local_endpoint)
+    ::Trace.tracer.end_span(span)
+  end
+
+  def record_error
+    span.record_tag(::Trace::BinaryAnnotation::ERROR, status, ::Trace::BinaryAnnotation::Type::STRING, local_endpoint)
+  end
+
+  def record_status
+    span.record_tag(::Trace::BinaryAnnotation::STATUS, status, ::Trace::BinaryAnnotation::Type::STRING, local_endpoint)
+  end
+
+  def local_endpoint
+    @local_endpoint ||= ::Trace.default_endpoint
+  end
+
+  def remote_endpoint
+    @remote_endpoint ||= ::Trace::Endpoint.remote_endpoint(url, service_name, local_endpoint.ip_format)
+  end
+
+  def dependencies?
+    (
+      defined?(ZipkinTracer::TraceContainer) &&
+      ZipkinTracer::TraceContainer.current &&
+      defined?(Trace)
+    ) || warn('[WARNING] Zipkin interceptor is enabled but dependencies are not found. See: https://github.com/local-ch/lhc/blob/master/docs/interceptors/zipkin.md')
+  end
+end

data/lib/lhc/version.rb

@@ -1,3 +1,3 @@
 module LHC
-  VERSION ||= '8.0.0'
+  VERSION ||= '8.1.0'
 end

data/spec/basic_methods/request_without_rails_spec.rb

@@ -1,9 +1,28 @@
 require 'spec_helper'
 
 describe LHC do
-  context 'request' do
+  context 'GET' do
+    before do
+      stub_request(:get, "http://datastore/v2/feedbacks").to_return(status: 200, body: "{}")
+    end
     it "is able to call .request without LHC raising NoMethodError: undefined method `blank?' for nil:NilClass when calling it outside of the rails context" do
-      expect { LHC.request(url: "http://datastore/v2/feedbacks", method: :get) }.not_to raise_error(NoMethodError)
+      expect { LHC.request(url: "http://datastore/v2/feedbacks", method: :get) }.not_to raise_error
+    end
+  end
+
+  context 'POST' do
+    before do
+      stub_request(:post, "http://datastore/v2/feedbacks").to_return(status: 200, body: "{}")
+    end
+
+    it "is able to call .request without LHC raising NoMethodError: undefined method `deep_symbolize_keys' for {}:Hash" do
+      options = {
+        url: "http://datastore/v2/feedbacks",
+        method: :post,
+        body: "{}",
+        headers: { 'Content-Type' => 'application/json' }
+      }
+      expect { LHC.request(options) }.not_to raise_error
     end
   end
 end

data/spec/interceptors/zipkin/distributed_tracing_spec.rb

@@ -0,0 +1,52 @@
+require 'rails_helper'
+
+describe LHC::Zipkin do
+  before(:each) do
+    LHC.config.interceptors = [described_class]
+    LHC.config.endpoint(:local, 'http://local.ch')
+    stub_request(:get, 'http://local.ch').to_return(status: 200, body: 'The Website')
+  end
+
+  context 'with zipkin tracer integration' do
+    before(:all) do
+      ::ZipkinTracer::TraceContainer.setup_mock(
+        trace_id: 'trace_id',
+        parent_id: 'parent_id',
+        span_id: 'span_id',
+        sampled: 'sampled',
+        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('sampled')
+      expect(headers['X-B3-Flags']).to eq('flags')
+    end
+  end
+
+  context 'wihtout zipkin integration' do
+    before(:all) do
+      TemporaryZipkinTracer = ::ZipkinTracer
+      Object.send(:remove_const, :ZipkinTracer)
+    end
+
+    after(:all) do
+      ::ZipkinTracer = TemporaryZipkinTracer
+    end
+
+    it 'adds the proper X-B3 headers' do
+      headers = nil
+      expect { headers = LHC.get(:local).request.headers }.not_to raise_error
+
+      expect(headers['X-B3-TraceId']).to be_nil
+      expect(headers['X-B3-ParentSpanId']).to be_nil
+      expect(headers['X-B3-SpanId']).to be_nil
+      expect(headers['X-B3-Sampled']).to be_nil
+      expect(headers['X-B3-Flags']).to be_nil
+    end
+  end
+end

data/spec/support/zipkin_mock.rb

@@ -0,0 +1,113 @@
+module ZipkinTracer
+  class TraceContainer
+    attr_reader :trace_id, :parent_id, :span_id, :sampled, :flags
+    class << self
+      attr_accessor :current
+
+      def setup_mock(trace_id:, parent_id:, span_id:, sampled:, flags:)
+        @current = new(trace_id: trace_id, parent_id: parent_id, span_id: span_id, sampled: sampled, flags: flags)
+      end
+
+      def with_trace_id(trace_id)
+        yield trace_id
+      end
+    end
+
+    def initialize(trace_id:, parent_id:, span_id:, sampled:, flags:)
+      @trace_id = trace_id
+      @parent_id = parent_id
+      @span_id = span_id
+      @sampled = sampled
+      @flags = flags
+    end
+  end
+
+  class TraceGenerator
+    def next_trace_id
+      TraceId.new
+    end
+  end
+
+  class TraceId
+    def trace_id
+      'trace_id'
+    end
+
+    def parent_id
+      'parent_id'
+    end
+
+    def span_id
+      'span_id'
+    end
+
+    def sampled
+      'sampled'
+    end
+
+    def flags
+      'flags'
+    end
+
+    def sampled?
+      true
+    end
+  end
+
+  class Span
+    def record_tag(*)
+    end
+
+    def record(*)
+    end
+  end
+end
+
+module Trace
+  def self.default_endpoint
+    Endpoint.new
+  end
+
+  def self.tracer
+    Tracer.new
+  end
+
+  class Tracer
+    def start_span(*)
+      return ZipkinTracer::Span.new
+    end
+
+    def end_span(*)
+      return ZipkinTracer::Span.new
+    end
+  end
+
+  class Annotation
+    CLIENT_SEND = 'client_send'.freeze
+    CLIENT_RECV = 'client_recv'.freeze
+  end
+
+  class BinaryAnnotation
+    PATH = 'path'.freeze
+    SERVER_ADDRESS = 'server_address'.freeze
+    STATUS = 'status'.freeze
+    ERROR = 'error'.freeze
+
+    class Type
+      STRING = 'string'.freeze
+      BOOL = 'bool'.freeze
+    end
+  end
+
+  class Endpoint
+    class << self
+      def remote_endpoint(*)
+        new
+      end
+    end
+
+    def ip_format
+      'ipv4'
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lhc
 version: !ruby/object:Gem::Version
-  version: 8.0.0
+  version: 8.1.0
 platform: ruby
 authors:
 - https://github.com/local-ch/lhc/contributors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-08 00:00:00.000000000 Z
+date: 2018-03-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -199,6 +199,7 @@ files:
 - docs/interceptors/prometheus.md
 - docs/interceptors/retry.md
 - docs/interceptors/rollbar.md
+- docs/interceptors/zipkin.md
 - docs/request.md
 - docs/response.md
 - lhc.gemspec
@@ -225,6 +226,7 @@ files:
 - lib/lhc/interceptors/prometheus.rb
 - lib/lhc/interceptors/retry.rb
 - lib/lhc/interceptors/rollbar.rb
+- lib/lhc/interceptors/zipkin.rb
 - lib/lhc/railtie.rb
 - lib/lhc/request.rb
 - lib/lhc/response.rb
@@ -316,6 +318,7 @@ files:
 - spec/interceptors/retry/main_spec.rb
 - spec/interceptors/return_response_spec.rb
 - spec/interceptors/rollbar/main_spec.rb
+- spec/interceptors/zipkin/distributed_tracing_spec.rb
 - spec/rails_helper.rb
 - spec/request/encoding_spec.rb
 - spec/request/error_handling_spec.rb
@@ -341,6 +344,7 @@ files:
 - spec/support/fixtures/json/localina_content_ad.json
 - spec/support/load_json.rb
 - spec/support/reset_config.rb
+- spec/support/zipkin_mock.rb
 - spec/timeouts/no_signal_spec.rb
 - spec/timeouts/timings_spec.rb
 homepage: https://github.com/local-ch/lhc
@@ -364,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
@@ -450,6 +454,7 @@ test_files:
 - spec/interceptors/retry/main_spec.rb
 - spec/interceptors/return_response_spec.rb
 - spec/interceptors/rollbar/main_spec.rb
+- spec/interceptors/zipkin/distributed_tracing_spec.rb
 - spec/rails_helper.rb
 - spec/request/encoding_spec.rb
 - spec/request/error_handling_spec.rb
@@ -475,5 +480,6 @@ test_files:
 - spec/support/fixtures/json/localina_content_ad.json
 - spec/support/load_json.rb
 - spec/support/reset_config.rb
+- spec/support/zipkin_mock.rb
 - spec/timeouts/no_signal_spec.rb
 - spec/timeouts/timings_spec.rb