metriks-instrumental 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in metriks-instrumental.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Chris Zelenak
+
+MIT License
+
+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,42 @@
+# metriks-instrumental
+
+A gem to report your [Metriks][metriks] data to [Instrumental][instrumental].  
+
+## Usage
+
+Send metrics to [Instrumental][instrumental] every 60 seconds.
+
+``` ruby
+  # Using an API key
+  reporter = Metriks::Reporter::Instrumental.new(:api_key => "Your Instrumental API key")
+
+  # Using an already instantiated agent
+  reporter = Metriks::Reporter::Instrumental.new(:agent => existing_instrumental_agent)
+
+  reporter.start
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'metriks-instrumental'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install metriks-instrumental
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+[metriks]: http://github.com/eric/metriks
+[instrumental]: https://instrumentalapp.com/

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+
+task :default => :test
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end

data/lib/metriks-instrumental.rb

@@ -0,0 +1,3 @@
+require "metriks-instrumental/version"
+require "metriks/reporter/instrumental"
+

data/lib/metriks-instrumental/version.rb

@@ -0,0 +1,5 @@
+module Metriks
+  module Instrumental
+    VERSION = "0.0.1"
+  end
+end

data/lib/metriks/reporter/instrumental.rb

@@ -0,0 +1,134 @@
+require 'metriks/time_tracker'
+require 'instrumental_agent'
+
+module Metriks::Reporter
+
+  # Reports metrics to Instrumental (http://instrumentalapp.com/)
+  class Instrumental
+    attr_accessor :prefix, :source, :agent
+
+    # You MUST provide either :api_token or :agent as an argument to this method.
+    #
+    # options:
+    # :api_token:: Your Instrumental API token
+    # :agent:: A specific instance of the Instrumental Agent to use with this reporter
+    # :prefix:: A string prefix to prepend to all your metrics
+    # :registry:: The Metriks registry that will be providing your metrics
+    # :interval:: How often to report metrics to Instrumental (default value is every 60 seconds, cannot be lower)
+    # :on_error:: A callable object to be executed when an error occurs. This WILL be called
+    #             from a separate thread, you must ensure that your provided code will be 
+    #             thread safe.
+
+    def initialize(options = {})
+      raise "You must provide either :agent or :api_token as an option" unless options[:agent] || options[:api_token]
+      @agent        = options[:agent] || ::Instrumental::Agent.new(options[:api_token])
+      @prefix       = options[:prefix]
+      @registry     = options[:registry] || Metriks::Registry.default
+      interval      = options[:interval] || 60
+      interval      = [interval, 60].max
+      @time_tracker = Metriks::TimeTracker.new(interval)
+      @on_error     = options[:on_error] || proc { |ex| }
+    end
+
+    def start
+      @thread ||= Thread.new do
+        loop do
+          @time_tracker.sleep
+
+          Thread.new do
+            begin
+              write
+            rescue Exception => ex
+              @on_error[ex] rescue nil
+            end
+          end
+        end
+      end
+    end
+
+    def stop
+      @thread.kill if @thread
+      @thread = nil
+    end
+
+    def restart
+      stop
+      start
+    end
+
+    def write
+      @registry.each do |name, metric|
+        case metric
+        when Metriks::Meter
+          send_metric name, metric, [
+            :count, :one_minute_rate, :five_minute_rate,
+            :fifteen_minute_rate, :mean_rate
+          ]
+        when Metriks::Counter
+          send_metric name, metric, [
+            :count
+          ]
+        when Metriks::UtilizationTimer
+          send_metric name, metric, [
+            :count, :one_minute_rate, :five_minute_rate,
+            :fifteen_minute_rate, :mean_rate,
+            :min, :max, :mean, :stddev,
+            :one_minute_utilization, :five_minute_utilization,
+            :fifteen_minute_utilization, :mean_utilization,
+          ], [
+            :median, :get_95th_percentile
+          ]
+        when Metriks::Timer
+          send_metric name, metric, [
+            :count, :one_minute_rate, :five_minute_rate,
+            :fifteen_minute_rate, :mean_rate,
+            :min, :max, :mean, :stddev
+          ], [
+            :median, :get_95th_percentile
+          ]
+        when Metriks::Histogram
+          send_metric name, metric, [
+            :count, :min, :max, :mean, :stddev
+          ], [
+            :median, :get_95th_percentile
+          ]
+        end
+      end
+    end
+
+    def send_metric(base_name, metric, keys, snapshot_keys = [])
+      time = @time_tracker.now_floored
+
+      base_name = base_name.to_s.gsub(/ +/, '_')
+      if @prefix
+        base_name = "#{@prefix}.#{base_name}"
+      end
+
+      keys.flatten.each do |key|
+        name = key.to_s.gsub(/^get_/, '').to_s
+        full_name = "#{base_name}.#{name}"
+        value = metric.send(key)
+        if name == "count"
+          @agent.increment(full_name, value, time)
+        else
+          @agent.gauge(full_name, value, time)
+        end
+      end
+
+      unless snapshot_keys.empty?
+        snapshot = metric.snapshot
+        snapshot_keys.flatten.each do |key|
+          name = key.to_s.gsub(/^get_/, '').to_s
+          full_name = "#{base_name}.#{name}"
+          value = snapshot.send(key)
+          if name == "count"
+            @agent.increment(full_name, value, time)
+          else
+            @agent.gauge(full_name, value, time)
+          end
+        end
+      end
+
+    end
+  end
+end

data/metriks-instrumental.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'metriks-instrumental/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "metriks-instrumental"
+  gem.version       = Metriks::Instrumental::VERSION
+  gem.authors       = ["Chris Zelenak"]
+  gem.email         = ["chris@fastestforward.com"]
+  gem.description   = %q{A Metriks reporter that submits to Instrumental}
+  gem.summary       = %q{A Metriks reporter that submits to Instrumental}
+  gem.homepage      = "http://github.com/fastestforward/metriks-instrumental"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency("metriks", ["~> 0.9.9"])
+  gem.add_dependency("instrumental_agent", ["~> 0.12"])
+  gem.add_development_dependency("rake", ["~> 10"])
+  gem.add_development_dependency("mocha", ["~> 0.10"])
+
+
+end

data/test/instrumental_reporter_test.rb

@@ -0,0 +1,35 @@
+require 'test_helper'
+require 'metriks/reporter/instrumental'
+
+class InstrumentalReporterTest < Test::Unit::TestCase
+
+  def setup
+    @registry = Metriks::Registry.new
+    @agent    = Instrumental::Agent.new('SOME_TOKEN', :enabled => false)
+    @reporter = Metriks::Reporter::Instrumental.new(:registry => @registry, :agent => @agent)
+  end
+
+  def teardown
+    @reporter.stop
+    @registry.stop
+  end
+
+  def test_write
+    @registry.meter('meter.testing').mark
+    @registry.counter('counter.testing').increment
+    @registry.timer('timer.testing').update(1.5)
+    @registry.histogram('histogram.testing').update(1.5)
+    @registry.utilization_timer('utilization_timer.testing').update(1.5)
+
+    @agent.expects(:gauge).at_least(4)
+    @agent.expects(:increment).at_least(1)
+    @reporter.write
+  end
+
+  def test_invalid_arguments()
+    assert_raise(::RuntimeError) { Metriks::Reporter::Instrumental.new }
+    assert_nothing_thrown { Metriks::Reporter::Instrumental.new(:api_token => "TEST") }
+    assert_nothing_thrown { Metriks::Reporter::Instrumental.new(:agent => Instrumental::Agent.new("TEST", :enabled => false)) }
+  end
+  
+end

data/test/test_helper.rb

@@ -0,0 +1,7 @@
+require 'test/unit'
+require 'pp'
+
+require 'mocha/setup'
+
+require 'metriks'
+

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: metriks-instrumental
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Chris Zelenak
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-01-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: metriks
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.9
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.9
+- !ruby/object:Gem::Dependency
+  name: instrumental_agent
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.12'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.10'
+description: A Metriks reporter that submits to Instrumental
+email:
+- chris@fastestforward.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/metriks-instrumental.rb
+- lib/metriks-instrumental/version.rb
+- lib/metriks/reporter/instrumental.rb
+- metriks-instrumental.gemspec
+- test/instrumental_reporter_test.rb
+- test/test_helper.rb
+homepage: http://github.com/fastestforward/metriks-instrumental
+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'
+      segments:
+      - 0
+      hash: -651605823
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -651605823
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: A Metriks reporter that submits to Instrumental
+test_files:
+- test/instrumental_reporter_test.rb
+- test/test_helper.rb