metrician 0.0.7 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9cf863462aef4c2b2425233de2c527f3b1286bdf
-  data.tar.gz: 461a4cafdc0255467e2b7cbf9c236c49575a2a6b
+  metadata.gz: 52f0bb06f70b89a43c10dfdbbfa5b989c2dfad48
+  data.tar.gz: 61bc03ef7baf8a15640ed25e8608fe8c3481a8ce
 SHA512:
-  metadata.gz: 8f98d615943e39c4f1257420c7bb7f301c9d3c9ecf25bdea95b6c4c083b9b4c63b85519218385b468240c550790f126b06d8355764d13f912d708d678e91ba37
-  data.tar.gz: cf46b4c1638fd04ec00d3565e6650b511ea60e37b21edbfa38248ba796b06b9f00c42998903d36bba11928182427c45b823956bb88c9402ee328c20aee0a825f
+  metadata.gz: 865aa70211d3d49137d2b8e53b9b7568fea8b74299bed02bda52aa24b8a4ec4b8850e705a12b8ad63b92088d8aa486678eee465c685d55f09381ecc79f5b0809
+  data.tar.gz: 0af23a989d74ccbb153fd665d1bdac9c9eec041aafd7420050dcc139efde8712dcaead5b981340f0e36e485a9b4fb5b2d745aa1437642c5af0b6405aa6b81a6a

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+### 0.0.8 [August 4, 2017]
+* Integrate with memcached and dalli if both are available
+
 ### 0.0.7 [August 3, 2017]
 * Allow partial config files
 * Officially require Ruby 2

data/gemfiles/Gemfile.4.2.sidekiq-4

@@ -17,8 +17,11 @@ gem 'database_cleaner'
 gem 'delayed_job_active_record'
 gem 'resque'
 gem 'redis'
-gem 'memcached'
+gem 'dalli', '~>2.6'
+gem 'memcached', '~>1.7'
 gem 'rack-test'
+gem 'simplecov', :require => false, :group => :test
+gem 'honeybadger'
 
 # Gem under test
 gem 'metrician', :path => '..'

data/gemfiles/Gemfile.4.2.sidekiq-4.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    metrician (0.0.7)
+    metrician (0.0.8)
 
 GEM
   remote: https://rubygems.org/
@@ -45,6 +45,7 @@ GEM
     byebug (9.0.6)
     concurrent-ruby (1.0.5)
     connection_pool (2.2.1)
+    dalli (2.7.6)
     database_cleaner (1.6.1)
     delayed_job (4.1.3)
       activesupport (>= 3.0, < 5.2)
@@ -52,12 +53,15 @@ GEM
       activerecord (>= 3.0, < 5.2)
       delayed_job (>= 3.0, < 5)
     diff-lcs (1.3)
+    docile (1.1.5)
     erubis (2.7.0)
     gemika (0.3.2)
     globalid (0.4.0)
       activesupport (>= 4.2.0)
+    honeybadger (3.1.2)
     i18n (0.8.4)
     instrumental_agent (1.0.1)
+    json (1.8.6)
     loofah (2.0.3)
       nokogiri (>= 1.5.9)
     mail (2.6.6)
@@ -130,6 +134,11 @@ GEM
       connection_pool (~> 2.2, >= 2.2.0)
       rack-protection (>= 1.5.0)
       redis (~> 3.2, >= 3.2.1)
+    simplecov (0.14.1)
+      docile (~> 1.1.0)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.1)
     sinatra (1.4.8)
       rack (~> 1.5)
       rack-protection (~> 1.4)
@@ -154,11 +163,13 @@ PLATFORMS
 
 DEPENDENCIES
   byebug
+  dalli (~> 2.6)
   database_cleaner
   delayed_job_active_record
   gemika
+  honeybadger
   instrumental_agent
-  memcached
+  memcached (~> 1.7)
   metrician!
   mysql2 (= 0.3.17)
   rack-test
@@ -168,6 +179,7 @@ DEPENDENCIES
   resque
   rspec (~> 3.4)
   sidekiq (~> 4.0)
+  simplecov
 
 BUNDLED WITH
    1.14.6

data/gemfiles/Gemfile.5.0.pg

@@ -18,7 +18,10 @@ gem 'delayed_job_active_record'
 gem 'resque'
 gem 'redis'
 gem 'dalli'
+gem 'memcached'
 gem 'rack-test'
+gem 'simplecov', :require => false, :group => :test
+gem 'honeybadger'
 
 # Gem under test
 gem 'metrician', :path => '..'

data/gemfiles/Gemfile.5.0.pg.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    metrician (0.0.7)
+    metrician (0.0.8)
 
 GEM
   remote: https://rubygems.org/
@@ -56,16 +56,20 @@ GEM
       activerecord (>= 3.0, < 5.2)
       delayed_job (>= 3.0, < 5)
     diff-lcs (1.3)
+    docile (1.1.5)
     erubis (2.7.0)
     gemika (0.3.2)
     globalid (0.4.0)
       activesupport (>= 4.2.0)
+    honeybadger (3.1.2)
     i18n (0.8.4)
     instrumental_agent (1.0.1)
+    json (1.8.6)
     loofah (2.0.3)
       nokogiri (>= 1.5.9)
     mail (2.6.5)
       mime-types (>= 1.16, < 4)
+    memcached (1.8.0)
     method_source (0.8.2)
     mime-types (3.1)
       mime-types-data (~> 3.2015)
@@ -135,6 +139,11 @@ GEM
       connection_pool (~> 2.2, >= 2.2.0)
       rack-protection (>= 1.5.0)
       redis (~> 3.3, >= 3.3.3)
+    simplecov (0.14.1)
+      docile (~> 1.1.0)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.1)
     sinatra (2.0.0)
       mustermann (~> 1.0)
       rack (~> 2.0)
@@ -167,7 +176,9 @@ DEPENDENCIES
   database_cleaner
   delayed_job_active_record
   gemika
+  honeybadger
   instrumental_agent
+  memcached
   metrician!
   pg (~> 0.18.4)
   rack-test
@@ -177,6 +188,7 @@ DEPENDENCIES
   resque
   rspec (~> 3.5)
   sidekiq
+  simplecov
 
 BUNDLED WITH
    1.15.1

data/lib/metrician/reporters/honeybadger.rb

@@ -7,6 +7,7 @@ module Metrician
     end
 
     def instrument
+      return if ::Honeybadger::Agent.method_defined?(:notify_with_metrician)
       ::Honeybadger::Agent.class_eval do
         def notify_with_metrician(exception, options = {})
           # We can differentiate whether or not we live inside a web
@@ -15,6 +16,7 @@ module Metrician
           notify_without_metrician(exception, options)
         ensure
           Metrician.increment("exception.raise") if Metrician.configuration[:exception][:raise][:enabled]
+          # TODO: underscore is rails only
           Metrician.increment("exception.raise.#{Metrician.dotify(exception.class.name.underscore)}") if exception && Metrician.configuration[:exception][:exception_specific][:enabled]
         end
         alias_method :notify_without_metrician, :notify

data/lib/metrician/reporters/memcache.rb

@@ -11,12 +11,11 @@ module Metrician
       !!defined?(::Dalli) && !!defined?(::Dalli::Client)
     end
 
-    def client_class
-      if self.class.memcached_gem?
-        Memcached
-      elsif self.class.dalli_gem?
-        Dalli::Client
-      end
+    def client_classes
+      [
+        self.class.memcached_gem? && Memcached,
+        self.class.dalli_gem? && Dalli::Client,
+      ].compact
     end
 
     def self.enabled?
@@ -25,10 +24,16 @@ module Metrician
     end
 
     def instrument
+      client_classes.each do |client_class|
+        instrument_class(client_class)
+      end
+    end
+
+    def instrument_class(client_class)
       return if client_class.method_defined?(:get_with_metrician_trace)
       METHODS.each do |method_name|
         next unless client_class.method_defined?(method_name)
-        client_class.class_eval <<-EOD
+        client_class.class_eval <<-RUBY
           def #{method_name}_with_metrician_trace(*args, &blk)
             start_time = Time.now
             begin
@@ -41,7 +46,7 @@ module Metrician
           end
           alias #{method_name}_without_metrician_trace #{method_name}
           alias #{method_name} #{method_name}_with_metrician_trace
-        EOD
+        RUBY
       end
     end
 

data/lib/metrician/version.rb

@@ -1,5 +1,5 @@
 module Metrician
 
-  VERSION = "0.0.7".freeze
+  VERSION = "0.0.8".freeze
 
 end

data/metrician.gemspec

@@ -26,4 +26,5 @@ Gem::Specification.new do |s|
   s.add_development_dependency("rake", "~> 10.0")
   s.add_development_dependency("rspec", "~> 3.0")
   s.add_development_dependency("byebug", "~> 0")
+  s.add_development_dependency("simplecov", "~> 0")
 end

data/spec/metrician_spec.rb

@@ -60,6 +60,51 @@ RSpec.describe Metrician do
     end
   end
 
+  describe "exception tracking" do
+    before do
+      Metrician.configuration[:exception][:enabled] = true
+      Honeybadger.configure do |config|
+        config.disabled = true
+      end
+      @agent = Metrician.null_agent
+      Metrician.activate(@agent)
+    end
+
+    describe "honeybadger" do
+      specify "exceptions are instrumented" do
+        @agent.stub(:increment)
+        @agent.should_receive(:increment).with("exception.raise", 1)
+        Honeybadger.notify('Something went wrong.', {
+          error_class: 'MyClass',
+          context: {my_data: 'value'}
+        })
+      end
+
+      specify "exceptions are instrumented (job specific, string)" do
+        Metrician.configuration[:exception][:exception_specific][:enabled] = true
+        @agent.stub(:increment)
+        @agent.should_receive(:increment).with("exception.raise.string", 1)
+        Honeybadger.notify('Something went wrong.', {
+          error_class: 'MyClass',
+          context: {my_data: 'value'}
+        })
+      end
+
+      specify "exceptions are instrumented (job specific, exception)" do
+        Metrician.configuration[:exception][:exception_specific][:enabled] = true
+        @agent.stub(:increment)
+        @agent.should_receive(:increment).with("exception.raise.runtime_error", 1)
+        begin
+          fail 'badgers!'
+        rescue => exception
+          Honeybadger.notify(exception, context: {
+            my_data: 'value'
+          })
+        end
+      end
+    end
+  end
+
   describe "ActiveRecord" do
     before do
       @agent = Metrician.null_agent
