tunemygc 1.0.34 → 1.0.35

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e33b23bc2454c7112b58d3a3d248cef73dd989c0
-  data.tar.gz: 4d9de7ed2cf2103a8a0f256d818881b4258f7f4d
+  metadata.gz: dee917a9ec1d9d1433370df607a9fffebf3770c2
+  data.tar.gz: 417022d4328e4efe72d6bffac93b57890288b5a8
 SHA512:
-  metadata.gz: 67f321a822e3c30fae6152dab9e1fd929e79cc297f7bda4a58f05f7bb33fb25ef1182060f324e5409ffe7eb6ad17e562f767f66a0425b346a8584186988f38a3
-  data.tar.gz: a8c8c316f64d8389c2cd00df6d498df16684264bbfd21072f2cc818d7cc642e5f3d2bc8e84c653beb1da1b188b2fac970b57f59f4829dc431f5dc377fb95b60f
+  metadata.gz: 57b3e42ca8b6274972d1cd2dfa47fb20d100497d0238293b45589d83a2549fbcba234d8cec0d0906060922c8ad3c2938b4eaf6ba473a3630072a5dd9936ae7e7
+  data.tar.gz: be9de035273d60d524df9b1e57e5e81a5dbe4e00a572d4ae75109333627db574159541aad560e1fa219665e588eda613ecea81c325a5f5b76a39f4bb93458732

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    tunemygc (1.0.34)
+    tunemygc (1.0.35)
       certified (~> 1.0, >= 1.0.0)
 
 GEM

data/README.md

