leafy-rack 0.4.0-java → 0.5.0-java

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d1239867bb5be43b57a52dcce8f281d146b9edf1
-  data.tar.gz: 51137ff0563f9a8e922f4af160253f9b34a9c66c
+  metadata.gz: 9327f7232dde3bad14695b18b3859ad0410378fe
+  data.tar.gz: 7b922a92a4ff45b0a6b43d70042c2f5bc315307d
 SHA512:
-  metadata.gz: 90e49272d516440d2208bfd84d922d94fbfe0eb948c0e76ba228e104a1e21e2314f802e68ee9e26a4df0121eee008c02a5389ce1eadd4bcce207a547f90f13e1
-  data.tar.gz: 669522fc78cea7d8bee811485e82b15b8ca288f65d3ea8791dd9b3cf6cb198473e221780e147bf06cb719a94f95adb0324272031f626c73eaaab06a6c874d7bf
+  metadata.gz: ef7e3b693a75420b6a9fa18c02b287dc9c4d660bb6b9cc3d9f361b1b12d30b48ff7bf826451faf019faa93122e90c3c3fee0c225934b1293822229ef55ef2924
+  data.tar.gz: d2721c20256b0fe0f48b8a72eb05fb017dcee70519e31db9a8e0e636e941762d0e1b20322c5c1c924a2aab8086c078009493e7f0a281c0a4f5da534e5a4fc22e

data/Gemfile

@@ -4,6 +4,7 @@ source 'https://rubygems.org'
 
 gem 'leafy-metrics', :path => '../leafy-metrics'
 gem 'leafy-health', :path => '../leafy-health'
+gem 'leafy-logger', :path => '../leafy-logger'
 
 gemspec
 

data/README.md

@@ -96,6 +96,40 @@ or with custom path
     health = Leafy::Health::Registry.new
     use Leafy::Rack::Health, health, '/admin/health'
 
+the json response looks like
+
+    {
+      "deadlock": {
+        "healthy": true,
+        "message": null
+      },
+      "elasticsearch": {
+        "healthy": false,
+        "message": 'error'
+      }
+    }
+
+if you want to add host info to your health report you can do so by adding the respective data to the middleware
+
+    Leafy::Rack::Health.hostinfo[ 'version' ] = '1.0'
+    Leafy::Rack::Health.hostinfo[ 'env' ] = 'staging'
+
+then the json response has slightly different structure
+
+     {
+       "host": {
+         "version": "",
+         "hostname": "localhost",
+         "env": "boot",
+       },
+       "checks": {
+          "deadlock": {
+            "healthy": true,
+            "message": null
+          }
+        }
+      }
+
 ### ping middleware
 
 under the path **/ping**

data/leafy-rack.gemspec

@@ -22,6 +22,7 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency 'jar-dependencies', '~> 0.1.8'
   s.add_runtime_dependency 'leafy-metrics', "~> #{Leafy::Rack::VERSION}"
   s.add_runtime_dependency 'leafy-health',  "~> #{Leafy::Rack::VERSION}"
+  s.add_runtime_dependency 'leafy-logger', "~> #{Leafy::Rack::VERSION}"
   s.add_development_dependency 'rspec', '~> 3.1'
   s.add_development_dependency 'yard', '~> 0.8.7'
   s.add_development_dependency 'rake', '~> 10.2'

data/lib/leafy/rack/health.rb

@@ -6,9 +6,18 @@ module Leafy
   module Rack
     class Health
 
+      def self.hostinfo
+        @info ||= {}
+      end
+
       def self.response( health, env )
-        data = health.run_health_checks
-        is_healthy = data.values.all? { |r| r.healthy? }
+        checks = health.run_health_checks
+        if @info
+          data = { 'host' => @info, 'checks' => checks.to_hash }
+        else
+          data = checks
+        end
+        is_healthy = checks.values.all? { |r| r.healthy? }
         json = if env[ 'QUERY_STRING' ] == 'pretty'
                  JSON.pretty_generate( data.to_hash )
                else

data/lib/leafy/rack/logger.rb

@@ -0,0 +1,20 @@
+require 'leafy/logger/factory'
+
+module Leafy
+  module Rack
+    # Sets our Leafy logger as the rack logger to be used by other middleware / frameworks down
+    # the line. If you want your middleware to use this logger, we require that this runs first.
+    class Logger
+
+      def initialize(app, logger_name)
+        @app = app
+        @logger = Leafy::Logger::Factory.get_logger(logger_name)
+      end
+
+      def call(env)
+        env['rack.logger'] = @logger
+        @app.call(env)
+      end
+    end
+  end
+end

data/lib/leafy/rack/version.rb

@@ -1,6 +1,6 @@
 module Leafy
   module Rack
-    VERSION = '0.4.0'.freeze
+    VERSION = '0.5.0'.freeze
   end
 end
 

data/spec/collected_instrumented_spec.rb

@@ -26,7 +26,7 @@ describe Leafy::Instrumented::CollectedInstrumented do
       expected[ index ] = 1
       expect( stati ).to eq expected
 
-      expect( registry.metrics.meters.values.to_a[ index ].mean_rate ).to be > 50
+      expect( registry.metrics.meters.values.to_a[ index ].mean_rate ).to be > 30
     end
   end
 end

data/spec/health_rack_spec.rb

@@ -32,6 +32,11 @@ describe Leafy::Rack::Health do
     let( :report ) do
       { 'two' => { 'healthy' => true, 'message' => 'ok' } }
     end
+    let( :report_with_info ) do
+      { 'host' => { 'version' => '1.2.3' },
+        'checks' => report }
+    end
+    after { subject.instance_variable_set( :@info, nil ) }
 
     it 'has response' do
       status, headers, body = subject.response( health, {} )
@@ -41,6 +46,15 @@ describe Leafy::Rack::Health do
       expect( body.to_yaml ).to eq report.to_yaml
     end
 
+    it 'has response with hostinfo' do
+      subject.hostinfo[ 'version' ] = '1.2.3'
+      status, headers, body = subject.response( health, {} )
+      expect( status ).to eq 200
+      expect( headers.to_yaml).to eq expected_headers.to_yaml
+      body = JSON.parse( body.join )
+      expect( body.to_yaml ).to eq report_with_info.to_yaml
+    end
+
     it 'has pretty response' do
       status, headers, body = subject.response( health, { 'QUERY_STRING' => 'pretty' } )
       expect( status ).to eq 200
@@ -49,6 +63,16 @@ describe Leafy::Rack::Health do
       body = JSON.parse( body.join )
       expect( body.to_yaml ).to eq report.to_yaml
     end
+    
+    it 'has pretty response with hostinfo' do
+      subject.hostinfo[ 'version' ] = '1.2.3'
+      status, headers, body = subject.response( health, { 'QUERY_STRING' => 'pretty' } )
+      expect( status ).to eq 200
+      expect( headers.to_yaml).to eq expected_headers.to_yaml
+      expect( body.join.count( "\n" ) ).to eq 10
+      body = JSON.parse( body.join )
+      expect( body.to_yaml ).to eq report_with_info.to_yaml
+    end
   end
 
   describe 'unhealthy' do

data/spec/logger_rack_spec.rb

@@ -0,0 +1,20 @@
+require_relative 'setup'
+require 'leafy/rack/logger'
+require 'logger'
+
+describe Leafy::Rack::Logger do
+  let(:logger) { instance_double(::Logger) }
+  let(:logger_name) { 'some logger' }
+  let(:app) { double(call: nil) }
+  subject(:middleware) { described_class.new(app, logger_name) }
+
+  before { allow(Leafy::Logger::Factory).to receive(:get_logger).and_return(logger) }
+
+  describe '#call' do
+    let(:env) { { } }
+    it 'should set the logger' do
+      middleware.call(env)
+      expect(env['rack.logger']).to eq logger
+    end
+  end
+end

data/spec/metrics_writer_spec.rb

