tunemygc 1.0.6 → 1.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f335f0a411ceb5bd4af313a30c3c7df9accd3aff
-  data.tar.gz: 208ddfc32ef3e24bd7fbe1e31b4560d6b00b3253
+  metadata.gz: 759855e794865c4d3a4dd7fb6eeee7789c07283d
+  data.tar.gz: 51e021f692c505cc6c102bac6287d17214930d9f
 SHA512:
-  metadata.gz: e261548fe3b52cbb58c93ef5be2e58600f184ea7a5e20c91e5f2817983338547a08dc5c23e2a4cbc78f057cb33d6544b5ffb4ca33d018843253e4509d639837a
-  data.tar.gz: c8959c605ba3bd607589ff3efacb16a658e65fe4a5c0f1738ad0be5ded8def2d5796b95ea8a33e5043b73b1528ea2edf9facbd734d4e5d724f755a812fadad87
+  metadata.gz: 73b470f53ef683edc2294adc3738ba8e4a329efbcfc127b18f7a2e51bf1777efc4b4fb7726108969dcc6998560b5c6a1a69c14ed93984dc150be25839be7151b
+  data.tar.gz: eefd05ae81273e370dd01d1087f278d13f4ed4350c3d6d8357fa4c1e42866ffac082f8c364a9d28addfc6860f4b783ae057914394f4059a70a649b29fbe9da3c

data/.travis.yml

@@ -18,3 +18,4 @@ branches:
   only:
     - master
     - compact-samples
+    - minitest

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    tunemygc (1.0.2)
+    tunemygc (1.0.6)
       activesupport (~> 4.1)
       certified (~> 1.0, >= 1.0.0)
 

data/README.md

