leafy-rack 0.3.0 → 0.3.1

data/leafy-metrics/spec/graphite_reporter_spec.rb

@@ -0,0 +1,72 @@
+require_relative 'setup'
+require 'leafy/metrics/graphite/graphite_reporter'
+
+describe Leafy::Metrics::GraphiteReporter do
+
+  subject { Leafy::Metrics::GraphiteReporter }
+
+  let( :metrics ) { Leafy::Metrics::Registry.new }
+  let( :requests ) { metrics.register_meter( "requests" ) }
+  let( :logfile ) { LOG_FILE }
+
+  graphites = [ Leafy::Metrics::Graphite.new_tcp( 'localhost', 12345 ),
+                Leafy::Metrics::Graphite.new_pickled( 'localhost', 12345, 1 ) ]
+  graphites.each_with_index do |graphite, index|
+    describe graphite.sender.class do
+      it 'run reporter with defaults' do
+        log = File.read( logfile )
+        begin
+          reporter = metrics.reporter_builder( subject ).build( graphite )
+          requests.mark
+          reporter.start( 10, Leafy::Metrics::Reporter::MILLISECONDS )
+          sleep 0.02
+          reporter.stop
+          result = File.read( logfile )[ (log.size)..-1 ]
+          expect( result ).to match /metrics-graphite-reporter-.+-thread-1] WARN com.codahale.metrics.graphite.GraphiteReporter/
+        ensure
+          reporter.stop if reporter
+        end
+      end
+
+      it 'run reporter via builder config' do
+        log = File.read( logfile )
+        begin
+          reporter = metrics.reporter_builder( subject )
+            .convert_rates_to( Leafy::Metrics::Reporter::MILLISECONDS )
+            .convert_durations_to( Leafy::Metrics::Reporter::MILLISECONDS )
+            .prefixed_with( 'myapp' )
+            .build( graphite )
+
+          requests.mark
+          reporter.start( 10, Leafy::Metrics::Reporter::MILLISECONDS )
+          sleep 0.02
+          reporter.stop
+          result = File.read( logfile )[ (log.size)..-1 ]
+          expect( result ).to match /metrics-graphite-reporter-.+-thread-1] WARN com.codahale.metrics.graphite.GraphiteReporter/
+        ensure
+          reporter.stop if reporter
+        end
+      end
+
+      it 'run reporter via block config' do
+        log = File.read( logfile )
+        begin
+          reporter = metrics.reporter_builder( subject ) do
+            convert_rates_to( Leafy::Metrics::Reporter::MILLISECONDS )
+            convert_durations_to( Leafy::Metrics::Reporter::MILLISECONDS )
+            prefixed_with( 'myapp' )
+          end.build( graphite )
+
+          requests.mark
+          reporter.start( 10, Leafy::Metrics::Reporter::MILLISECONDS )
+          sleep 0.02
+          reporter.stop
+          result = File.read( logfile )[ (log.size)..-1 ]
+          expect( result ).to match /metrics-graphite-reporter-.+-thread-1] WARN com.codahale.metrics.graphite.GraphiteReporter/
+        ensure
+          reporter.stop if reporter
+        end
+      end
+    end
+  end
+end

data/leafy-metrics/spec/graphite_spec.rb

@@ -0,0 +1,23 @@
+require_relative 'setup'
+require 'leafy/metrics/graphite/graphite'
+
+describe Leafy::Metrics::Graphite do
+
+  subject { Leafy::Metrics::Graphite }
+
+  it 'fails to create an instance without proper sender' do
+    expect { subject.new Object.new }.to raise_error RuntimeError
+  end
+
+  it 'creates tcp graphite' do
+    expect( subject.new_tcp( 'localhost', 123 ) ).not_to be_nil
+  end
+
+  it 'creates udp graphite' do
+    expect( subject.new_udp( 'localhost', 123 ) ).not_to be_nil
+  end
+
+  it 'creates pickled graphite' do
+    expect( subject.new_pickled( 'localhost', 123, 456 ) ).not_to be_nil
+  end
+end

data/leafy-metrics/spec/registry_spec.rb