@@ -191,6 +236,26 @@ RSpec.describe Metrician do
         # worker bits at latest possible time
         lambda { TestSidekiqWorker.perform_async({ "error" => true}) }.should raise_error(StandardError)
       end
+
+      specify "per job instrumentation" do
+        Metrician.configuration[:jobs][:job_specific][:enabled] = true
+        @agent.stub(:gauge)
+
+        @agent.should_receive(:gauge).with("jobs.run.job.TestSidekiqWorker", anything)
+        # avoid load order error of sidekiq here by just including the
+        # worker bits at latest possible time
+        TestSidekiqWorker.perform_async({ "success" => true})
+      end
+
+      specify "job errors are instrumented per job" do
+        Metrician.configuration[:jobs][:job_specific][:enabled] = true
+        @agent.stub(:increment)
+        @agent.should_receive(:increment).with("jobs.error.job.TestSidekiqWorker", 1)
+
+        # avoid load order error of sidekiq here by just including the
+        # worker bits at latest possible time
+        lambda { TestSidekiqWorker.perform_async({ "error" => true}) }.should raise_error(StandardError)
+      end
     end
   end
 
@@ -205,10 +270,9 @@ RSpec.describe Metrician do
     end
 
     memcached_clients = [
-      defined?(::Memcached) && ::Memcached.new("localhost:11211"),
-      defined?(::Dalli::Client) && ::Dalli::Client.new("localhost:11211"),
-    ].compact
-    raise "no memcached client" if memcached_clients.empty?
+      ::Memcached.new("localhost:11211"),
+      ::Dalli::Client.new("localhost:11211"),
+    ]
 
     memcached_clients.each do |client|
       specify "memcached is instrumented (#{client.class.name})" do
@@ -412,5 +476,25 @@ RSpec.describe Metrician do
       end
 
     end
+
+    describe "rails" do
+      def app
+        TestRailsApp.instance
+      end
+
+      let(:agent) { Metrician.null_agent }
+
+      before do
+        Metrician.activate(agent)
+      end
+
+      it "hooks into rails automatically" do
+        agent.stub(:gauge)
+        agent.should_receive(:gauge).with("web.request", anything)
+
+        get "/"
+        last_response.body.should == "foobar response"
+      end
+    end
   end
 end

data/spec/spec_helper.rb

@@ -1,3 +1,9 @@
+require 'simplecov'
+SimpleCov.start
+SimpleCov.command_name "#{RUBY_VERSION}_#{File.basename(ENV["BUNDLE_GEMFILE"])}"
+SimpleCov.minimum_coverage 90
+SimpleCov.refuse_coverage_drop
+
 ENV["RAILS_ENV"] = "test"
 
 require "bundler/setup"

data/spec/support/test_rails_app.rb

@@ -0,0 +1,21 @@
+require "rails/all"
+
+class TestRailsApp < Rails::Application
+  secrets.secret_token    = "secret_token"
+  secrets.secret_key_base = "secret_key_base"
+
+  config.logger = Logger.new($stdout)
+  Rails.logger = config.logger
+
+  routes.draw do
+    get "/", to: "foobars#index"
+  end
+end
+
+class FoobarsController < ActionController::Base
+  include Rails.application.routes.url_helpers
+
+  def index
+    render inline: "foobar response"
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: metrician
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
 platform: ruby
 authors:
 - Expected Behavior
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-03 00:00:00.000000000 Z
+date: 2017-08-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: instrumental_agent
@@ -94,6 +94,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Automatically report the most important metrics about your ruby application,
   from request timing to job execution.
 email:
@@ -151,6 +165,7 @@ files:
 - spec/support/database.travis.yml
 - spec/support/models.rb
 - spec/support/test_delayed_job.rb
+- spec/support/test_rails_app.rb
 - spec/support/test_resque_job.rb
 - spec/support/test_sidekiq_worker.rb
 homepage: http://instrumentalapp.com/
@@ -187,5 +202,6 @@ test_files:
 - spec/support/database.travis.yml
 - spec/support/models.rb
 - spec/support/test_delayed_job.rb
+- spec/support/test_rails_app.rb
 - spec/support/test_resque_job.rb
 - spec/support/test_sidekiq_worker.rb