leafy-health 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 19b3d546b5202841ed7456d0e3558311f3d485d8
-  data.tar.gz: 2942aaf142b3c01f4ddaf1ffd07d2d011d5bbc4b
+  metadata.gz: feebb04febf01947d0cb9097fe2d2506c8043628
+  data.tar.gz: 7ae1c75cd9aef3e40c61110a84bd931fe77e96ba
 SHA512:
-  metadata.gz: 11fcc8168409f777ebfed83bc2286615e40b5e0b50223d7dfa992512b57a0ca8fabf41ee108afb1a93f46cd6fec17ce4c53c644157f8a864f21531ab80fea2af
-  data.tar.gz: dfbb26d6b09877fe02f6a3dacf56aec6d6008868b17e0cd936bab395663bd202274f3dd60449e8d9d474e9ee4d56a05fe8e36f27fe822ab888cb40ae1e62072e
+  metadata.gz: 8de968175a2fb17784430b6ff1f557e04c966c6bc5a30b0660d577dda7d0af68e256583e8653b8d3b3ccb1a45118b46732fcc51b550964b89c9f05390f46956b
+  data.tar.gz: 99b3f3a0673b6aafd1d0d9a05db5d362a81c798cd6cdd342cdc8125d7d2447b129e7810119c7a81862640eb1b8c32a6d7de4b0b061ac2f627d7dd15678e35f3d

data/README.md

@@ -8,7 +8,7 @@ gem install leafy-health
 ```
 or add to your Gemfile
 ```