@@ -0,0 +1,106 @@
+require_relative 'setup'
+require 'leafy/metrics/registry'
+
+describe Leafy::Metrics::Registry do
+
+  subject { Leafy::Metrics::Registry.new }
+
+  it 'registers and unregister a meter' do
+    obj = subject.register_meter('me')
+    expect(obj).to be_a(Java::ComCodahaleMetrics::Meter)
+    expect(subject.metrics.meters['me']).to be obj
+    expect(obj.respond_to? :mark).to be true
+
+    subject.remove('me')
+    expect(subject.metrics.meters).to be_empty
+  end
+
+  it 'registers and unregister a counter' do
+    obj = subject.register_counter('me')
+    expect(obj).to be_a(Java::ComCodahaleMetrics::Counter)
+    expect(subject.metrics.counters['me']).to be obj
+    expect(obj.respond_to? :inc).to be true
+    expect(obj.respond_to? :dec).to be true
+
+    subject.remove('me')
+    expect(subject.metrics.counters).to be_empty
+  end
+
+  it 'registers and unregister a histogram' do
+    obj = subject.register_histogram('me')
+    expect(obj).to be_a(Java::ComCodahaleMetrics::Histogram)
+    expect(subject.metrics.histograms['me']).to be obj
+    expect(obj.respond_to? :update).to be true
+
+    subject.remove('me')
+    expect(subject.metrics.histograms).to be_empty
+  end
+
+  it 'registers and unregister a timer' do
+    obj = subject.register_timer('me')
+    expect(obj).to be_a(Leafy::Metrics::Registry::Timer)
+    expect(subject.metrics.timers['me']).to be obj.timer
+    expect(obj.timer.respond_to? :time).to be true
+
+    subject.remove('me')
+    expect(subject.metrics.timers).to be_empty
+  end
+
+  it 'registers and unregister gauge as block' do
+    obj = subject.register_gauge('me') do
+      123
+    end
+    expect(obj).to be_a(Leafy::Metrics::Gauge)
+    expect(subject.metrics.gauges['me']).to be obj
+    expect(obj.value).to eq 123
+
+    subject.remove('me')
+    expect(subject.metrics.gauges).to be_empty
+  end
+
+  it 'registers and unregister gauge as object with call method' do
+    obj = subject.register_gauge('me', Proc.new do
+      123
+    end )
+    expect(obj).to be_a(Leafy::Metrics::Gauge)
+    expect(subject.metrics.gauges['me']).to be obj
+    expect(obj.value).to eq 123
+
+    subject.remove('me')
+    expect(subject.metrics.gauges).to be_empty
+  end
+
+  it 'registers and unregister com.codahale.metrics.Gauge' do
+    g = Leafy::Metrics::Gauge.new
+    def g.value
+      123
+    end
+    obj = subject.register_gauge('me', g)
+    expect(obj).to be_a(Leafy::Metrics::Gauge)
+    expect(subject.metrics.gauges['me']).to be obj
+    expect(obj.value).to eq 123
+
+    subject.remove('me')
+    expect(subject.metrics.gauges).to be_empty
+  end
+
+  it 'fails register gauge as object without call method' do
+    expect { subject.register_gauge('me', Object.new ) }.to raise_error
+  end
+
+  describe Leafy::Metrics::Registry::Timer do
+
+    it 'can messure duration' do
+      obj = subject.register_timer('me')
+      expect(obj.timer.mean_rate).to eq 0.0
+
+      obj.time do
+        sleep 0.1
+      end
+      
+      expect(obj.timer.mean_rate).to be > 0.0
+
+      subject.remove('me')
+    end
+  end
+end

data/leafy-metrics/spec/setup.rb

@@ -0,0 +1,10 @@
+$LOAD_PATH.unshift File.expand_path( '../../lib', __FILE__ )
+require 'jar-dependencies'
+
+# setup logging
+LOG_FILE = File.expand_path( '../../pkg/log', __FILE__ )
+require 'fileutils'
+FileUtils.mkdir_p File.dirname( LOG_FILE )
+FileUtils.rm_f( LOG_FILE )
+java.lang.System.set_property( 'org.slf4j.simpleLogger.logFile', LOG_FILE )
+require_jar( 'org.slf4j', 'slf4j-simple', '1.7.7' )

data/leafy-rack/.gitignore

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

data/leafy-rack/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/leafy-rack/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/leafy-rack/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/leafy-rack/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 → leafy-rack/leafy-rack.gemspec}

@@ -19,8 +19,8 @@ Gem::Specification.new do |s|
   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', '~> 0.2.0'
-  s.add_runtime_dependency 'leafy-health',  '~> 0.2.0'
+  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.0'
   s.add_development_dependency 'yard', '~> 0.8.7'
   s.add_development_dependency 'rake', '~> 10.2'