metriks-reporter-new_relic 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-reporter-new_relic.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Jon Guymon
+
+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,21 @@
+# Metriks::Reporter::NewRelic
+
+Allows metric data collected by with the Metriks gem to be reported to your New Relic account via a running New Relic Ruby agent.
+
+## Usage
+
+```ruby
+require 'metriks/reporter/new_relic'
+
+Metriks::Reporter::NewRelic.start
+```
+
+Metric data will be available via [custom dashboards](https://newrelic.com/docs/instrumentation/custom-dashboards) in the "Custom" namespace.  If you record some timer data like this:
+
+```ruby
+Metriks.timer('some.time') do
+  something(that, takes).a.while
+end
+```
+
+It will be recorded in New Relic as "Custom/some/time".

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/reporter/new_relic.rb

@@ -0,0 +1,23 @@
+require 'metriks'
+require 'newrelic_rpm'
+require 'metriks/reporter/new_relic/sampler'
+
+module Metriks
+  module Reporter
+    module NewRelic
+      extend self
+
+      def start
+        ::NewRelic::Agent.instance.stats_engine.add_harvest_sampler(Sampler.new)
+      end
+
+      def stop
+        # not yet able
+      end
+
+      def restart
+        # not yet able
+      end
+    end
+  end
+end

data/lib/metriks/reporter/new_relic/sampler.rb

@@ -0,0 +1,62 @@
+require 'new_relic/agent/sampler'
+
+module Metriks::Reporter
+  module NewRelic
+    class Sampler < ::NewRelic::Agent::Sampler
+      def initialize(options={})
+        @registry = options[:registry] || Metriks::Registry.default
+        @cache = Hash.new
+      end
+
+      def poll
+        @registry.each do |name, metric|
+          case metric
+          when defined?(Metriks::Gauge) && metric.kind_of?(Metriks::Gauge)
+            NewRelic::Agent.record_metric(newrelic_name(name), metric.value)
+  
+          when Metriks::Timer
+            count = value_update(name, :count, metric.count) do |old,new|
+              new - old
+            end
+            min = value_update(name, :min, metric.min) do |old,new|
+              new < old ? new : old
+            end
+            max = value_update(name, :max, metric.max) do |old,new|
+              new > old ? new : old
+            end
+            value = {
+              :total => metric.mean,
+              :count => count,
+              :min => min,
+              :max => max,
+              # NOTE: we lose the total sum of squares, not in the registry
+              :sum_of_squares => 0
+            }
+            ::NewRelic::Agent.record_metric(newrelic_name(name), value)
+
+          when Metriks::Counter
+            count = value_update(name, :count, metric.count) do |old,new|
+              new - old
+            end
+            ::NewRelic::Agent.increment_metric(newrelic_name(name), count)
+          end
+        end
+      end
+
+      def newrelic_name(name)
+        "Custom/" + name.gsub('.', '/')
+      end
+
+      def value_update(metric_name, field_name, new_value)
+        cache_key = "#{metric_name}-#{field_name}"
+        if @cache[cache_key] == nil
+          update = new_value
+        else
+          update = yield(@cache[cache_key], new_value)
+        end
+        @cache[cache_key] = update
+        return update
+      end
+    end
+  end
+end

data/lib/metriks/reporter/new_relic/version.rb

@@ -0,0 +1,7 @@
+module Metriks
+  module Reporter
+    module NewRelic
+      VERSION = "0.0.1"
+    end
+  end
+end

data/metriks-reporter-new_relic.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'metriks/reporter/new_relic/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "metriks-reporter-new_relic"
+  spec.version       = Metriks::Reporter::NewRelic::VERSION
+  spec.authors       = ["Jon Guymon"]
+  spec.email         = ["jon@newrelic.com"]
+  spec.description   = %q{Allows metric data collected by with the Metriks gem to be reported to your New Relic account via a running New Relic Ruby agent.}
+  spec.summary       = %q{Metriks Reporter for New Relic.}
+  spec.homepage      = "https://github.com/newrelic/metriks-reporter-new_relic"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+
+  spec.add_dependency 'newrelic_rpm', '> 3.5.0'
+  spec.add_dependency 'metriks'
+end

data/test/metriks/reporter/new_relic/sampler_test.rb

@@ -0,0 +1,47 @@
+require 'test_helper'
+require 'metriks/reporter/new_relic/sampler'
+
+class Metriks::Reporter::NewRelic::SamplerTest < Test::Unit::TestCase
+  def setup
+    @registry = Metriks::Registry.new
+    @sampler = Metriks::Reporter::NewRelic::Sampler.new(:registry => @registry)
+  end
+
+  def test_harvests_guage_values_from_registry
+    @registry.gauge('queue.size').set(666)
+    @sampler.poll
+    assert_equal(666, NewRelic::Agent.instance.stats_engine \
+                   .lookup_stats('Custom/queue/size').total_call_time)
+  end if Metriks.respond_to?(:gauge)
+
+  def test_harvests_timer_data
+    @registry.timer('queue.time').update(2)
+    @registry.timer('queue.time').update(4)
+    @registry.timer('queue.time').update(6)
+
+    @sampler.poll
+
+    stats = NewRelic::Agent.instance.stats_engine \
+      .lookup_stats('Custom/queue/time')
+    assert_equal(3, stats.call_count)
+    assert_equal(4, stats.total_call_time)
+    assert_equal(2, stats.min_call_time)
+    assert_equal(6, stats.max_call_time)
+  end
+
+  def test_harvests_counter_data_incrementally
+    @registry.counter('queue.push').increment
+
+    @sampler.poll
+
+    @registry.counter('queue.push').increment
+    @registry.counter('queue.push').increment
+    
+    @sampler.poll
+
+    stats = NewRelic::Agent.instance.stats_engine \
+      .lookup_stats('Custom/queue/push')
+    assert_equal 3, stats.call_count # 3 not 4, don't recount the first
+    assert_equal 0, stats.total_call_time
+  end
+end

data/test/metriks/reporter/new_relic_test.rb

@@ -0,0 +1,14 @@
+require 'test_helper'
+require 'metriks/reporter/new_relic'
+
+class Metriks::Reporter::NewRelicTest < Test::Unit::TestCase
+  def test_start_adds_sampler_to_agent
+    ::NewRelic::Agent.manual_start
+    Metriks::Reporter::NewRelic.start
+    assert(::NewRelic::Agent.instance.stats_engine.send(:harvest_samplers) \
+             .map{|s| s.class}.include?(Metriks::Reporter::NewRelic::Sampler))
+  end
+
+  def _test_stop_removes_sampler_from_agent
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,2 @@
+require 'test/unit'
+require 'metriks/reporter/new_relic'

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification
+name: metriks-reporter-new_relic
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Jon Guymon
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: newrelic_rpm
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>'
+      - !ruby/object:Gem::Version
+        version: 3.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>'
+      - !ruby/object:Gem::Version
+        version: 3.5.0
+- !ruby/object:Gem::Dependency
+  name: metriks
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Allows metric data collected by with the Metriks gem to be reported to
+  your New Relic account via a running New Relic Ruby agent.
+email:
+- jon@newrelic.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/metriks/reporter/new_relic.rb
+- lib/metriks/reporter/new_relic/sampler.rb
+- lib/metriks/reporter/new_relic/version.rb
+- metriks-reporter-new_relic.gemspec
+- test/metriks/reporter/new_relic/sampler_test.rb
+- test/metriks/reporter/new_relic_test.rb
+- test/test_helper.rb
+homepage: https://github.com/newrelic/metriks-reporter-new_relic
+licenses:
+- MIT
+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: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Metriks Reporter for New Relic.
+test_files:
+- test/metriks/reporter/new_relic/sampler_test.rb
+- test/metriks/reporter/new_relic_test.rb
+- test/test_helper.rb