ostrich-jruby 2.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a5501e591147820c321e0b7e44c807f431664f66
+  data.tar.gz: 76fabcc57352345790b7e6b5ac9a265ac08f85fa
+SHA512:
+  metadata.gz: 5365b0eb50c41dd1e13063191f919a8c2774ad7719ca63a99a82e5dfdd9fadd5e8ecd25ad54d1548cea8d82a8b618c6b7653d543fdcaefee72191fe9b4ec450b
+  data.tar.gz: 3db43bca39f2197d98dd1d3669f56a7b01fcf9c3b644626e5c04e2b3744b6698f57e17619621a15b9189acf90bbd674d566cf78f661d29eeb1ee5b6d4f900f3c

data/Gemfile

@@ -0,0 +1,23 @@
+source "http://gems.local.twitter.com"
+
+group :development, :test do
+  gem "rake"
+  gem "jbundler"
+
+  # necessary for development because jbundler
+  # doesn't bootstrap our environment properly
+  load 'ostrich-jruby.gemspec'
+
+  require 'jbundler/classpath_file'
+  JBundler::ClasspathFile.new.require_classpath
+
+  require 'ostrich-jruby'
+end
+
+group :test do
+  gem 'rspec', '~> 2.11.0'
+  gem 'rr',    '~> 1.0.4'
+  gem 'grape', '~> 0.11.0'
+  gem 'json'
+  gem 'rack-test'
+end

data/Rakefile

@@ -0,0 +1,18 @@
+# encoding: UTF-8
+
+require 'rubygems' unless ENV['NO_RUBYGEMS']
+
+require 'bundler'
+require 'digest'
+
+require 'rubygems/package_task'
+require 'rspec/core/rake_task'
+
+Bundler::GemHelper.install_tasks
+
+task :default => :spec
+
+desc 'Run specs'
+RSpec::Core::RakeTask.new do |t|
+  t.pattern = './spec/**/*_spec.rb'
+end

data/lib/ostrich-jruby.rb

@@ -0,0 +1,12 @@
+module Ostrich
+  autoload :Stats,          "ostrich-jruby/stats"
+  autoload :CommandHandler, "ostrich-jruby/command_handler"
+  autoload :GrapeEndpoint,  "ostrich-jruby/grape_endpoint"
+end
+
+require "java"
+require "ostrich-jruby/util"
+
+require "ostrich-jruby/ext/hash"
+require "ostrich-jruby/scala/functions"
+require "ostrich-jruby/scala/kernel"

data/lib/ostrich-jruby/command_handler.rb

@@ -0,0 +1,41 @@
+# https://github.com/twitter/ostrich/blob/master/src/main/scala/com/twitter/ostrich/admin/CommandHandler.scala
+module Ostrich
+  class CommandHandler
+
+    attr_reader :handler
+
+    DEFAULT_MIN_DURATION = Util::Duration.from_seconds(60)
+
+    def initialize(stats_collection, min_period = DEFAULT_MIN_DURATION)
+      @handler = handler_class.new(nil, stats_collection, min_period)
+    end
+
+    %w(ping stats).each do |command|
+      define_method(command.to_sym) do |parameters = {}, format = :json|
+        execute(command.to_s, parameters, format)
+      end
+    end
+
+    private
+
+    def execute(command, parameters, format)
+      handler.apply(command, parameters.to_scala, format_obj_for(format))
+    end
+
+    def handler_class
+      com.twitter.ostrich.admin.CommandHandler
+    end
+
+    def format_obj_for(symbol)
+      java_sym = case symbol
+        when :txt then :PlainText
+        when :json then :Json
+        else
+          raise "Invalid format"
+      end
+
+      companion(com.twitter.ostrich.admin, :Format, java_sym)
+    end
+
+  end
+end

data/lib/ostrich-jruby/ext/hash.rb

@@ -0,0 +1,9 @@
+class Hash
+  def to_scala
+    Java::Scala.collection.mutable::HashMap.new.tap do |map|
+      each_pair do |key, val|
+        map.put(key, val)
+      end
+    end
+  end
+end

data/lib/ostrich-jruby/grape_endpoint.rb

@@ -0,0 +1,22 @@
+require 'grape'
+
+module Ostrich
+  class GrapeEndpoint < Grape::API
+
+    # let Ostrich handle the formatting for json (just return the string)
+    content_type :json, "application/json"
+    formatter :json, lambda { |object, env| object }
+
+    default_format :json
+
+    desc "Get stats from ostrich." do
+      named: 'stats'
+    end
+
+    get :stats do
+      handler = Ostrich::CommandHandler.new(Ostrich::Stats.collection)
+      handler.stats(params, params[:format].to_sym)
+    end
+
+  end
+end

data/lib/ostrich-jruby/scala/functions.rb

