leafy-rack 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a4dc0bc8ee3f99f626e3b9cccdec95c2aa11fb7e
-  data.tar.gz: 6010a636ee0e01f8af8d519b15d147f966300cdb
+  metadata.gz: 45a059202e7dce86e4bd2906a0cae00ba661a8d1
+  data.tar.gz: 1f7e29163f2adf8cfa07cd37fd2ecaa07104155f
 SHA512:
-  metadata.gz: bbf62b2dc243c2ce84162e340ffb18c9c3d0111e8b6771485a43b1962450b10f08bb7289fd251d38c6bde42578af369dd2187e7d6480cdd4db1765fa68ff03ba
-  data.tar.gz: a068fd948b09c8d64f22943cf207b09a5f2d6acfeef5ca0764ba918f703ab8519fedf623561c77f6614f6b116028caf1ac77c59aa7a6d3960d143ff1751ddf1f
+  metadata.gz: 6fb48a0c9b1b90a79c4e1ec965a6229d6caf91cf011d35e9f57e646483a490ae8c397ea33cbb72dabf6625b53ee61fd849316564b78970ed067380a4e8bab5b1
+  data.tar.gz: fd552f9fa3ca5d89e58598824e18836115e14773e5b7da29fdc26a6dbc81bc113c80aa345906eae73ff2b993f151fc59212b4363c8ca969c424a4ace0e40386b

data/.gitignore

@@ -1,4 +1,34 @@
-.yardoc
-doc
-pkg
-*.lock
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+Gemfile.lock
+.ruby-version
+.ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/.travis.yml