@@ -8,6 +8,8 @@ The Ruby garbage collector has been flagged as the crux of Ruby performance and
 
 ![tunemygc workflow diagram](https://raw.githubusercontent.com/bear-metal/tunemygc/master/assets/tunemygc-graphic2x-80dac1571cacc70d9b272bb62ae9f6df.png?token=AAABe8sM_ofiQkrCpNw7OYRbtHMLO9l5ks5UuQlYwA%3D%3D)
 
+We also recently [blogged](http://bearmetal.eu/theden/2015-02-20-rails-garbage-collection-tuning-approaches) about how the product works.
+
 ## Benefits
 
 * Faster boot times
@@ -33,6 +35,7 @@ Add to your Gemfile and run `bundle install`
 ``` sh
 gem 'tunemygc'
 ```
+
 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
@@ -52,6 +55,14 @@ For the above command sequences, to sample your app or script for tuning, run (i
 RUBY_GC_TOKEN=08de9e8822c847244b31290cedfc1d51 RUBY_GC_TUNE=1 bundle exec rails s
 ```
 
+And after some profiling requests, when the process terminates, you can visit the given report URL for a config recommendation and some further insights:
+
+``` sh
+[TuneMyGC, pid: 70160] Syncing 688 snapshots
+[TuneMyGC, pid: 70160] ==== Recommended GC configs for ActionController
+[TuneMyGC, pid: 70160] Please visit https://tunemygc.com/configs/d739119e4abc38d42e183d1361991818 to view your configuration and other Garbage Collector insights
+```
+
 The CLI interface supports retrieving configuration options for your application as well.
 
 ``` sh
@@ -81,12 +92,20 @@ Application registered. Use RUBY_GC_TOKEN=08de9e8822c847244b31290cedfc1d51 in yo
 
 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:
+For the above command sequences, to sample a Rails app for tuning, run:
 
 ``` sh
 RUBY_GC_TOKEN=08de9e8822c847244b31290cedfc1d51 RUBY_GC_TUNE=1 bundle exec rails s
 ```
 
+And after some profiling requests, when the process terminates, you can visit the given report URL for a config recommendation and some further insights:
+
+``` sh
+[TuneMyGC, pid: 70160] Syncing 688 snapshots
+[TuneMyGC, pid: 70160] ==== Recommended GC configs for ActionController
+[TuneMyGC, pid: 70160] Please visit https://tunemygc.com/configs/d739119e4abc38d42e183d1361991818 to view your configuration and other Garbage Collector insights
+```
+
 #### Advanced
 
 * `RUBY_GC_SPY=action_controller` (Spy on the GC for this type of processing. `action_controller`, `active_job`, `minitest` or `rspec` are supported)
@@ -107,26 +126,16 @@ Controls the interposer lifetime for sampling a [minitest](https://github.com/se
 
 ## How do I use this?
 
-This gem is only a lightweight agent and designed to not get in your way. There's not much workflow at the moment other than applying the suggested GC configuration to your application's environment.
+This gem is only a lightweight agent and designed to not get in your way. It samples your application during runtime, syncs data with our web service when it terminates and we provide a report URL where you can view a suggested GC configuration and additional tips and insights.
 
-#### Interpreting configurations
+#### Interpreting results
 
-An instrumented process dumps a reccommended config to the Rails logger.
+An instrumented process dumps a report URL with a reccommended config to the Rails logger.
 
 ``` sh
-[TuneMyGC] Syncing 688 snapshots
-[TuneMyGC] ==== Recommended GC configs from https://tunemygc.com/configs/d739119e4abc38d42e183d1361991818
-[TuneMyGC] export RUBY_GC_HEAP_INIT_SLOTS=382429
-[TuneMyGC] export RUBY_GC_HEAP_FREE_SLOTS=603850
-[TuneMyGC] export RUBY_GC_HEAP_GROWTH_FACTOR=1.2
-[TuneMyGC] export RUBY_GC_HEAP_GROWTH_MAX_SLOTS=301925
-[TuneMyGC] export RUBY_GC_HEAP_OLDOBJECT_LIMIT_FACTOR=2.0
-[TuneMyGC] export RUBY_GC_MALLOC_LIMIT=35818030
-[TuneMyGC] export RUBY_GC_MALLOC_LIMIT_MAX=42981636
-[TuneMyGC] export RUBY_GC_MALLOC_LIMIT_GROWTH_FACTOR=1.32
-[TuneMyGC] export RUBY_GC_OLDMALLOC_LIMIT=32782669
-[TuneMyGC] export RUBY_GC_OLDMALLOC_LIMIT_MAX=49174003.5
-[TuneMyGC] export RUBY_GC_OLDMALLOC_LIMIT_GROWTH_FACTOR=1.2
+[TuneMyGC, pid: 70160] Syncing 688 snapshots
+[TuneMyGC, pid: 70160] ==== Recommended GC configs for ActionController
+[TuneMyGC, pid: 70160] Please visit https://tunemygc.com/configs/d739119e4abc38d42e183d1361991818 to view your configuration and other Garbage Collector insights
 ```
 
 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:
@@ -148,9 +157,11 @@ export RUBY_GC_OLDMALLOC_LIMIT_MAX=49174003.5
 export RUBY_GC_OLDMALLOC_LIMIT_GROWTH_FACTOR=1.2
 ```
 
+We're busy working on adding tips on the report URLs for some common problem contexts.
+
 #### Heroku and 12 factor
 
-We have a [Heroku](http://www.heroku.com) addon in Alpha testing and the Ruby GC lends itself well to tuning through 12 factor principles as it's designed around environment variables.
+We have a [Heroku](http://www.heroku.com) addon in Alpha testing and the Ruby GC lends itself well to tuning through [12 factor](http://12factor.net) principles as it's designed around environment variables.
 
 ## Security and privacy concerns
 

data/lib/tunemygc/agent.rb

@@ -48,8 +48,6 @@ module TuneMyGc
       require "tunemygc/syncer"
       syncer = TuneMyGc::Syncer.new
       config = syncer.sync(snapshotter)
-      require "tunemygc/configurator"
-      TuneMyGc::Configurator.new(config).configure
     end
   rescue Exception => e
     log "Config reccommendation error (#{e.message})"

data/lib/tunemygc/cli.rb

@@ -5,7 +5,7 @@ require 'optparse'
 
 module TuneMyGc
   class CLI
-    attr_reader :uri, :client, :options
+    attr_reader :client, :options
 
     def self.start(args)
       args = ["-h"] if args.empty?
@@ -29,12 +29,14 @@ module TuneMyGc
 
     def initialize(options)
       @options = options
-      @uri = URI("http://#{TuneMyGc::HOST}")
-      @client = Net::HTTP.new(@uri.host, @uri.port)
-      @client.use_ssl = (uri.port == 443)
-      @client.read_timeout = NETWORK_TIMEOUT
-      register if options[:email]
-      fetch_config if options[:config]
+      @client = TuneMyGc.http_client
+      if options[:email]
+        register
+      elsif options[:config]
+        fetch_config
+      else
+        raise ArgumentError, "Invalid CLI argument: you can either register or retrieve your last known GC config"
+      end
     end
 
     def register

data/lib/tunemygc/network.rb

@@ -6,4 +6,12 @@ require 'timeout'
 
 module TuneMyGc
   NETWORK_TIMEOUT = 30 #seconds
+
+  def self.http_client
+    uri = URI("https://#{TuneMyGc::HOST}")
+    client = Net::HTTP.new(uri.host, uri.port)
+    client.use_ssl = true
+    client.read_timeout = NETWORK_TIMEOUT
+    client
+  end
 end

data/lib/tunemygc/spies/action_controller.rb

@@ -32,14 +32,13 @@ module TuneMyGc
       attr_reader :subscriptions
 
       def initialize
+        super
         @subscriptions = []
-        @requests_processed = 0
-        @requests_limit = nil
       end
 
       def install
-        @subscriptions << ActiveSupport::Notifications.subscribe(/^start_processing.action_controller$/, TuneMyGc::StartRequestSubscriber.new)
-        @subscriptions << ActiveSupport::Notifications.subscribe(/^process_action.action_controller$/, TuneMyGc::EndRequestSubscriber.new)
+        subscription(/^start_processing.action_controller$/, TuneMyGc::StartRequestSubscriber.new)
+        subscription(/^process_action.action_controller$/, TuneMyGc::EndRequestSubscriber.new)
         TuneMyGc.log "hooked: action_controller"
       end
 
@@ -53,14 +52,19 @@ module TuneMyGc
 
       def check_uninstall
         if ENV["RUBY_GC_TUNE_REQUESTS"]
-          @requests_limit ||= Integer(ENV["RUBY_GC_TUNE_REQUESTS"])
-          @requests_processed += 1
-          if @requests_processed == @requests_limit
+          @limit ||= Integer(ENV["RUBY_GC_TUNE_REQUESTS"])
+          @processed += 1
+          if @processed == @limit
             uninstall
-            TuneMyGc.log "kamikaze after #{@requests_processed} of #{@requests_limit} requests"
+            TuneMyGc.log "kamikaze after #{@processed} of #{@limit} requests"
           end
         end
       end
+
+      private
+      def subscription(pattern, handler)
+        @subscriptions << ActiveSupport::Notifications.subscribe(pattern, handler)
+      end
     end
   end
 end

data/lib/tunemygc/spies/active_job.rb

@@ -5,11 +5,6 @@ require 'active_job'
 module TuneMyGc
   module Spies
     class ActiveJob < TuneMyGc::Spies::Base
-      def initialize
-        @jobs_processed = 0
-        @jobs_limit = nil
-      end
-
       def install
         ::ActiveJob::Base.__send__(:include, hooks_module)
         TuneMyGc.log "hooked: active_job"
@@ -24,11 +19,11 @@ module TuneMyGc
 
       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
+          @limit ||= Integer(ENV["RUBY_GC_TUNE_JOBS"])
+          @processed += 1
+          if @processed == @limit
             uninstall
-            TuneMyGc.log "kamikaze after #{@jobs_processed} of #{@jobs_limit} jobs"
+            TuneMyGc.log "kamikaze after #{@processed} of #{@limit} jobs"
           end
         end
       end

data/lib/tunemygc/spies/base.rb

@@ -3,6 +3,11 @@
 module TuneMyGc
   module Spies
     class Base
+      def initialize
+        @processed = 0
+        @limit = nil
+      end
+
       def install
         raise NotImplementedError
       end

data/lib/tunemygc/spies/minitest.rb

@@ -5,11 +5,6 @@ require 'minitest'
 module TuneMyGc
   module Spies
     class Minitest < TuneMyGc::Spies::Base
-      def initialize
-        @tests_processed = 0
-        @tests_limit = nil
-      end
-
       def install
         MiniTest::Unit::TestCase.__send__(:include, hooks_module)
         TuneMyGc.log "hooked: minitest"
@@ -24,11 +19,11 @@ module TuneMyGc
 
       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
+          @limit ||= Integer(ENV["RUBY_GC_TUNE_TESTS"])
+          @processed += 1
+          if @processed == @limit
             uninstall
-            TuneMyGc.log "kamikaze after #{@tests_processed} of #{@tests_limit} tests"
+            TuneMyGc.log "kamikaze after #{@processed} of #{@limit} tests"
           end
         end
       end

data/lib/tunemygc/spies/rspec.rb

@@ -9,11 +9,6 @@ end
 module TuneMyGc
   module Spies
     class Rspec < TuneMyGc::Spies::Base
-      def initialize
-        @tests_processed = 0
-        @tests_limit = nil
-      end
-
       def install
         RSpec::Core.__send__(:include, hooks_module)
         TuneMyGc.log "hooked: rspec"
@@ -28,11 +23,11 @@ module TuneMyGc
 
       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
+          @limit ||= Integer(ENV["RUBY_GC_TUNE_TESTS"])
+          @processed += 1
+          if @processed == @limit
             uninstall
-            TuneMyGc.log "kamikaze after #{@tests_processed} of #{@tests_limit} tests"
+            TuneMyGc.log "kamikaze after #{@processed} of #{@limit} tests"
           end
         end
       end

data/lib/tunemygc/syncer.rb

@@ -6,13 +6,10 @@ module TuneMyGc
   class Syncer
     ENVIRONMENT = [ENV['RUBY_GC_TOKEN'], RUBY_VERSION, TuneMyGc.rails_version, ENV.select {|k,v| k =~ /RUBY_GC_/ }, TuneMyGc::VERSION, GC::OPTS, GC::INTERNAL_CONSTANTS].freeze
 
-    attr_reader :uri, :client
+    attr_reader :client
 
     def initialize(host = TuneMyGc::HOST)
-      @uri = URI("http://#{host}/ruby")
-      @client = Net::HTTP.new(@uri.host, @uri.port)
-      @client.use_ssl = (uri.port == 443)
-      @client.read_timeout = NETWORK_TIMEOUT
+      @client = TuneMyGc.http_client
     end
 
     def sync(snapshotter)
@@ -58,7 +55,7 @@ module TuneMyGc
         payload << snapshot
       end
       data = ActiveSupport::JSON.encode(payload)
-      response = client.post(uri.path, data, TuneMyGc::HEADERS)
+      response = client.post('/ruby', data, TuneMyGc::HEADERS)
       snapshotter.unit_of_work = false
       if Net::HTTPNotFound === response
         TuneMyGc.log "Invalid application token. Please generate one with 'bundle exec tunemygc <a_valid_email_address>' and set the RUBY_GC_TOKEN environment variable"
@@ -94,11 +91,7 @@ module TuneMyGc
 
     def process_config_callback(response)
       report_url = response.body.gsub(/\.json$/, '')
-      config = client.get(URI(response.body).path)
-      ActiveSupport::JSON.decode(config.body).merge('report' => report_url)
-    rescue Exception => e
       TuneMyGc.log "Please visit #{report_url} to view your configuration and other Garbage Collector insights"
-      return false
     end
   end
 end

data/lib/tunemygc/version.rb

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

data/test/test_syncer.rb

@@ -3,12 +3,6 @@
 require File.join(File.dirname(__FILE__), 'helper')
 
 class TestSyncer < TuneMyGcTestCase
-  def test_uri
-    syncer = TuneMyGc::Syncer.new
-    assert_equal "tunemygc.com", syncer.uri.host
-    assert_equal 443, syncer.uri.port
-  end
-
   def test_client
     syncer = TuneMyGc::Syncer.new
     assert_instance_of Net::HTTP, syncer.client

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tunemygc
 version: !ruby/object:Gem::Version
-  version: 1.0.34
+  version: 1.0.35
 platform: ruby
 authors:
 - Bear Metal
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-09 00:00:00.000000000 Z
+date: 2015-03-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: certified
@@ -139,7 +139,6 @@ files:
 - lib/tunemygc.rb
 - lib/tunemygc/agent.rb
 - lib/tunemygc/cli.rb
-- lib/tunemygc/configurator.rb
 - lib/tunemygc/interposer.rb
 - lib/tunemygc/network.rb
 - lib/tunemygc/railtie.rb

data/lib/tunemygc/configurator.rb

@@ -1,25 +0,0 @@
-# encoding: utf-8
-
-module TuneMyGc
-  class Configurator
-    attr_reader :config
-
-    def initialize(config)
-      @config = config
-    end
-
-    def configure
-      if Hash === config && !config.empty?
-        TuneMyGc.log "==== Recommended GC configs for #{TuneMyGCc::Spies.current}: #{config.delete("report")}"
-        write_env("Speed")
-      end
-    end
-
-    private
-    def write_env(strategy)
-      config.delete(strategy).each do |var,val|
-        TuneMyGc.log "export #{var}=#{val}"
-      end
-    end
-  end
-end