leafy-health 0.4.0-java

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cdc45ec69142d34dfae94a796e5a0ef9eddb4ff5
+  data.tar.gz: dba5e44c0c2174009e152ab2ba865b829f2f0774
+SHA512:
+  metadata.gz: e81fc0e1c3ca060adfc4544e94e153e8c665a6fa250667f117537317fef8f62eb4fe57586289e824000f33894787969e3cd5530a8cc35511a7db2d1f336e183a
+  data.tar.gz: e32d2286f628db6fad6e7201ad79d7e75c2e6e34f667cfc3037abf6bba3723458b29a64833f35085e7690c408595b4d7f3e22818fef274341942027a3117e12f

data/.gitignore

@@ -0,0 +1,4 @@
+.yardoc
+doc
+pkg
+*.lock

data/Gemfile

@@ -0,0 +1,7 @@
+#-*- mode: ruby -*-
+
+source 'https://rubygems.org'
+
+gemspec
+
+# vim: syntax=Ruby

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Lookout
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+

data/README.md

@@ -0,0 +1,123 @@
+# Leafy-Health
+
+## installation
+
+via rubygems
+```
+gem install leafy-health
+```
+or add to your Gemfile
+```
+gem 'leafy-health'
+```
+
+installing the gem also takes care of the jar dependencies with jruby-1.7.16+
+
+## usage
+
+an instance of the registry ```Leafy::Health::Registry``` can register and unresgister health-checks under a given name. any object with a #call method will do or block on the register method.
+
+     registry = Leafy::Health::Registry.new
+
+you can ask the registry which names have already health-checks registered:
+
+     registry.names
+
+### simple health check
+
+simple in the sense that either call returns ```nil``` which means healthy or a message which is the unhealthy state. the message can be any ```String```.
+     
+    registry.register( 'simple.block') do
+      if app.crashed
+        'application crashed'
+      end
+    end
+
+or with a health-check object
+
+    class AppCheck < Leafy::Health::HealthCheck
+      def call
+        if app.crashed
+          'application crashed'
+        end
+      end
+    end
+    registry.register( 'simple.class', AppCheck.new )
+
+### health checks with message on healthy state
+
+here the call method gets an argument which allows to create both
+healthy and unhealthy states with message.
+         
+    registry.register( 'app.block') do
+      if app.crashed
+        unhealthy( 'application crashed' )
+      else
+        healthy( 'application ok' )
+      end
+    end
+
+or with a health-check object
+
+    class AppCheck < Leafy::Health::HealthCheck
+      def call
+        if app.crashed
+          unhealthy( 'application crashed' )
+        else
+          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
+    registry.register( 'app.class', AppCheck.new )
+
+### unregister health checks
+
+    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**
+
+    Leafy::Json::HealthWriter.to_json( registry.health )
+
+## developement
+
+get all the gems and jars in place
+
+    gem install jar-dependencies --development
+	bundle install
+
+for running all specs
+
+	rake
+
+or
+
+    rspec spec/reporter_spec.rb

data/Rakefile

@@ -0,0 +1,14 @@
+#-*- mode: ruby -*-
+
+require "rspec/core/rake_task"
+RSpec::Core::RakeTask.new
+
+require "yard"
+YARD::Rake::YardocTask.new do |t|
+  t.files   = ['lib/**/*.rb']
+  t.options += ["--title", "Leafy Health API"]
+end
+
+task :default => [ :spec ]
+
+# vim: syntax=Ruby

data/leafy-health.gemspec

@@ -0,0 +1,28 @@
+#-*- mode: ruby -*-
+
+require File.expand_path( '../lib/leafy/health/version', __FILE__ )
+
+Gem::Specification.new do |s|
+  s.name = 'leafy-health'
+  s.version = Leafy::Health::VERSION
+  s.author = 'christian meier'
+  s.email = [ 'christian.meier@lookout.com' ]
+
+  s.platform = 'java'
+  s.license = 'MIT'
+  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'
+  s.add_development_dependency 'yard', '~> 0.8.7'
+  s.add_development_dependency 'rake', '~> 10.2'
+end
+
+# vim: syntax=Ruby

