tuttle 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 73376a729eaa050431d5429bc44cbaf0ae395102
-  data.tar.gz: 28f8cbd544f44c4313aab862c4851c73a1db19b2
+  metadata.gz: afd1a594a8f4791f9d32265d0c3845df82ede0f9
+  data.tar.gz: dd185815e582e48e5e9eeb56df7abcffc2a5fe3f
 SHA512:
-  metadata.gz: d1adf98bdb6bee5241729f1d3f63fe837b7c8827940e149915a2b26c65d05e594d00a642039d5e4c2335efe3561db24db2bc43375f42d3a866b8c9519079f6f5
-  data.tar.gz: cbc6476294b3e90d88ba033798f9e6854f5784ecb3b3c15ff78714eb1bdc4b628a2233efa472c93a3ab41d61b6a7f4b61234ce36bf1d5d4f82ddd46ef851d525
+  metadata.gz: b3dd8bb7b3411012cd4adba504ae9d80c9882b16f1ba34ad9219005ce572021102feac399a1bf4dd14e5b337f291fc93ab4d55ea83c8314d7d97439f4287a8b9
+  data.tar.gz: 1fd05873a8248f3ef3a04c0e3975345d648e9c89ea0c0213ef867372dcf949e081237587dbbe6b19be9b59707ede7ac1bcddca21bbe7cbd56ac6d6f1cae9dabd

data/CHANGELOG.md

@@ -1,6 +1,16 @@
+### 0.0.3
+
+* Features
+  * Rails caching instrumentation
+  * Improved initialization/configuration approach
+  * Gem detection and reporting for HTTP clients and JSON libraries
+  * Ruby GC tuning stats and advice
+  * Favicon!
+  * Experimental Postgres stored-procedure cache inspection
+
 ### 0.0.2
 
-* features
+* Features
   * Tuttle::Engine will now auto-mount routes
   * Engine configurable via initializer
   * ActiveSupport cache configuration inspection
@@ -8,7 +18,7 @@
 
 ### 0.0.1
 
-* features
+* Features
   * Initial engine implementation with instrumentation monitoring
   * Rails inspection for general configuration, controllers, models, assets, helpers
   * Ruby VM inspection

data/README.md

@@ -7,7 +7,7 @@
 
 Tuttle is a tool for assisting Rails developers by exposing runtime configuration information for your application. It is similar to the `/rails/info/routes` and `/rails/info/properties` information pages or the `rake routes` and `rake middleware` tasks.
 
-Tuttle is very much in alpha/proof-of-concept mode. The [tuttle-demo](github.com/dgynn/tuttle-demo) project shows it being used in a simple application.
+Tuttle is very much in alpha/proof-of-concept mode. You can see it in action in a [simple demo application](http://tuttle-demo.herokuapp.com/). The [source code](https://github.com/dgynn/tuttle-demo) for that demo is also on GitHub.
 
 ## To use...
 

data/app/controllers/tuttle/application_controller.rb

@@ -6,12 +6,9 @@ module Tuttle
 
     def check_reload_status
       return unless Tuttle::Engine.reload_needed && !Rails.configuration.eager_load
-      Rails.logger.warn('Tuttle: Eager-loading application')
-      # Rails::Application::Finisher defines an initializer that *would* execute
-      #   these two lines if eager_load were enabled
-      # ActiveSupport.run_load_hooks(:before_eager_load, Rails.application)
+      Tuttle::Engine.logger.warn('Eager-loading application')
       ActiveSupport::Notifications.instrument 'tuttle.perform_eager_load' do
-        Rails.configuration.eager_load_namespaces.each(&:eager_load!)
+        Rails.application.eager_load!
         Tuttle::Engine.reload_needed = false
       end
     end

data/app/controllers/tuttle/cancancan_controller.rb

@@ -9,12 +9,15 @@ module Tuttle
     end
 
     def rule_tester
+      @models = ActiveRecord::Base.descendants
       @action = params[:action_name] || 'read'
+
       subject_class = params[:subject_class]
       subject_id = params[:subject_id]
-      if subject_class
+
+      if !subject_class.blank? && Kernel.const_defined?(subject_class)
         begin
-          subject_klass = subject_class.constantize
+          subject_klass = Kernel.const_get(params[:subject_class])
           @subject = subject_klass.find(subject_id) unless subject_id.blank?
           @subject ||= subject_klass.new
         rescue

data/app/controllers/tuttle/gems_controller.rb

@@ -0,0 +1,19 @@
+require_dependency 'tuttle/application_controller'
+
+module Tuttle
+  class GemsController < ApplicationController
+
+    def http_clients
+
+    end
+
+    def json
+
+    end
+
+    def other
+
+    end
+
+  end
+end

data/app/controllers/tuttle/rails_controller.rb

@@ -59,8 +59,14 @@ module Tuttle
     end
 
     def cache
+      # TODO: make cache instrumentation controllable - this will automatically turn in on in Rails < 4.2
+      # Instrumentation is always on in Rails 4.2+
+      if Rails::VERSION::STRING =~ /^4\.1\./ && !ActiveSupport::Cache::Store.instrument
+        ActiveSupport::Cache::Store.instrument=true
+      end
       @cache = Rails.cache
       @cache_events = Tuttle::Engine.events.select {|e| /cache_(read|write)\.active_support/ =~ e.name }
+      @tuttle_cache_events = Tuttle::Engine.cache_events
     end
 
   end

data/app/controllers/tuttle/ruby_controller.rb

@@ -8,5 +8,28 @@ module Tuttle
       @filtered_env = ENV.to_hash.tap{ |h| h.each{ |k,_v| h[k] = '--FILTERED--' if /.*_(URL|PASSWORD|KEY|KEY_BASE)$/ =~ k  } }
     end
 
+    def tuning
+      @gc_enabled = (GC.disable ? false : GC.enable)
+
+      # taken verbatim from the ruby 2.2 man page
+      @gc_params = {
+        'RUBY_GC_HEAP_INIT_SLOTS' =>               'Initial allocation slots.  Introduced in Ruby 2.1, default: 10000.',
+        'RUBY_GC_HEAP_FREE_SLOTS' =>               'Prepare at least this amount of slots after GC. Allocate this number slots if there are not enough slots.  Introduced in Ruby 2.1, default: 4096',
+        'RUBY_GC_HEAP_GROWTH_FACTOR' =>            'Increase allocation rate of heap slots by this factor.  Introduced in Ruby 2.1, default: 1.8, minimum: 1.0 (no growth)',
+        'RUBY_GC_HEAP_GROWTH_MAX_SLOTS' =>         'Allocation rate is limited to this number of slots, preventing excessive allocation due to RUBY_GC_HEAP_GROWTH_FACTOR.  Introduced in Ruby 2.1, default: 0 (no limit)',
+        'RUBY_GC_HEAP_OLDOBJECT_LIMIT_FACTOR' =>   'Perform a full GC when the number of old objects is more than R * N, where R is this factor and N is the number of old objects after the last full GC.  Introduced in Ruby 2.1.1, default: 2.0',
+        'RUBY_GC_MALLOC_LIMIT' =>                  'The initial limit of young generation allocation from the malloc-family.  GC will start when this limit is reached.  Default: 16MB',
+        'RUBY_GC_MALLOC_LIMIT_MAX' =>              'The maximum limit of young generation allocation from malloc before GC starts.  Prevents excessive malloc growth due to RUBY_GC_MALLOC_LIMIT_GROWTH_FACTOR.  Introduced in Ruby 2.1, default: 32MB.',
+        'RUBY_GC_MALLOC_LIMIT_GROWTH_FACTOR' =>    'Increases the limit of young generation malloc calls, reducing GC frequency but increasing malloc growth until RUBY_GC_MALLOC_LIMIT_MAX is reached. Introduced in Ruby 2.1, default: 1.4, minimum: 1.0 (no growth)',
+        'RUBY_GC_OLDMALLOC_LIMIT' =>               'The initial limit of old generation allocation from malloc, a full GC will start when this limit is reached.  Introduced in Ruby 2.1, default: 16MB',
+        'RUBY_GC_OLDMALLOC_LIMIT_MAX' =>           'The maximum limit of old generation allocation from malloc before a full GC starts.  Prevents excessive malloc growth due to RUBY_GC_OLDMALLOC_LIMIT_GROWTH_FACTOR.  Introduced in Ruby 2.1, default: 128MB',
+        'RUBY_GC_OLDMALLOC_LIMIT_GROWTH_FACTOR' => 'Increases the limit of old generation malloc allocation, reducing full GC frequency but increasing malloc growth until RUBY_GC_OLDMALLOC_LIMIT_MAX is reached.  Introduced in Ruby 2.1, default: 1.2, minimum: 1.0 (no growth)'
+      }
+    end
+
+    def miscellaneous
+
+    end
+
   end
 end

data/app/helpers/tuttle/application_helper.rb

@@ -1,4 +1,9 @@
 module Tuttle
   module ApplicationHelper
+
+    def truth_label(is_true, true_label='true', false_label='false')
+      "<span class='label label-#{ is_true ? 'success':'danger'}'>#{ is_true ? true_label : false_label}</span>".html_safe
+    end
+
   end
 end

data/app/views/layouts/tuttle/application.html.erb

@@ -5,8 +5,10 @@
   <meta http-equiv="X-UA-Compatible" content="IE=edge">
   <meta name="viewport" content="width=device-width, initial-scale=1">
   <title>Tuttle</title>
-  <link rel="stylesheet" href="//maxcdn.bootstrapcdn.com/bootstrap/3.2.0/css/bootstrap.min.css">
-  <link rel="stylesheet" href="//maxcdn.bootstrapcdn.com/bootstrap/3.2.0/css/bootstrap-theme.min.css">
+  <link rel="stylesheet" href="//maxcdn.bootstrapcdn.com/bootstrap/latest/css/bootstrap.min.css">
+  <link rel="stylesheet" href="//maxcdn.bootstrapcdn.com/bootstrap/latest/css/bootstrap-theme.min.css">
+  <link rel="icon" href="<%= image_path 'tuttle/favicon.ico' %>">
+
   <%= stylesheet_link_tag "tuttle/application", :media => "all" %>
   <%= csrf_meta_tags %>
 </head>
@@ -45,11 +47,26 @@
         <li class="dropdown">
           <a href="#" class="dropdown-toggle" data-toggle="dropdown">Gems <span class="caret"></span></a>
           <ul class="dropdown-menu" role="menu">
-            <li><%= link_to 'Devise', devise_path if defined?(Devise) %></li>
-            <li><%= link_to 'CanCanCan', cancancan_path if defined?(CanCanCan) %></li>
+            <%- if defined?(Devise) %>
+              <li><%= link_to 'Devise', devise_path %></li>
+            <%- end %>
+            <%- if defined?(CanCanCan) %>
+              <li><%= link_to 'CanCanCan', cancancan_path %></li>
+            <%- end %>
+            <li><%= link_to 'HTTP Clients', gems_http_clients_path %></li>
+            <li><%= link_to 'JSON', gems_json_path %></li>
+            <li><%= link_to 'Other', gems_other_path %></li>
+          </ul>
+        </li>
+        <li class="dropdown">
+          <a href="#" class="dropdown-toggle" data-toggle="dropdown">Ruby <span class="caret"></span></a>
+          <ul class="dropdown-menu" role="menu">
+            <li><%= link_to 'Overview', ruby_path %></li>
+            <li class="divider"></li>
+            <li><%= link_to 'Tuning', ruby_tuning_path %></li>
+            <li><%= link_to 'Miscellaneous', ruby_miscellaneous_path %></li>
           </ul>
         </li>
-        <li><%= link_to 'Ruby', ruby_path %></li>
       </ul>
     </div>
   </div>
@@ -61,8 +78,8 @@
 </div>
 </div>
 
-<script src="//ajax.googleapis.com/ajax/libs/jquery/1.11.1/jquery.min.js"></script>
-<script src="//maxcdn.bootstrapcdn.com/bootstrap/3.2.0/js/bootstrap.min.js"></script>
+<script src="//code.jquery.com/jquery-2.1.3.min.js"></script>
+<script src="//maxcdn.bootstrapcdn.com/bootstrap/latest/js/bootstrap.min.js"></script>
 <script src="//cdnjs.cloudflare.com/ajax/libs/typeahead.js/0.10.4/typeahead.bundle.min.js"></script>
 <%= javascript_include_tag "tuttle/application" =%>
 <%= content_for(:javascripts) =%>

data/app/views/tuttle/cancancan/_rule_table.html.erb

@@ -21,7 +21,7 @@
         <%- subjects = rule.instance_variable_get('@subjects') %>
         <td>
           <% subjects.each do |s| %>
-              <%= s.class <= Symbol ? s.to_s : s.name %>
+              <%= s %>
           <% end %>
         </td>
         <td><%= rule.conditions unless rule.conditions.empty? %></td>

data/app/views/tuttle/cancancan/index.html.erb

@@ -32,7 +32,7 @@
       <%- subjects = rule.instance_variable_get('@subjects') %>
       <td>
         <% subjects.each do |s| %>
-          <%= s.class <= Symbol ? s.to_s : s.name %>
+          <%= s %>
         <% end %>
       </td>
       <td><%= rule.conditions %></td>

data/app/views/tuttle/cancancan/rule_tester.html.erb

@@ -11,13 +11,13 @@
   <div class="form-group">
     <label for="action_name" class="col-sm-2 control-label">Action</label>
     <div class="col-sm-10">
-      <input type="text" class="form-control typeahead" name="action_name" id="action_name" value="<%= params[:action_name] || 'read' %>">
+      <input type="text" class="form-control typeahead" name="action_name" id="action_name" value="<%= @action %>">
     </div>
   </div>
   <div class="form-group">
     <label for="subject_class" class="col-sm-2 control-label">Subject Class</label>
     <div class="col-sm-10">
-      <input type="text" class="form-control" name="subject_class" value="<%= @subject.try(:class) || params[:subject_class] %>">
+      <%= select_tag('subject_class',options_for_select(@models.collect(&:name).sort, params[:subject_class]),:include_blank=>true, :class => 'form-control') %>
     </div>
   </div>
   <div class="form-group">

data/app/views/tuttle/gems/http_clients.html.erb

@@ -0,0 +1,35 @@
+<h1>HTTP Clients</h1>
+
+<div class="panel panel-default">
+  <div class="panel-heading">
+    <h3 class="panel-title">HTTP Client Libraries</h3>
+  </div>
+  <div class="panel-body">
+    <p>
+      HTTP client libraries are used to make requests to remote servers often as REST or SOAP requests.
+      There are many libraries available with different features and purposes.
+      Often client libraries are pulled in as dependencies of other gems you've included.
+    </p>
+
+    <p>Libraries detected and loaded</p>
+    <ul>
+      <li>Net::HTTP (core ruby) <%= truth_label(defined?(Net::HTTP)) %></li>
+      <li>Excon: <%= truth_label(defined?(Excon)) %></li>
+      <li>HTTPI: <%= truth_label(defined?(HTTPI)) %></li>
+      <li>httpclient: <%= truth_label(defined?(HTTPClient)) %></li>
+      <li>Typhoeus: <%= truth_label(defined?(Typhoeus)) %></li>
+      <li>Faraday: <%= truth_label(defined?(Faraday)) %>
+        <%- if defined?(Faraday) %>
+          &mdash; (Default adapter: <%= Faraday.default_adapter %>)
+        <%- end %>
+      </li>
+      <li>Net::HTTP::Post::Multipart: <%= truth_label(defined?(Net::HTTP::Post::Multipart)) %></li>
+      <li>Patron: <%= truth_label(defined?(Patron::Session)) %></li>
+      <li>Savon: <%= truth_label(defined?(Savon)) %></li>
+      <li>Event Machine HttpRequest: <%= truth_label(defined?(EventMachine::HttpRequest)) %></li>
+    </ul>
+    <p></p>
+  </div>
+  <div class="panel-footer">
+  </div>
+</div>

data/app/views/tuttle/gems/json.html.erb

@@ -0,0 +1,31 @@
+<h1>JSON Gems</h1>
+
+<div class="panel panel-default">
+  <div class="panel-heading">
+    <h3 class="panel-title">JSON Libraries</h3>
+  </div>
+  <div class="panel-body">
+    <p>
+      There are a small number of libraries that are involved in JSON encoding and decoding.
+      Depending on the nature of the JSON you are decoding or objects you are encoding you may see a benefit by using the appropriate library.
+    </p>
+
+    <p>Libraries detected</p>
+    <ul>
+      <li>JSON Pure: <%= truth_label(defined?(JSON::Pure)) %></li>
+      <li>JSON: <%= truth_label(defined?(JSON) && !defined?(JSON::Pure)) %></li>
+      <li>Yajl: <%= truth_label(defined?(Yajl)) %></li>
+      <li>Oj: <%= truth_label(defined?(Oj)) %></li>
+      <li>
+        MultiJson: <%= truth_label(defined?(MultiJson)) %>
+        <%- if defined?(MultiJson) %>
+          &mdash; (Adapter: <%= MultiJson.adapter %>)
+        <%- end %>
+      </li>
+      <li>ActiveSupport::JSON: <%= truth_label(defined?(ActiveSupport::JSON)) %></li>
+    </ul>
+    <p></p>
+  </div>
+  <div class="panel-footer">
+  </div>
+</div>

data/app/views/tuttle/gems/other.html.erb

@@ -0,0 +1,16 @@
+<h1>Other Gems</h1>
+
+<div class="panel panel-default">
+  <div class="panel-heading">
+    <h3 class="panel-title">Performance Libraries</h3>
+  </div>
+  <div class="panel-body">
+    <p>
+      Various gems are often included in applications to eke out a bit more performance.
+      Here are various gems which may be helpful.
+    </p>
+    <p>fast_blank - <%= truth_label("TEST".methods.include?(:blank_as?), 'installed', 'not installed') %></p>
+  </div>
+  <div class="panel-footer">
+  </div>
+</div>

data/app/views/tuttle/rails/cache.html.erb

@@ -75,7 +75,33 @@ DalliStore options
   <% end -%>
 </table>
 
+<h3>Recent cache call locations</h3>
+
+<table class="table">
+  <tr>
+    <th>Action</th>
+    <th>File</th>
+    <th>Line</th>
+    <th>Key</th>
+    <th>Hit?</th>
+    <th>Options</th>
+    <th>Time</th>
+    <th>TransactionID</th>
+  </tr>
+  <% @tuttle_cache_events.reverse.each do |event| -%>
+    <tr >
+      <td>Read</td>
+      <td><%= event.payload[:call_location_path] %></td>
+      <td><%= event.payload[:call_location_lineno] %></td>
+      <td><%= event.payload[:key] %></td>
+      <td><%= event.payload[:hit] %></td>
+      <td><%= event.payload.reject {|k,_v| %i(key hit call_location_path call_location_lineno).include?(k) } %></td>
+      <td><%= event.time.to_s(:db) %></td>
+      <td><%= event.transaction_id %></td>
+    </tr>
+  <% end -%>
+</table>
+
 <%-
     # TODO: Track calls and record keys broken down by namespace
-    # TODO: Possibly track calls with backtrace to identify calling location
 -%>

data/app/views/tuttle/rails/database.html.erb

@@ -16,6 +16,27 @@
 <p>Schema Cache size = <%= @conn.schema_cache.size %></p>
 
 <%- if defined?(ActiveRecord::ConnectionAdapters::PostgreSQLAdapter) && @conn.class <= ActiveRecord::ConnectionAdapters::PostgreSQLAdapter -%>
+
+<%- statement_pool = @conn.instance_variable_get(:@statements) %>
+<%- if statement_pool.present? %>
+  <h3>Prepared Statement Pool</h3>
+    <p>Max = <%= statement_pool.instance_variable_get(:@max) %></p>
+    <p>Counter = <%= statement_pool.instance_variable_get(:@counter) %></p>
+    <h4>Cache</h4>
+    <ol>
+    <%- statement_pool.instance_variable_get(:@cache).each do |pid,cache| %>
+      <li>PID: <%= pid %>
+        <ol>
+          <%- cache.each do |k,v| %>
+            <li><%= v %> = <%= k %></li>
+          <%- end %>
+        </ol>
+      </li>
+    <%- end %>
+    </ol>
+<%- end %>
+
+
 <h3>PostgreSQL-only Info</h3>
 <p>Database = <%= @conn.current_database %></p>
 <p>Schema = <%= @conn.current_schema %></p>

data/app/views/tuttle/rails/index.html.erb

@@ -93,11 +93,21 @@ Log Level = <%= Rails.configuration.log_level %>
   <div class="tab-pane" id="initializers">
     <p>Rails initializers are blocks of code that run during application initialization.</p>
     <p>Initializers can be provided by any Railtie, which includes Rails components themselves as well as many Gems.</p>
-    <ol>
-      <%- Rails.application.initializers.each do |initializer| %>
-        <li><%= initializer.name %> - <%= initializer.instance_variable_get('@context').class.name %></li>
-      <%- end %>
-    </ol>
+    <table class="table table-condensed">
+      <tr><th>#</th><th>Name</th><th>Context Class</th><th>Group</th><th>After</th><th>Before</th></tr>
+    <%- idx = 0 %>
+    <%- Rails.application.initializers.tsort_each do |initializer| %>
+      <%- options = initializer.instance_variable_get('@options') %>
+      <tr>
+        <td><%= idx+=1 %></td>
+        <td><%= initializer.name %></td>
+        <td><%= initializer.instance_variable_get('@context').class.name %></td>
+        <td><%= options.try(:[],:group) %></td>
+        <td><%= options.try(:[],:after) %></td>
+        <td><%= options.try(:[],:before) %></td>
+      </tr>
+    <%- end %>
+    </table>
   </div>
   <div class="tab-pane" id="middleware">
     <p>The Rack middleware configuration shows the modules in the Rack stack that will process the request and response.</p>
@@ -120,7 +130,7 @@ Log Level = <%= Rails.configuration.log_level %>
     <ol>
       <%- # TODO: protected methods `ordered_railties` changed to return an array of arrays between rails 4.1.5 and 4.1.8. investigate and replace. -%>
       <%- ordered_railties = Rails.application.send(:ordered_railties) -%>
-      <%- ordered_railties = ordered_railties[0] if ordered_railties.is_a?(Array) -%>
+      <%- ordered_railties = ordered_railties[0] if ordered_railties.is_a?(Array) && ordered_railties[0].is_a?(Array) -%>
       <%- ordered_railties.each do |railtie| %>
           <li><%= railtie.railtie_name %> - <%= railtie.class.name %></li>
       <%- end %>

data/app/views/tuttle/rails/instrumentation.html.erb

@@ -15,7 +15,7 @@
         <td><%= event.name %></td>
         <td><%= event.time.to_s(:db) %></td>
         <td><%= number_with_precision(event.duration) %></td>
-        <td><%= truncate(event.payload.to_s, length: 250) %></td>
+        <td><%= truncate(event.payload.to_s, length: 250) rescue 'Payload not captured' %></td>
         <td><%= event.transaction_id %></td>
       </tr>
   <% end -%>