lhc 6.5.0 → 6.6.0.zipkin.pre

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a1870e7f765bd88ab8d601bf98828dec1dad3578
-  data.tar.gz: 2ee4018796f6db877e144888e3211c7cae3cd72c
+  metadata.gz: 9ec061c1dd54c6c48e6d3053eeaa5cfde466cbf9
+  data.tar.gz: 9b01c8475dd3c7002f4fb7f1a23c1e2eb5711566
 SHA512:
-  metadata.gz: 8868211d499b67b58d67abbeadfd4fd12aabbf61d2a99f18a7f4e06ff5f51856b0203997e914e43143503c02315448913253b914b87c51c830ecbc1955b95aec
-  data.tar.gz: 8f558506283ca904cda4c0db565f24f1728dd9976778523dcd7b74ed155aa82dce6eb4a28a5156dd4bcaea5f9b301dd2d4ee720beae1fca6a8aeee2ad615251c
+  metadata.gz: 3332b1305c96357cb69617ae27945b2a09f1621a5733e96d8366d4d07dbebf35fe428937e1e5ca34567f3a3007ff7ae649302afd946f37b7b77138933ec84637
+  data.tar.gz: bbbebb1d677c39e8f875b25bc494833043cacfa7b15013928153678f10ebf9d0b7dcf0083e12087ba5775c58da98870bd9f8f096970fab65a9057b7ea413c3f4

data/README.md

@@ -106,7 +106,7 @@ You can configure global endpoints, placeholders and interceptors.
   LHC.configure do |c|
     c.placeholder :datastore, 'http://datastore/v2'
     c.endpoint :feedbacks, ':datastore/feedbacks', params: { has_reviews: true }
-    c.interceptors = [CacheInterceptor]
+    c.interceptors = [LHC::Caching]
   end
 ```
 
@@ -185,7 +185,12 @@ To monitor and manipulate the http communication done with LHC, you can define i
 → [Read more about interceptors](docs/interceptors.md)
 
 A set of core interceptors is part of LHC,
-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),
+[Prometheus](/docs/interceptors/prometheus.md).
 
 → [Read more about core interceptors](docs/interceptors.md#core-interceptors)
 

data/docs/interceptors.md

@@ -67,7 +67,7 @@ Inside an interceptor, you are able to provide a response, rather then doing a r
 This is usefull for implementing an interceptor for caching.
 
 ```ruby
-class CacheInterceptor < LHC::Interceptor
+class LHC::Cache < LHC::Interceptor
 
   def before_request(request)
     cached_response = Rails.cache.fetch(request.url)

data/docs/interceptors/caching.md

@@ -34,6 +34,13 @@ Only GET requests are cached by default. If you want to cache any other request
   LHC.get('http://local.ch', cache: { methods: [:get] })
 ```
 
+Responses served from cache are marked as served from cache:
+
+```ruby
+  response = LHC.get('http://local.ch', cache: true)
+  response.from_cache? # true
+```
+
 ## Options
 
 ```ruby

data/docs/interceptors/prometheus.md

@@ -0,0 +1,18 @@
+# Prometheus Interceptor
+
+Logs basic request/response information to prometheus.
+
+```ruby
+  require 'prometheus/client'
+  LHC::Prometheus.client = Prometheus::Client
+  LHC::Prometheus.namespace = 'web_location_app'
+  LHC.config.interceptors = [LHC::Prometheus]
+```
+
+```ruby
+  LHC.get('http://local.ch')
+```
+
+- Creates a promethues counter that receives additional meta information for: `:code`, `:success` and `:timeout`.
+
+- Creates a promethues histogram for response times in milliseconds.

data/lhc.gemspec

@@ -30,6 +30,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'pry'
   s.add_development_dependency 'rubocop', '~> 0.36.0'
   s.add_development_dependency 'rubocop-rspec'