data/lib/leafy-health.rb

@@ -0,0 +1,2 @@
+require 'leafy-health_jars'
+require 'leafy/health/registry'

data/lib/leafy-health_jars.rb

@@ -0,0 +1,7 @@
+# this is a generated file, to avoid over-writing it just delete this comment
+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/lib/leafy/health.rb

@@ -0,0 +1,2 @@
+require 'leafy-health_jars'
+require 'leafy/health/registry'

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

@@ -0,0 +1,55 @@
+require 'leafy/health'
+require 'leafy/health/health_check'
+module Leafy
+  module Health
+    class Registry
+
+      # state ofthe registry
+      attr_reader :health
+
+      def initialize
+        @health = com.codahale.metrics.health.HealthCheckRegistry.new
+      end
+
+      # register a HealthCheck under a given name
+      # 
+      # @param [String] name
+      # @param [String] instead of block any check object which responds to 'call'
+      # @yieldparam [HealthCheckRegistry::HealthCheck] which has convienient methods to create healthy and unhealthy results with message
+      # @yieldreturn [String] if the healthcheck fails return the message
+      # @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.is_a? com.codahale.metrics.health.HealthCheck
+          @health.register( name, check )
+        elsif check.nil? and block_given?
+          @health.register( name, HealthCheck.new( &block ) )
+        else
+          raise 'needs either a block and object with call method'
+        end
+      end
+ 
+      # unregister a HealthCheck for a given name
+      # 
+      # @param [String] name
+      def unregister(name)
+        @health.unregister(name)
+      end
+
+      # the names of all registered HealthCheck
+      # 
+      # @return [Array<String>] names of HealthCheck in order of their registration
+      def names
+        @health.names.to_a
+      end
+
+      # # run a healthcheck for a given name
+      # # 
+      # # @param [String] name
+      # # @return [Java::ComCodahaleMetricsHealth::HealthCheck::Result] result of the health-check
+      # def run_health_check(name) 
+      #   @health.runHealthCheck(name)
+      # end
+    end
+  end
+end

data/lib/leafy/health/version.rb

@@ -0,0 +1,6 @@
+module Leafy
+  module Health
+    VERSION = '0.4.0'.freeze
+  end
+end
+

data/spec/registry_spec.rb

@@ -0,0 +1,164 @@
+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']
+
+    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 block using dsl' do
+    subject.register('me') do
+      healthy 'ok'
+    end
+    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 '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 wrong object' do
+    expect { subject.register('me', Object.new ) }.to raise_error
+  end
+
+  describe Leafy::Health::HealthCheck do
+
+    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 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
+      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 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 with simple block' do
+      check = Leafy::Health::HealthCheck.new do
+        unhealthy 'really sick'
+      end
+      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
+  end
+end

data/spec/setup.rb

@@ -0,0 +1 @@
+$LOAD_PATH.unshift File.expand_path( '../../lib', __FILE__ )

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: leafy-health
+version: !ruby/object:Gem::Version
+  version: 0.4.0
+platform: java
+authors:
+- christian meier
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2015-04-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.1.8
+  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
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  name: rspec
+  prerelease: false
+  type: :development
+  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
+  prerelease: false
+  type: :development
+  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
+  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
+email:
+- christian.meier@lookout.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- leafy-health.gemspec
+- 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
+- spec/setup.rb
+homepage: https://github.com/lookout/leafy
+licenses:
+- MIT
+metadata: {}
+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
+- jar io.dropwizard.metrics:metrics-jvm, 3.1.0
+rubyforge_project:
+rubygems_version: 2.4.5
+signing_key:
+specification_version: 4
+summary: provides an API to register healthchecks
+test_files: []
+has_rdoc: