metrics-java 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in metrics-java.gemspec
+gemspec

data/README.md

@@ -0,0 +1,41 @@
+# Metrics
+
+This is a primitive JRuby wrapper around [Coda Hale's Metrics library](https://github.com/codahale/metrics). It is very incomplete and still a work in progress. Feedback is appreciated.
+
+# How to Use
+
+Somewhere during the initialization of your app, you should set the name of your app. If you do not, it will default to "MyProject"
+
+```ruby
+MetricsJ.app_name = "Foo App"
+```
+
+You can view the metrics that your app is collecting by running `jconsole` from the command line. Select your JRuby app and navigate to the "MBeans" tab.
+
+## Meters
+
+```ruby
+class Foo
+  extend MetricsJ::Meter
+
+  meter :bar
+
+  def baz
+    bar_meter.mark
+    # Do something...
+  end
+
+end
+```
+
+# Todo
+
+Most everything, still:
+
+- Gauges
+- Counters
+- Histograms
+- Timers
+- Health Checks
+
+In addition, there will be a Rails and a Sinatra/Padrino plugin that will hopefully hide most of these details.

data/Rakefile

@@ -0,0 +1,19 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+
+require 'rspec'
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+desc "Run Specs"
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern    = "spec/**/*_spec.rb"
+  spec.verbose    = true
+  spec.rspec_opts = ['--color']
+end
+
+task :consumer_email => :build do
+  require 'exact_target/version'
+
+  `cp pkg/exact_target-#{ExactTarget::VERSION}.gem ../consumer_email/vendor/cache/`
+end

data/lib/metrics-java.rb

@@ -0,0 +1,41 @@
+Dir[ File.join(File.expand_path(__FILE__), '../metrics-java/jars/*.jar') ].each { |fi| require fi }
+
+require 'slf4j'
+require 'metrics-java/jars/log4j-1.2.16.jar'
+require 'metrics-java/jars/metrics-core-3.0.0-SNAPSHOT.jar'
+require 'metrics-java/jars/metrics-log4j-3.0.0-SNAPSHOT.jar'
+
+require 'metrics-java/meter'
+require 'metrics-java/version'
+
+module MetricsJ
+  java_import 'java.util.concurrent.TimeUnit'
+  java_import 'com.yammer.metrics.Metrics'
+  java_import 'com.yammer.metrics.core.MetricName'
+
+  class << self
+    attr_accessor :app_name
+
+    def app_name
+      @app_name || "MyProject"
+    end
+
+    def time_unit_seconds
+      TimeUnit::SECONDS
+    end
+
+    # @param [String] group
+    # @param [String] type
+    # @param [String] name
+    # @param [optional, String] scope
+    # @return [com.yammer.metrics.core.MetricName]
+    def create_metric_name(group, type, name, scope=nil)
+      if scope
+        MetricName.new(group, type, name, scope)
+      else
+        MetricName.new(group, type, name)
+      end
+    end
+  end
+
+end

data/lib/metrics-java/base_mixin.rb

@@ -0,0 +1,24 @@
+require 'metrics-java'
+
+module MetricsJ
+  module BaseMixin
+    attr_writer   :metric_group, :metric_type
+    attr_accessor :metric_name
+
+    # @return [String] The group name to use for the metrics being collected
+    def metric_group
+      @metric_group ||= MetricsJ.app_name
+    end
+
+    # @return [String] The group name to use for the metrics being collected
+    def metric_type
+      @metrics_type ||= self.name
+    end
+
+    # @return [com.yammer.metrics.core.MetricName] The MetricName that describes where the Metric data lives in JMX
+    # @see MetricsJ.create_metric_name
+    def metric_name
+      @metric_name ||= MetricsJ.create_metric_name(metric_group, metric_type, metric_name)
+    end
+  end
+end

data/lib/metrics-java/meter.rb

@@ -0,0 +1,39 @@
+require 'metrics-java'
+require 'metrics-java/base_mixin'
+
+module MetricsJ
+  module Meter
+    java_import 'java.util.concurrent.TimeUnit'
+    java_import 'com.yammer.metrics.Metrics'
+
+    def self.extended(base)
+      base.instance_exec {
+        extend  MetricsJ::BaseMixin
+        include MetricsJ::Meter::InstanceMethods
+      }
+    end
+
+    # @param [Symbol, String] meter_name The name of the meter
+    # @return [com.yammer.metrics.core.MetricName] The MetricName that describes where the Metric data lives in JMX
+    # @see MetricsJ.create_metric_name
+    def meter(meter_name)
+      scoped_name = "#{meter_name}_meter"
+      metric_name = MetricsJ.create_metric_name(metric_group, metric_type, meter_name.to_s)
+
+      new_meter = Metrics.new_meter(metric_name, meter_name.to_s, MetricsJ.time_unit_seconds)
+
+      define_method(scoped_name) { new_meter }
+
+      new_meter
+    end
+
+    def meters(*meter_names)
+      meter_names.map!{ |meter_name| meter(meter_name) }
+    end
+
+    module InstanceMethods
+      # @todo
+    end
+
+  end
+end

data/lib/metrics-java/version.rb

@@ -0,0 +1,3 @@
+module MetricsJ
+  VERSION = "0.0.1"
+end

data/metrics-java.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "metrics-java/version"
+
+Gem::Specification.new do |s|
+  s.name        = "metrics-java"
+  s.version     = MetricsJ::VERSION
+  s.authors     = ["Scott Gonyea"]
+  s.email       = ["sgonyea@truecar.com"]
+  s.homepage    = ""
+  s.summary     = %q{JRuby wrapper around Coda's Metrics Library}
+  s.description = %q{A JRuby wrapper around Coda Hale's Metrics Library}
+
+  s.rubyforge_project = "metrics-java"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_runtime_dependency "slf4j"
+
+  s.add_development_dependency "rspec"
+end

data/spec/metrics-java/lib/metrics-java/meter_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+describe MetricsJ::Meter do
+  class MeterTest
+    extend MetricsJ::Meter
+
+    meter :foo
+    meters :baz, 'bar'
+  end
+
+  context "DSL" do
+    describe '.meter' do
+      it "should expose instance methods" do
+        meter_test = MeterTest.new
+
+        meter_test.foo_meter.should be_a com.yammer.metrics.core.Meter
+      end
+    end
+
+    describe '.meters' do
+      it "should expose instance methods" do
+        meter_test = MeterTest.new
+
+        meter_test.baz_meter.should be_a com.yammer.metrics.core.Meter
+        meter_test.bar_meter.should be_a com.yammer.metrics.core.Meter
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+require 'bundler/setup'
+
+Bundler.require :default, :development, :test
+
+require 'metrics-java'
+
+# Pull in the support files
+Dir[ Bundler.root.join("spec/support/**/*.rb") ].each{|f| require f}
+
+RSpec.configure do |c|
+  c.include CustomMatchers
+end

data/spec/support/custom_matchers.rb

@@ -0,0 +1,54 @@
+module CustomMatchers
+  class BeWellFormed
+    attr_writer :errors
+
+    def errors
+      @errors ||= []
+    end
+
+    def matches?(files)
+      self.errors = files.dup
+
+      errors.map! do |filename|
+        file = File.read(filename).encode!("UTF-8")
+
+        next unless file.valid_encoding?
+
+        [ check_for_tabs(filename, file), excessive_spacing(filename, file), newline_precedes_eof(filename, file) ]
+      end
+
+      errors.flatten!
+      errors.compact!
+
+      errors.empty?
+    end
+
+    def failure_message_for_should
+      errors.join("\n")
+    end
+
+    def check_for_tabs(filename, file)
+      bad_lines = file.lines.each_with_index.map do |line, line_no|
+                    line_no + 1 if line["\t"] and line !~ /^\s+#.*\s+\n$/
+                  end.flatten.compact
+
+      "#{filename} has tab characters on lines #{bad_lines.join(', ')}" if bad_lines.any?
+    end
+
+    def excessive_spacing(filename, file)
+      bad_lines = file.lines.each_with_index.map do |line, line_no|
+                    line_no + 1 if line =~ /\s+\n$/ and line !~ /^\s+#.*\s+\n$/
+                  end.flatten.compact
+
+      "#{filename} has spaces on the EOL on lines #{bad_lines.join(', ')}" if bad_lines.any?
+    end
+
+    def newline_precedes_eof(filename, file)
+      "#{filename} does not have a newline (\\n) before EOF" if file !~ /\n$/
+    end
+  end
+
+  def be_well_formed
+    BeWellFormed.new
+  end
+end

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification 
+name: metrics-java
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.0.1
+platform: ruby
+authors: 
+  - Scott Gonyea
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-03-25 00:00:00 Z
+dependencies: 
+  - !ruby/object:Gem::Dependency 
+    name: slf4j
+    prerelease: false
+    requirement: &id001 !ruby/object:Gem::Requirement 
+      none: false
+      requirements: 
+        - - ">="
+          - !ruby/object:Gem::Version 
+            version: "0"
+    type: :runtime
+    version_requirements: *id001
+  - !ruby/object:Gem::Dependency 
+    name: rspec
+    prerelease: false
+    requirement: &id002 !ruby/object:Gem::Requirement 
+      none: false
+      requirements: 
+        - - ">="
+          - !ruby/object:Gem::Version 
+            version: "0"
+    type: :development
+    version_requirements: *id002
+description: A JRuby wrapper around Coda Hale's Metrics Library
+email: 
+  - sgonyea@truecar.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+  - .gitignore
+  - Gemfile
+  - README.md
+  - Rakefile
+  - lib/metrics-java.rb
+  - lib/metrics-java/base_mixin.rb
+  - lib/metrics-java/jars/log4j-1.2.16.jar
+  - lib/metrics-java/jars/metrics-core-3.0.0-SNAPSHOT.jar
+  - lib/metrics-java/jars/metrics-log4j-3.0.0-SNAPSHOT.jar
+  - lib/metrics-java/meter.rb
+  - lib/metrics-java/version.rb
+  - metrics-java.gemspec
+  - spec/metrics-java/lib/metrics-java/meter_spec.rb
+  - spec/spec_helper.rb
+  - spec/support/custom_matchers.rb
+homepage: ""
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+  - lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+requirements: []
+
+rubyforge_project: metrics-java
+rubygems_version: 1.8.9
+signing_key: 
+specification_version: 3
+summary: JRuby wrapper around Coda's Metrics Library
+test_files: 
+  - spec/metrics-java/lib/metrics-java/meter_spec.rb
+  - spec/spec_helper.rb
+  - spec/support/custom_matchers.rb