@@ -20,6 +20,8 @@ The Ruby garbage collector has been flagged as the crux of Ruby performance and
 
 We used [Discourse](http://www.discourse.org) as our primary test harness as it's representative of most Rails applications and has been instrumental in asserting RGenC developments on Rails as well.
 
+[Discourse](http://www.discourse.org) throughput: [GC defaults](https://tunemygc.com/configs/c5214cfa00b3bf429badd2161c4b6a08) VS TuneMyGc [suggestions](https://tunemygc.com/configs/e129791f94159a8c75bef3a636c05798)
+
 ![tunemygc workflow diagram](https://raw.githubusercontent.com/bear-metal/tunemygc/master/assets/discourse_bench.png?token=AAABe8sM_ofiQkrCpNw7OYRbtHMLO9l5ks5UuQlYwA%3D%3D)
 
 ## Installing
@@ -42,7 +44,7 @@ Has not been tested at all.
 There isn't much setup other than adding the gem to your Gemfile and running a single command from your application root to register your application with the `https://tunemygc.com` service:
 
 ``` sh
-Lourenss-MacBook-Air-2:discourse lourens$ bundle exec tunemygc -r lourens@bearmetal.eu
+$ bundle exec tunemygc -r lourens@bearmetal.eu
 Application registered. Use RUBY_GC_TOKEN=08de9e8822c847244b31290cedfc1d51 in your environment.
 ```
 
@@ -57,7 +59,7 @@ RUBY_GC_TOKEN=08de9e8822c847244b31290cedfc1d51 RUBY_GC_TUNE=1 bundle exec rails
 The CLI interface supports retrieving configuration options for your application as well.
 
 ``` sh
-Lourenss-MacBook-Air-2:discourse lourens$ bundle exec tunemygc
+$ bundle exec tunemygc
 Usage: tunemygc [options]
     -r, --register EMAIL             Register this Rails app with the https://tunemygc.com service
     -c, --config TOKEN               Fetch the last known config for a given Rails app
@@ -75,13 +77,13 @@ We fully embrace and encourage [12 factor](http://12factor.net) conventions and
 This application specific token is required for GC instrumentation. You can generate one from the CLI interface by registering for the service with a valid email address:
 
 ``` sh
-Lourenss-MacBook-Air-2:discourse lourens$ bundle exec tunemygc -r lourens@bearmetal.eu
+$ bundle exec tunemygc -r lourens@bearmetal.eu
 Application registered. Use RUBY_GC_TOKEN=08de9e8822c847244b31290cedfc1d51 in your environment.
 ```
 
 * `RUBY_GC_TUNE=1`
 
-Enables the interposer for taking a few lightweight snapshots and submitting them to `tunemygc.com`. Without this environment variable set, it won't interpose itself.
+Enables the interposer for taking a few lightweight snapshots of Rails requests and submitting them to `tunemygc.com`. Without this environment variable set, it won't interpose itself.
 
 For the above command sequences, to sample my Rails app for tuning, I'd run:
 
@@ -91,9 +93,17 @@ 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`)
+
+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.
+
 * `RUBY_GC_TUNE_REQUESTS=x` (a numeric value eg. `200`)
 
-Controls the interposer lifetime for sampling requests. It will enable itself, then remove request instrumentation after the specified number of requests. A good minimum ballpark sample set would be 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_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.
 
 ## How do I use this?
 
@@ -122,7 +132,7 @@ An instrumented process dumps a reccommended config to the Rails logger.
 We're still in the process of building tools and a launcher shim around this. You can also retrieve the last known configuration for you app via the CLI interface:
 
 ``` sh
-Lourenss-MacBook-Air-2:discourse lourens$ bundle exec tunemygc -c 3b8796e5627f97ec760f000d55d9b3f5
+$ bundle exec tunemygc -c 3b8796e5627f97ec760f000d55d9b3f5
 === Suggested GC configuration:
 
 export RUBY_GC_HEAP_INIT_SLOTS=382429

data/lib/tunemygc/agent.rb

@@ -22,6 +22,14 @@ module TuneMyGc
     logger.info "[TuneMyGC] #{message}"
   end
 
+  def spy
+    if ENV['RUBY_GC_SPY']
+      ENV['RUBY_GC_SPY'].classify
+    else
+      :ActionController
+    end
+  end
+
   def reccommendations
     MUTEX.synchronize do
       require "tunemygc/syncer"

data/lib/tunemygc/interposer.rb

@@ -1,15 +1,16 @@
 # encoding: utf-8
 
 require 'active_support'
-require 'tunemygc/spies/action_controller'
+require 'tunemygc/spies'
 
 module TuneMyGc
   class Interposer
     attr_reader :spy
     attr_accessor :installed
 
-    def initialize
+    def initialize(spy = TuneMyGc.spy)
       reset
+      @spy = TuneMyGc::Spies.const_get(spy).new
     end
 
     def on_initialized
@@ -54,7 +55,6 @@ module TuneMyGc
     private
     def reset
       @installed = false
-      @spy = TuneMyGc::Spies::ActionController.new
     end
   end
 end

data/lib/tunemygc/spies.rb

@@ -0,0 +1,8 @@
+# encoding: utf-8
+
+module TuneMyGc
+  module Spies
+    autoload :ActionController, 'tunemygc/spies/action_controller'
+    autoload :Minitest, 'tunemygc/spies/minitest'
+  end
+end

data/lib/tunemygc/spies/minitest.rb

@@ -0,0 +1,74 @@
+# encoding: utf-8
+
+require 'minitest'
+
+module TuneMyGc
+  module Spies
+    class Minitest
+      def initialize
+        @tests_processed = 0
+        @tests_limit = nil
+      end
+
+      def install
+        MiniTest::Unit::TestCase.__send__(:include, hooks_module)
+        TuneMyGc.log "hooked: minitest"
+      end
+
+      def uninstall
+        TuneMyGc.uninstall_gc_tracepoint
+        TuneMyGc.log "uninstalled GC tracepoint"
+        MiniTest::Unit::TestCase.__send__(:include, disabled_hooks_module)
+        TuneMyGc.log "uninstalled minitest spy"
+      end
+
+      def check_uninstall
+        if ENV["RUBY_GC_TUNE_TESTS"]
+          @tests_limit ||= Integer(ENV["RUBY_GC_TUNE_TESTS"])
+          @tests_processed += 1
+          if @tests_processed == @tests_limit
+            uninstall
+            TuneMyGc.log "kamikaze after #{@tests_processed} of #{@tests_limit} tests"
+          end
+        end
+      end
+
+      def hooks_module
+        Module.new do
+          def before_setup
+            tunemygc_before_setup
+            super
+          end
+
+          def after_teardown
+            super
+            tunemygc_after_teardown
+          end
+
+          private
+          def tunemygc_before_setup
+            TuneMyGc.snapshot(:TEST_PROCESSING_STARTED)
+          end
+
+          def tunemygc_after_teardown
+            TuneMyGc.snapshot(:TEST_PROCESSING_ENDED)
+            TuneMyGc.interposer.check_uninstall
+          end
+        end
+      end
+
+      def disabled_hooks_module
+        Module.new do
+          private
+          def tunemygc_before_setup
+            # noop
+          end
+
+          def tunemygc_after_teardown
+            # noop
+          end
+        end
+      end
+    end
+  end
+end

data/lib/tunemygc/syncer.rb

@@ -39,7 +39,7 @@ module TuneMyGc
     end
 
     def environment(snapshotter)
-      ENVIRONMENT.dup.push(snapshotter.stat_keys)
+      ENVIRONMENT.dup.concat([snapshotter.stat_keys, TuneMyGc.spy])
     end
 
     private

data/lib/tunemygc/version.rb

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

data/test/helper.rb

@@ -23,8 +23,23 @@ class TuneMyGcTestCase < Minitest::Test
     end
   end
 
-  def process_request(path = '/test')
+  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_interposer.rb → test_action_controller_interposer.rb}

@@ -2,7 +2,7 @@
 
 require File.join(File.dirname(__FILE__), 'helper')
 
-class TestInterposer < TuneMyGcTestCase
+class TestActionControllerInterposer < TuneMyGcTestCase
   def setup
     TuneMyGc.interposer.uninstall
   end
@@ -58,10 +58,21 @@ class TestInterposer < TuneMyGcTestCase
 
     ENV["RUBY_GC_TUNE_REQUESTS"] = "2"
 
-    process_request
+    process_tunemygc_request
     assert_equal 2, interposer.spy.subscriptions.size
-    process_request
+    process_tunemygc_request
     assert_equal 0, interposer.spy.subscriptions.size
+
+    stages = []
+
+    while !TuneMyGc.snapshotter.empty?
+      stages << TuneMyGc.snapshotter.deq
+    end
+
+    cycles = [:REQUEST_PROCESSING_STARTED]
+
+    assert stages.any?{|s| cycles.include?(s[3]) }
+
     interposer.uninstall
   ensure
     ENV.delete("RUBY_GC_TUNE_REQUESTS")

data/test/test_agent.rb

@@ -11,6 +11,14 @@ class TestAgent < TuneMyGcTestCase
     assert_instance_of TuneMyGc::Snapshotter, TuneMyGc.snapshotter
   end
 
+  def test_spy
+    assert_equal :ActionController, TuneMyGc.spy
+    ENV['RUBY_GC_SPY'] = "minitest"
+    assert_equal 'Minitest', TuneMyGc.spy
+  ensure
+    ENV.delete('RUBY_GC_SPY')
+  end
+
   def test_log
     out, err = capture_io do
       TuneMyGc.logger = Logger.new($stdout)

data/test/test_minitest_interposer.rb

@@ -0,0 +1,79 @@
+# encoding: utf-8
+
+require File.join(File.dirname(__FILE__), 'helper')
+
+class TestMinitestInterposer < TuneMyGcTestCase
+  def setup
+    TuneMyGc.interposer.uninstall
+  end
+
+  def teardown
+    TuneMyGc.interposer = TuneMyGc::Interposer.new(:ActionController)
+  end
+
+  def test_init
+    TuneMyGc.interposer = TuneMyGc::Interposer.new(:Minitest)
+    interposer = TuneMyGc.interposer
+    assert !interposer.installed
+  end
+
+  def test_install_uninstall
+    TuneMyGc.interposer = TuneMyGc::Interposer.new(:Minitest)
+    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(:Minitest)
+    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(:Minitest)
+    interposer = TuneMyGc.interposer
+    interposer.install
+    TuneMyGc.interposer.on_initialized
+
+    ENV["RUBY_GC_TUNE_TESTS"] = "2"
+
+    run_tunemygc_test
+    run_tunemygc_test
+    
+    stages = []
+
+    while !TuneMyGc.snapshotter.empty?
+      stages << TuneMyGc.snapshotter.deq
+    end
+
+    cycles = [:TEST_PROCESSING_STARTED]
+
+    assert stages.any?{|s| cycles.include?(s[3]) }
+
+    interposer.uninstall
+  ensure
+    ENV.delete("RUBY_GC_TUNE_TESTS")
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tunemygc
 version: !ruby/object:Gem::Version
-  version: 1.0.6
+  version: 1.0.7
 platform: ruby
 authors:
 - Bear Metal
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-06 00:00:00.000000000 Z
+date: 2015-02-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -129,14 +129,17 @@ files:
 - 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/minitest.rb
 - lib/tunemygc/subscriber.rb
 - lib/tunemygc/syncer.rb
 - lib/tunemygc/version.rb
 - test/fixtures.rb
 - test/helper.rb
+- test/test_action_controller_interposer.rb
 - test/test_agent.rb
-- test/test_interposer.rb
+- test/test_minitest_interposer.rb
 - test/test_railtie.rb
 - test/test_snapshotter.rb
 - test/test_syncer.rb
@@ -186,8 +189,9 @@ summary: TuneMyGC - optimal MRI Ruby 2.1+ Garbage Collection
 test_files:
 - test/fixtures.rb
 - test/helper.rb
+- test/test_action_controller_interposer.rb
 - test/test_agent.rb
-- test/test_interposer.rb
+- test/test_minitest_interposer.rb
 - test/test_railtie.rb
 - test/test_snapshotter.rb
 - test/test_syncer.rb