leafy-health 0.3.0 → 0.3.1

data/leafy-rack/lib/leafy-rack.rb

@@ -0,0 +1 @@
+require 'leafy/rack'

data/leafy-rack/lib/leafy-rack_jars.rb

@@ -0,0 +1,10 @@
+# this is a generated file, to avoid over-writing it just delete this comment
+require 'jar_dependencies'
+
+require_jar( 'com.fasterxml.jackson.core', 'jackson-annotations', '2.4.0' )
+require_jar( 'com.fasterxml.jackson.core', 'jackson-core', '2.4.2' )
+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' )
+require_jar( 'com.fasterxml.jackson.core', 'jackson-databind', '2.4.2' )
+require_jar( 'io.dropwizard.metrics', 'metrics-json', '3.1.0' )

data/leafy-rack/lib/leafy/instrumented/basic_instrumented.rb

@@ -0,0 +1,38 @@
+module Leafy
+  module Instrumented
+    class BasicInstrumented
+
+      NAME_PREFIX = "responseCodes"
+
+      def initialize( registry, name, meter_names_by_status_code = {} )
+        @meters_by_status_code = java.util.concurrent.ConcurrentHashMap.new
+        meter_names_by_status_code.each do |k,v|
+          @meters_by_status_code[ k ] = registry.register_meter( "#{name}.#{v}" )
+        end
+        @other = registry.register_meter( "#{name}.#{NAME_PREFIX}.other" )
+        @active = registry.register_counter( "#{name}.active_requests" )
+        @timer = registry.register_timer( "#{name}.requests" )
+      end
+
+      def call( &block )
+        raise "block needed" unless block_given?
+        @active.inc
+
+        @timer.time do
+
+          result = block.call
+          mark_meter_for_status_code result[0]
+          result
+
+        end
+      ensure
+        @active.dec
+      end
+
+      def mark_meter_for_status_code( status )
+        metric = @meters_by_status_code[ status ] || @other
+        metric.mark
+      end
+    end
+  end
+end

data/leafy-rack/lib/leafy/instrumented/instrumented.rb

@@ -0,0 +1,27 @@
+require 'leafy/instrumented/basic_instrumented'
+
+module Leafy
+  module Instrumented
+    class Instrumented < BasicInstrumented
+
+      OK = 200;
+      CREATED = 201;
+      NO_CONTENT = 204;
+      RESET_CONTENT = 205;
+      BAD_REQUEST = 400;
+      NOT_FOUND = 404;
+      SERVER_ERROR = 500;
+
+      def initialize( registry, name )
+        super( registry, name,
+               { OK => "#{NAME_PREFIX}.ok",
+                 CREATED => "#{NAME_PREFIX}.created",
+                 NO_CONTENT => "#{NAME_PREFIX}.noContent",
+                 RESET_CONTENT => "#{NAME_PREFIX}.resetContent",
+                 BAD_REQUEST => "#{NAME_PREFIX}.badRequest",
+                 NOT_FOUND => "#{NAME_PREFIX}.notFound",
+                 SERVER_ERROR => "#{NAME_PREFIX}.serverError" } )
+      end
+    end
+  end
+end

data/leafy-rack/lib/leafy/json/health_writer.rb

@@ -0,0 +1,15 @@
+require 'leafy/health'
+require 'leafy/json/json_writer'
+
+java_import com.codahale.metrics.json.HealthCheckModule
+
+module Leafy
+  module Json
+    class HealthWriter < JsonWriter
+
+      def initialize
+        super( HealthCheckModule.new )
+      end
+    end
+  end
+end

data/leafy-rack/lib/leafy/json/json_writer.rb

@@ -0,0 +1,33 @@
+java_import com.fasterxml.jackson.databind.ObjectMapper
+
+module Leafy
+  module Json
+    class JsonWriter
+
+      def initialize( jacksonModule )
+        @mapper = ObjectMapper.new.registerModule( jacksonModule )
+      end
+
+      def data
+        raise 'need implementation'
+      end
+
+      def to_json( data, pretty = false )
+        # TODO make this stream
+        output = java.io.ByteArrayOutputStream.new
+        writer( pretty ).writeValue(output, data);
+        output.to_s
+      end
+  
+      private
+  
+      def writer( pretty )
+        if pretty
+          @mapper.writerWithDefaultPrettyPrinter
+        else
+          @mapper.writer
+        end
+      end
+    end
+  end
+end

data/leafy-rack/lib/leafy/json/metrics_writer.rb

@@ -0,0 +1,22 @@
+require 'leafy/metrics'
+require 'leafy/json/json_writer'
+
+java_import com.codahale.metrics.MetricFilter
+java_import com.codahale.metrics.json.MetricsModule
+
+java_import java.util.concurrent.TimeUnit
+
+module Leafy
+  module Json
+    class MetricsWriter < JsonWriter
+
+      def initialize
+        super( # make this configurable
+              MetricsModule.new(TimeUnit::SECONDS,
+                                TimeUnit::SECONDS,
+                                true,
+                                MetricFilter::ALL) )
+      end
+    end
+  end
+end

data/leafy-rack/lib/leafy/rack.rb

@@ -0,0 +1 @@
+require 'leafy-rack_jars'

data/leafy-rack/lib/leafy/rack/admin.rb

@@ -0,0 +1,73 @@
+require 'leafy/rack/metrics'
+require 'leafy/rack/health'
+require 'leafy/rack/ping'
+require 'leafy/rack/thread_dump'
+
+module Leafy
+  module Rack
+    class Admin
+      
+      def self.response( path )
+        path = path.sub( /^\//, '' )
+        [  
+         200, 
+         { 'Content-Type' => 'text/html' }, 
+         [ <<EOF
+<DOCTYPE html>
+<html>
+  <head>
+    <title>metrics</title>
+  </head>
+  <body>
+    <h1>menu</h1>
+    <ul>
+      <li><a href='#{path}/metrics'>metrics</a> (<a href='#{path}/metrics?pretty'>pretty</a>)</li>
+      <li><a href='#{path}/health'>health</a> (<a href='#{path}/health?pretty'>pretty</a>)</li>
+      <li><a href='#{path}/ping'>ping</a></li>
+      <li><a href='#{path}/threads'>thread-dump</a></li>
+    </ul>
+  </body>
+</html>  
+EOF
+         ]
+        ]
+      end
+
+      def initialize(app, metrics_registry, health_registry, path = '/admin')
+        @app = app
+        @path = path
+        @metrics = metrics_registry
+        @health = health_registry
+      end
+
+      def call(env)
+        if ( path = env['PATH_INFO'] ).start_with? @path
+          dispatch( path.sub( /#{@path}/, ''), env )
+        else
+          @app.call( env )
+        end
+      end
+
+      private
+
+      def dispatch( path, env )
+        case path
+        when '/metrics'
+          Metrics.response( @metrics.metrics, env )
+        when '/health'
+          Health.response( @health.health, env )
+        when '/ping'
+          Ping.response
+        when '/threads'
+          ThreadDump.response
+        when '/'
+          Admin.response( @path )
+        when ''
+          Admin.response( @path )
+        else # let the app deal with "not found"
+          @app.call( env )
+        end
+      end
+    end
+  end
+end

data/leafy-rack/lib/leafy/rack/health.rb

@@ -0,0 +1,43 @@
+require 'leafy/rack'
+require 'leafy/json/health_writer'
+require 'json' unless defined? :JSON
+
+module Leafy
+  module Rack
+    class Health
+
+      def self.response( health, env )
+        data = health.run_health_checks
+        is_healthy = data.values.all? { |r| r.healthy? }
+        json = if env[ 'QUERY_STRING' ] == 'pretty'
+                 JSON.pretty_generate( data.to_hash )
+               else
+                 # to use data.to_hash.to_json did produce
+                 # a different json structure on some
+                 # rack setup
+                 JSON.generate( data.to_hash )
+               end
+        [
+         is_healthy ? 200 : 503, 
+         { 'Content-Type' => 'application/json',
+           'Cache-Control' => 'must-revalidate,no-cache,no-store' }, 
+         [ json ]
+        ]
+      end
+
+      def initialize(app, registry, path = '/health')
+        @app = app
+        @path = path
+        @registry = registry
+      end
+      
+      def call(env)
+        if env['PATH_INFO'] == @path
+          Health.response( @registry.health, env )
+        else
+          @app.call( env )
+        end
+      end
+    end
+  end
+end

data/leafy-rack/lib/leafy/rack/instrumented.rb

@@ -0,0 +1,20 @@
+require 'leafy/rack'
+require 'leafy/instrumented/instrumented'
+
+module Leafy
+  module Rack
+    class Instrumented
+      
+      def initialize( app, instrumented )
+        @app = app
+        @instrumented = instrumented
+      end
+      
+      def call( env )
+        @instrumented.call do
+          @app.call env
+        end
+      end      
+    end
+  end
+end

data/leafy-rack/lib/leafy/rack/metrics.rb

@@ -0,0 +1,35 @@
+require 'leafy/rack'
+require 'leafy/metrics'
+require 'leafy/json/metrics_writer'
+module Leafy
+  module Rack
+
+    class Metrics
+
+      WRITER = ::Leafy::Json::MetricsWriter.new
+
+      def self.response( metrics, env )
+        [ 
+         200, 
+         { 'Content-Type' => 'application/json',
+           'Cache-Control' => 'must-revalidate,no-cache,no-store' }, 
+         [ WRITER.to_json( metrics, env[ 'QUERY_STRING' ] == 'pretty' ) ]
+        ]
+      end
+
+      def initialize(app, registry, path = '/metrics')
+        @app = app
+        @path = path
+        @registry = registry
+      end
+      
+      def call(env)
+        if env['PATH_INFO'] == @path
+          Metrics.response( @registry.metrics, env )
+        else
+          @app.call( env )
+        end
+      end
+    end
+  end
+end

data/leafy-rack/lib/leafy/rack/ping.rb

@@ -0,0 +1,29 @@
+require 'leafy/rack'
+module Leafy
+  module Rack
+    class Ping
+      
+      def self.response
+        [ 
+         200, 
+         { 'Content-Type' => 'text/plain',
+           'Cache-Control' => 'must-revalidate,no-cache,no-store' }, 
+         [ 'pong' ]
+        ]
+      end
+
+      def initialize(app, path = '/ping')
+        @app = app
+        @path = path
+      end
+
+      def call(env)
+        if env['PATH_INFO'] == @path
+          Ping.response
+        else
+          @app.call( env )
+        end
+      end
+    end
+  end
+end

data/leafy-rack/lib/leafy/rack/thread_dump.rb

@@ -0,0 +1,56 @@
+require 'leafy/rack'
+
+java_import java.lang.management.ManagementFactory
+
+module Leafy
+ module Rack
+   class ThreadDumpWriter
+
+      def initialize
+        begin
+          # Some PaaS like Google App Engine blacklist java.lang.managament
+          @threads = com.codahale.metrics.jvm.ThreadDump.new(ManagementFactory.getThreadMXBean());
+        rescue LoadError
+          # we won't be able to provide thread dump
+        end
+      end
+
+      def to_text
+        if @threads
+          # TODO make this stream
+          output = java.io.ByteArrayOutputStream.new
+          @threads.dump(output)
+          output.to_s
+        end
+      end
+    end
+
+    class ThreadDump
+
+      WRITER = ThreadDumpWriter.new
+
+      def self.response
+        dump = WRITER.to_text
+        [  
+         200, 
+         { 'Content-Type' => 'text/plain',
+           'Cache-Control' => 'must-revalidate,no-cache,no-store' }, 
+         [ dump ? dump : 'Sorry your runtime environment does not allow to dump threads.' ]
+        ]
+      end
+
+      def initialize(app, path = '/threads')
+        @app = app
+        @path = path
+      end
+
+      def call(env)
+        if env['PATH_INFO'] == @path
+          ThreadDump.response
+        else
+          @app.call( env )
+        end
+      end
+    end
+  end
+end

data/leafy-rack/lib/leafy/rack/version.rb

@@ -0,0 +1,6 @@
+module Leafy
+  module Rack
+    VERSION = '0.3.1'.freeze
+  end
+end
+

data/leafy-rack/spec/admin_rack_spec.rb

@@ -0,0 +1,141 @@
+require_relative 'setup'
+
+require 'leafy/rack/admin'
+require 'yaml'
+require 'json'
+
+describe Leafy::Rack::Admin do
+
+  subject { Leafy::Rack::Admin }
+  
+  let( :expected_headers ) do
+    { 'Content-Type' => 'text/html' }
+  end
+
+  let( :metrics ) { Leafy::Metrics::Registry.new }
+
+  let( :health ) { Leafy::Health::Registry.new }
+
+  let( :health_report ) do
+    { 'version' => '3.0.0',
+      'gauges' => {},
+      'counters' => {},
+      'histograms' => {},
+      'meters' => {},
+      'timers' =>  {}
+    }
+  end
+
+  let( :result ){ [ 200, nil, [] ] }
+  let( :app ) do
+    Proc.new() { result }
+  end
+
+  it 'has response' do
+    status, headers, body = subject.response( "/path" )
+    expect( status ).to eq 200
+    expect( headers.to_yaml).to eq expected_headers.to_yaml
+    expect( body.join.count("\n" ) ).to eq 15
+    expect( body.join.gsub( 'path/' ).collect { |f| f }.size ).to eq 6
+  end
+
+  describe 'default path' do
+    subject { Leafy::Rack::Admin.new( app, metrics, health ) }
+
+    it 'passes request if not matches the given path' do
+      env = { 'PATH_INFO'=> '/something' }
+      expect( subject.call( env ) ).to eq result
+    end
+
+    it 'shows menu page on admin path' do
+      env = { 'PATH_INFO'=> '/admin' }
+      status, headers, body = subject.call( env )
+      expect( status ).to eq 200
+      expect( headers.to_yaml).to eq expected_headers.to_yaml
+      expect( body.join.count("\n" ) ).to eq 15
+    end
+
+    it 'pongs on ping path' do
+      env = { 'PATH_INFO'=> '/admin/ping' }
+      status, _, body = subject.call( env )
+      expect( status ).to eq 200
+      expect( body.join ).to eq 'pong'
+    end
+
+    it 'thread dump on threads path' do
+      env = { 'PATH_INFO'=> '/admin/threads' }
+      status, _, body = subject.call( env )
+      expect( status ).to eq 200
+      expect( body.join.count( "\n" ) ).to be > 100
+    end
+
+    it 'reports metrics on metrics path' do
+      env = { 'PATH_INFO'=> '/admin/metrics' }
+      status, _, body = subject.call( env )
+      expect( status ).to eq 200
+      expect( body.join.count( "\n" ) ).to eq 0
+      body = JSON.parse(body.join)
+      expect( body.to_yaml ).to eq health_report.to_yaml
+    end
+
+    it 'reports health-checks on health path' do
+      env = { 'PATH_INFO'=> '/admin/health' }
+      status, _, body = subject.call( env )
+      expect( status ).to eq 200
+      expect( body.join.count( "\n" ) ).to eq 0
+      body = JSON.parse(body.join)
+      expect( body.to_yaml ).to eq "--- {}\n"
+    end
+  end
+
+  describe 'custom path' do
+    subject { Leafy::Rack::Admin.new( app, metrics, health, '/custom' ) }
+
+    it 'passes request if not matches the given path' do
+      env = { 'PATH_INFO'=> '/something' }
+      expect( subject.call( env ) ).to eq result
+      env = { 'PATH_INFO'=> '/ping' }
+      expect( subject.call( env ) ).to eq result
+    end
+
+    it 'shows menu page on admin path' do
+      env = { 'PATH_INFO'=> '/custom' }
+      status, headers, body = subject.call( env )
+      expect( status ).to eq 200
+      expect( headers.to_yaml).to eq expected_headers.to_yaml
+      expect( body.join.count("\n" ) ).to eq 15
+    end
+
+    it 'pongs on ping path' do
+      env = { 'PATH_INFO'=> '/custom/ping' }
+      status, _, body = subject.call( env )
+      expect( status ).to eq 200
+      expect( body.join ).to eq 'pong'
+    end
+
+    it 'thread dump on threads path' do
+      env = { 'PATH_INFO'=> '/custom/threads' }
+      status, _, body = subject.call( env )
+      expect( status ).to eq 200
+      expect( body.join.count( "\n" ) ).to be > 100
+    end
+
+    it 'reports metrics on metrics path' do
+      env = { 'PATH_INFO'=> '/custom/metrics' }
+      status, _, body = subject.call( env )
+      expect( status ).to eq 200
+      expect( body.join.count( "\n" ) ).to eq 0
+      body = JSON.parse(body.join)
+      expect( body.to_yaml ).to eq health_report.to_yaml
+    end
+
+    it 'reports health-checks on health path' do
+      env = { 'PATH_INFO'=> '/custom/health' }
+      status, _, body = subject.call( env )
+      expect( status ).to eq 200
+      expect( body.join.count( "\n" ) ).to eq 0
+      body = JSON.parse(body.join)
+      expect( body.to_yaml ).to eq "--- {}\n"
+    end
+  end
+end