-gem 'leqfy-health'
+gem 'leafy-health'
 ```
 
 installing the gem also takes care of the jar dependencies with jruby-1.7.16+
@@ -35,12 +35,12 @@ simple in the sense that either call returns ```nil``` which means healthy or a
 
 or with a health-check object
 
-    class AppCheck
+    class AppCheck < Leafy::Health::HealthCheck
       def call
         if app.crashed
           'application crashed'
         end
-      enf
+      end
     end
     registry.register( 'simple.class', AppCheck.new )
 
@@ -49,22 +49,45 @@ or with a health-check object
 here the call method gets an argument which allows to create both
 healthy and unhealthy states with message.
          
-    registry.register( 'app.block') do |health|
+    registry.register( 'app.block') do
       if app.crashed
-        health.unhealthy( 'application crashed' )
+        unhealthy( 'application crashed' )
       else
-        health.healthy( 'application ok' )
+        healthy( 'application ok' )
       end
     end
 
 or with a health-check object
 
-    class AppCheck
-      def call( health )
+    class AppCheck < Leafy::Health::HealthCheck
+      def call
         if app.crashed
-          health.unhealthy( 'application crashed' )
+          unhealthy( 'application crashed' )
         else
-          health.healthy( 'application ok' )
+          healthy( 'application ok' )
+        end
+      end
+    end
+    registry.register( 'app.class', AppCheck.new )
+
+### health checks with structural data as message
+
+    registry.register( 'app.block') do
+      if app.crashed
+        unhealthy( :host => 'localhost', :msg => 'not good' )
+      else
+        healthy( :host => 'localhost', :msg => 'application ok' )
+      end
+    end
+
+or as health-check object
+
+    class AppCheck < Leafy::Health::HealthCheck
+      def call
+        if app.crashed
+          unhealthy( :host => 'localhost', :msg => 'application crashed' )
+        else
+          healthy( :host => 'localhost', :msg => 'application ok' )
         end
       end
     end
@@ -74,6 +97,10 @@ or with a health-check object
 
     registry.unregister( 'app.class' )
 
+### builtin ThreadDeadlockHeathCheck
+
+    registry.register( 'app.deadlock', Leafy::Health::ThreadDeadlockHeathCheck.new )
+
 ### note
 
 currently there is not further introspection on the registry and its health-check. with the ```Leafy::Json::HealthWriter``` (from leafy-rack) you can get a json representation of the current **health report**

data/leafy-health.gemspec

@@ -12,10 +12,11 @@ Gem::Specification.new do |s|
   s.summary = %q(provides an API to register healthchecks)
   s.homepage = 'https://github.com/lookout/leafy'
   s.description = %q(provides an API to register healthchecks which uses dropwizrd-metrics-healthchecks)
-  
+
   s.files = `git ls-files`.split($/)
 
   s.requirements << 'jar io.dropwizard.metrics:metrics-healthchecks, 3.1.0'
+  s.requirements << 'jar io.dropwizard.metrics:metrics-jvm, 3.1.0'
 
   s.add_runtime_dependency 'jar-dependencies', '~> 0.1.8'
   s.add_development_dependency 'rspec', '~> 3.1.0'

data/lib/leafy/health/health_check.rb

@@ -0,0 +1,72 @@
+require 'leafy/health'
+
+# add json serialization definition
+class com.codahale.metrics.health.HealthCheck::Result
+
+  attr_writer :data
+
+  def to_json( *args )
+    { :healthy => healthy?, :message => @data || message }.to_json( *args )
+  end
+end
+
+module Leafy
+  module Health
+    ThreadDeadlockHealthCheck = com.codahale.metrics.health.jvm.ThreadDeadlockHealthCheck
+    class HealthCheck < com.codahale.metrics.health.HealthCheck
+
+      def initialize( &block )
+        @block = block if block
+      end
+
+      # create healthy result object with given message
+      #
+      # param [String] optional result message, can be nil
+      # return [com.codahale.metrics.health.HealthCheck::Result]
+      def healthy( result = nil )
+        if result.is_a? Hash
+          r = com.codahale.metrics.health.HealthCheck::Result.healthy( result.to_json )
+          r.data = result
+          r
+        else
+          com.codahale.metrics.health.HealthCheck::Result.healthy( result )
+        end
+      end
+
+      # create unhealthy result object with given message
+      #
+      # param [String] result message
+      # return [com.codahale.metrics.health.HealthCheck::Result]
+      def unhealthy( result )
+        if result.is_a? Hash
+          r = com.codahale.metrics.health.HealthCheck::Result.unhealthy( result.to_json )
+          r.data = result
+          r
+        else
+          com.codahale.metrics.health.HealthCheck::Result.unhealthy( result )
+        end
+      end
+
+      def check
+        case result = call
+        when String
+          unhealthy( result )
+        when NilClass
+          healthy
+        when com.codahale.metrics.health.HealthCheck::Result
+          result
+        else
+          raise 'wrong result type'
+        end
+      end
+
+      def call
+        if @block
+          instance_eval( &@block )
+        else
+          'health check "call" method not implemented'
+        end
+      end
+    end
+  end
+end

data/lib/leafy/health/registry.rb

@@ -1,43 +1,9 @@
 require 'leafy/health'
+require 'leafy/health/health_check'
 module Leafy
   module Health
     class Registry
 
-      class HealthCheck < com.codahale.metrics.health.HealthCheck
-
-        # create healthy result object with given message
-        #
-        # param [String] optional result message, can be nil
-        # return [com.codahale.metrics.health.HealthCheck::Result]
-        def healthy( result = nil )
-          com.codahale.metrics.health.HealthCheck::Result.healthy( result )
-        end
-
-        # create unhealthy result object with given message
-        #
-        # param [String] result message
-        # return [com.codahale.metrics.health.HealthCheck::Result]
-        def unhealthy( result )
-          com.codahale.metrics.health.HealthCheck::Result.unhealthy( result )
-        end
-
-        def initialize( block )
-          super()
-          @block = block
-        end
-    
-        def check
-          case result = @block.call( self )
-          when String
-            unhealthy( result )
-          when NilClass
-            healthy
-          else
-            result
-          end
-        end
-      end
-
       # state ofthe registry
       attr_reader :health
 
@@ -54,11 +20,10 @@ module Leafy
       # @yieldreturn [NilClass] if the healthcheck succeeds
       # @yieldreturn [com.codahale.metrics.health.HealthCheck::Result] if the check produces its own result object
       def register(name, check = nil, &block )
-        if check and not block_given? and check.respond_to? :call
-          @health.register( name, HealthCheck.new( check ) )
-          
+        if check and not block_given? and check.is_a? com.codahale.metrics.health.HealthCheck
+          @health.register( name, check )
         elsif check.nil? and block_given?
-          @health.register( name, HealthCheck.new( block ) )
+          @health.register( name, HealthCheck.new( &block ) )
         else
           raise 'needs either a block and object with call method'
         end

data/lib/leafy/health/version.rb

@@ -1,6 +1,6 @@
 module Leafy
   module Health
-    VERSION = '0.1.0'.freeze
+    VERSION = '0.2.0'.freeze
   end
 end
-    
+

data/lib/leafy-health_jars.rb

@@ -3,3 +3,5 @@ require 'jar_dependencies'
 
 require_jar( 'io.dropwizard.metrics', 'metrics-healthchecks', '3.1.0' )
 require_jar( 'org.slf4j', 'slf4j-api', '1.7.7' )
+require_jar( 'io.dropwizard.metrics', 'metrics-jvm', '3.1.0' )
+require_jar( 'io.dropwizard.metrics', 'metrics-core', '3.1.0' )

data/spec/registry_spec.rb

@@ -1,61 +1,162 @@
 require 'leafy/health'
+require 'json'
 
 describe Leafy::Health::Registry do
 
   subject { Leafy::Health::Registry.new }
 
+  it 'has thread-deadlock-health-check' do
+    subject.register( 'app', Leafy::Health::ThreadDeadlockHealthCheck.new )
+
+    expect(subject.names).to eq ['app']
+  end
+
   it 'registers and unregister check as block' do
     subject.register('me') do
       'error'
     end
     expect(subject.names).to eq ['me']
-    expect(subject.health.run_health_checks.keys).to eq ['me']
+
+    results = subject.health.run_health_checks
+    expect(results.keys).to eq ['me']
+
+    first = results.values.to_array.first
+    expect(first.message).to eq 'error'
+    expect(first.healthy?).to eq false
 
     subject.unregister('me')
     expect(subject.names).to be_empty
   end
 
-  it 'registers and unregister check as object with call method' do
-    subject.register('me', Proc.new {} )
+  it 'registers and unregister check as block using dsl' do
+    subject.register('me') do
+      healthy 'ok'
+    end
     expect(subject.names).to eq ['me']
-    expect(subject.health.run_health_checks.keys).to eq ['me']
+
+    results = subject.health.run_health_checks
+    expect(results.keys).to eq ['me']
+
+    first = results.values.to_array.first
+    expect(first.message).to eq 'ok'
+    expect(first.healthy?).to eq true
+
+    subject.unregister('me')
+    expect(subject.names).to be_empty
+  end
+
+  it 'registers and unregister check as HealthCheck with block' do
+    subject.register('me',  Leafy::Health::HealthCheck.new {} )
+
+    expect(subject.names).to eq ['me']
+
+    results = subject.health.run_health_checks
+    expect(results.keys).to eq ['me']
+
+    first = results.values.to_array.first
+    expect(first.message).to be_nil
+    expect(first.healthy?).to eq true
+
+    subject.unregister('me')
+    expect(subject.names).to be_empty
+  end
+
+  it 'registers and unregister check as HealthCheck without implementing call' do
+    subject.register('me',  Leafy::Health::HealthCheck.new )
+
+    expect(subject.names).to eq ['me']
+
+    results = subject.health.run_health_checks
+    expect(results.keys).to eq ['me']
+
+    first = results.values.to_array.first
+    expect(first.message).to eq 'health check "call" method not implemented'
+    expect(first.healthy?).to eq false
     
     subject.unregister('me')
     expect(subject.names).to be_empty
   end
 
-  it 'fails register check as object without call method' do
+  it 'fails register check as wrong object' do
     expect { subject.register('me', Object.new ) }.to raise_error
   end
 
-  describe Leafy::Health::Registry::HealthCheck do
+  describe Leafy::Health::HealthCheck do
 
-    it 'is healthy with simple block' do
-      check = Leafy::Health::Registry::HealthCheck.new( Proc.new { nil } )
+    it 'is healthy default with simple block' do
+      check = Leafy::Health::HealthCheck.new do
+        nil
+      end
       expect( check.check.healthy? ).to be true
       expect( check.check.message ).to be nil
+      expect( check.check.to_json ).to eq "{\"healthy\":true,\"message\":null}"
     end
 
-    it 'is healthy' do
-      checker = Proc.new do |health|
-        health.healthy( 'ok' )
+    it 'is healthy with simple block' do
+      check = Leafy::Health::HealthCheck.new do
+        healthy 'happy'
+      end
+      expect( check.check.healthy? ).to be true
+      expect( check.check.message ).to eq 'happy'
+      expect( check.check.to_json ).to eq "{\"healthy\":true,\"message\":\"happy\"}"
+    end
+
+    it 'is healthy with structural message' do
+      check = Leafy::Health::HealthCheck.new do
+        healthy :msg => 'happy', :date => '11-11-2011'
       end
-      check = Leafy::Health::Registry::HealthCheck.new( checker )
+      expect( check.check.healthy? ).to be true
+      expect( check.check.to_json ).to eq "{\"healthy\":true,\"message\":{\"msg\":\"happy\",\"date\":\"11-11-2011\"}}"
+    end
+
+    it 'is healthy default' do
+      check = Leafy::Health::HealthCheck.new
+      def check.call; nil; end
+      expect( check.check.healthy? ).to be true
+      expect( check.check.message ).to eq nil
+    end
+
+    it 'is healthy' do
+      check = Leafy::Health::HealthCheck.new
+      def check.call; healthy( 'ok' ); end
       expect( check.check.healthy? ).to be true
       expect( check.check.message ).to eq 'ok'
     end
 
-    it 'is unhealthy with simple block' do
-      check = Leafy::Health::Registry::HealthCheck.new( Proc.new { 'sick' } )
+    it 'is unhealthy default with simple block' do
+      check = Leafy::Health::HealthCheck.new do
+        'sick'
+      end
       expect( check.check.healthy? ).to be false
       expect( check.check.message ).to eq 'sick'
     end
 
-    it 'is unhealthy' do
-      checker = Proc.new do |health|
-        health.unhealthy( 'not ok' )
+    it 'is unhealthy with simple block' do
+      check = Leafy::Health::HealthCheck.new do
+        unhealthy 'really sick'
       end
-      check = Leafy::Health::Registry::HealthCheck.new( checker )
+      expect( check.check.healthy? ).to be false
+      expect( check.check.message ).to eq 'really sick'
+    end
+
+    it 'is unhealthy with structural message' do
+      check = Leafy::Health::HealthCheck.new do
+        unhealthy :msg => 'oh je', :date => '11-11-2011'
+      end
+      expect( check.check.healthy? ).to be false
+      expect( check.check.to_json ).to eq "{\"healthy\":false,\"message\":{\"msg\":\"oh je\",\"date\":\"11-11-2011\"}}"
+    end
+
+    it 'is unhealthy default' do
+      check = Leafy::Health::HealthCheck.new
+      def check.call; 'not ok'; end
+      expect( check.check.healthy? ).to be false
+      expect( check.check.message ).to eq 'not ok'
+    end
+
+    it 'is unhealthy' do
+      check = Leafy::Health::HealthCheck.new
+      def check.call; unhealthy( 'not ok' ); end
       expect( check.check.healthy? ).to be false
       expect( check.check.message ).to eq 'not ok'
     end

metadata

@@ -1,69 +1,69 @@
 --- !ruby/object:Gem::Specification
 name: leafy-health
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - christian meier
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2015-02-19 00:00:00.000000000 Z
+date: 2015-03-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: jar-dependencies
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 0.1.8
-  type: :runtime
+  name: jar-dependencies
   prerelease: false
+  type: :runtime
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 0.1.8
 - !ruby/object:Gem::Dependency
-  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 3.1.0
-  type: :development
+  name: rspec
   prerelease: false
+  type: :development
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 3.1.0
 - !ruby/object:Gem::Dependency
-  name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 0.8.7
-  type: :development
+  name: yard
   prerelease: false
+  type: :development
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 0.8.7
 - !ruby/object:Gem::Dependency
-  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '10.2'
-  type: :development
+  name: rake
   prerelease: false
+  type: :development
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '10.2'
 description: provides an API to register healthchecks which uses dropwizrd-metrics-healthchecks
@@ -73,7 +73,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
+- .gitignore
 - Gemfile
 - LICENSE
 - README.md
@@ -82,6 +82,7 @@ files:
 - lib/leafy-health.rb
 - lib/leafy-health_jars.rb
 - lib/leafy/health.rb
+- lib/leafy/health/health_check.rb
 - lib/leafy/health/registry.rb
 - lib/leafy/health/version.rb
 - spec/registry_spec.rb
@@ -90,25 +91,27 @@ homepage: https://github.com/lookout/leafy
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements:
 - jar io.dropwizard.metrics:metrics-healthchecks, 3.1.0
-rubyforge_project: 
+- jar io.dropwizard.metrics:metrics-jvm, 3.1.0
+rubyforge_project:
 rubygems_version: 2.4.5
-signing_key: 
+signing_key:
 specification_version: 4
 summary: provides an API to register healthchecks
 test_files: []
+has_rdoc: