lhc 9.1.2 → 9.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0ccdb2e118bc3eda413de13c19ebb6c7997c3211
-  data.tar.gz: 1fdb9d5d4eec69c752b077df9907380c5c1ac4e9
+  metadata.gz: e82411889a538078642c154032b132cec72cf53b
+  data.tar.gz: 12f685a1fb5cb8e9452ecd3c2f8ffaf2621a7122
 SHA512:
-  metadata.gz: d7346bf0487a5748637f8ff2edcaba6ec25b7c83f1216bfceeae6b9154cb407fa038282dd387bf28ffd53e452aec40b5431c7c552adc27ea347872f124ba1643
-  data.tar.gz: 1fa1ae36d6347c9177ab355785109a10500289f6da89113d8c34bff9c560f3174ea414ab59fb785ef61d8dca7dc29d7b855f1cb606d898dcdba9c4f1718dc752
+  metadata.gz: efa93d6795be75faa9151a9b4fb273338e6fe7ff4d9772302b3f6a04b08364c3111b71e7b0d3529d2af8a8f965d9e23c5d71df5141a83677dfa21bafd2a26738
+  data.tar.gz: 8d88b401cfe5122a19cb6ac5c2f5b2478a0bf231858e7430edd133f4f6c592e165f9ca2c6bf1cbf8e433a93027f7892bbcc890bd638c1cec4d8419b158331b8e

data/README.md

@@ -259,17 +259,11 @@ 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),
-[Retry](/docs/interceptors/retry.md),
-[Rollbar](/docs/interceptors/rollbar.md),
-[Prometheus](/docs/interceptors/prometheus.md).
+### Core Interceptors
 
-→ [Read more about core interceptors](docs/interceptors.md#core-interceptors)
+There are some interceptors that are part of LHC already, that cover some basic usecases:
 
+[Available Core Interceptors](/docs/interceptors)
 
 ## License
 

data/docs/interceptors.md

@@ -23,7 +23,8 @@ 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), [Zipkin](/docs/interceptors/zipkin.md).
+
+[Available Core Interceptors](/docs/interceptors)
 
 ## Callbacks
 

data/docs/interceptors/logging.md

@@ -0,0 +1,29 @@
+# Logging Interceptor
+
+The logging interceptor logs all requests done with LHC to the Rails logs.
+
+## Installation
+
+```ruby
+  LHC.config.interceptors = [LHC::Logging]
+
+  LHC::Logging.logger = Rails.logger  
+```
+
+## What and how it logs
+
+The logging Interceptor logs basic information about the request and the response:
+
+```ruby
+LHC.get('http://local.ch')
+# Before LHC request<70128730317500> GET http://local.ch at 2018-05-23T07:53:19+02:00 Params={} Headers={\"User-Agent\"=>\"Typhoeus - https://github.com/typhoeus/typhoeus\", \"Expect\"=>\"\"}
+# After LHC response for request<70128730317500>: GET http://local.ch at 2018-05-23T07:53:28+02:00 Time=0ms URL=http://local.ch:80/
+```
+
+## Configure
+
+You can configure the logger beeing used by the logging interceptor:
+
+```ruby
+LHC::Logging.logger = Another::Logger
+```

data/docs/interceptors/monitoring.md

@@ -1,6 +1,8 @@
 # Monitoring Interceptor
 
-Add the monitoring interceptor to your basic set of LHC interceptors.
+The monitoring interceptor reports all requests done with LHC to a given StatsD instance.
+
+## Installation
 
 ```ruby
   LHC.config.interceptors = [LHC::Monitoring]
@@ -12,8 +14,17 @@ You also have to configure statsd in order to have the monitoring interceptor re
   LHC::Monitoring.statsd = <your-instance-of-statsd>
 ```
 
-The monitoring interceptor reports all the HTTP communication done with LHS.
-It reports the trial always.
+## What it tracks
+
+It tracks request attempts with `before_request` and `after_request` (counts).
+
+In case your workers/processes are getting killed due limited time constraints, 
+you are able to detect deltas with relying on "before_request", and "after_request" counts:
+
+```ruby
+  "lhc.<app_name>.<env>.<host>.<http_method>.before_request", 1
+  "lhc.<app_name>.<env>.<host>.<http_method>.after_request", 1
+```
 
 In case of a successful response it reports the response code with a count and the response time with a gauge value.
 
@@ -25,14 +36,6 @@ In case of a successful response it reports the response code with a count and t
   "lhc.<app_name>.<env>.<host>.<http_method>.time", 43
 ```
 
-In case your workers/processes are getting killed due limited time constraints, 
-you are able to detect deltas with relying on "before_request", and "after_request" counts:
-
-```ruby
-  "lhc.<app_name>.<env>.<host>.<http_method>.before_request", 1
-  "lhc.<app_name>.<env>.<host>.<http_method>.after_request", 1
-```
-
 Timeouts are also reported:
 
 ```ruby
