tunemygc 1.0.21 → 1.0.22

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0835ea9c7b907e38b0d816dd64d73cdea16215c0
-  data.tar.gz: 426c1f8515ba83dd3c021beb85ade70346f71ccc
+  metadata.gz: 9672bbb45047e92d9539dc1cb38852dfbb0e2cc6
+  data.tar.gz: 1d3f3d06a6c128a0d982ede89904f237d78610f4
 SHA512:
-  metadata.gz: d910a5911e19f611c4c6331d546019527d2ecb5987dcc91b644c00d55a21e1b915c71ce4fb47378d37067719e8f380e2e8bb25ed963e23663c0a4de509c9445b
-  data.tar.gz: f32c86c4b5303ecd93a32256d210ef5afd8d30b019c7d7c8fcfe82e2090fa0a9d479a203abbe73c11133f4aa5111fc1892ef4b9b1739e7cdb7b3d4faba4a8688
+  metadata.gz: 66ef450dba0017bf54915abda65be2fbbba8729f1fb096df36bea2d4bf30d50532d64d04f3db3c42bf3629378186fc2a6b649893d0e77a8f8ee0e1971ac127b3
+  data.tar.gz: e631316dc487e2dd4d7ca190ccd33c062f1e614305abc8c854d3093f5a4b28e3230b96d012e9d5a975c4842366bcadfe966f5f01a496be054e39fd1c49669c11

data/README.md

