leafy-metrics 0.4.0-java

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4a8092d5e138c5aad7a59e2e1bc4f9704f437b90
+  data.tar.gz: 7320c95178976b70d9d7996262c092ca4755d1d2
+SHA512:
+  metadata.gz: 3ad6f08dc5230ddd5747ca5b773f8fc500340335727d8504cab2ba64cedbd382c310b81828c3c2ef0c6f2b9b2872518320a5463bb23416b587885345ddb6ce60
+  data.tar.gz: c5090ecf465ee518cde818c2497b9acda135a0153caeee2b7a6c3d9e6630c8a8f5f74087d8e66c3e28a78c79d60849a149525274b182ce11e44b450afeada8b5

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,7 @@
+#-*- mode: ruby -*-
+
+source 'https://rubygems.org'
+
+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,221 @@
+# Leafy-Metrics
+
+## installation
+
+via rubygems
+```
+gem install leafy-metrics
+```
+or add to your Gemfile
+```
+gem 'leafy-metrics'
+```
+
+installing the gem also takes care of the jar dependencies with jruby-1.7.16+
+
+## usage
+
+an instance of the registry ```Leafy::Metrics::Registry``` can register various metrics like gauge, timer, meter, counter and histogram and remove them again.
+
+     registry = Leafy::Metrics::Registry.new
+
+### gauge
+
+it can be other a given block or any object with a #call method returning the gauge - a number
+     
+    registry.register_gauge( 'app.uptime') do
+	  App.uptime
+	end
+
+or with an object
+
+    class UptimeGauge
+	  def call
+	    App.uptime
+      enf
+	end
+	registry.register_gauge( 'app.uptime', UptimeGauge.new )
+
+### timer
+
+a timer can measure the time an block needs to execute:
+
+    timer = registry.register_timer( 'app.timer' )
+	timer.time do
+      App.update_data
+    end
+
+### counter
+
+a counter simply counts i.e. can be incremented or decremented
+
+    counter = registry.register_counter( 'active.users.counter' )
+
+	# one new user logged on
+	counter.inc
+	
+	# three new users logged on
+	counter.inc 3
+	
+    # one user logged off
+    counter.dec
+
+    # two users logged off
+    counter.dec 2
+
+### meter
+
+    used = registry.register_meter( 'app.used' )
+
+mark the occurrence of an event
+
+	used.mark
+
+mark the occurrence of 'n' events
+
+	used.mark n
+
+
+### histogram
+
+measures the distribution of values in a stream of data using an exponentially decaying reservoir
+
+    histogram = registry.register_histogram( 'search.results' )
+    histogram.update( Search.last_result.size )
+
+### remove any metrics
+
+    registry.unregister( 'app.uptime )
+
+### note
+
+currently there is not further introspection on the registry and its health-check. with the ```Leafy::Json::MetricsWriter``` (from leafy-rack) you can get a json representation of the current **metrics report**
+
+    Leafy::Json::MetricsWriter.to_json( registry.metrics )
+
+## reporters
+
+all reporters use a builder pattern. there are following timeunits for
+configuration:
+
+* ```Leafy::Metrics::Reporter::DAYS```
+* ```Leafy::Metrics::Reporter::HOURS```
+* ```Leafy::Metrics::Reporter::MINUTES```
+* ```Leafy::Metrics::Reporter::SECONDS```
+* ```Leafy::Metrics::Reporter::MILLISECONDS```
+* ```Leafy::Metrics::Reporter::MICROSECONDS```
+* ```Leafy::Metrics::Reporter::NANOSECONDS```
+
+in all examples below ```metrics = Leafy::Metrics::Registry.new```
+
+### console reporter
+
+    require 'leafy/metrics/console_reporter'
+    reporter = metrics.reporter_builder( Leafy::Metrics::ConsoleReporter ).build
+	reporter.start( 1, Leafy::Metrics::Reporter::SECONDS )
+	....
+	reporter.stop
+
+or with all the possible configuration
+
+	reporter =  metrics.reporter_builder( Leafy::Metrics::ConsoleReporter )
+	    .convert_rates_to( Leafy::Metrics::Reporter::MILLISECONDS )
+        .convert_durations_to( Leafy::Metrics::Reporter::MILLISECONDS )
+        .output_to( STDERR )
+        .build
+
+or the config via a block
+
+	reporter =  metrics.reporter_builder( Leafy::Metrics::ConsoleReporter ) do
+	  convert_rates_to( Leafy::Metrics::Reporter::MILLISECONDS )
+      convert_durations_to( Leafy::Metrics::Reporter::MILLISECONDS )
+      output_to( STDERR )
+	end.build
+
+### csv reporter
+
+for each metric there will be a CSV file inside a given directory
+
+    require 'leafy/metrics/csv_reporter'
+    reporter = metrics.reporter_builder( Leafy::Metrics::CSVReporter )
+	    .build( 'metrics/directory' )
+	reporter.start( 1, Leafy::Metrics::Reporter::SECONDS )
+	....
+	reporter.stop
+
+or with all possible configuration
+
+	reporter = metrics.reporter_builder( Leafy::Metrics::CSVReporter )
+	    .convert_rates_to( Leafy::Metrics::Reporter::MILLISECONDS )
+        .convert_durations_to( Leafy::Metrics::Reporter::MILLISECONDS )
+        .build( 'metrics/directory' )
+
+or configuration via block
+
+	reporter = metrics.reporter_builder( Leafy::Metrics::CSVReporter ) do
+	  convert_rates_to( Leafy::Metrics::Reporter::MILLISECONDS )
+      convert_durations_to( Leafy::Metrics::Reporter::MILLISECONDS )
+    end.build( 'metrics/directory' )
+
+### graphite reporter
+
+there are three targets where to send the data
+
+* ```Leafy::Metrics::Graphite.new_tcp( hostname, port )```
+* ```Leafy::Metrics::Graphite.new_udp( hostname, port )```
+* ```Leafy::Metrics::Graphite.new_pickled( hostname, port, batchsize )```
+
+the latter is collecting a few report event and sends them as batch. the ```sender``` is one of the above targets.
+
+    require 'leafy/metrics/graphite_reporter'
+    reporter = metrics.reporter_builder( Leafy::Metrics::GraphiteReporter )
+	    .build_tcp( hostname, port )
+	reporter.start( 1, Leafy::Metrics::Reporter::SECONDS )
+	....
+	reporter.stop
+
+or with full configuration
+
+	reporter = metrics.reporter_builder( Leafy::Metrics::GraphiteReporter )
+	    .convert_rates_to( Leafy::Metrics::Reporter::MILLISECONDS )
+        .convert_durations_to( Leafy::Metrics::Reporter::MILLISECONDS )
+		.prefixed_with( 'myapp' )
+        .build( sender )
+
+or with block configuration
+
+	reporter = metrics.reporter_builder( Leafy::Metrics::GraphiteReporter ) do
+	  convert_rates_to( Leafy::Metrics::Reporter::MILLISECONDS )
+      convert_durations_to( Leafy::Metrics::Reporter::MILLISECONDS )
+	  prefixed_with( 'myapp' )
+    end.build_udp( host, port )
+
+### any third party reporter
+
+	reporter = metrics.reporter_builder( com.readytalk.metrics.StatsDReporter ) do
+	  convert_rates_to( Leafy::Metrics::Reporter::MILLISECONDS )
+      convert_durations_to( Leafy::Metrics::Reporter::MILLISECONDS )
+    end.build( host, port )
+
+or using the Java module reference
+
+	reporter = metrics.reporter_builder( Java::ComReadytalkMetrics::StatsDReporter ) do
+	  convert_rates_to( Leafy::Metrics::Reporter::MILLISECONDS )
+      convert_durations_to( Leafy::Metrics::Reporter::MILLISECONDS )
+      prefixed_with( 'app' )
+    end.build( host, port )
+
+## 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/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.gemspec

@@ -0,0 +1,31 @@
+#-*- 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.platform = 'java'
+  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 io.dropwizard.metrics:metrics-jvm, #{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'
+  s.add_development_dependency 'yard', '~> 0.8.7'
+  s.add_development_dependency 'rake', '~> 10.2'
+end
+
+# vim: syntax=Ruby

data/lib/leafy-metrics.rb

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

data/lib/leafy-metrics_jars.rb

@@ -0,0 +1,7 @@
+# this is a generated file, to avoid over-writing it just delete this comment
+require 'jar_dependencies'
+
+require_jar( 'org.slf4j', 'slf4j-api', '1.7.7' )
+require_jar( 'io.dropwizard.metrics', 'metrics-graphite', '3.1.0' )
+require_jar( 'io.dropwizard.metrics', 'metrics-jvm', '3.1.0' )
+require_jar( 'io.dropwizard.metrics', 'metrics-core', '3.1.0' )

data/lib/leafy/metrics.rb

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

data/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/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/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/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/lib/leafy/metrics/jruby_metrics.rb

@@ -0,0 +1,26 @@
+require 'leafy/metrics'
+
+module Leafy
+  module Metrics
+    module JRubyMetrics
+
+      # registers a few thread gauges under the given basename: total.com, executing.count and sleeping.count
+      #
+      # @param [Leafy::Metrics::Registry] where to register the metrics
+      # @param [String] basename
+      def self.register_ruby_thread_state_gauges( registry, name )
+        registry.register_gauge( name + '.total.count' ) do
+          Thread.list.size
+        end
+
+        registry.register_gauge( name + '.executing.count' ) do
+          Thread.list.select { |t| t.status == 'run' }.size
+        end
+
+        registry.register_gauge( name + '.sleeping.count' ) do
+          Thread.list.select { |t| t.status == 'sleep' }.size
+        end
+      end
+    end
+  end
+end

data/lib/leafy/metrics/jvm_metrics.rb

@@ -0,0 +1,43 @@
+require 'leafy/metrics'
+
+module Leafy
+  module Metrics
+    module JvmMetrics
+
+      # registers some buffer pool metrics. more details see https://github.com/dropwizard/metrics/blob/master/metrics-jvm/src/main/java/com/codahale/metrics/jvm/BufferPoolMetricSet.java#L19
+      #
+      # @param [Leafy::Metrics::Registry] where to register the metrics
+      # @param [String] basename
+      def self.register_buffer_pool_metrics( registry, name )
+        # use the same MBenServer as JRuby does
+        registry.register_metric( name, com.codahale.metrics.jvm.BufferPoolMetricSet.new( java.lang.management.ManagementFactory.getPlatformMBeanServer ) )
+      end
+
+      # registers some memory usage gauges. more details see https://github.com/dropwizard/metrics/blob/master/metrics-jvm/src/main/java/com/codahale/metrics/jvm/MemoryUsageGaugeSet.java#L18
+      #
+      # @param [Leafy::Metrics::Registry] where to register the metrics
+      # @param [String] basename
+      def self.register_memory_usage_gauges( registry, name )
+        registry.register_metric( name, com.codahale.metrics.jvm.MemoryUsageGaugeSet.new )
+      end
+
+      # registers some garbage collection metrics. more details see https://github.com/dropwizard/metrics/blob/master/metrics-jvm/src/main/java/com/codahale/metrics/jvm/GarbageCollectorMetricSet.java#L15
+      #
+      # @param [Leafy::Metrics::Registry] where to register the metrics
+      # @param [String] basename
+      def self.register_garbage_collector_metrics( registry, name )
+        registry.register_metric( name, com.codahale.metrics.jvm.GarbageCollectorMetricSet.new )
+      end
+
+      # registers some (java) thread state gauges. more details see https://github.com/dropwizard/metrics/blob/master/metrics-jvm/src/main/java/com/codahale/metrics/jvm/ThreadStatesGaugeSet.java#L18
+      #
+      # @param [Leafy::Metrics::Registry] where to register the metrics
+      # @param [String] basename
+      def self.register_thread_state_gauges( registry, name )
+        registry.register_metric( name, com.codahale.metrics.jvm.ThreadStatesGaugeSet.new )
+      end
+
+      # TODO not sure about the FileDescriptorRatioGauge and ClassLoadingGaugeSet
+    end
+  end
+end

data/lib/leafy/metrics/registry.rb

@@ -0,0 +1,112 @@
+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 register_metric( name, metric )
+        @metrics.register( name, metric )
+      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/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/lib/leafy/metrics/version.rb

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

data/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/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

data/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/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/spec/jruby_metrics_spec.rb

@@ -0,0 +1,20 @@
+require_relative 'setup'
+require 'leafy/metrics/registry'
+require 'leafy/metrics/jruby_metrics'
+
+describe Leafy::Metrics::JRubyMetrics do
+
+  subject do
+    r = Leafy::Metrics::Registry.new
+    Leafy::Metrics::JRubyMetrics.register_ruby_thread_state_gauges( r, 'test' )
+    r
+  end
+
+  it 'registers and unregister a meter' do
+
+    expect( subject.metrics.gauges['test.total.count'].value ).to eq 1
+    expect( subject.metrics.gauges['test.executing.count'].value ).to eq 1
+    expect( subject.metrics.gauges['test.sleeping.count'].value ).to eq 0
+
+  end
+end

data/spec/jvm_metrics_spec.rb

@@ -0,0 +1,79 @@
+require_relative 'setup'
+require 'leafy/metrics/registry'
+require 'leafy/metrics/jvm_metrics'
+
+describe Leafy::Metrics::JvmMetrics do
+
+  let(:registry) { Leafy::Metrics::Registry.new }
+
+  describe "register_thread_state_gauges" do
+  
+    before do
+      Leafy::Metrics::JvmMetrics.register_thread_state_gauges( registry, 'test' )
+    end
+
+    it 'registers gauges' do
+      
+      expect( registry.metrics.names.to_a ).to include( *["test.blocked.count", "test.count", "test.daemon.count", "test.deadlock.count", "test.deadlocks", "test.new.count", "test.runnable.count", "test.terminated.count", "test.timed_waiting.count", "test.waiting.count"] )
+    end
+
+    it 'follows changes in thread counts' do
+      
+      total = registry.metrics.gauges['test.count'].value
+      
+      t = Thread.new do
+        Thread.current[:running] = true
+        while( Thread.current[:running] ) do
+          sleep 0.1
+        end
+      end
+
+      expect( registry.metrics.gauges['test.count'].value ).to eq total + 1
+      
+      t[:running] = false
+      sleep 0.1
+      t.join
+
+      expect( registry.metrics.gauges['test.count'].value ).to eq total
+    end
+  end
+
+  describe "register_memory_usage_gauges" do
+  
+    before do
+      Leafy::Metrics::JvmMetrics.register_memory_usage_gauges( registry, 'test' )
+    end
+
+    it 'registers gauges' do
+      
+      expect( registry.metrics.names.to_a ).to include( *["test.heap.committed", "test.heap.init", "test.heap.max", "test.heap.usage", "test.heap.used", "test.non-heap.committed", "test.non-heap.init", "test.non-heap.max", "test.non-heap.usage", "test.non-heap.used", "test.total.committed", "test.total.init", "test.total.max", "test.total.used"] )
+      
+    end
+  end
+
+  describe "register_buffer_pool_metrics" do
+  
+    before do
+      Leafy::Metrics::JvmMetrics.register_buffer_pool_metrics( registry, 'test' )
+    end
+
+    it 'registers metrics' do
+      
+      expect( registry.metrics.names.to_a ).to include( *["test.direct.capacity", "test.direct.count", "test.direct.used", "test.mapped.capacity", "test.mapped.count", "test.mapped.used"] )
+      
+    end
+  end
+
+  describe "register_garbage_collector_metrics" do
+  
+    before do
+      Leafy::Metrics::JvmMetrics.register_garbage_collector_metrics( registry, 'test' )
+    end
+
+    it 'registers metrics' do
+      
+      expect( registry.metrics.names.to_a ).to include( *["test.PS-MarkSweep.count", "test.PS-MarkSweep.time", "test.PS-Scavenge.count", "test.PS-Scavenge.time"] )
+      
+    end
+  end
+end

data/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/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' )

metadata

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification
+name: leafy-metrics
+version: !ruby/object:Gem::Version
+  version: 0.4.0
+platform: java
+authors:
+- christian meier
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2015-04-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.1.8
+  name: jar-dependencies
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.1.8
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  name: rspec
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.7
+  name: yard
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.7
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.2'
+  name: rake
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.2'
+description: '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'
+email:
+- christian.meier@lookout.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- leafy-metrics.gemspec
+- lib/leafy-metrics.rb
+- lib/leafy-metrics_jars.rb
+- lib/leafy/metrics.rb
+- lib/leafy/metrics/console_reporter.rb
+- lib/leafy/metrics/csv_reporter.rb
+- lib/leafy/metrics/graphite/graphite.rb
+- lib/leafy/metrics/graphite/graphite_reporter.rb
+- lib/leafy/metrics/jruby_metrics.rb
+- lib/leafy/metrics/jvm_metrics.rb
+- lib/leafy/metrics/registry.rb
+- lib/leafy/metrics/reporter.rb
+- lib/leafy/metrics/version.rb
+- spec/console_reporter_spec.rb
+- spec/csv_reporter_spec.rb
+- spec/graphite_reporter_spec.rb
+- spec/graphite_spec.rb
+- spec/jruby_metrics_spec.rb
+- spec/jvm_metrics_spec.rb
+- spec/registry_spec.rb
+- spec/setup.rb
+homepage: https://github.com/lookout/leafy
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements:
+- jar io.dropwizard.metrics:metrics-core, 3.1.0
+- jar io.dropwizard.metrics:metrics-graphite, 3.1.0
+- jar io.dropwizard.metrics:metrics-jvm, 3.1.0
+- jar org.slf4j, slf4j-simple, 1.7.7, :scope => :test
+rubyforge_project:
+rubygems_version: 2.4.5
+signing_key:
+specification_version: 4
+summary: provide an API to register metrics
+test_files: []
+has_rdoc: