RubyGems - leafy-rack - Versions diffs - 0.4.0-java - Mend

leafy-rack 0.4.0-java

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (36) hide show

checksums.yaml +7 -0
data/.gitignore +4 -0
data/Gemfile +10 -0
data/LICENSE +22 -0
data/README.md +155 -0
data/Rakefile +14 -0
data/leafy-rack.gemspec +30 -0
data/lib/leafy-rack.rb +1 -0
data/lib/leafy-rack_jars.rb +10 -0
data/lib/leafy/instrumented/basic_instrumented.rb +35 -0
data/lib/leafy/instrumented/collected_instrumented.rb +30 -0
data/lib/leafy/instrumented/instrumented.rb +53 -0
data/lib/leafy/json/health_writer.rb +15 -0
data/lib/leafy/json/json_writer.rb +33 -0
data/lib/leafy/json/metrics_writer.rb +22 -0
data/lib/leafy/rack.rb +1 -0
data/lib/leafy/rack/admin.rb +73 -0
data/lib/leafy/rack/health.rb +43 -0
data/lib/leafy/rack/instrumented.rb +20 -0
data/lib/leafy/rack/metrics.rb +35 -0
data/lib/leafy/rack/ping.rb +29 -0
data/lib/leafy/rack/thread_dump.rb +56 -0
data/lib/leafy/rack/version.rb +6 -0
data/spec/admin_rack_spec.rb +141 -0
data/spec/basic_instrumented_spec.rb +26 -0
data/spec/collected_instrumented_spec.rb +32 -0
data/spec/health_rack_spec.rb +136 -0
data/spec/health_writer_spec.rb +47 -0
data/spec/instrumented_rack_spec.rb +37 -0
data/spec/instrumented_spec.rb +56 -0
data/spec/metrics_rack_spec.rb +110 -0
data/spec/metrics_writer_spec.rb +55 -0
data/spec/ping_rack_spec.rb +63 -0
data/spec/setup.rb +3 -0
data/spec/thread_dump_spec.rb +59 -0
metadata +165 -0

data/lib/leafy/rack.rb ADDED Viewed

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

data/lib/leafy/rack/admin.rb ADDED Viewed

@@ -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/lib/leafy/rack/health.rb ADDED Viewed

@@ -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/lib/leafy/rack/instrumented.rb ADDED Viewed

@@ -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/lib/leafy/rack/metrics.rb ADDED Viewed

@@ -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/lib/leafy/rack/ping.rb ADDED Viewed

@@ -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/lib/leafy/rack/thread_dump.rb ADDED Viewed

@@ -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/lib/leafy/rack/version.rb ADDED Viewed

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

data/spec/admin_rack_spec.rb ADDED Viewed

@@ -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

data/spec/basic_instrumented_spec.rb ADDED Viewed

@@ -0,0 +1,26 @@
+require_relative 'setup'
+require 'leafy/instrumented/basic_instrumented'
+describe Leafy::Instrumented::BasicInstrumented do
+  subject { Leafy::Instrumented::BasicInstrumented.new( registry, "name" ) }
+  let( :registry ) { Leafy::Metrics::Registry.new }
+  let( :app ) do
+    Proc.new() do
+      sleep 0.1
+      [ 200, nil, "" ]
+    end
+  end
+  it 'collects metrics for a call' do
+    _, _, _ = subject.call do
+      app.call
+    end
+    expect( registry.metrics.meters.keys ).to eq [ 'name.responseCodes.other' ]
+    expect( registry.metrics.meters.values.collect { |a| a.count } ).to eq [ 1 ]
+    expect( registry.metrics.meters.values.first.mean_rate ).to be > 5.0
+  end
+end