leafy-rack 0.3.0 → 0.3.1

data/leafy-metrics/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 Metrics API"]
+end
+
+task :default => [ :spec ]
+
+# vim: syntax=Ruby

data/leafy-metrics/leafy-metrics.gemspec

@@ -0,0 +1,29 @@
+#-*- mode: ruby -*-
+
+require File.expand_path( '../lib/leafy/metrics/version', __FILE__ )
+
+Gem::Specification.new do |s|
+  s.name = 'leafy-metrics'
+  s.version = Leafy::Metrics::VERSION
+  s.author = 'christian meier'
+  s.email = [ 'christian.meier@lookout.com' ]
+  
+  s.license = 'MIT'
+  s.summary = %q(provide an API to register metrics)
+  s.homepage = 'https://github.com/lookout/leafy'
+  s.description = %q(provides an API to register metrics like meters, timers, gauge, counter using dropwizard-metrics. it also allows to setup reporters: console-reporter, csv-reporter and graphite-reporter)
+  
+  s.files = `git ls-files`.split($/)
+
+  METRICS_VERSION = '3.1.0'
+  s.requirements << "jar io.dropwizard.metrics:metrics-core, #{METRICS_VERSION}"
+  s.requirements << "jar io.dropwizard.metrics:metrics-graphite, #{METRICS_VERSION}"
+  s.requirements << "jar org.slf4j, slf4j-simple, 1.7.7, :scope => :test"
+
+  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-metrics/lib/leafy-metrics.rb

@@ -0,0 +1,2 @@
+require 'leafy-metrics_jars'
+require 'leafy/metrics/registry'

data/leafy-metrics/lib/leafy-metrics_jars.rb

@@ -0,0 +1,5 @@
+require 'jar_dependencies'
+
+require_jar( 'io.dropwizard.metrics', 'metrics-graphite', '3.1.0' )
+require_jar( 'org.slf4j', 'slf4j-api', '1.7.7' )
+require_jar( 'io.dropwizard.metrics', 'metrics-core', '3.1.0' )

data/leafy-metrics/lib/leafy/metrics.rb

@@ -0,0 +1,2 @@
+require 'leafy-metrics_jars'
+require 'leafy/metrics/registry'

data/leafy-metrics/lib/leafy/metrics/console_reporter.rb

@@ -0,0 +1,32 @@
+require 'leafy/metrics/reporter'
+
+java_import com.codahale.metrics.ConsoleReporter
+
+module Leafy
+  module Metrics
+    class ConsoleReporter < Reporter
+
+      class Builder < Reporter::Builder
+        def initialize( metrics )
+          super( ::ConsoleReporter, metrics )
+        end
+        
+        def output_to( io )
+          # IO objects in jruby do have a to_outputstream method
+          @io = java.io.PrintStream.new( io.to_outputstream )
+          @builder.output_to( @io )
+          self
+        end
+        
+        def build
+          Reporter.new( @builder.build )
+        end
+      end
+
+      def self.for_registry( metrics )
+        Builder.new( metrics )
+      end
+    end
+  end
+end
+

data/leafy-metrics/lib/leafy/metrics/csv_reporter.rb

@@ -0,0 +1,26 @@
+require 'leafy/metrics/reporter'
+
+java_import com.codahale.metrics.CsvReporter
+
+module Leafy
+  module Metrics
+    class CSVReporter < Reporter
+
+      class Builder < Reporter::Builder
+        def initialize( metrics )
+          super( ::CsvReporter, metrics )
+        end
+        
+        def build( directory )
+          directory = java.io.File.new( directory )
+          Reporter.new( @builder.build( directory ) )
+        end
+      end
+
+      def self.for_registry( metrics )
+        Builder.new( metrics )
+      end
+    end
+  end
+end
+

data/leafy-metrics/lib/leafy/metrics/graphite/graphite.rb