@@ -0,0 +1,21 @@
+module Scala
+  class Function
+    attr_reader :proc
+
+    def initialize(proc)
+      @proc = proc
+    end
+
+    def method_missing(method, *args, &block)
+      # This is necessary for Scala's "specialization" feature,
+      # which will call `apply$mcD$sp` if it wants a double, for example.
+      if method.to_s =~ /\Aapply/
+        proc.call(*args, &block)
+      end
+    end
+  end
+
+  class Function0 < Function
+    include Java::Scala.Function0
+  end
+end

data/lib/ostrich-jruby/scala/kernel.rb

@@ -0,0 +1,7 @@
+module Kernel
+  def companion(klass, *names)
+    singleton = klass.const_get(:"#{names.join("$")}$")
+    field = singleton.java_class.field(:"MODULE$")
+    field.value(singleton)
+  end
+end

data/lib/ostrich-jruby/stats.rb

@@ -0,0 +1,43 @@
+# https://github.com/twitter/ostrich/blob/master/src/main/scala/com/twitter/ostrich/stats/Stats.scala
+# https://github.com/twitter/ostrich/blob/master/src/main/scala/com/twitter/ostrich/stats/StatsCollection.scala
+# https://github.com/twitter/ostrich/blob/master/src/main/scala/com/twitter/ostrich/stats/StatsProvider.scala
+module Ostrich
+  class Stats
+    class << self
+
+      def incr(name, amount = 1)
+        collection.incr(name, amount)
+      end
+
+      def get_counter(name)
+        collection.getCounter(name)
+      end
+
+      def add_gauge(name, &block)
+        proc = Scala::Function0.new(block)
+        collection.addGauge(name, proc)
+      end
+
+      def get_gauge(name)
+        collection.getGauge(name)
+      end
+
+      def add_metric(name, value)
+        collection.addMetric(name, value)
+      end
+
+      def get_metric(name)
+        collection.getMetric(name)
+      end
+
+      def clear_all
+        collection.clearAll
+      end
+
+      def collection
+        companion(com.twitter.ostrich.stats, :Stats)
+      end
+
+    end
+  end
+end

data/lib/ostrich-jruby/util.rb

@@ -0,0 +1,3 @@
+module Util
+  autoload :Duration, "ostrich-jruby/util/duration"
+end

data/lib/ostrich-jruby/util/duration.rb

@@ -0,0 +1,18 @@
+# https://github.com/twitter/util/blob/master/util-core/src/main/scala/com/twitter/util/Duration.scala
+module Util
+  class Duration
+    class << self
+
+      def from_seconds(seconds)
+        duration.fromSeconds(seconds)
+      end
+
+      private
+
+      def duration
+        companion(com.twitter.util, :Duration)
+      end
+
+    end
+  end
+end

data/lib/ostrich-jruby/version.rb

@@ -0,0 +1,3 @@
+module Ostrich
+  VERSION = "1.0.0"
+end

data/ostrich-jruby.gemspec

@@ -0,0 +1,22 @@
+# encoding: UTF-8
+
+$:.unshift File.join(File.dirname(__FILE__), 'lib')
+require 'ostrich-jruby/version'
+
+Gem::Specification.new do |s|
+  s.name     = "ostrich-jruby"
+  s.version  = '2.0.1'
+  s.authors  = ["Cameron Dutro"]
+  s.email    = ["cdutro@twitter.com"]
+  s.homepage = ""
+
+  s.description = s.summary = "Ruby wrapper around the stats collector & reporter for Scala servers"
+
+  s.platform = Gem::Platform::RUBY
+  s.has_rdoc = true
+
+  s.requirements << "jar 'com.twitter:ostrich', '9.2.0'"
+  s.require_path = 'lib'
+
+  s.files = Dir["{lib,spec}/**/*", "Gemfile", "History.txt", "LICENSE", "README.md", "Rakefile", "ostrich-jruby.gemspec"]
+end

data/spec/command_handler_spec.rb

@@ -0,0 +1,21 @@
+# encoding: UTF-8
+
+require 'spec_helper'
+
+describe Ostrich::CommandHandler do
+  let(:handler) { Ostrich::CommandHandler.new(Ostrich::Stats.collection) }
+
+  describe "#ping" do
+    it "should return 'pong'" do
+      JSON.parse(handler.ping).should == { "response" => "pong" }
+    end
+  end
+
+  describe "#stats" do
+    def get_stats(params)
+      handler.stats({}, params[:format])
+    end
+
+    it_behaves_like "a stats reporter"
+  end
+end

data/spec/ext/hash_spec.rb

@@ -0,0 +1,19 @@
+# encoding: UTF-8
+
+require 'spec_helper'
+
+describe Hash do
+  describe "#to_scala" do
+    let(:hash) do
+      { "a" => "b", "c" => "d" }
+    end
+
+    it "should convert the ruby hash into a mutable scala hashmap" do
+      hash.to_scala.tap do |hash_map|
+        hash_map.should be_a(Java::Scala.collection.mutable::HashMap)
+        hash_map.get("a").get.should == "b"
+        hash_map.get("c").get.should == "d"
+      end
+    end
+  end
+end

