tunemygc 1.0.12 → 1.0.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5c004b858c9d84c91d9ac30f5ab02c38523e21c0
-  data.tar.gz: 5d3267590cd9081b8d080326ea4f6d68a0c55fae
+  metadata.gz: b3f306241edb410736b2b01067f4904c2b49f91b
+  data.tar.gz: a8bc6b26e270e9dae4a864a24828d6f7352864ea
 SHA512:
-  metadata.gz: ecf0488e21335e5951b3d45c073cf3211551ee933643a0ce04608861c017f3d80b8819aa00d72567794012976a68c41763aa1d71d1426459970ea3188f0da8d7
-  data.tar.gz: 02a61c92b7abf6a1aa8d4a012ff4fa6dae7b657b5719ae5822c48b5cd730915921f4b157d19070086c8d4e65e4308dc52f7eff5be2a98717d7a3d13d42cfcb8b
+  metadata.gz: 8e58c2e51304db18732f5ba275d8b599b6c5b6cc703e9caef7e739fdea01bfadf08bae0d7b034943a5ba6475f527ee3e27ef40579250b995be0a0a795092093f
+  data.tar.gz: 0bd6ccde3394c560038b1e7612ede7a8e9081cc657796523dd5dbedcfba47ad356aff16404b557406b11fd3f2a6fd0aabe82b86a557549348a43ec00672d507a

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    tunemygc (1.0.6)
+    tunemygc (1.0.12)
       activesupport (~> 4.1)
       certified (~> 1.0, >= 1.0.0)
 
@@ -118,6 +118,7 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
+  activejob (~> 4.2.0)
   rails
   rake (~> 10.3)
   rake-compiler (~> 0.9, >= 0.9.5)

data/README.md

@@ -93,14 +93,18 @@ RUBY_GC_TOKEN=08de9e8822c847244b31290cedfc1d51 RUBY_GC_TUNE=1 bundle exec rails
 
 #### Advanced
 
-* `RUBY_GC_SPY=action_controller` (Spy on the GC for this type of processing. Either `action_controller` or `minitest`)
+* `RUBY_GC_SPY=action_controller` (Spy on the GC for this type of processing. `action_controller`, `active_job` or `minitest` are supported)
 
