RubyGems - leafy-rack - Versions diffs - 0.3.0 → 0.3.1 - Mend

leafy-rack 0.3.0 → 0.3.1

Files changed (108) hide show

checksums.yaml +4 -4
data/.gitignore +34 -4
data/.travis.yml +19 -0
data/CHANGELOG.md +7 -0
data/Gemfile +1 -8
data/README.md +10 -148
data/examples/datadog/.gitignore +2 -0
data/examples/datadog/Gemfile +12 -0
data/examples/datadog/Mavenfile +22 -0
data/examples/datadog/README.md +16 -0
data/examples/datadog/lib/java_gauge.rb +20 -0
data/examples/datadog/lib/metrics.rb +18 -0
data/examples/datadog/lib/ruby_gauge.rb +19 -0
data/examples/hellowarld/.gitignore +3 -0
data/examples/hellowarld/Gemfile +15 -0
data/examples/hellowarld/Mavenfile +162 -0
data/examples/hellowarld/README.md +44 -0
data/examples/hellowarld/Rakefile +13 -0
data/examples/hellowarld/WEB-INF/web.xml +31 -0
data/examples/hellowarld/app/hellowarld.rb +55 -0
data/examples/hellowarld/app/views/person.erb +52 -0
data/examples/hellowarld/config.ru +12 -0
data/leafy-complete.gemspec +22 -0
data/leafy-health/.gitignore +4 -0
data/leafy-health/Gemfile +7 -0
data/leafy-health/LICENSE +22 -0
data/leafy-health/README.md +123 -0
data/leafy-health/Rakefile +14 -0
data/leafy-health/leafy-health.gemspec +27 -0
data/leafy-health/lib/leafy-health.rb +2 -0
data/leafy-health/lib/leafy-health_jars.rb +7 -0
data/leafy-health/lib/leafy/health.rb +2 -0
data/leafy-health/lib/leafy/health/health_check.rb +72 -0
data/leafy-health/lib/leafy/health/registry.rb +55 -0
data/leafy-health/lib/leafy/health/version.rb +6 -0
data/leafy-health/spec/registry_spec.rb +164 -0
data/leafy-health/spec/setup.rb +1 -0
data/leafy-logger/.gitignore +5 -0
data/leafy-logger/Gemfile +9 -0
data/leafy-logger/LICENSE +22 -0
data/leafy-logger/README.md +174 -0
data/{Rakefile → leafy-logger/Rakefile} +0 -0
data/leafy-logger/leafy-logger.gemspec +32 -0
data/leafy-logger/lib/leafy-logger.rb +1 -0
data/leafy-logger/lib/leafy-logger_jars.rb +33 -0
data/leafy-logger/lib/leafy/logger.rb +1 -0
data/leafy-logger/lib/leafy/logger/appender_factories.rb +89 -0
data/leafy-logger/lib/leafy/logger/factory.rb +141 -0
data/leafy-logger/lib/leafy/logger/version.rb +6 -0
data/leafy-logger/spec/appender_factories_spec.rb +147 -0
data/leafy-logger/spec/factory_spec.rb +176 -0
data/leafy-logger/spec/logging.yml +16 -0
data/leafy-logger/spec/setup.rb +2 -0
data/leafy-metrics/.gitignore +5 -0
data/leafy-metrics/Gemfile +7 -0
data/leafy-metrics/LICENSE +22 -0
data/leafy-metrics/README.md +221 -0
data/leafy-metrics/Rakefile +14 -0
data/leafy-metrics/leafy-metrics.gemspec +29 -0
data/leafy-metrics/lib/leafy-metrics.rb +2 -0
data/leafy-metrics/lib/leafy-metrics_jars.rb +5 -0
data/leafy-metrics/lib/leafy/metrics.rb +2 -0
data/leafy-metrics/lib/leafy/metrics/console_reporter.rb +32 -0
data/leafy-metrics/lib/leafy/metrics/csv_reporter.rb +26 -0
data/leafy-metrics/lib/leafy/metrics/graphite/graphite.rb +28 -0
data/leafy-metrics/lib/leafy/metrics/graphite/graphite_reporter.rb +43 -0
data/leafy-metrics/lib/leafy/metrics/registry.rb +108 -0
data/leafy-metrics/lib/leafy/metrics/reporter.rb +51 -0
data/leafy-metrics/lib/leafy/metrics/version.rb +6 -0
data/leafy-metrics/spec/console_reporter_spec.rb +72 -0
data/leafy-metrics/spec/csv_reporter_spec.rb +75 -0
data/leafy-metrics/spec/graphite_reporter_spec.rb +72 -0
data/leafy-metrics/spec/graphite_spec.rb +23 -0
data/leafy-metrics/spec/registry_spec.rb +106 -0
data/leafy-metrics/spec/setup.rb +10 -0
data/leafy-rack/.gitignore +4 -0
data/leafy-rack/Gemfile +10 -0
data/leafy-rack/LICENSE +22 -0
data/leafy-rack/README.md +155 -0
data/leafy-rack/Rakefile +14 -0
data/{leafy-rack.gemspec → leafy-rack/leafy-rack.gemspec} +2 -2
data/{lib → leafy-rack/lib}/leafy-rack.rb +0 -0
data/{lib → leafy-rack/lib}/leafy-rack_jars.rb +0 -0
data/{lib → leafy-rack/lib}/leafy/instrumented/basic_instrumented.rb +0 -0
data/{lib → leafy-rack/lib}/leafy/instrumented/instrumented.rb +0 -0
data/{lib → leafy-rack/lib}/leafy/json/health_writer.rb +0 -0
data/{lib → leafy-rack/lib}/leafy/json/json_writer.rb +0 -0
data/{lib → leafy-rack/lib}/leafy/json/metrics_writer.rb +0 -0
data/{lib → leafy-rack/lib}/leafy/rack.rb +0 -0
data/{lib → leafy-rack/lib}/leafy/rack/admin.rb +0 -0
data/{lib → leafy-rack/lib}/leafy/rack/health.rb +0 -0
data/{lib → leafy-rack/lib}/leafy/rack/instrumented.rb +0 -0
data/{lib → leafy-rack/lib}/leafy/rack/metrics.rb +0 -0
data/{lib → leafy-rack/lib}/leafy/rack/ping.rb +0 -0
data/{lib → leafy-rack/lib}/leafy/rack/thread_dump.rb +0 -0
data/{lib → leafy-rack/lib}/leafy/rack/version.rb +1 -1
data/{spec → leafy-rack/spec}/admin_rack_spec.rb +0 -0
data/{spec → leafy-rack/spec}/basic_instrumented_spec.rb +0 -0
data/{spec → leafy-rack/spec}/health_rack_spec.rb +0 -0
data/{spec → leafy-rack/spec}/health_writer_spec.rb +0 -0
data/{spec → leafy-rack/spec}/instrumented_rack_spec.rb +0 -0
data/{spec → leafy-rack/spec}/instrumented_spec.rb +0 -0
data/{spec → leafy-rack/spec}/metrics_rack_spec.rb +0 -0
data/{spec → leafy-rack/spec}/metrics_writer_spec.rb +0 -0
data/{spec → leafy-rack/spec}/ping_rack_spec.rb +0 -0
data/{spec → leafy-rack/spec}/setup.rb +0 -0
data/{spec → leafy-rack/spec}/thread_dump_spec.rb +0 -0
metadata +110 -34

data/examples/hellowarld/README.md ADDED

@@ -0,0 +1,44 @@
+# show case for leafy gems
+get all the gems in place
+	gem install jar-dependencies --development
+    bundle install
+## starting the server
+### with jetty
+    rmvn jetty:run
+the urls:
+    [http://localhost:8080/app](http://localhost:8080/app)
+    [http://localhost:8080/admin](http://localhost:8080/admin)
+### with tomcat or wildfly
+	rmvn tomcat:run
+	rmvn wildfly:run
+the urls:
+    [http://localhost:8080/hellowarld/app](http://localhost:8080/hellowarld/app)
+    [http://localhost:8080/hellowarld/admin](http://localhost:8080/hellowarld/admin)
+## configurations
+* Mavenfile
+* WEB-INF/web.xml
+## run some integration test
+    rmvn verify
+or
+    rake
+with jruby-9k due to some bundler bug you need to run (not needed with rvm)
+    BUNDLE_DISABLE_SHARED_GEMS=true rake

data/examples/hellowarld/Rakefile ADDED

@@ -0,0 +1,13 @@
+#-*- mode: ruby -*-
+require 'maven/ruby/maven'
+task :default do
+  mvn = Maven::Ruby::Maven.new
+  mvn.property 'jruby.version', JRUBY_VERSION
+  if mvn.verify
+    puts "\n\ndone ok\n\n"
+  else
+    raise "\n\nintegration test failed\n\n"
+  end
+end

data/examples/hellowarld/WEB-INF/web.xml ADDED

@@ -0,0 +1,31 @@
+<!DOCTYPE web-app PUBLIC
+  "-//Sun Microsystems, Inc.//DTD Web Application 2.3//EN"
+  "http://java.sun.com/dtd/web-app_2_3.dtd">
+<web-app>
+  <context-param>
+    <param-name>public.root</param-name>
+    <param-value>/</param-value>
+  </context-param>
+  <context-param>
+    <param-name>rack.env</param-name>
+    <param-value>production</param-value>
+  </context-param>
+  <!-- needed for wildfly -->
+  <context-param>
+    <param-name>gem.path</param-name>
+    <param-value>WEB-INF/classes</param-value>
+  </context-param>
+  <filter>
+    <filter-name>RackFilter</filter-name>
+    <filter-class>org.jruby.rack.RackFilter</filter-class>
+  </filter>
+  <filter-mapping>
+    <filter-name>RackFilter</filter-name>
+    <url-pattern>/*</url-pattern>
+  </filter-mapping>
+  <listener>
+    <listener-class>org.jruby.rack.RackServletContextListener</listener-class>
+  </listener>
+</web-app>

data/examples/hellowarld/app/hellowarld.rb ADDED

@@ -0,0 +1,55 @@
+require 'sinatra'
+require 'json'
+require 'ostruct'
+require 'leafy/metrics'
+require 'leafy/health'
+require 'leafy/instrumented/instrumented'
+require 'leafy/rack/admin'
+require 'leafy/rack/instrumented'
+data = OpenStruct.new
+data.surname = 'meier'
+data.firstname = 'christian'
+configure do
+  metrics = Leafy::Metrics::Registry.new
+  health = Leafy::Health::Registry.new
+  use Leafy::Rack::Admin, metrics, health
+  use Leafy::Rack::Metrics, metrics
+  use Leafy::Rack::Health, health
+  use Leafy::Rack::Ping
+  use Leafy::Rack::ThreadDump
+  use Leafy::Rack::Instrumented, Leafy::Instrumented::Instrumented.new( metrics, 'webapp' )
+  metrics.register_gauge('app.data_length' ) do
+    data.surname.length + data.firstname.length
+  end
+  health.register( 'app.health' ) do
+    if data.surname.length + data.firstname.length < 4
+      "stored names are too short"
+    end
+  end
+  set :histogram, metrics.register_histogram( 'app.name_length' )
+end
+get '/app' do
+  p @person = data
+  erb :person
+end
+get '/person' do
+  p @person = data
+  content_type 'application/json'
+  { :surname =>  data.surname, :firstname => data.firstname }.to_json
+end
+patch '/person' do
+  payload = JSON.parse request.body.read
+  data.send :"#{payload.keys.first}=", payload.values.first
+  settings.histogram.update( data.surname.length + data.firstname.length )
+  status 205
+end

data/examples/hellowarld/app/views/person.erb ADDED

@@ -0,0 +1,52 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title><%= @person.firstname %> <%= @person.surname %></title>
+    <script src="http://ajax.googleapis.com/ajax/libs/jquery/1.11.1/jquery.min.js"></script>
+    <script>
+$(document).ready(function(){
+  $("#reload").click(function(){
+    $.getJSON("person", function(result) {
+      $("title").text(result.firstname + " " + result.surname);
+    })
+  });
+  $("#firstname").last().click(function(){
+    $.ajax({ url:"person",
+             contentType:"application/json",
+             type:"PATCH",
+             data: '{"firstname":"' + $("#first").val() + '"}',
+             success:function(result){
+    }});
+  });
+  $("#surname").last().click(function(){
+    $.ajax({ url:"person",
+             contentType:"application/json",
+             type:"PATCH",
+             data: '{"surname":"' + $("#sur").val() + '"}',
+             success:function(result){
+    }});
+  });
+});
+    </script>
+  </head>
+  <body>
+    <h1>person</h1>
+    <div>
+      Firstname <input type="text" size="30" id="first" value="<%=@person.firstname %>" /> <button id="firstname">update</button>
+    </div>
+    <div>
+      Surname <input type="text" size="30"  id="sur" value="<%=@person.surname %>" /> <button id="surname">update</button>
+    </div>
+     <button id="reload">update title from server data</button>
+</body>
+</html>

data/examples/hellowarld/config.ru ADDED

@@ -0,0 +1,12 @@
+#\ -s webrick
+$LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__)))
+$LOAD_PATH.unshift($servlet_context.getRealPath("/WEB-INF")) if defined?($servlet_context)
+require 'bundler/setup'
+require 'app/hellowarld'
+map '/' do
+  run Sinatra::Application
+end

data/leafy-complete.gemspec ADDED

@@ -0,0 +1,22 @@
+#-*- mode: ruby -*-
+Gem::Specification.new do |s|
+  s.name = 'leafy-complete'
+  s.version = '0.3.1'
+  s.author = 'Christian Meier'
+  s.email = [ 'christian.meier@lookout.com' ]
+  s.license = 'MIT'
+  s.summary = %q('meta' gem which pulls all the leafy gems)
+  s.homepage = 'https://github.com/lookout/leafy'
+  s.description = %q(this gem has no code only dependencies to all the other leafy gems. it is meant as convenient way to pull in all leafy gems in one go)
+  s.files = ['leafy-complete.gemspec', 'README.md', 'LICENSE']
+  s.add_runtime_dependency 'leafy-metrics', '~> 0.2.0'
+  s.add_runtime_dependency 'leafy-health', '~> 0.2.0'
+  s.add_runtime_dependency 'leafy-rack', '~> 0.2.0'
+  s.add_runtime_dependency 'leafy-logger', '~> 0.2.0'
+end
+# vim: syntax=Ruby

data/leafy-health/.gitignore ADDED

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

data/leafy-health/Gemfile ADDED

@@ -0,0 +1,7 @@
+#-*- mode: ruby -*-
+source 'https://rubygems.org'
+gemspec
+# vim: syntax=Ruby

data/leafy-health/LICENSE ADDED

@@ -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-health/README.md ADDED

@@ -0,0 +1,123 @@
+# Leafy-Health
+## installation
+via rubygems
+```
+gem install leafy-health
+```
+or add to your Gemfile
+```
+gem 'leafy-health'
+```
+installing the gem also takes care of the jar dependencies with jruby-1.7.16+
+## usage
+an instance of the registry ```Leafy::Health::Registry``` can register and unresgister health-checks under a given name. any object with a #call method will do or block on the register method.
+     registry = Leafy::Health::Registry.new
+you can ask the registry which names have already health-checks registered:
+     registry.names
+### simple health check
+simple in the sense that either call returns ```nil``` which means healthy or a message which is the unhealthy state. the message can be any ```String```.
+    registry.register( 'simple.block') do
+      if app.crashed
+        'application crashed'
+      end
+    end
+or with a health-check object
+    class AppCheck < Leafy::Health::HealthCheck
+      def call
+        if app.crashed
+          'application crashed'
+        end
+      end
+    end
+    registry.register( 'simple.class', AppCheck.new )
+### health checks with message on healthy state
+here the call method gets an argument which allows to create both
+healthy and unhealthy states with message.
+    registry.register( 'app.block') do
+      if app.crashed
+        unhealthy( 'application crashed' )
+      else
+        healthy( 'application ok' )
+      end
+    end
+or with a health-check object
+    class AppCheck < Leafy::Health::HealthCheck
+      def call
+        if app.crashed
+          unhealthy( 'application crashed' )
+        else
+          healthy( 'application ok' )
+        end
+      end
+    end
+    registry.register( 'app.class', AppCheck.new )
+### health checks with structural data as message
+    registry.register( 'app.block') do
+      if app.crashed
+        unhealthy( :host => 'localhost', :msg => 'not good' )
+      else
+        healthy( :host => 'localhost', :msg => 'application ok' )
+      end
+    end
+or as health-check object
+    class AppCheck < Leafy::Health::HealthCheck
+      def call
+        if app.crashed
+          unhealthy( :host => 'localhost', :msg => 'application crashed' )
+        else
+          healthy( :host => 'localhost', :msg => 'application ok' )
+        end
+      end
+    end
+    registry.register( 'app.class', AppCheck.new )
+### unregister health checks
+    registry.unregister( 'app.class' )
+### builtin ThreadDeadlockHeathCheck
+    registry.register( 'app.deadlock', Leafy::Health::ThreadDeadlockHeathCheck.new )
+### note
+currently there is not further introspection on the registry and its health-check. with the ```Leafy::Json::HealthWriter``` (from leafy-rack) you can get a json representation of the current **health report**
+    Leafy::Json::HealthWriter.to_json( registry.health )
+## developement
+get all the gems and jars in place
+    gem install jar-dependencies --development
+	bundle install
+for running all specs
+	rake
+or
+    rspec spec/reporter_spec.rb

data/leafy-health/Rakefile ADDED

@@ -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 Health API"]
+end
+task :default => [ :spec ]
+# vim: syntax=Ruby

data/leafy-health/leafy-health.gemspec ADDED

@@ -0,0 +1,27 @@
+#-*- mode: ruby -*-
+require File.expand_path( '../lib/leafy/health/version', __FILE__ )
+Gem::Specification.new do |s|
+  s.name = 'leafy-health'
+  s.version = Leafy::Health::VERSION
+  s.author = 'christian meier'
+  s.email = [ 'christian.meier@lookout.com' ]
+  s.license = 'MIT'
+  s.summary = %q(provides an API to register healthchecks)
+  s.homepage = 'https://github.com/lookout/leafy'
+  s.description = %q(provides an API to register healthchecks which uses dropwizrd-metrics-healthchecks)
+  s.files = `git ls-files`.split($/)
+  s.requirements << 'jar io.dropwizard.metrics:metrics-healthchecks, 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_development_dependency 'rspec', '~> 3.1.0'
+  s.add_development_dependency 'yard', '~> 0.8.7'
+  s.add_development_dependency 'rake', '~> 10.2'
+end
+# vim: syntax=Ruby

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

	@@ -0,0 +1,2 @@
1	+ require 'leafy-health_jars'
2	+ require 'leafy/health/registry'