metrician 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a191afe161c4357de6c30940adf1dd405419aed1
-  data.tar.gz: a1154276f6c09cc3c4ca9bdffbcdfcf00044309a
+  metadata.gz: 723f0b86a48f4c5105357ce4df6c792e53824849
+  data.tar.gz: df432f573bc722606600b382ec4762ced6a19fc7
 SHA512:
-  metadata.gz: e3dde17cb1da6670d88fa0bf88d7833b28fdf979519e107b1ccb24b9986a359aa6b8b00e1cb62e4dd91e15052a3be8bbc53ab65313c036d7cb31e7a880c957a5
-  data.tar.gz: 95c30e45864e10cd236739eb5b1f5d1aaa74dc2e592db616cf5f803fe9ba3b2a0bc10f8ee16730ee5db4daf8b81d4f12b12d17717c30babd774d0c4420c484c0
+  metadata.gz: 728a482d9a7a8a7e95db8b6c429fc418051fcef77cf9bf67b51b449f1d9f8e1ccc1a7df0faf4c9910f83183ee7f5e1cab32031d38e810ef7f78950b5d39305ad
+  data.tar.gz: 4f683f3998d632daff059f965fd7f383cff9d817b45a5d35dd29aad75b1db5497bda39264467369fca6edfb56ea42b43474026414a23f114de65e6d76e838f4b

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+### 0.0.5 [July 25, 2017]
+* Automate Resque integration
+
 ### 0.0.4 [July 24, 2017]
 * Handle exceptions in other middlewares for response size tracking
 

data/README.md

@@ -75,3 +75,22 @@ run YOUR_APP::Application.routes
 
 Your exception tracking middleware may try to get in first (hey, Honeybadger), so you will have to change the load order in an initializer, because we want to track that as middleware time, too.
 