+  s.add_development_dependency 'prometheus-client', '~> 0.7.1'
 
   s.license = 'GPL-3'
 end

data/lib/lhc.rb

@@ -16,6 +16,8 @@ module LHC
     'lhc/interceptors/auth'
   autoload :Caching,
     'lhc/interceptors/caching'
+  autoload :Prometheus,
+    'lhc/interceptors/prometheus'
   autoload :Config,
     'lhc/config'
   autoload :Endpoint,

data/lib/lhc/interceptors/prometheus.rb

@@ -0,0 +1,38 @@
+class LHC::Prometheus < LHC::Interceptor
+  include ActiveSupport::Configurable
+
+  config_accessor :client, :namespace
+
+  class << self
+    attr_accessor :registered
+  end
+
+  def self.request_key
+    [LHC::Prometheus.namespace, 'lhc_requests'].join('_').to_sym
+  end
+
+  def self.times_key
+    [LHC::Prometheus.namespace, 'lhc_times'].join('_').to_sym
+  end
+
+  def initialize
+    return if LHC::Prometheus.registered || LHC::Prometheus.client.blank?
+    LHC::Prometheus.client.registry.counter(LHC::Prometheus.request_key, 'Counter of all LHC requests.')
+    LHC::Prometheus.client.registry.histogram(LHC::Prometheus.times_key, 'Times for all LHC requests.')
+    LHC::Prometheus.registered = true
+  end
+
+  def after_response(response)
+    return if !LHC::Prometheus.registered || LHC::Prometheus.client.blank?
+    LHC::Prometheus.client.registry
+      .get(LHC::Prometheus.request_key)
+      .increment(
+        code: response.code,
+        success: response.success?,
+        timeout: response.timeout?
+      )
+    LHC::Prometheus.client.registry
+      .get(LHC::Prometheus.times_key)
+      .observe({}, response.time_ms)
+  end
+end

data/lib/lhc/interceptors/zipkin.rb

@@ -0,0 +1,11 @@
+class LHC::Zipkin < LHC::Interceptor
+
+  def before_request(request)
+    return unless defined?(ZipkinTracer::TraceContainer)
+    container = ZipkinTracer::TraceContainer.current
+    request.headers['X-B3-TraceId'] = container.trace_id.to_s
+    request.headers['X-B3-ParentSpanId'] = container.parent_id.to_s if container.parent_id
+    request.headers['X-B3-Sampled'] = container.sampled
+    request.headers['X-B3-Flags'] = container.flags
+  end
+end

data/lib/lhc/response.rb

@@ -32,9 +32,14 @@ class LHC::Response
     body_replacement || raw.body.presence
   end
 
-  # Provides response time in ms.
+  # Provides response time in seconds
   def time
-    (raw.time || 0) * 1000
+    time_ms * 1000
+  end
+
+  # Provides response time in milliseconds
+  def time_ms
+    raw.time || 0
   end
 
   def timeout?

data/lib/lhc/version.rb

@@ -1,3 +1,3 @@
 module LHC
-  VERSION ||= "6.5.0"
+  VERSION ||= "6.6.0.zipkin.pre"
 end

data/spec/interceptors/prometheus_spec.rb