@@ -0,0 +1,28 @@
+module Leafy
+  module Metrics
+    class Graphite
+
+      attr_reader :sender
+
+      def initialize( sender )
+        unless sender.java_kind_of? Java::ComCodahaleMetricsGraphite::GraphiteSender
+          raise "not instance of 'Java::ComCodahaleMetricsGraphite::Graphite'"
+        end
+        @sender = sender
+      end
+  
+      def self.new_tcp( hostname, port )
+        new com.codahale.metrics.graphite.Graphite.new( hostname, port )
+      end
+
+      def self.new_udp( hostname, port )
+        new com.codahale.metrics.graphite.GraphiteUDP.new( hostname, port )
+      end
+
+      def self.new_pickled( hostname, port, batchsize )
+        new com.codahale.metrics.graphite.PickledGraphite.new( hostname, port, batchsize )
+      end
+    end
+  end
+end
+

data/leafy-metrics/lib/leafy/metrics/graphite/graphite_reporter.rb

@@ -0,0 +1,43 @@
+require 'leafy/metrics/reporter'
+require 'leafy/metrics/graphite/graphite'
+
+java_import com.codahale.metrics.graphite.GraphiteReporter
+
+module Leafy
+  module Metrics
+    class GraphiteReporter < Reporter
+
+      class Builder < Reporter::Builder
+        def initialize( metrics )
+          super( ::GraphiteReporter, metrics )
+        end
+        
+        def prefixed_with( prefix )
+          @builder.prefixed_with( prefix )
+          self
+        end
+
+        def build( graphite )
+          Reporter.new( @builder.build( graphite.sender ) )
+        end
+
+        def build_tcp( host, port )
+          build( Leafy::Metrics::Graphite.new_tcp( host, port ) )
+        end
+
+        def build_udp( host, port )
+          build( Leafy::Metrics::Graphite.new_udp( host, port ) )
+        end
+
+        def build_pickled( host, port )
+          build( Leafy::Metrics::Graphite.new_pickled( host, port ) )
+        end
+      end
+
+      def self.for_registry( metrics )
+        Builder.new( metrics )
+      end
+    end
+  end
+end
+

data/leafy-metrics/lib/leafy/metrics/registry.rb

@@ -0,0 +1,108 @@
+require 'leafy/metrics'
+module Leafy
+  module Metrics
+
+    class Gauge
+      include com.codahale.metrics.Gauge
+    end
+
+    class Registry
+
+      class Timer
+
+        attr_reader :timer
+
+        def initialize( timer )
+          @timer = timer
+        end
+        
+        def time( &block )
+          context = @timer.time
+          
+          yield
+          
+        ensure
+          context.stop
+        end
+      end
+      
+      class GaugeWrapper < Leafy::Metrics::Gauge
+        
+        def initialize( block )
+          @block = block
+        end
+        
+        def value
+          @block.call
+        end
+      end
+
+      # state ofthe registry
+      attr_reader :metrics
+      
+      def initialize
+        @metrics = com.codahale.metrics.MetricRegistry.new
+      end
+      
+      # register a gauge under a given name
+      # 
+      # @param [String] name
+      # @param [String] instead of block any gauge object which responds to 'call'
+      # @yieldreturn [Object] can be any object like Fixnum, String, Float
+      # @return [MetricsRegistry::Gauge] gauge object which has a 'value' method to retrieve the current value
+      def register_gauge( name, gauge = nil, &block )
+        if gauge and not block_given? and gauge.respond_to? :call
+          @metrics.register( name, GaugeWrapper.new( gauge ) )
+        elsif gauge and not block_given? and gauge.kind_of? com.codahale.metrics.Gauge
+          @metrics.register( name, gauge )
+        elsif gauge.nil? and block_given?
+          @metrics.register( name, GaugeWrapper.new( block ) )
+        else
+          raise 'needs either a block and object with call method'
+        end
+      end
+      
+      # register a meter under a given name
+      # 
+      # @param [String] name
+      # @return [Java::ComCodahaleMetrics::Meter] meter object which has a 'mark' method to mark the meter
+      def register_meter( name )
+        @metrics.meter( name )
+      end
+      
+      # register a counter under a given name
+      # 
+      # @param [String] name
+      # @return [Java::ComCodahaleMetrics::Counter] counter object which has an 'inc' and 'dec' method
+      def register_counter( name )
+        @metrics.counter( name )
+      end
+      
+      # register a timer under a given name
+      # 
+      # @param [String] name
+      # @return [Java::ComCodahaleMetrics::Timer] timer object which has an 'context' method which starts the timer. the context has a 'stop' method to stop it.
+      def register_timer( name )
+        Timer.new( @metrics.timer( name ) )
+      end
+      
+      # register a histogram under a given name
+      # 
+      # @param [String] name
+      # @return [Java::ComCodahaleMetrics::Counter] histogram object which has an 'update' method
+      def register_histogram( name )
+        @metrics.histogram( name )
+      end
+
+      def remove( name )
+        @metrics.remove( name )
+      end
+
+      def reporter_builder( clazz, &block )
+        r = clazz.for_registry( @metrics )
+        r.instance_eval( &block ) if block
+        r
+      end
+    end
+  end
+end

