leafy-rack 0.4.0-java

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d1239867bb5be43b57a52dcce8f281d146b9edf1
+  data.tar.gz: 51137ff0563f9a8e922f4af160253f9b34a9c66c
+SHA512:
+  metadata.gz: 90e49272d516440d2208bfd84d922d94fbfe0eb948c0e76ba228e104a1e21e2314f802e68ee9e26a4df0121eee008c02a5389ce1eadd4bcce207a547f90f13e1
+  data.tar.gz: 669522fc78cea7d8bee811485e82b15b8ca288f65d3ea8791dd9b3cf6cb198473e221780e147bf06cb719a94f95adb0324272031f626c73eaaab06a6c874d7bf

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,10 @@
+#-*- mode: ruby -*-
+
+source 'https://rubygems.org'
+
+gem 'leafy-metrics', :path => '../leafy-metrics'
+gem 'leafy-health', :path => '../leafy-health'
+
+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,155 @@
+# Leafy-Rack
+
+## installation
+
+via rubygems
+```
+gem install leafy-rack
+```
+or add to your Gemfile
+```
+gem 'leafy-rack
+```
+
+installing the gem also takes care of the jar dependencies with jruby-1.7.16+
+
+## intro
+
+there actually three parts to this gem
+
+* serializers to write out json data from the collected data of ```Leafy::Health::Registry``` and ```Leafy::Metrics::Registry```
+
+* instrumented class which is almost like a rack middleware but is threadsafe and is meant to be shared with **ALL** requests. with this sharing in can count the number of active requests.
+
+* a collection of middleware
+
+## serializers for health and metrics data
+
+are using the internal API of ```Leafy::Health::Registry``` or ```Leafy::Metrics::Registry``` to ```run_health_checks``` or retrieve the collect metrics and produces the json representation of these data.
+
+    registry = Leafy::Health::Registry.new
+	json_writer = Leafy::Json::HealthWriter.new
+	json_writer.to_json( registry.health.run_health_checks )
+
+or
+
+    registry = Leafy::Metrics::Registry.new
+	json_writer = Leafy::Json::MetricsWriter.new
+	json_writer.to_json( registry.metrics )
+
+both json writers can take a second argument to generate pretty prints:
+
+	json_writer.to_json( registry.health.run_health_checks, true )  
+	json_writer.to_json( registry.metrics, true )
+
+## instrumented http response
+
+the class ```Leafy::Instrumented::Instrumented``` has a call method which expect a block. the block needs to return the usual rack middleware result ```[status, headers, body]```.
+
+typical usage of this inside a rack-middleware
+
+    metrics = Leafy::Metrics::Registry.new
+    instrumented = Leafy::Instrumented::Instrumented.new( metrics, 'myapp' )
+	instrumented.call do
+       @app.call( env )
+	end
+
+see the ```Leafy::Rack::Instrumented``` for an example.
+
+## rack middleware
+
+* instrumented middleware collecting metrics on response status, response time, and active requests
+* json data of metrics snapshot
+* json data of current health
+* ping
+* java thread-dump
+* admin page with links to metrics, health, ping and thread-dump data
+
+### instrumented middleware
+
+    metrics = Leafy::Metrics::Registry.new
+    use Leafy::Rack::Instrumented, Leafy::Instrumented::Instrumented.new( metrics, 'webapp' )
+
+note: when this instrumented middleware gets configured **after** any of the admin middleware (see below) then those admin requests are not going into the instrumented metrics.
+
+### metrics middleware
+
+json data of a snapshot of metrics are under the path **/metrics**
+
+    metrics = Leafy::Metrics::Registry.new
+    use Leafy::Rack::Metrics, metrics
+
+or with custom path
+
+    metrics = Leafy::Metrics::Registry.new
+    use Leafy::Rack::Metrics, metrics, '/admin/metrics'
+
+### health-checks middleware
+
+json data of current health are under the path **/health**
+
+    health = Leafy::Health::Registry.new
+    use Leafy::Rack::Health, health
+
+or with custom path
+
+    health = Leafy::Health::Registry.new
+    use Leafy::Rack::Health, health, '/admin/health'
+
+### ping middleware
+
+under the path **/ping**
+
+    use Leafy::Rack::Ping
+
+or with custom path
+
+    use Leafy::Rack::Ping, '/admin/ping'
+
+### java thread-dump middleware
+
+under the path **/threads**
+
+    use Leafy::Rack::ThreadDump
+
+or with custom path
+
+    use Leafy::Rack::ThreadDump, '/admin/threads'
+
+
+### admin page middleware
+
+a simple page with links to metrics, health, ping and thread-dump data under the path **/admin**
+
+    metrics = Leafy::Metrics::Registry.new
+    health = Leafy::Health::Registry.new
+
+    use Leafy::Rack::Admin, metrics, health
+
+or with custom path
+
+    metrics = Leafy::Metrics::Registry.new
+    health = Leafy::Health::Registry.new
+
+    use Leafy::Rack::Admin, metrics, health, '/hidden/admin'
+
+## example sinatra app
+
+there is an [example sinatra application](https://github.com/lookout/leafy/tree/master/examples/hellowarld) which uses admin and instrumented middleware and adds some extra metrics inside the application.
+
+## developement
+
+get all the gems and jars in place
+
+    gem install jar-dependencies --development
+	bundle install
+
+please make sure you are using jar-dependencies > 0.1.8 !
+
+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 Rack Middleware"]
+end
+
+task :default => [ :spec ]
+
+# vim: syntax=Ruby

data/leafy-rack.gemspec

@@ -0,0 +1,30 @@
+#-*- mode: ruby -*-
+
+require File.expand_path( '../lib/leafy/rack/version', __FILE__ )
+
+Gem::Specification.new do |s|
+  s.name = 'leafy-rack'
+  s.version = Leafy::Rack::VERSION
+  s.author = 'christian meier'
+  s.email = [ 'christian.meier@lookout.com' ]
+
+  s.platform = 'java'
+  s.license = 'MIT'
+  s.summary = %q(rack middleware to expose leafy metrics/health data and more)
+  s.homepage = 'https://github.com/lookout/leafy'
+  s.description = %q(rack middleware to expose leafy metrics/health data as well a ping rack and a thread-dump rack)
+
+  s.files = `git ls-files`.split($/)
+
+  s.requirements << 'jar io.dropwizard.metrics:metrics-json, 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_runtime_dependency 'leafy-metrics', "~> #{Leafy::Rack::VERSION}"
+  s.add_runtime_dependency 'leafy-health',  "~> #{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'
+end
+
+# vim: syntax=Ruby

data/lib/leafy-rack.rb

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

data/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/lib/leafy/instrumented/basic_instrumented.rb

@@ -0,0 +1,35 @@
+# basically a meter on all requests. but can customized by a status-code to meter map. see constructor.
+module Leafy
+  module Instrumented
+    class BasicInstrumented
+
+      NAME_PREFIX = "responseCodes"
+
+      # creates the metrics. all none registered status codes are marked on the meter named 'other'
+      #
+      # @param [Leafy::Metrics::Registry] the registry on which register the metrics
+      # @param [String] name basename of the metrics
+      # @param [Hash] map of status code [Integer] to meter-name [String]. for each code there will be a meter.
+      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" )
+      end
+
+      # basically wraps a rack middleware call
+      def call( &block )
+        raise "block needed" unless block_given?
+        result = block.call
+        mark_meter_for_status_code result[0]
+        result
+      end
+
+      def mark_meter_for_status_code( status )
+        metric = @meters_by_status_code[ status ] || @other
+        metric.mark
+      end
+    end
+  end
+end

data/lib/leafy/instrumented/collected_instrumented.rb

@@ -0,0 +1,30 @@
+require 'leafy/instrumented/basic_instrumented'
+
+module Leafy
+  module Instrumented
+    class CollectedInstrumented < BasicInstrumented
+
+      INFO = 1;
+      SUCCESS = 2;
+      REDIRECT = 3;
+      CLIENT = 4;
+      SERVER = 5;
+
+      # creates the some metrics for status code 2xx, 3xx, 4xx and 5xx. all none registered status codes are marked on the meter named 'other'.
+      #
+      # @param [Leafy::Metrics::Registry] the registry on which register the metrics
+      # @param [String] name basename of the metrics
+      def initialize( registry, name )
+        super( registry, name,
+               { SUCCESS => "#{NAME_PREFIX}.2xx",
+                 REDIRECT => "#{NAME_PREFIX}.3xx",
+                 CLIENT => "#{NAME_PREFIX}.4xx",
+                 SERVER => "#{NAME_PREFIX}.5xx" } )
+      end
+
+      def mark_meter_for_status_code( status )
+        super( status/ 100 )
+      end
+    end
+  end
+end

data/lib/leafy/instrumented/instrumented.rb

@@ -0,0 +1,53 @@
+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;
+
+      # creates the some metrics for status code 200, 201, 204, 205, 400, 404 and 500. all none registered status codes are marked on the meter named 'other'. further the request time get measured and the active request counter is maintained.
+      #
+      # @param [Leafy::Metrics::Registry] the registry on which register the metrics
+      # @param [String] name basename of the metrics
+      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" } )
+        @active = registry.register_counter( "#{name}.active_requests" )
+        @timer = registry.register_timer( "#{name}.requests" )
+      end
+
+      # basically wraps a rack middleware call. mesures the request time and
+      # keeps an active request counter.
+      def call( &block )
+        raise "block needed" unless block_given?
+        @active.inc
+
+        @timer.time do
+
+          super
+
+        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/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/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/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