@@ -0,0 +1,49 @@
+require 'rails_helper'
+require 'prometheus/client'
+
+describe LHC::Prometheus do
+  before(:each) do
+    LHC.config.interceptors = [LHC::Prometheus]
+    LHC::Prometheus.client = Prometheus::Client
+    LHC::Prometheus.namespace = 'test_app'
+    stub_request(:get, 'http://local.ch')
+    expect(Prometheus::Client).to receive(:registry).and_call_original.at_least(:once)
+  end
+
+  let(:client) { double("prometheus/client") }
+
+  context 'registering' do
+    it 'creates a counter and histogram registry in the prometheus client' do
+      expect(Prometheus::Client.registry).to receive(:counter).and_call_original.once
+        .with(:test_app_lhc_requests, 'Counter of all LHC requests.')
+      expect(Prometheus::Client.registry).to receive(:histogram).and_call_original.once
+        .with(:test_app_lhc_times, 'Times for all LHC requests.')
+
+      LHC.get('http://local.ch')
+      LHC.get('http://local.ch') # second request, registration should happen only once
+    end
+  end
+
+  context 'logging' do
+    let(:requests_registry_double) { double('requests_registry_double') }
+    let(:times_registry_double) { double('times_registry_double') }
+
+    it 'logs monitoring information to the created registries' do
+      expect(Prometheus::Client.registry).to receive(:get).and_return(requests_registry_double).once
+        .with(:test_app_lhc_requests)
+      expect(Prometheus::Client.registry).to receive(:get).and_return(times_registry_double).once
+        .with(:test_app_lhc_times)
+
+      expect(requests_registry_double).to receive(:increment).once
+        .with(
+          code: 200,
+          success: true,
+          timeout: false
+        )
+      expect(times_registry_double).to receive(:observe).once
+        .with({}, 0)
+
+      LHC.get('http://local.ch')
+    end
+  end
+end

data/spec/response/time_spec.rb

@@ -6,9 +6,14 @@ describe LHC::Response do
 
     let(:raw_response) { OpenStruct.new(time: time) }
 
-    it 'provides response time in milliseconds' do
+    it 'provides response time in seconds' do
       response = LHC::Response.new(raw_response, nil)
       expect(response.time).to eq time * 1000
     end
+
+    it 'provides response time in seconds' do
+      response = LHC::Response.new(raw_response, nil)
+      expect(response.time_ms).to eq time
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lhc
 version: !ruby/object:Gem::Version
-  version: 6.5.0
+  version: 6.6.0.zipkin.pre
 platform: ruby
 authors:
 - https://github.com/local-ch/lhc/contributors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-06 00:00:00.000000000 Z
+date: 2017-10-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -136,6 +136,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: prometheus-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.1
 description: 'Rails gem for HTTP: Wraps typhoeus and provides additional features
   (like interceptors)'
 email:
@@ -167,6 +181,7 @@ files:
 - docs/interceptors/authentication.md
 - docs/interceptors/caching.md
 - docs/interceptors/monitoring.md
+- docs/interceptors/prometheus.md
 - docs/interceptors/rollbar.md
 - docs/request.md
 - docs/response.md
@@ -190,7 +205,9 @@ files:
 - lib/lhc/interceptors/auth.rb
 - lib/lhc/interceptors/caching.rb
 - lib/lhc/interceptors/monitoring.rb
+- lib/lhc/interceptors/prometheus.rb
 - lib/lhc/interceptors/rollbar.rb
+- lib/lhc/interceptors/zipkin.rb
 - lib/lhc/railtie.rb
 - lib/lhc/request.rb
 - lib/lhc/response.rb
@@ -274,6 +291,7 @@ files:
 - spec/interceptors/default_interceptors_spec.rb
 - spec/interceptors/define_spec.rb
 - spec/interceptors/monitoring/main_spec.rb
+- spec/interceptors/prometheus_spec.rb
 - spec/interceptors/response_competition_spec.rb
 - spec/interceptors/return_response_spec.rb
 - spec/interceptors/rollbar/main_spec.rb
@@ -318,13 +336,13 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements:
 - Ruby >= 2.0.0
 rubyforge_project: 
-rubygems_version: 2.6.12
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: LocalHttpClient
@@ -402,6 +420,7 @@ test_files:
 - spec/interceptors/default_interceptors_spec.rb
 - spec/interceptors/define_spec.rb
 - spec/interceptors/monitoring/main_spec.rb
+- spec/interceptors/prometheus_spec.rb
 - spec/interceptors/response_competition_spec.rb
 - spec/interceptors/return_response_spec.rb
 - spec/interceptors/rollbar/main_spec.rb