simple-metrics 0.0.10-java

data/lib/simple/metrics/healthcheck.rb

@@ -0,0 +1,65 @@
+java_import com.yammer.metrics.core.HealthCheck
+
+module Simple
+  module Metrics
+    module Healthchecks
+      include Simple::Metrics
+
+      # Create a new healthcheck
+      #
+      # @param [String] name The name of the healthcheck, eg `check_db`.
+      # @return [MetricName] the newly created metric name
+      def new_healthcheck(name, &blk)
+        healthcheck = Check.new(name, &blk)
+        Java::ComYammerMetrics::HealthChecks.register(healthcheck)
+        run_healthcheck_loop
+      end
+
+      # Run the healthcheck loop
+      # This starts a new thread that runs all of the defined healthcheck loops.
+      def run_healthcheck_loop
+        return if @running_healthcheck_loop
+        Thread.new do
+          loop do
+            run_all_healthchecks
+            sleep 5
+          end
+        end
+        @running_healthcheck_loop = true
+      end
+
+      # Run all of the healthchecks that have been defined
+      def run_all_healthchecks
+        Java::ComYammerMetrics::HealthChecks.runHealthChecks
+      end
+    end
+
+    class Check < Java::ComYammerMetricsCore::HealthCheck
+      def initialize(name, &blk)
+        super(name)
+        @blk = blk
+      end
+
+      # Call the block and capture the return value.
+      # If the result is `Simple::Metrics::HEALTHY`, mark the healthcheck as healthy.
+      # If the result is a `Simple::Metrics::WARNING`, mark the healthcheck in the warning state.
+      # If the result is a `Simple::Metrics::UNHEALTHY`, or throws an error,
+      # mark the healthcheck as unhealthy.
+      def check
+        begin
+          r = @blk.call
+          case (r.is_a?(Class) ? r.new : r)
+          when Simple::Metrics::HEALTHY
+            Java::ComYammerMetricsCore::HealthCheck::Result.healthy
+          when Simple::Metrics::WARNING
+            Java::ComYammerMetricsCore::HealthCheck::Result.warning
+          when Simple::Metrics::UNHEALTHY
+            Java::ComYammerMetricsCore::HealthCheck::Result.unhealthy(r.message)
+          end
+        rescue StandardError => e
+          Java::ComYammerMetricsCore::HealthCheck::Result.unhealthy(e.message)
+        end
+      end
+    end
+  end
+end

data/lib/simple/metrics/meter.rb

@@ -0,0 +1,22 @@
+module Simple
+  module Metrics
+    module Meter
+      include Simple::Metrics
+
+      # Create a new meter
+      #
+      # @param [String] name The name of the meter
+      # @param [String] klass_name The name of the class, usually the application. Defaults to
+      # `self.class.name`
+      def define_meter(name, klass_name = self.class.name)
+        type = "meter"
+        metric_name = new_metric_name(klass_name, name, type)
+        meter = Java::ComYammerMetrics::Metrics.new_meter(metric_name, name.to_s,
+                                                            Simple::Metrics::DEFAULT_RATE_UNIT)
+        define_method("#{name}") do
+          meter
+        end
+      end
+    end
+  end
+end

data/lib/simple/metrics/rack_metrics.rb

@@ -0,0 +1,32 @@
+module Simple
+  module Metrics
+    class RackMetrics
+      extend Simple::Metrics::Meter
+
+      # Rack middleware for capturing response codes
+      #
+      # Creates a series of response meters that will be marked based on the response
+      # code that is returned by rack.
+      # @param [Object] app Rack application
+      # @param [String] application_name The name of the application
+      def initialize(app, application_name)
+        @app = app
+
+        self.class.define_meter '2xx-responses', application_name
+        self.class.define_meter '3xx-responses', application_name
+        self.class.define_meter '4xx-responses', application_name
+        self.class.define_meter '5xx-responses', application_name
+      end
+
+      def call(env)
+        begin
+          status, headers, body = @app.call(env)
+        ensure
+          status_code = (status ||= 500).to_s[0]
+          status_method = "#{status_code}xx-responses".to_sym
+          self.send(status_method).mark
+        end
+      end
+    end
+  end
+end

data/lib/simple/metrics/timer.rb

@@ -0,0 +1,22 @@
+module Simple
+  module Metrics
+    module Timer
+      # Create creates a new timer, registers it with the metrics registry,
+      # yields the timer to the block and stops it when the block returns.
+      #
+      # @param [String] name The name of the timer.
+      def timer(name)
+        metric_name = new_metric_name(sanitize_classname(self.class.name), name, "timer")
+        new_timer = metrics_registry.newTimer(metric_name,
+                                              DEFAULT_DURATION_UNIT,
+                                              DEFAULT_RATE_UNIT)
+        captured_timer = new_timer.time
+        begin
+          yield new_timer
+        ensure
+          captured_timer.stop
+        end
+      end
+    end
+  end
+end