@@ -21,17 +21,17 @@ describe Leafy::Json::MetricsWriter do
 
   let( :expected ) do
     {
-      "two"=> {"count"=>1,
-        "m15_rate"=>0.0,
-        "m1_rate"=>0.0,
-        "m5_rate"=>0.0,
-        "units"=>"events/second"}, 
       "one"=> {"count"=>1, 
         "m15_rate"=>0.0, 
         "m1_rate"=>0.0, 
         "m5_rate"=>0.0, 
         "units"=>"events/second"}, 
-      "three"=>{"count"=>2}
+      "three"=>{"count"=>2}, 
+      "two"=> {"count"=>1,
+        "m15_rate"=>0.0,
+        "m1_rate"=>0.0,
+        "m5_rate"=>0.0,
+        "units"=>"events/second"}
     }
   end
 
@@ -41,7 +41,7 @@ describe Leafy::Json::MetricsWriter do
     data = JSON.parse( data )
     expect( data['one'].delete('mean_rate') ).to be >0
     expect( data['two'].delete('mean_rate') ).to be >0
-    expect( data.to_yaml ).to eq expected.to_yaml
+    expect( Hash[data.sort_by{|k,v| k }].to_yaml ).to eq expected.to_yaml
   end
 
   it 'serializes metrics data to json (pretty print)' do
@@ -50,6 +50,6 @@ describe Leafy::Json::MetricsWriter do
     data = JSON.parse( data )
     expect( data['one'].delete('mean_rate') ).to be >0
     expect( data['two'].delete('mean_rate') ).to be >0
-    expect( data.to_yaml ).to eq expected.to_yaml
+    expect( Hash[data.sort_by{|k,v| k }].to_yaml ).to eq expected.to_yaml
   end
 end

metadata

@@ -1,99 +1,113 @@
 --- !ruby/object:Gem::Specification
 name: leafy-rack
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: java
 authors:
 - christian meier
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2015-04-21 00:00:00.000000000 Z
+date: 2015-05-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
+  name: jar-dependencies
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.1.8
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: 0.1.8
-  name: jar-dependencies
   prerelease: false
   type: :runtime
+- !ruby/object:Gem::Dependency
+  name: leafy-metrics
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.1.8
-- !ruby/object:Gem::Dependency
+        version: 0.5.0
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.4.0
-  name: leafy-metrics
+        version: 0.5.0
   prerelease: false
   type: :runtime
+- !ruby/object:Gem::Dependency
+  name: leafy-health
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.4.0
-- !ruby/object:Gem::Dependency
+        version: 0.5.0
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.4.0
-  name: leafy-health
+        version: 0.5.0
   prerelease: false
   type: :runtime
+- !ruby/object:Gem::Dependency
+  name: leafy-logger
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.4.0
-- !ruby/object:Gem::Dependency
+        version: 0.5.0
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '3.1'
-  name: rspec
+        version: 0.5.0
   prerelease: false
-  type: :development
+  type: :runtime
+- !ruby/object:Gem::Dependency
+  name: rspec
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '3.1'
-- !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.8.7
-  name: yard
+        version: '3.1'
   prerelease: false
   type: :development
+- !ruby/object:Gem::Dependency
+  name: yard
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: 0.8.7
-- !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '10.2'
-  name: rake
+        version: 0.8.7
   prerelease: false
   type: :development
+- !ruby/object:Gem::Dependency
+  name: rake
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '10.2'
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.2'
+  prerelease: false
+  type: :development
 description: rack middleware to expose leafy metrics/health data as well a ping rack and a thread-dump rack
 email:
 - christian.meier@lookout.com
@@ -119,6 +133,7 @@ files:
 - lib/leafy/rack/admin.rb
 - lib/leafy/rack/health.rb
 - lib/leafy/rack/instrumented.rb
+- lib/leafy/rack/logger.rb
 - lib/leafy/rack/metrics.rb
 - lib/leafy/rack/ping.rb
 - lib/leafy/rack/thread_dump.rb
@@ -130,6 +145,7 @@ files:
 - spec/health_writer_spec.rb
 - spec/instrumented_rack_spec.rb
 - spec/instrumented_spec.rb
+- spec/logger_rack_spec.rb
 - spec/metrics_rack_spec.rb
 - spec/metrics_writer_spec.rb
 - spec/ping_rack_spec.rb