@@ -0,0 +1,19 @@
+language: ruby
+rvm:
+  - jruby
+  - jruby-9.0.0.0-pre1
+env:
+  - DIR=leafy-health
+  - DIR=leafy-metrics
+  - DIR=leafy-rack
+  - DIR=examples/hellowarld
+
+gemfile: $DIR/Gemfile
+install: cd $DIR; gem install jar-dependencies --development -v '~> 0.1.8'; bundle install --jobs=1 --retry=3 --gemfile Gemfile
+
+script: bundle exec rake
+
+matrix:
+  allow_failures:
+    - env: DIR=examples/hellowarld
+      rvm: jruby-9.0.0.0-pre1

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+# Changelog
+
+## 0.3.0
+
+ * [#30](https://github.com/lookout/leafy/pull/30) allow to reconfigure the loggers via yaml or options during runtime
+ * [#26](https://github.com/lookout/leafy/issues/26) Admin endpoint URLs are not relative to where the app is being served
+

data/Gemfile

@@ -1,10 +1,3 @@
-#-*- mode: ruby -*-
-
 source 'https://rubygems.org'
 
-gem 'leafy-metrics', :path => '../leafy-metrics'
-gem 'leafy-health', :path => '../leafy-health'
-
-gemspec
-
-# vim: syntax=Ruby
+# dummy Gemfile for travis to run ```bundle install```

data/README.md

@@ -1,155 +1,17 @@
-# Leafy-Rack
+# Leafy
 
-## installation
+[![Build Status](https://travis-ci.org/lookout/leafy.svg?branch=master)](https://travis-ci.org/lookout/leafy)
 
-via rubygems
-```
-gem install leafy-rack
-```
-or add to your Gemfile
-```
-gem 'leafy-rack
-```
+The green way to build Ruby-based web services
 
-installing the gem also takes care of the jar dependencies with jruby-1.7.16+
 
-## intro
+## Goals
 
-there actually three parts to this gem
+The goal of Leafy is to provide an out-of-the-box set of best practices and tools for building [JRuby](http://jruby.org)-based web services. In its initial form, it is based largely on [Dropwizard](http://dropwizard.io) underneath but this is not a long-term guarantee and may change in the future. As such the APIs exposed by Leafy should be stable regardless of what is "under the hood."
 
-* serializers to write out json data from the collected data of ```Leafy::Health::Registry``` and ```Leafy::Metrics::Registry```
+Leafy should provide standard means of:
 
-* 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
+ * Tracking metrics
+ * Logging
+ * Health checks
+ * Exposing operations-friendly interfaces

data/examples/datadog/.gitignore

@@ -0,0 +1,2 @@
+target
+Jars.lock

data/examples/datadog/Gemfile

@@ -0,0 +1,12 @@
+#-*- mode: ruby -*-
+
+source 'https://rubygems.org'
+
+gem 'leafy-metrics', :path => '../../leafy-metrics'
+
+group 'development' do
+  gem 'ruby-maven'
+  gem 'rake', '~> 10.2'
+end
+
+# vim: syntax=Ruby

data/examples/datadog/Mavenfile

@@ -0,0 +1,22 @@
+#-*- mode: ruby -*-
+
+repository :id => 'bintray', :url => 'http://dl.bintray.com/lookout/systems'
+
+jar 'com.github.lookout:metrics-datadog:0.1.4'
+
+# dump Jars.lock
+################
+
+plugin_repository :id => 'sonatype-snapshots', :url => 'https://oss.sonatype.org/content/repositories/snapshots'
+
+repository :id => 'rubygems-releases', :url => 'http://rubygems-proxy.torquebox.org/releases'
+
+#properties 'jruby.plugins.version' => 
+jruby_plugin! :gem, '1.0.9-SNAPSHOT' do
+  
+  # duplicate dependency here and assume the local gem has the same
+  # dependencies as this one here
+  execute_goal 'jars-lock', :gems => ['leafy-metrics:0.3.0']
+end
+
+# vim: syntax=Ruby

data/examples/datadog/README.md

@@ -0,0 +1,16 @@
+# datadog gauge with tags example
+
+## setup
+
+execute with jruby
+
+    # installs all the gems
+    bundle install
+    # install all the jars and creates Jars.lock for the runtime
+    rmvn initialize
+
+## run example
+
+needs the datadog agent running and then
+
+    bundle exec ruby lib/metrics.rb

data/examples/datadog/lib/java_gauge.rb

@@ -0,0 +1,20 @@
+class JavaGauge
+  include Java::OrgCourseraMetricsDatadog::Tagged
+  include com.codahale.metrics.Gauge
+
+  def value
+    r = Time.now.usec
+    p r
+    r
+  end
+
+  def name
+    'leafy.demo.usec.java'
+  end
+
+  def tags
+    t = [Date::DAYNAMES[Time.now.wday]]
+    p t
+    t
+  end
+end

data/examples/datadog/lib/metrics.rb

@@ -0,0 +1,18 @@
+require 'leafy/metrics'
+require 'leafy/metrics/reporter'
+require_relative 'java_gauge'
+require_relative 'ruby_gauge'
+
+metrics = Leafy::Metrics::Registry.new
+my = metrics.register_gauge( 'leafy.demo.java.usec', JavaGauge.new )
+my = metrics.register_gauge( 'leafy.demo.ruby.usec', RubyGauge.new )
+
+transport =  Java::OrgCourseraMetricsDatadogTransport::UdpTransport::Builder.new.build
+
+reporter = metrics.reporter_builder( Java::OrgCourseraMetricsDatadog::DatadogReporter ).withTransport(transport).build
+
+reporter.start(1, Leafy::Metrics::Reporter::SECONDS)
+
+sleep 3
+
+reporter.stop

data/examples/datadog/lib/ruby_gauge.rb

@@ -0,0 +1,19 @@
+class RubyGauge < Leafy::Metrics::Gauge
+  include Java::OrgCourseraMetricsDatadog::Tagged
+
+  def value
+    r = Time.now.usec
+    p r
+    r
+  end
+
+  def name
+    'leafy.demo.usec.ruby'
+  end
+
+  def tags
+    t = [Date::DAYNAMES[Time.now.wday]]
+    p t
+    t
+  end
+end

data/examples/hellowarld/.gitignore

@@ -0,0 +1,3 @@
+.ruby-*
+pkg
+*war

data/examples/hellowarld/Gemfile

@@ -0,0 +1,15 @@
+#-*- mode: ruby -*-
+
+source 'https://rubygems.org'
+
+gem 'leafy-metrics', :path => '../../leafy-metrics'
+gem 'leafy-health', :path => '../../leafy-health'
+gem 'leafy-rack', :path => '../../leafy-rack'
+
+gem 'sinatra'
+
+group 'development' do
+  gem 'ruby-maven'
+  gem 'rake', '~> 10.2'
+end
+# vim: syntax=Ruby

data/examples/hellowarld/Mavenfile

@@ -0,0 +1,162 @@
+#-*- mode: ruby -*-
+
+gemfile
+
+packaging :war
+
+jar( 'org.jruby.rack:jruby-rack', '1.1.18', 
+     :exclusions => [ 'org.jruby:jruby-complete' ] )
+
+gem! 'bundler', '1.7.7'
+# bug in getting all the gems in place via :path
+gem! 'jar-dependencies', '0.1.8'
+
+pom 'org.jruby:jruby', '${jruby.version}'
+
+properties( 'project.build.sourceEncoding' => 'utf-8',
+            'jruby.version' => '1.7.19')
+
+resource do
+  directory '${basedir}'
+  includes [ 'app/**', 'config.ru' ]
+end
+
+resource do
+  directory '${basedir}'
+  includes [ 'config.ru' ]
+  target_path 'WEB-INF'
+end
+
+build do
+  final_name File.basename( File.expand_path( '.' ) )
+  directory 'pkg'
+end
+
+# read the Jarfile.lock and embed those jars in WEB-INF/classes
+if File.exists?( 'Jarfile.lock' )
+phase 'generate-resources' do
+  plugin :dependency do
+    items = []
+    File.read( 'Jarfile.lock' ).each_line do |l|
+      data = l.sub(/-\ /, '').strip.split(':')
+      if data.size > 3
+        data = Hash[ [:groupId, :artifactId, :type, :version, :classifier].zip( data ) ]
+        data[ :outputDirectory ] = File.join( '${project.build.outputDirectory}',
+                                              data[:groupId].gsub(/[.]/, '/'),
+                                              data[:artifactId],
+                                              data[:version] )
+        items << data
+      end
+    end
+    execute_goal( :copy,
+                  :id => 'copy jar dependencies',
+                  :artifactItems => items )
+  end
+end
+end
+
+# Gemfile with references to local gems which again reference local gems
+# does not work with this plugin. so we use our own setup
+plugins.remove plugins.detect { |d| d.artifact_id == 'gem-maven-plugin' }
+
+jruby_plugin!( :gem,
+               :includeRubygemsInResources => true ) do
+  execute_goal :initialize
+end
+
+
+plugin( :war, '2.2',
+        :webAppSourceDirectory => "${basedir}",
+        :webXml => 'WEB-INF/web.xml',
+        :webResources => [ { :directory => '${basedir}',
+                             :targetPath => 'WEB-INF',
+                             :includes => [ 'config.ru' ] } ] )
+
+# integration tests
+###################
+
+require 'open-uri'
+results = []
+execute 'download', :phase => 'integration-test' do
+  results << open( 'http://localhost:8080/hellowarld/app' ).string
+  results << open( 'http://localhost:8080/hellowarld/admin' ).string
+  results << open( 'http://localhost:8080/hellowarld/admin/ping' ).string
+  results << open( 'http://localhost:8080/hellowarld/admin/health' ).string
+  results << open( 'http://localhost:8080/hellowarld/admin/metrics' ).string
+  results << open( 'http://localhost:8080/hellowarld/admin/threads' ).read
+  results << open( 'http://localhost:8080/hellowarld/ping' ).string
+  results << open( 'http://localhost:8080/hellowarld/health' ).string
+  results << open( 'http://localhost:8080/hellowarld/metrics' ).string
+  results << open( 'http://localhost:8080/hellowarld/threads' ).read
+  results.each { |r| puts r[0..20] }
+end
+
+# verify the downloads
+require 'json'
+execute 'verify downloads', :phase => :verify do
+  sleep 1 #let jetty shut down in peace
+  expected = 'christian'
+  unless results[0].match( /#{expected}/ )
+    raise "missed expected string in download: #{expected}"
+  end
+  expected = 'menu'
+  unless results[1].match( /#{expected}/ )
+    raise "missed expected string in download: #{expected}"
+  end
+  expected = 'pong'
+  unless results[2].match( /#{expected}/ )
+    raise "missed expected string in download: #{expected}"
+  end
+  json = JSON.parse( results[3] )
+  unless json["app.health"]["healthy"]
+    raise "healthy expected"
+  end
+  json = JSON.parse( results[4] )
+  unless json["meters"]["webapp.responseCodes.ok"]["count"] == 1
+    raise "one OK request expected"
+  end
+  unless results[5].length > 10000
+    puts result[5]
+    raise "expected thread dump to be big"
+  end
+  expected = 'pong'
+  unless results[6].match( /#{expected}/ )
+    raise "missed expected string in download: #{expected}"
+  end
+  json = JSON.parse( results[7] )
+  unless json["app.health"]["healthy"]
+    raise "healthy expected"
+  end
+  json = JSON.parse( results[8] )
+  unless json["meters"]["webapp.responseCodes.ok"]["count"] == 1
+    raise "one OK request expected"
+  end
+  unless results[9].length > 10000
+    puts result[9]
+    raise "expected thread dump to be big"
+  end
+end
+
+# jetty runner 
+##############
+
+#plugin( 'org.mortbay.jetty:jetty-maven-plugin', '8.1.14.v20131031',
+#        :webAppSourceDirectory => "${basedir}" )
+plugin( 'org.eclipse.jetty:jetty-maven-plugin', '9.3.0.M1',
+        :webAppSourceDirectory => "${basedir}",
+        :webApp => { :contextPath => '/hellowarld' },
+        :stopPort => 9999,
+        :stopKey => 'foo' ) do
+   execute_goal( 'start', :id => 'start jetty', :phase => 'pre-integration-test', :daemon => true )
+   execute_goal( 'stop', :id => 'stop jetty', :phase => 'post-integration-test' )
+end
+
+
+# tomcat runner
+###############
+plugin( 'org.codehaus.mojo:tomcat-maven-plugin', '1.1',
+        :warSourceDirectory => '${basedir}' )
+
+# wildfly runner
+################
+plugin( 'org.wildfly.plugins:wildfly-maven-plugin:1.0.2.Final' )