+
+## Release Process
+
+1. Pull latest master
+2. Merge feature branch(es) into master
+3. `script/test`
+4. Increment version in:
+  - `lib/metrician/version.rb`
+5. Run `rake matrix:install` to generate new gem lockfiles
+6. Update [CHANGELOG.md](CHANGELOG.md)
+7. Commit "Release vX.Y.Z"
+8. Push to GitHub
+9. Release packages: `rake release`
+10. Verify package release at https://rubygems.org/gems/metrician
+
+
+## Version Policy
+
+This library follows [Semantic Versioning 2.0.0](http://semver.org).

data/config/metrician.yaml

@@ -1,4 +1,4 @@
-# A configuration for Metrician that controls the features of our
+# A configuration for Metrician that controls the features of its
 # automated metric reporting
 
 ---

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

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    metrician (0.0.4)
+    metrician (0.0.5)
 
 GEM
   remote: https://rubygems.org/

data/gemfiles/Gemfile.5.0.pg.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    metrician (0.0.4)
+    metrician (0.0.5)
 
 GEM
   remote: https://rubygems.org/

data/lib/metrician.rb

@@ -78,4 +78,12 @@ module Metrician
   def self.configuration
     @configuration ||= Metrician::Configuration.load
   end
+
+  def self.reset
+    %i[@agent @configuration].each do |memo_ivar|
+      if Metrician.instance_variable_defined?(memo_ivar)
+        Metrician.remove_instance_variable(memo_ivar)
+      end
+    end
+  end
 end

data/lib/metrician/configuration.rb

@@ -5,6 +5,8 @@ module Metrician
     FileMissing = Class.new(StandardError)
 
     def self.load
+      reset_dependents
+
       if env_location
         # this should never raise unless a bad ENV setting has been set
         raise(FileMissing.new(env_location)) unless File.exist?(env_location)
@@ -29,5 +31,10 @@ module Metrician
     def self.gem_location
       File.expand_path("../../../config/metrician.yaml", __FILE__)
     end
+
+    def self.reset_dependents
+      Metrician::Jobs.reset
+      Metrician::Middleware.reset
+    end
   end
 end

data/lib/metrician/jobs.rb

@@ -28,5 +28,13 @@ module Metrician
       job_name.gsub(/[^\w]+/, ".").gsub(/\.+$/, "")
     end
 
+    def self.reset
+      %i[@configuration @enabled @run @error @job_specific].each do |memo_ivar|
+        if instance_variable_defined?(memo_ivar)
+          remove_instance_variable(memo_ivar)
+        end
+      end
+    end
+
   end
 end

data/lib/metrician/jobs/resque_plugin.rb

@@ -3,34 +3,50 @@
 module Metrician
   module Jobs
     module ResquePlugin
-
-      def around_perform_with_metrician(*_args)
-        start = Time.now
-        yield
-      ensure
-        if Jobs.run?
-          duration = Time.now - start
-          Metrician.gauge(Jobs::RUN_METRIC, duration)
-          if Jobs.job_specific?
-            Metrician.gauge("#{Jobs::RUN_METRIC}.job.#{Jobs.instrumentation_name(self.to_s)}", duration)
+      module Extension
+        def around_perform_with_metrician(*_args)
+          start = Time.now
+          yield
+        ensure
+          if Jobs.run?
+            duration = Time.now - start
+            Metrician.gauge(Jobs::RUN_METRIC, duration)
+            if Jobs.job_specific?
+              Metrician.gauge("#{Jobs::RUN_METRIC}.job.#{Jobs.instrumentation_name(self.to_s)}", duration)
+            end
+            Metrician.agent.cleanup
           end
-          Metrician.agent.cleanup
         end
-      end
 
-      def on_failure_with_metrician(_e, *_args)
-        if Jobs.error?
-          Metrician.increment(Jobs::ERROR_METRIC)
-          if Jobs.job_specific?
-            Metrician.increment("#{Jobs::ERROR_METRIC}.job.#{Jobs.instrumentation_name(self.to_s)}")
+        def on_failure_with_metrician(_e, *_args)
+          if Jobs.error?
+            Metrician.increment(Jobs::ERROR_METRIC)
+            if Jobs.job_specific?
+              Metrician.increment("#{Jobs::ERROR_METRIC}.job.#{Jobs.instrumentation_name(self.to_s)}")
+            end
+            Metrician.agent.cleanup
           end
-          Metrician.agent.cleanup
         end
+
+        ::Resque.before_fork = proc { Metrician.agent.cleanup }
       end
 
-      ::Resque.before_fork = proc { Metrician.agent.cleanup }
+      module Installer
+        def self.included(base)
+          base.send(:alias_method, :payload_class_without_metrician, :payload_class)
+          base.send(:alias_method, :payload_class, :payload_class_with_metrician)
+        end
 
+        def payload_class_with_metrician
+          payload_class_without_metrician.tap do |klass|
+            unless klass.respond_to?(:around_perform_with_metrician)
+              klass.instance_eval do
+                extend(::Metrician::Jobs::ResquePlugin::Extension)
+              end
+            end
+          end
+        end
+      end
     end
-
   end
 end

data/lib/metrician/middleware.rb

@@ -60,5 +60,14 @@ module Metrician
     def self.apdex?
       @apdex ||= configuration[:apdex][:enabled]
     end
+
+    def self.reset
+      %w[@configuration @enabled @request @error @idle @response_size @middleware @queue_time @route_tracking @apdex].each do |memo_ivar|
+        if instance_variable_defined?(memo_ivar)
+          remove_instance_variable(memo_ivar)
+        end
+      end
+    end
+
   end
 end

data/lib/metrician/reporters/active_record.rb

@@ -37,11 +37,11 @@ module Metrician
       config = Metrician.configuration[:database]
       metrics = []
       metrics << "database.query" if config[:query][:enabled]
-      if config[:command] || config[:table]
+      if config[:command][:enabled] || config[:table][:enabled]
         command, table = parse_sql(sql)
-        metrics << "database.#{command}" if config[:command] && command
-        metrics << "database.#{table}" if config[:table] && table
-        metrics << "database.#{command}.#{table}" if config[:command] && config[:table] && command && table
+        metrics << "database.#{command}" if config[:command][:enabled] && command
+        metrics << "database.#{table}" if config[:table][:enabled] && table
+        metrics << "database.#{command}.#{table}" if config[:command][:enabled] && config[:table] && command && table
       end
       begin
         log_without_metrician(*args, &block)

data/lib/metrician/reporters/resque.rb

@@ -8,8 +8,8 @@ module Metrician
 
     def instrument
       require "metrician/jobs/resque_plugin"
-      unless ::Resque::Job.respond_to?(:around_perform_with_metrician)
-        ::Resque::Job.send(:extend, Metrician::Jobs::ResquePlugin)
+      unless ::Resque::Job.method_defined?(:payload_class_with_metrician)
+        ::Resque::Job.send(:include, Metrician::Jobs::ResquePlugin::Installer)
       end
     end
 

data/lib/metrician/version.rb

@@ -1,5 +1,5 @@
 module Metrician
 
-  VERSION = "0.0.4".freeze
+  VERSION = "0.0.5".freeze
 
 end

data/spec/metrician_spec.rb

@@ -8,8 +8,8 @@ module Metrician
 end
 
 RSpec.describe Metrician do
-  before do
-    Metrician.instance_variable_set("@agent", nil)
+  before(:each) do
+    Metrician.reset
   end
 
   it "has a version number" do
@@ -62,7 +62,7 @@ RSpec.describe Metrician do
     end
 
     specify "per table instrumentation" do
-      Metrician.configuration[:database][:table] = true
+      Metrician.configuration[:database][:table][:enabled] = true
       @agent.stub(:gauge)
       @agent.should_receive(:gauge).with("database.users", anything)
 
@@ -70,8 +70,8 @@ RSpec.describe Metrician do
     end
 
     specify "per command and table instrumentation" do
-      Metrician.configuration[:database][:command] = true
-      Metrician.configuration[:database][:table] = true
+      Metrician.configuration[:database][:command][:enabled] = true
+      Metrician.configuration[:database][:table][:enabled] = true
       @agent.stub(:gauge)
       @agent.should_receive(:gauge).with("database.select.users", anything)
 
@@ -127,22 +127,14 @@ RSpec.describe Metrician do
         @agent.stub(:gauge)
         @agent.should_receive(:gauge).with("jobs.run", anything)
 
-        # typically Metrician would be loaded in an initalizer
-        # and this _extend_ could be done inside the job itself, but here
-        # we are in a weird situation.
-        TestResqueJob.send(:extend, Metrician::Jobs::ResquePlugin)
-        Resque.enqueue(TestResqueJob, { "success" => true })
+        Resque::Job.create(:default, TestResqueJob, { "success" => true })
       end
 
       specify "job errors are instrumented" do
         @agent.stub(:increment)
         @agent.should_receive(:increment).with("jobs.error", 1)
 
-        # typically Metrician would be loaded in an initalizer
-        # and this _extend_ could be done inside the job itself, but here
-        # we are in a weird situation.
-        TestResqueJob.send(:extend, Metrician::Jobs::ResquePlugin)
-        lambda { Resque.enqueue(TestResqueJob, { "error" => true }) }.should raise_error(StandardError)
+        lambda { Resque::Job.create(:default, TestResqueJob, { "error" => true }) }.should raise_error(StandardError)
       end
     end
 

data/spec/spec_helper.rb

@@ -5,7 +5,7 @@ Bundler.require(:default)
 require "metrician"
 require "gemika"
 require "byebug"
-
+require "pp"
 
 Dir["#{File.dirname(__FILE__)}/support/*.rb"].sort.each {|f| require f}
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: metrician
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Expected Behavior
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-24 00:00:00.000000000 Z
+date: 2017-07-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: instrumental_agent