data/spec/grape_endpoint_spec.rb

@@ -0,0 +1,20 @@
+# encoding: UTF-8
+
+require 'spec_helper'
+
+describe Ostrich::GrapeEndpoint do
+  include Rack::Test::Methods
+
+  def app
+    Ostrich::GrapeEndpoint
+  end
+
+  describe "#stats" do
+    def get_stats(params)
+      get "stats.#{params[:format]}"
+      last_response.body
+    end
+
+    it_behaves_like "a stats reporter"
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,49 @@
+# encoding: UTF-8
+
+require "rspec"
+require "ostrich-jruby"
+require 'rack/test'
+require 'json'
+require 'yaml'
+
+RSpec.configure do |config|
+  config.mock_with(:rr)
+
+  config.before(:each) do
+    Ostrich::Stats.clear_all
+  end
+
+  shared_examples "a stats reporter" do
+    it "should report basic JVM stats in json format" do
+      results = JSON.parse(get_stats(format: :json))
+      results["gauges"].should include("jvm_heap_committed")
+      results["counters"].should include("jvm_gc_msec")
+    end
+
+    # NOTE: the txt format just so happens to be yaml
+    it "should report basic JVM stats in txt format" do
+      results = YAML.load(get_stats(format: :txt))
+      results["gauges"].should include("jvm_heap_committed")
+      results["counters"].should include("jvm_gc_msec")
+    end
+
+    context "with some statsy things" do
+      before(:each) do
+        Ostrich::Stats.incr("foo", 2)
+        Ostrich::Stats.add_gauge("bar") { 4 + 1 }
+      end
+
+      it "should report custom counters and gauges in json format" do
+        results = JSON.parse(get_stats(format: :json))
+        results["counters"]["foo"].should == 2
+        results["gauges"]["bar"].should == 5
+      end
+
+      it "should report custom counters and gauges in txt format" do
+        results = YAML.load(get_stats(format: :txt))
+        results["counters"]["foo"].should == 2
+        results["gauges"]["bar"].should == 5
+      end
+    end
+  end
+end

data/spec/stats_spec.rb

@@ -0,0 +1,29 @@
+# encoding: UTF-8
+
+require 'spec_helper'
+
+describe Ostrich::Stats do
+  let(:stats) { Ostrich::Stats }
+
+  describe "#incr" do
+    it "should increment the stat" do
+      stats.incr("blarg").should == 1
+      stats.incr("blarg", 2).should == 3
+      stats.get_counter("blarg").apply.should == 3
+    end
+  end
+
+  describe "#add_gauge" do
+    it "should add a gauge with a block" do
+      stats.add_gauge("foobar") { 10.2 }
+      stats.get_gauge("foobar").get.should == 10.2
+    end
+  end
+
+  describe "#add_metric" do
+    it "should add a metric" do
+      stats.add_metric("teapot", 14.1)
+      stats.get_metric("teapot").should be_a(com.twitter.ostrich.stats.Metric)
+    end
+  end
+end

data/spec/util/duration_spec.rb

@@ -0,0 +1,14 @@
+# encoding: UTF-8
+
+require 'spec_helper'
+
+describe Util::Duration do
+  describe "#from_seconds" do
+    it "should return a Duration object with the correct length of time" do
+      Util::Duration.from_seconds(60).tap do |duration|
+        duration.should be_a(com.twitter.util.Duration)
+        duration.inNanoseconds.should == 60_000_000_000
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification
+name: ostrich-jruby
+version: !ruby/object:Gem::Version
+  version: 2.0.1
+platform: ruby
+authors:
+- Cameron Dutro
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-05-14 00:00:00.000000000 Z
+dependencies: []
+description: Ruby wrapper around the stats collector & reporter for Scala servers
+email:
+- cdutro@twitter.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Rakefile
+- lib/ostrich-jruby.rb
+- lib/ostrich-jruby/command_handler.rb
+- lib/ostrich-jruby/ext/hash.rb
+- lib/ostrich-jruby/grape_endpoint.rb
+- lib/ostrich-jruby/scala/functions.rb
+- lib/ostrich-jruby/scala/kernel.rb
+- lib/ostrich-jruby/stats.rb
+- lib/ostrich-jruby/util.rb
+- lib/ostrich-jruby/util/duration.rb
+- lib/ostrich-jruby/version.rb
+- ostrich-jruby.gemspec
+- spec/command_handler_spec.rb
+- spec/ext/hash_spec.rb
+- spec/grape_endpoint_spec.rb
+- spec/spec_helper.rb
+- spec/stats_spec.rb
+- spec/util/duration_spec.rb
+homepage: ''
+licenses: []
+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 'com.twitter:ostrich', '9.2.0'
+rubyforge_project: 
+rubygems_version: 2.4.3
+signing_key: 
+specification_version: 4
+summary: Ruby wrapper around the stats collector & reporter for Scala servers
+test_files: []
+has_rdoc: true