-Defines what type of processing you would like to sample for GC activity. An Action Controller spy is the default, but [minitest](https://github.com/seattlerb/minitest) is also supported as an experimental feature.
+Defines what type of processing you would like to sample for GC activity. An Action Controller spy is the default, but [ActiveJob](https://github.com/rails/rails/tree/master/activejob) and [minitest](https://github.com/seattlerb/minitest) are also supported as experimental features.
 
 * `RUBY_GC_TUNE_REQUESTS=x` (a numeric value eg. `200`)
 
 Controls the interposer lifetime for sampling Rails requests. It will enable itself, then remove request instrumentation after the specified number of requests. A good minimum ballpark sample set would be 200.
 
+* `RUBY_GC_TUNE_JOBS=x` (a numeric value eg. `200`)
+
+Controls the interposer lifetime for sampling ActiveJob jobs. It will enable itself, then remove job instrumentation after the specified number of jobs were processed. A good minimum ballpark sample set would be 200.
+
 * `RUBY_GC_TUNE_TESTS=x` (a numeric value eg. `200`)
 
 Controls the interposer lifetime for sampling a [minitest](https://github.com/seattlerb/minitest) based test suite. It will enable itself, then remove request instrumentation after the specified number of tests has been run. A good minimum ballpark sample set would be 200.

data/lib/tunemygc/spies.rb

@@ -4,5 +4,6 @@ module TuneMyGc
   module Spies
     autoload :ActionController, 'tunemygc/spies/action_controller'
     autoload :Minitest, 'tunemygc/spies/minitest'
+    autoload :ActiveJob, 'tunemygc/spies/active_job'
   end
 end

data/lib/tunemygc/spies/action_controller.rb

@@ -1,6 +1,21 @@
 # encoding: utf-8
 
-require 'tunemygc/request_subscriber'
+require 'tunemygc/subscriber'
+
+module TuneMyGc
+  class StartRequestSubscriber < Subscriber
+    def start(name, id, payload)
+      TuneMyGc.snapshot(:PROCESSING_STARTED)
+    end
+  end
+
+  class EndRequestSubscriber < Subscriber
+    def finish(name, id, payload)
+      TuneMyGc.snapshot(:PROCESSING_ENDED)
+      TuneMyGc.interposer.check_uninstall
+    end
+  end
+end
 
 module TuneMyGc
   module Spies
@@ -15,10 +30,8 @@ module TuneMyGc
 
       def install
         @subscriptions << ActiveSupport::Notifications.subscribe(/^start_processing.action_controller$/, TuneMyGc::StartRequestSubscriber.new)
-        TuneMyGc.log "hooked: start_processing.action_controller"
-
         @subscriptions << ActiveSupport::Notifications.subscribe(/^process_action.action_controller$/, TuneMyGc::EndRequestSubscriber.new)
-        TuneMyGc.log "hooked: process_action.action_controller"
+        TuneMyGc.log "hooked: action_controller"
       end
 
       def uninstall
@@ -26,7 +39,7 @@ module TuneMyGc
         TuneMyGc.log "uninstalled GC tracepoint"
         @subscriptions.each{|s| ActiveSupport::Notifications.unsubscribe(s) }
         @subscriptions.clear
-        TuneMyGc.log "cleared ActiveSupport subscriptions"
+        TuneMyGc.log "uninstalled action_controller spy"
       end
 
       def check_uninstall

data/lib/tunemygc/spies/active_job.rb

@@ -0,0 +1,70 @@
+# encoding: utf-8
+
+require 'active_job'
+
+module TuneMyGc
+  module Spies
+    class ActiveJob
+      def initialize
+        @jobs_processed = 0
+        @jobs_limit = nil
+      end
+
+      def install
+        ::ActiveJob::Base.__send__(:include, hooks_module)
+        TuneMyGc.log "hooked: active_job"
+      end
+
+      def uninstall
+        TuneMyGc.uninstall_gc_tracepoint
+        TuneMyGc.log "uninstalled GC tracepoint"
+        ::ActiveJob::Base.__send__(:include, disabled_hooks_module)
+        TuneMyGc.log "uninstalled active_job spy"
+      end
+
+      def check_uninstall
+        if ENV["RUBY_GC_TUNE_JOBS"]
+          @jobs_limit ||= Integer(ENV["RUBY_GC_TUNE_JOBS"])
+          @jobs_processed += 1
+          if @jobs_processed == @jobs_limit
+            uninstall
+            TuneMyGc.log "kamikaze after #{@jobs_processed} of #{@jobs_limit} jobs"
+          end
+        end
+      end
+
+      def hooks_module
+        Module.new do
+          def self.included(base)
+            base.around_perform :tunemygc_perform_job
+          end
+
+          def tunemygc_perform_job(*args)
+            tunemygc_before_perform
+            yield
+            tunemygc_after_perform
+          end
+
+          def tunemygc_before_perform
+            TuneMyGc.snapshot(:PROCESSING_STARTED)
+          end
+
+          def tunemygc_after_perform
+            TuneMyGc.snapshot(:PROCESSING_ENDED)
+            TuneMyGc.interposer.check_uninstall
+          end
+        end
+      end
+
+      def disabled_hooks_module
+        Module.new do
+          def tunemygc_before_perform
+          end
+
+          def tunemygc_after_perform
+          end
+        end
+      end
+    end
+  end
+end

data/lib/tunemygc/version.rb

@@ -1,5 +1,5 @@
 # encoding: utf-8
 
 module TuneMyGc
-  VERSION = "1.0.12"
+  VERSION = "1.0.13"
 end

data/test/helper.rb

@@ -22,24 +22,4 @@ class TuneMyGcTestCase < Minitest::Test
       GC.stress = false
     end
   end
-
-  def process_tunemygc_request(path = '/test')
-    ActiveSupport::Notifications.instrument('start_processing.action_controller', path: path) {}
-    ActiveSupport::Notifications.instrument('process_action.action_controller', path: path) {}
-  end
-
-  def run_tunemygc_test
-    MinitestSandboxTest.new("test_minitest_spy").run
-  end
 end
-
-# for Minitest spy
-class MinitestSandboxTest < MiniTest::Unit::TestCase
-  def setup
-    @value = 123
-  end
-
-  def test_minitest_spy
-    assert_equal 123, @value
-  end
-end

data/test/test_action_controller_interposer.rb

@@ -77,4 +77,9 @@ class TestActionControllerInterposer < TuneMyGcTestCase
   ensure
     ENV.delete("RUBY_GC_TUNE_REQUESTS")
   end
+
+  def process_tunemygc_request(path = '/test')
+    ActiveSupport::Notifications.instrument('start_processing.action_controller', path: path) {}
+    ActiveSupport::Notifications.instrument('process_action.action_controller', path: path) {}
+  end
 end

data/test/test_activejob_interposer.rb

@@ -0,0 +1,89 @@
+# encoding: utf-8
+
+require File.join(File.dirname(__FILE__), 'helper')
+require 'active_job'
+
+class TuneMyGcJob < ActiveJob::Base
+  def perform
+  end
+end
+
+class TestActiveJobInterposer < TuneMyGcTestCase
+  def setup
+    TuneMyGc.interposer.uninstall
+  end
+
+  def teardown
+    TuneMyGc.interposer = TuneMyGc::Interposer.new(:ActionController)
+  end
+
+  def test_init
+    TuneMyGc.interposer = TuneMyGc::Interposer.new(:ActiveJob)
+    interposer = TuneMyGc.interposer
+    assert !interposer.installed
+  end
+
+  def test_install_uninstall
+    TuneMyGc.interposer = TuneMyGc::Interposer.new(:ActiveJob)
+    interposer = TuneMyGc.interposer
+    interposer.install
+    interposer.on_initialized
+    assert interposer.installed
+    assert_nil interposer.install
+
+    interposer.uninstall
+  end
+
+  def test_gc_hooks
+    TuneMyGc.interposer = TuneMyGc::Interposer.new(:ActiveJob)
+    interposer = TuneMyGc.interposer
+    interposer.install
+    TuneMyGc.interposer.on_initialized
+
+    GC.start(full_mark: true, immediate_sweep: false)
+    GC.start(full_mark: true, immediate_sweep: true)
+
+    stages = []
+
+    while !TuneMyGc.snapshotter.empty?
+      stages << TuneMyGc.snapshotter.deq
+    end
+
+    # Account for incremental GC on 2.2
+    cycles = [:GC_CYCLE_STARTED, :GC_CYCLE_ENTERED]
+
+    assert stages.any?{|s| cycles.include?(s[3]) }
+
+    interposer.uninstall
+  end
+
+  def test_tests_limit
+    TuneMyGc.interposer = TuneMyGc::Interposer.new(:ActiveJob)
+    interposer = TuneMyGc.interposer
+    interposer.install
+    TuneMyGc.interposer.on_initialized
+
+    ENV["RUBY_GC_TUNE_JOBS"] = "2"
+
+    run_tunemygc_job
+    run_tunemygc_job
+    
+    stages = []
+
+    while !TuneMyGc.snapshotter.empty?
+      stages << TuneMyGc.snapshotter.deq
+    end
+
+    cycles = [:PROCESSING_STARTED]
+
+    assert stages.any?{|s| cycles.include?(s[3]) }
+
+    interposer.uninstall
+  ensure
+    ENV.delete("RUBY_GC_TUNE_TESTS")
+  end
+
+  def run_tunemygc_job
+    TuneMyGcJob.new.perform_now
+  end
+end

data/test/test_minitest_interposer.rb

@@ -2,6 +2,16 @@
 
 require File.join(File.dirname(__FILE__), 'helper')
 
+class MinitestSandboxTest < MiniTest::Unit::TestCase
+  def setup
+    @value = 123
+  end
+
+  def test_minitest_spy
+    assert_equal 123, @value
+  end
+end
+
 class TestMinitestInterposer < TuneMyGcTestCase
   def setup
     TuneMyGc.interposer.uninstall
@@ -76,4 +86,8 @@ class TestMinitestInterposer < TuneMyGcTestCase
   ensure
     ENV.delete("RUBY_GC_TUNE_TESTS")
   end
+
+  def run_tunemygc_test
+    MinitestSandboxTest.new("test_minitest_spy").run
+  end
 end

data/tunemygc.gemspec

@@ -26,7 +26,7 @@ Gem::Specification.new do |s|
 
   Run this setup command from your application root to register your application with the `https://tunemygc.com` service:
 
-  bundle exec tunemygc -r your@email.address
+  $ bundle exec tunemygc -r your@email.address
 
   You should get back a token reference to identify this Rails app:
 
@@ -34,7 +34,7 @@ Gem::Specification.new do |s|
 
   Then sample your Rails app for tuning:
 
-  RUBY_GC_TOKEN=08de9e8822c847244b31290cedfc1d32 RUBY_GC_TUNE=1 bundle exec rails s
+  $ RUBY_GC_TOKEN=08de9e8822c847244b31290cedfc1d32 RUBY_GC_TUNE=1 bundle exec rails s
 
   We require a valid email address as a canonical reference for tuner tokens for your applications.
 
@@ -47,4 +47,5 @@ eos
   s.add_development_dependency('rake', '~> 10.3')
   s.add_development_dependency('rake-compiler', '~> 0.9', '>= 0.9.5')
   s.add_development_dependency('webmock', '~> 1.2', '>= 1.2.0')
+  s.add_development_dependency('activejob', '~> 4.2.0')
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tunemygc
 version: !ruby/object:Gem::Version
-  version: 1.0.12
+  version: 1.0.13
 platform: ruby
 authors:
 - Bear Metal
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-11 00:00:00.000000000 Z
+date: 2015-02-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -98,6 +98,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.2.0
+- !ruby/object:Gem::Dependency
+  name: activejob
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.0
 description: Agent for the GC tuning webservice https://www.tunemygc.com - optimal
   settings for throughput and memory usage of Rails applications
 email:
@@ -127,10 +141,10 @@ files:
 - lib/tunemygc/configurator.rb
 - lib/tunemygc/interposer.rb
 - lib/tunemygc/railtie.rb
-- lib/tunemygc/request_subscriber.rb
 - lib/tunemygc/snapshotter.rb
 - lib/tunemygc/spies.rb
 - lib/tunemygc/spies/action_controller.rb
+- lib/tunemygc/spies/active_job.rb
 - lib/tunemygc/spies/minitest.rb
 - lib/tunemygc/subscriber.rb
 - lib/tunemygc/syncer.rb
@@ -138,6 +152,7 @@ files:
 - test/fixtures.rb
 - test/helper.rb
 - test/test_action_controller_interposer.rb
+- test/test_activejob_interposer.rb
 - test/test_agent.rb
 - test/test_minitest_interposer.rb
 - test/test_railtie.rb
@@ -153,7 +168,7 @@ post_install_message: |2
 
     Run this setup command from your application root to register your application with the `https://tunemygc.com` service:
 
-    bundle exec tunemygc -r your@email.address
+    $ bundle exec tunemygc -r your@email.address
 
     You should get back a token reference to identify this Rails app:
 
@@ -161,7 +176,7 @@ post_install_message: |2
 
     Then sample your Rails app for tuning:
 
-    RUBY_GC_TOKEN=08de9e8822c847244b31290cedfc1d32 RUBY_GC_TUNE=1 bundle exec rails s
+    $ RUBY_GC_TOKEN=08de9e8822c847244b31290cedfc1d32 RUBY_GC_TUNE=1 bundle exec rails s
 
     We require a valid email address as a canonical reference for tuner tokens for your applications.
 
@@ -190,6 +205,7 @@ test_files:
 - test/fixtures.rb
 - test/helper.rb
 - test/test_action_controller_interposer.rb
+- test/test_activejob_interposer.rb
 - test/test_agent.rb
 - test/test_minitest_interposer.rb
 - test/test_railtie.rb

data/lib/tunemygc/request_subscriber.rb

@@ -1,18 +0,0 @@
-# encoding: utf-8
-
-require 'tunemygc/subscriber'
-
-module TuneMyGc
-  class StartRequestSubscriber < Subscriber
-    def start(name, id, payload)
-      TuneMyGc.snapshot(:PROCESSING_STARTED)
-    end
-  end
-
-  class EndRequestSubscriber < Subscriber
-    def finish(name, id, payload)
-      TuneMyGc.snapshot(:PROCESSING_ENDED)
-      TuneMyGc.interposer.check_uninstall
-    end
-  end
-end