data/leafy-metrics/lib/leafy/metrics/reporter.rb

@@ -0,0 +1,51 @@
+require 'leafy/metrics/registry'
+
+java_import java.util.concurrent.TimeUnit;
+
+module Leafy
+  module Metrics
+    class Reporter
+      # copy the TimeUnit constants
+      TimeUnit.constants.each do |c|
+        const_set( c, TimeUnit.const_get( c ) )
+      end
+
+      def initialize( reporter )
+        @reporter = reporter
+      end
+
+      def start( period, time_unit )
+        @reporter.start( period, time_unit )
+      end
+
+      def stop
+        @reporter.stop
+      end
+
+      def report
+        @reporter.report
+      end
+
+      class Builder
+        def initialize( reporter_class, metrics )
+          # stay backward compatible
+          # FIXME remove for first proper release
+          metrics = metrics.metrics if metrics.is_a?( Leafy::Metrics::Registry )
+          @builder = reporter_class.for_registry( metrics )
+          self
+        end
+        
+        def convert_rates_to( time_unit )
+          @builder.convert_rates_to( time_unit )
+          self
+        end
+        
+        def convert_durations_to( time_unit )
+          @builder.convert_durations_to( time_unit )
+          self
+        end
+      end
+    end
+  end
+end
+

data/leafy-metrics/lib/leafy/metrics/version.rb

@@ -0,0 +1,6 @@
+module Leafy
+  module Metrics
+    VERSION = '0.3.1'.freeze
+  end
+end
+

data/leafy-metrics/spec/console_reporter_spec.rb

@@ -0,0 +1,72 @@
+require_relative 'setup'
+require 'leafy/metrics/console_reporter'
+
+describe Leafy::Metrics::ConsoleReporter do
+
+  subject { Leafy::Metrics::ConsoleReporter }
+
+  let( :metrics ) { Leafy::Metrics::Registry.new }
+  let( :requests ) { metrics.register_meter( "requests" ) }
+
+  it 'run reporter with defaults' do
+    old_out = java.lang.System.out
+    bytes = StringIO.new
+    java.lang.System.out = java.io.PrintStream.new( bytes.to_outputstream )
+    begin
+      reporter = metrics.reporter_builder( subject ).build
+      requests.mark
+      reporter.start( 10, Leafy::Metrics::Reporter::MILLISECONDS )
+      sleep 0.02
+      reporter.stop
+      result = bytes.string.gsub( /\n/m, '')
+      expect( result ).to match /count = 1/
+      expect( result ).to match /second/
+    ensure
+      java.lang.System.out = old_out
+      reporter.stop if reporter
+    end
+  end
+
+  it 'run reporter via builder config' do
+    bytes = StringIO.new
+    begin
+      reporter = metrics.reporter_builder( subject )
+        .convert_rates_to( Leafy::Metrics::Reporter::MILLISECONDS )
+        .convert_durations_to( Leafy::Metrics::Reporter::MILLISECONDS )
+        .output_to( bytes )
+        .build
+
+      requests.mark
+      reporter.start( 10, Leafy::Metrics::Reporter::MILLISECONDS )
+      sleep 0.02
+      reporter.stop
+      result = bytes.string.gsub( /\n/m, '')
+      expect( result ).to match /count = 1/
+      expect( result ).to match /millisecond/
+    ensure
+      reporter.stop if reporter
+    end
+  end
+
+  it 'run reporter via block config' do
+    bytes = StringIO.new
+    begin
+      reporter = metrics.reporter_builder( subject ) do
+        convert_rates_to( Leafy::Metrics::Reporter::MILLISECONDS )
+        convert_durations_to( Leafy::Metrics::Reporter::MILLISECONDS )
+        output_to( bytes )
+      end.build
+
+      requests.mark
+      reporter.start( 10, Leafy::Metrics::Reporter::MILLISECONDS )
+      sleep 0.02
+      reporter.stop
+      result = bytes.string.gsub( /\n/m, '')
+      expect( result ).to match /count = 1/
+      expect( result ).to match /millisecond/
+    ensure
+      reporter.stop if reporter
+    end
+  end
+
+end