data/lib/simple/metrics.rb

@@ -0,0 +1,51 @@
+require 'java'
+require 'java/metrics-core-2.1.1'
+require 'java/slf4j-api-1.6.4'
+require 'java/jackson-core-asl-1.9.5'
+require 'java/jackson-mapper-asl-1.9.5'
+require 'java/metrics-servlet-2.1.1'
+
+require_relative 'metrics/timer'
+require_relative 'metrics/meter'
+require_relative 'metrics/healthcheck'
+require_relative 'metrics/health'
+require_relative 'metrics/graphite'
+
+java_import java.util.concurrent.TimeUnit
+java_import com.yammer.metrics.Metrics
+java_import com.yammer.metrics.core.MetricName
+
+module Simple
+  module Metrics
+    DEFAULT_DURATION_UNIT = TimeUnit::MILLISECONDS
+    DEFAULT_RATE_UNIT     = TimeUnit::SECONDS
+    DEFAULT_TIMING_UNIT   = TimeUnit::NANOSECONDS
+
+    include Timer
+
+    # Sanitize classnames for graphite
+    #
+    # @param [Object] klass_name The request object
+    # @return [String] The class name without colons
+    def sanitize_classname(klass_name)
+      klass_name.gsub(":","")
+    end
+
+    # The default metrics registry
+    #
+    # @return [Java::ComYammerMetrics::Metrics] the default metrics registry
+    def metrics_registry
+      Java::ComYammerMetrics::Metrics.defaultRegistry
+    end
+
+    # Create a new metric name
+    #
+    # @param [String] klass_name The name of the class, usually the application name
+    # @param [String] name The name of the metric
+    # @param [String] type The type of metric
+    # @return [MetricName] the newly created metric name
+    def new_metric_name(klass_name, name, type)
+      MetricName.new(klass_name.downcase, type, name.to_s)
+    end
+  end
+end

data/lib/simple/version.rb

@@ -0,0 +1,5 @@
+module Simple
+  module Metrics
+    VERSION = "0.0.10"
+  end
+end

data/lib/simple.rb

@@ -0,0 +1,6 @@
+require "simple/version"
+
+module Simple
+end
+
+require "simple/metrics"