@@ -2,7 +2,7 @@
 
 [![Build Status](https://travis-ci.org/bear-metal/tunemygc.svg)](https://travis-ci.org/bear-metal/tunemygc)
 
-The Ruby garbage collector has been flagged as the crux of Ruby performance and memory use for a long time. It has improved a lot over the last years, but there's still a lot to tune and control. *The default configuration is not suitable and optimal for Rails applications, and neither is there a one-size-fits-all set of tuned parameters that would suit every app.* However, hand-tuning the GC parameters is a slippery slope to navigate for most developers.
+The Ruby garbage collector has been flagged as the crux of Ruby performance and memory use for a long time. It has improved a lot over the last years, but there's still a lot to tune and control. *The default configuration is not suitable and optimal for large Ruby applications, and neither is there a one-size-fits-all set of tuned parameters that would suit every app.* However, hand-tuning the GC parameters is a slippery slope to navigate for most developers.
 
 ## We're fixing this
 
@@ -33,11 +33,7 @@ Add to your Gemfile and run `bundle install`
 ``` sh
 gem 'tunemygc'
 ```
-This gem linterposes itself into the Rails request/response lifecycles and piggy backs off the new GC events in Ruby 2.x for introspection. Tuning recommendations are handled through a web service at `https://tunemygc.com`. You will need a `rails > 4.1`, installation and MRI Ruby `2.1`, or later.
-
-#### Windows
-
-Has not been tested at all.
+This gem linterposes itself into the application and piggy backs off the new GC events in Ruby 2.x for introspection. Tuning recommendations are handled through a web service at `https://tunemygc.com`. You will need MRI Ruby `2.1`, or later. [Rails](http://www.rubyonrails.org) applications, background jobs, tests and any proprietary Ruby scripts and frameworks are supported.
 
 ## Getting started
 
@@ -50,7 +46,7 @@ Application registered. Use RUBY_GC_TOKEN=08de9e8822c847244b31290cedfc1d51 in yo
 
 We require a valid email address as a canonical reference for tuner tokens for your applications.
 
-For the above command sequences, to sample your Rails app for tuning, run:
+For the above command sequences, to sample your app or script for tuning, run (inject `RUBY_GC_TOKEN` and `RUBY_GC_TUNE` to your env):
 
 ``` sh
 RUBY_GC_TOKEN=08de9e8822c847244b31290cedfc1d51 RUBY_GC_TUNE=1 bundle exec rails s
@@ -61,8 +57,8 @@ The CLI interface supports retrieving configuration options for your application
 ``` sh
 $ 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
+    -r, --register EMAIL             Register this application with the https://tunemygc.com service
+    -c, --config TOKEN               Fetch the last known config for a given application
     -h, --help                       How to use the TuneMyGC agent CLI
 ```
 
@@ -93,9 +89,9 @@ 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. `action_controller`, `active_job` or `minitest` are supported)
+* `RUBY_GC_SPY=action_controller` (Spy on the GC for this type of processing. `action_controller`, `active_job`, `minitest` or `rspec` are supported)
 
-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.
+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), [minitest](https://github.com/seattlerb/minitest) and [rspec](http://rspec.info) are also supported as experimental features.
 
 * `RUBY_GC_TUNE_REQUESTS=x` (a numeric value eg. `200`)
 
@@ -107,7 +103,7 @@ Controls the interposer lifetime for sampling ActiveJob jobs. It will enable its
 
 * `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.
+Controls the interposer lifetime for sampling a [minitest](https://github.com/seattlerb/minitest) or [rspec](http://rspec.info) 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?
 

data/lib/tunemygc.rb

@@ -11,6 +11,10 @@ module TuneMyGc
   def self.rails?
     defined?(Rails) && Rails.version >= "4.0"
   end
+
+  def self.rails_version
+    rails? ? Rails.version : "0.0"
+  end
 end
 
 if ENV["RUBY_GC_TUNE"]

data/lib/tunemygc/agent.rb

@@ -35,10 +35,6 @@ module TuneMyGc
     logger.info "[TuneMyGC] #{message}"
   end
 
-  def rails_version
-    rails? ? Rails.version : "0.0"
-  end
-
   def spy
     TuneMyGc::Spies.current
   end

data/lib/tunemygc/cli.rb

@@ -13,10 +13,10 @@ module TuneMyGc
       OptionParser.new do |opts|
         opts.banner = "Usage: tunemygc [options]"
 
-        opts.on("-r ", "--register EMAIL", "Register this Rails app with the https://tunemygc.com service") do |email|
+        opts.on("-r ", "--register EMAIL", "Register this application with the https://tunemygc.com service") do |email|
           options[:email] = email
         end
-        opts.on("-c ", "--config TOKEN", "Fetch the last known config for a given Rails app") do |token|
+        opts.on("-c ", "--config TOKEN", "Fetch the last known config for a given application") do |token|
           options[:config] = token
         end
         opts.on_tail("-h", "--help", "How to use the TuneMyGC agent CLI") do

data/lib/tunemygc/spies.rb

@@ -11,6 +11,7 @@ module TuneMyGc
     spy :Minitest
     spy :ActiveJob
     spy :Manual
+    spy :Rspec
 
     def self.current
       s = if ENV['RUBY_GC_SPY']

data/lib/tunemygc/spies/rspec.rb

@@ -0,0 +1,59 @@
+# encoding: utf-8
+
+require 'rspec'
+
+module TuneMyGc
+  module Spies
+    class Rspec
+      def initialize
+        @tests_processed = 0
+        @tests_limit = nil
+      end
+
+      def install
+        RSpec::Core.__send__(:include, hooks_module)
+        TuneMyGc.log "hooked: rspec"
+      end
+
+      def uninstall
+        TuneMyGc.uninstall_gc_tracepoint
+        TuneMyGc.log "uninstalled GC tracepoint"
+        RSpec::Core.__send__(:include, disabled_hooks_module)
+        TuneMyGc.log "uninstalled rspec 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
+          RSpec.configure do |c|
+            c.before(:all) { TuneMyGc.processing_started }
+            c.after(:all) { TuneMyGc.processing_ended }
+          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/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tunemygc
 version: !ruby/object:Gem::Version
-  version: 1.0.21
+  version: 1.0.22
 platform: ruby
 authors:
 - Bear Metal
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-19 00:00:00.000000000 Z
+date: 2015-03-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -149,6 +149,7 @@ files:
 - lib/tunemygc/spies/active_job.rb
 - lib/tunemygc/spies/manual.rb
 - lib/tunemygc/spies/minitest.rb
+- lib/tunemygc/spies/rspec.rb
 - lib/tunemygc/subscriber.rb
 - lib/tunemygc/syncer.rb
 - lib/tunemygc/version.rb