data/leafy-metrics/spec/csv_reporter_spec.rb

@@ -0,0 +1,75 @@
+require_relative 'setup'
+require 'leafy/metrics/csv_reporter'
+require 'fileutils'
+
+describe Leafy::Metrics::CSVReporter do
+
+  subject { Leafy::Metrics::CSVReporter }
+
+  let( :metrics ) { Leafy::Metrics::Registry.new }
+  let( :requests ) { metrics.register_meter( "requests" ) }
+  let( :csvfile ) { File.expand_path( File.dirname( __FILE__ ) ) + "/tmp/requests.csv" }
+  let( :tmpdir ) do
+    dir = File.expand_path( File.dirname( csvfile ) )
+    FileUtils.mkdir_p( dir )
+    FileUtils.rm_f( csvfile )
+    dir
+  end
+  
+  it 'run reporter with defaults' do
+    begin
+      reporter = metrics.reporter_builder( subject ).build( tmpdir )
+      requests.mark
+      reporter.start( 10, Leafy::Metrics::Reporter::MILLISECONDS )
+      sleep 0.02
+      reporter.stop
+      result = File.read( csvfile )
+      expect( result ).to match /t,count,mean_rate,m1_rate,m5_rate,m15_rate,rate_unit/
+      expect( result ).to match /second/
+    ensure
+      FileUtils.rm_rf( tmpdir )
+      reporter.stop if reporter
+    end
+  end
+
+  it 'run reporter via builder config' do
+    begin
+      reporter = metrics.reporter_builder( subject )
+        .convert_rates_to( Leafy::Metrics::Reporter::MILLISECONDS )
+        .convert_durations_to( Leafy::Metrics::Reporter::MILLISECONDS )
+        .build( tmpdir )
+
+      requests.mark
+      reporter.start( 10, Leafy::Metrics::Reporter::MILLISECONDS )
+      sleep 0.02
+      reporter.stop
+      result = File.read( csvfile )
+      expect( result ).to match /t,count,mean_rate,m1_rate,m5_rate,m15_rate,rate_unit/
+      expect( result ).to match /second/
+    ensure
+      FileUtils.rm_rf( tmpdir )
+      reporter.stop if reporter
+    end
+  end
+
+  it 'run reporter via block config' do
+    begin
+      reporter = metrics.reporter_builder( subject ) do
+        convert_rates_to( Leafy::Metrics::Reporter::MILLISECONDS )
+        convert_durations_to( Leafy::Metrics::Reporter::MILLISECONDS )
+      end.build( tmpdir )
+
+      requests.mark
+      reporter.start( 10, Leafy::Metrics::Reporter::MILLISECONDS )
+      sleep 0.02
+      reporter.stop
+      result = File.read( csvfile )
+      expect( result ).to match /t,count,mean_rate,m1_rate,m5_rate,m15_rate,rate_unit/
+      expect( result ).to match /second/
+    ensure
+      FileUtils.rm_rf( tmpdir )
+      reporter.stop if reporter
+    end
+  end
+
+end