data/simple-metrics.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/simple/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["dan herrera", "james pozdena"]
+  gem.email         = ["dan@simple.com"]
+  gem.platform      = 'java'
+  gem.description   = %q{A simple JRuby wrapper around codahale's metrics package}
+  gem.summary       = %q{MEASURE ALL THE THINGS!}
+  gem.homepage      = "https://github.com/SimpleFinance/simple-metrics"
+  gem.files         = `git ls-files`.split($\)
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "simple-metrics"
+  gem.require_paths = ["lib"]
+  gem.version       = Simple::Metrics::VERSION
+
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'yard'
+  gem.add_development_dependency 'kramdown'
+end

data/spec/metrics/graphite_spec.rb

@@ -0,0 +1,9 @@
+require 'spec_helper'
+
+describe Simple::Metrics do
+  class GraphiteSpec
+    extend Simple::Metrics::Graphite
+
+    enable_graphite_reporter('graphite.example.com', 2003, 'example.class')
+  end
+end

data/spec/metrics/healthcheck_spec.rb

@@ -0,0 +1,55 @@
+require 'spec_helper'
+
+describe Simple::Metrics::Healthchecks do
+  it "should register a new healthcheck" do
+    class NurseRatched
+      extend Simple::Metrics::Healthchecks
+
+      class << self
+        def status=(v)
+          @status = v
+        end
+        def status
+          @status
+        end
+      end
+
+      self.status = "healthy"
+
+      new_healthcheck("temperature") do
+        case self.status
+        when "healthy"
+          Simple::Metrics::HEALTHY
+        when "unhealthy"
+          Simple::Metrics::UNHEALTHY.new("Too Many Tacos!")
+        when "dead"
+          raise "Pants"
+        end
+      end
+    end
+  end
+
+  it "should run all healthchecks" do
+    NurseRatched.status = "healthy"
+    NurseRatched.run_all_healthchecks.entrySet.each do |result|
+      result.getValue.isHealthy.should be_true
+    end
+  end
+
+  it "should return the last error message when unhealthy" do
+    NurseRatched.status = "unhealthy"
+    NurseRatched.run_all_healthchecks.entrySet.each do |result|
+      result.getValue.isHealthy.should be_false
+      result.getValue.getMessage.should == "Too Many Tacos!"
+    end
+  end
+
+  it "should return an unhealthy if the check raises an error" do
+    NurseRatched.status = "dead"
+    NurseRatched.run_all_healthchecks.entrySet.each do |result|
+      result.getValue.isHealthy.should be_false
+      result.getValue.getMessage.should == "Pants"
+    end
+  end
+
+end

data/spec/metrics/meter_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+
+describe Simple::Metrics do
+  class Rdio
+    extend Simple::Metrics::Meter
+
+    define_meter :bump_meter
+
+    def bump_dat
+      bump_meter.mark
+    end
+  end
+
+  let(:rdio) { Rdio.new }
+
+  it "should increment a meter" do
+    rdio.bump_dat
+    rdio.bump_meter.count.should == 1
+  end
+end

data/spec/metrics/timer_spec.rb

@@ -0,0 +1,29 @@
+require_relative '../spec_helper'
+
+describe Simple::Metrics::Timer do
+  context "setting a metrics timer" do
+    class Samovar
+      include Simple::Metrics
+      attr_accessor :tea_timer
+
+      def make_tea
+        timer("tea time") do |tea_timer|
+          @tea_timer = tea_timer
+          "Brewing..."
+        end
+      end
+    end
+
+    let(:samovar) { Samovar.new }
+
+    it "should yield a new timer to the block" do
+      samovar.make_tea
+      samovar.tea_timer.count.should_not be_zero
+    end
+
+    it "should create a new timer" do
+      samovar.make_tea
+      samovar.tea_timer.should be_a_kind_of(Java::ComYammerMetricsCore::Timer)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper.rb"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+end
+
+require 'simple/metrics'

metadata

@@ -0,0 +1,174 @@
+--- !ruby/object:Gem::Specification
+name: simple-metrics
+version: !ruby/object:Gem::Version
+  prerelease:
+  version: 0.0.10
+platform: java
+authors:
+- dan herrera
+- james pozdena
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2012-11-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency
+  name: rake
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency
+  name: yard
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency
+  name: kramdown
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  prerelease: false
+  type: :development
+description: A simple JRuby wrapper around codahale's metrics package
+email:
+- dan@simple.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rbenv-version
+- .rspec
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- doc/NurseRatched.html
+- doc/Rdio.html
+- doc/Samovar.html
+- doc/Simple.html
+- doc/Simple/Metrics.html
+- doc/Simple/Metrics/Check.html
+- doc/Simple/Metrics/Graphite.html
+- doc/Simple/Metrics/HEALTHY.html
+- doc/Simple/Metrics/Health.html
+- doc/Simple/Metrics/Healthchecks.html
+- doc/Simple/Metrics/Meter.html
+- doc/Simple/Metrics/RackMetrics.html
+- doc/Simple/Metrics/Timer.html
+- doc/Simple/Metrics/UNHEALTHY.html
+- doc/Simple/Metrics/WARNING.html
+- doc/_index.html
+- doc/class_list.html
+- doc/css/common.css
+- doc/css/full_list.css
+- doc/css/style.css
+- doc/file.README.html
+- doc/file_list.html
+- doc/frames.html
+- doc/index.html
+- doc/js/app.js
+- doc/js/full_list.js
+- doc/js/jquery.js
+- doc/method_list.html
+- doc/top-level-namespace.html
+- lib/java/jackson-core-asl-1.9.5.jar
+- lib/java/jackson-mapper-asl-1.9.5.jar
+- lib/java/metrics-core-2.1.1.jar
+- lib/java/metrics-graphite-2.1.1.jar
+- lib/java/metrics-servlet-2.1.1.jar
+- lib/java/slf4j-api-1.6.4.jar
+- lib/simple.rb
+- lib/simple/metrics.rb
+- lib/simple/metrics/graphite.rb
+- lib/simple/metrics/health.rb
+- lib/simple/metrics/healthcheck.rb
+- lib/simple/metrics/meter.rb
+- lib/simple/metrics/rack_metrics.rb
+- lib/simple/metrics/timer.rb
+- lib/simple/version.rb
+- simple-metrics.gemspec
+- spec/metrics/graphite_spec.rb
+- spec/metrics/healthcheck_spec.rb
+- spec/metrics/meter_spec.rb
+- spec/metrics/timer_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/SimpleFinance/simple-metrics
+licenses: []
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+  none: false
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+  none: false
+requirements: []
+rubyforge_project:
+rubygems_version: 1.8.24
+signing_key:
+specification_version: 3
+summary: MEASURE ALL THE THINGS!
+test_files:
+- spec/metrics/graphite_spec.rb
+- spec/metrics/healthcheck_spec.rb
+- spec/metrics/meter_spec.rb
+- spec/metrics/timer_spec.rb
+- spec/spec_helper.rb
+has_rdoc:
+...