@@ -41,7 +44,10 @@ Timeouts are also reported:
 
 All the dots in the host are getting replaced with underscore (_), because dot is the default separator in graphite.
 
-It is also possible to set the key for Monitoring Interceptor on per request basis:
+
+## Configure
+
+It is possible to set the key for Monitoring Interceptor on per request basis:
 
 ```ruby
   LHC.get('http://local.ch', monitoring_key: 'local_website')

data/lib/lhc.rb

@@ -18,12 +18,15 @@ module LHC
     'lhc/interceptors/auth'
   autoload :Caching,
     'lhc/interceptors/caching'
+  autoload :DefaultTimeout,
+    'lhc/interceptors/default_timeout'
+  autoload :Logging,
+    'lhc/interceptors/logging'
   autoload :Prometheus,
     'lhc/interceptors/prometheus'
   autoload :Retry,
     'lhc/interceptors/retry'
-  autoload :DefaultTimeout,
-    'lhc/interceptors/default_timeout'
+
   autoload :Config,
     'lhc/config'
   autoload :Endpoint,

data/lib/lhc/interceptors/logging.rb

@@ -0,0 +1,19 @@
+class LHC::Logging < LHC::Interceptor
+
+  include ActiveSupport::Configurable
+  config_accessor :logger
+
+  def before_request
+    return unless logger
+    logger.info(
+      "Before LHC request<#{request.object_id}> #{request.method.upcase} #{request.url} at #{DateTime.now} Params=#{request.params} Headers=#{request.headers}"
+    )
+  end
+
+  def after_response
+    return unless logger
+    logger.info(
+      "After LHC response for request<#{request.object_id}> #{request.method.upcase} #{request.url} at #{DateTime.now} Time=#{response.time_ms}ms URL=#{response.effective_url}"
+    )
+  end
+end

data/lib/lhc/version.rb

@@ -1,3 +1,3 @@
 module LHC
-  VERSION ||= '9.1.2'
+  VERSION ||= '9.2.0'
 end

data/spec/interceptors/logging/main_spec.rb

@@ -0,0 +1,21 @@
+require 'rails_helper'
+
+describe LHC::Logging do
+  let(:logger) { spy('logger') }
+
+  before(:each) do
+    LHC.config.interceptors = [LHC::Logging]
+    LHC::Logging.logger = logger
+  end
+
+  it 'does log information before and after every request made with LHC' do
+    stub_request(:get, 'http://local.ch').to_return(status: 200)
+    LHC.get('http://local.ch')
+    expect(logger).to have_received(:info).once.with(
+      %r{Before LHC request<\d+> GET http://local.ch at \d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\+\d{2}:\d{2} Params={} Headers={.*?}}
+    )
+    expect(logger).to have_received(:info).once.with(
+      %r{After LHC response for request<\d+> GET http://local.ch at \d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\+\d{2}:\d{2} Time=0ms URL=http://local.ch:80/}
+    )
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lhc
 version: !ruby/object:Gem::Version
-  version: 9.1.2
+  version: 9.2.0
 platform: ruby
 authors:
 - https://github.com/local-ch/lhc/contributors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-26 00:00:00.000000000 Z
+date: 2018-05-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -195,6 +195,7 @@ files:
 - docs/interceptors/authentication.md
 - docs/interceptors/caching.md
 - docs/interceptors/default_timeout.md
+- docs/interceptors/logging.md
 - docs/interceptors/monitoring.md
 - docs/interceptors/prometheus.md
 - docs/interceptors/retry.md
@@ -222,6 +223,7 @@ files:
 - lib/lhc/interceptors/auth.rb
 - lib/lhc/interceptors/caching.rb
 - lib/lhc/interceptors/default_timeout.rb
+- lib/lhc/interceptors/logging.rb
 - lib/lhc/interceptors/monitoring.rb
 - lib/lhc/interceptors/prometheus.rb
 - lib/lhc/interceptors/retry.rb
@@ -313,6 +315,7 @@ files:
 - spec/interceptors/default_timeout/main_spec.rb
 - spec/interceptors/define_spec.rb
 - spec/interceptors/dup_spec.rb
+- spec/interceptors/logging/main_spec.rb
 - spec/interceptors/monitoring/main_spec.rb
 - spec/interceptors/prometheus_spec.rb
 - spec/interceptors/response_competition_spec.rb
@@ -369,7 +372,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements:
 - Ruby >= 2.0.0
 rubyforge_project: 
-rubygems_version: 2.6.14
+rubygems_version: 2.6.12
 signing_key: 
 specification_version: 4
 summary: LocalHttpClient
@@ -450,6 +453,7 @@ test_files:
 - spec/interceptors/default_timeout/main_spec.rb
 - spec/interceptors/define_spec.rb
 - spec/interceptors/dup_spec.rb
+- spec/interceptors/logging/main_spec.rb
 - spec/interceptors/monitoring/main_spec.rb
 - spec/interceptors/prometheus_spec.rb
 - spec/interceptors/response_competition_spec.rb