memory_tracker 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8642b4f864b9dc88a373232dd35b13010e2bd38d
+  data.tar.gz: ab6461e8b38e5b8c83a3f10d0336f6100b433bb6
+SHA512:
+  metadata.gz: 728e6cab2a895542bacba8b1b6baf40d84a7888ea12b1faa3e2d3c88e2bc002725213e70eac08fd6dee03946a7ac27d141d767f2ffd5ea6b5a5555d0469ae44e
+  data.tar.gz: 2e866401d7468d068c9802a907d55de301d99b9b3dbe1b7da5cc41914b977c623530599104db6ea0ee63daa8bcbfaebc78232a1e0e9afc8635ee8fe27a49157d

data/Gemfile

@@ -0,0 +1,13 @@
+source "http://rubygems.org"
+
+gem 'sys-proctable'
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development, :test do
+  gem "debugger"
+  gem "rspec", "~> 2.14.0"
+  gem "rdoc", "~> 3.12"
+  gem "bundler", "~> 1.0"
+  gem "jeweler", "~> 1.8.7"
+end

data/Gemfile.lock

@@ -0,0 +1,73 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    addressable (2.3.5)
+    builder (3.2.2)
+    columnize (0.3.6)
+    debugger (1.6.2)
+      columnize (>= 0.3.1)
+      debugger-linecache (~> 1.2.0)
+      debugger-ruby_core_source (~> 1.2.3)
+    debugger-linecache (1.2.0)
+    debugger-ruby_core_source (1.2.3)
+    diff-lcs (1.2.4)
+    faraday (0.8.8)
+      multipart-post (~> 1.2.0)
+    git (1.2.6)
+    github_api (0.10.1)
+      addressable
+      faraday (~> 0.8.1)
+      hashie (>= 1.2)
+      multi_json (~> 1.4)
+      nokogiri (~> 1.5.2)
+      oauth2
+    hashie (2.0.5)
+    highline (1.6.20)
+    httpauth (0.2.0)
+    jeweler (1.8.8)
+      builder
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      github_api (= 0.10.1)
+      highline (>= 1.6.15)
+      nokogiri (= 1.5.10)
+      rake
+      rdoc
+    json (1.8.1)
+    jwt (0.1.8)
+      multi_json (>= 1.5)
+    multi_json (1.8.2)
+    multi_xml (0.5.5)
+    multipart-post (1.2.0)
+    nokogiri (1.5.10)
+    oauth2 (0.9.2)
+      faraday (~> 0.8)
+      httpauth (~> 0.2)
+      jwt (~> 0.1.4)
+      multi_json (~> 1.0)
+      multi_xml (~> 0.5)
+      rack (~> 1.2)
+    rack (1.5.2)
+    rake (10.1.0)
+    rdoc (3.12.2)
+      json (~> 1.4)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.7)
+    rspec-expectations (2.14.3)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.4)
+    sys-proctable (0.9.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0)
+  debugger
+  jeweler (~> 1.8.7)
+  rdoc (~> 3.12)
+  rspec (~> 2.14.0)
+  sys-proctable

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2013 Philippe Le Rohellec
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,31 @@
+= MemoryTracker
+
+MemoryTracker collects and analyzes memory usage data for each controller action of a Rails application. It's implemented as a Rails engine with a middleware that captures stats before and after each query. 
+
+== How?
+It uses GC.stats (Ruby garbage collector) to find how many objects were allocated, how many heaps were created and how many times the garbage collector ran.
+
+== Features
+* Collect stats on each controller action memory consumption.
+* Write a log file with GC.stat data.
+* The engine includes a couple of web pages that shows a summary of memory utilization per controller action.
+
+== Enable MemoryTracker in a Rails application
+In config/routes.rb
+  mount MemoryTracker::Engine, at: "/memory_tracker"
+
+== Contributing to memory_tracker
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2013 Philippe Le Rohellec. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,50 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "memory_tracker"
+  gem.homepage = "http://github.com/plerohellec/memory_tracker"
+  gem.license = "MIT"
+  gem.summary = %Q{Rails memory allocations tracker}
+  gem.description = %Q{Collect and analyze memory usage data for each individual Rails action controller.}
+  gem.email = "philippe@lerohellec.com"
+  gem.authors = ["Philippe Le Rohellec"]
+  # dependencies defined in Gemfile
+  gem.add_dependency 'sys-proctable'
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "memory_tracker #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/app/controllers/memory_tracker/dashboards_controller.rb

@@ -0,0 +1,24 @@
+module MemoryTracker
+  class DashboardsController <  ActionController::Base
+
+    layout 'memory_tracker'
+
+    def index
+      stats = MemoryTracker.instance.stats(:memory)
+      @data = stats.to_a
+      sort_by = params[:sort_by] ? params[:sort_by].to_sym : :count
+      if @data.any? && @data.first.keys.include?(sort_by)
+        @data = @data.sort{ |a,b| b[sort_by].to_f/b[:num] <=> a[sort_by].to_f/a[:num] }
+      end
+
+      respond_to do |format|
+        format.json do
+          render :json => @data.to_json
+        end
+        format.html do
+          render
+        end
+      end
+    end
+  end
+end

data/app/helpers/memory_tracker/dashboards_helper.rb

@@ -0,0 +1,7 @@
+module MemoryTracker
+  module DashboardsHelper
+    def link_to_dashboards(name)
+      link_to(name, memory_tracker.dashboards_path(:sort_by => name))
+    end
+  end
+end

data/app/views/layouts/memory_tracker.html.erb

@@ -0,0 +1,29 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>MemoryTracker Dashboard</title>
+  <%= csrf_meta_tag %>
+
+  <style>
+    body, td, th {
+        font-family: Verdana, Arial, sans-serif;
+        font-size: 14px }
+    th {
+      text-align: right;
+      font: bold
+    }
+    tr { border-top: 1px solid #444;
+         text-align: right
+       }
+    td { text-align: right }
+  </style>
+</head>
+<body>
+
+<%= yield %>
+
+<br>
+<p><%= link_to 'Back to the application', '/' %></p>
+
+</body>
+</html>

data/app/views/memory_tracker/dashboards/index.html.erb

@@ -0,0 +1,21 @@
+<% keys = [ :rss, :vsize, :count, :total_allocated_object, :heap_used ] %>
+<table width="100%">
+  <tr>
+    <th><%= link_to_dashboards('Controller') %></th>
+    <th><%= link_to_dashboards('Action') %></th>
+    <th><%= link_to_dashboards('num') %></th>
+    <% keys.each do |key| %>
+      <th><%= link_to_dashboards(key) %></th>
+    <% end %>
+  </tr>
+  <% @data.each do |row| %>
+    <tr>
+      <td><%= "#{row[:controller]}" %></td>
+      <td><%= "#{row[:action]}" %></td>
+      <td><%= row[:num] %></td>
+      <% keys.each do |key| %>
+        <td><%= '%.3f' % (row[key].to_f/row[:num]) %></td>
+      <% end %>
+    </tr>
+  <% end %>
+</table>

data/config/routes.rb

@@ -0,0 +1,3 @@
+MemoryTracker::Engine.routes.draw do
+  get '/'       => 'dashboards#index', :as => :dashboards
+end

data/docs/design.rb

@@ -0,0 +1,111 @@
+module MemoryTracker
+  class Middleware
+  end
+  
+  class Engine
+    def initialize_stores
+      MemoryTracker.instance.add_store(InMemoryStore.new)
+      MemoryTracker.instance.add_store(LogfileStore.new)
+    end
+  end
+  
+  class MemoryTracker
+    GCSTAT_LOGFILE = "#{Rails.root}/log/gcstat.log"
+    
+    include Singleton
+    
+    def stores
+      @stores ||= {}
+    end
+    
+    def add_stores
+    end
+    
+    def start_request(env)
+      @request = Request.new(env)
+    end
+    
+    def end_request(status)
+      @request.close
+      stores.each { |store| store.push(@request) }
+    end
+  end
+  
+  class Request
+    attr_reader :controller, :action, :gcstat_delta
+    def initialize(env)
+      @start_gcstat = GcStat.new(rss, vsize)
+    end
+    
+    def close
+      @end_gcstat = GcStat.new(rss, vsize)
+      @gcstat_delta = GcStatDelta.new(@start_gcstat, @end_gcstat)
+    end
+  end
+  
+  class GcStat
+    attr_reader :stat
+    def initialize(rss, vsize)
+      @stat = GC.stat.merge({ :rss => rss, :vsize => vsize})
+    end
+  end
+  
+  class GcStatDelta
+    def initialize(before, after)
+      @stat = after.inject({}) do |h, (k, v)|
+        h[k] = after[k] - before [k]
+        h
+      end
+    end
+  end
+  
+  module Stores
+    class InMemoryStore::Manager
+      def initialize(window_length)
+        @window1 = StatInterval.new(Time.now - length/2)
+        @window2 = StatInterval.new(Time.now)
+      end
+
+      def name
+        :memory
+      end
+
+      def rotate_windows
+        if @window1.start_time + length > Time.now
+          @window1 = @window2
+          @window2 = Window.new(Time.now)
+        end
+      end
+
+      def push
+        rotate_windows
+        @window1.push(request)
+        @window2.push(request)
+      end
+
+      def stats
+        @window1.stats
+      end
+    end
+
+    class InMemoryStore::StatInterval
+      attr_reader :start_time, :duration, :size
+      attr_accessor :data # {}
+
+      def initialize
+        @data = {}
+      end
+
+      def push(request)
+        @size += 1
+        delta = request.gcstat_delta
+        delta.each do |key|
+          increment_action_counter(request.controller, request.action, key, delta[key])
+        end
+      end
+
+      def increment_action_counter(controller, action, key, value)
+      end
+    end
+  end
+end

data/lib/memory_tracker.rb

@@ -0,0 +1,3 @@
+require 'memory_tracker/memory_tracker'
+require 'memory_tracker/engine' if defined?(Rails)
+

data/lib/memory_tracker/engine.rb

@@ -0,0 +1,23 @@
+module MemoryTracker
+  class Engine < Rails::Engine
+
+    isolate_namespace MemoryTracker
+
+    engine_base_dir = File.expand_path("../../..",     __FILE__)
+    app_base_dir    = File.expand_path("../../../app", __FILE__)
+    lib_base_dir    = File.expand_path("../../../lib", __FILE__)
+
+    config.autoload_paths << lib_base_dir
+
+    initializer "memory_tracker.add_middleware" do |app|
+      app.middleware.use MemoryTracker::Middleware
+    end
+
+    initializer "memory_tracker.setup_stores" do |app|
+      MemoryTracker.instance.add_store(Stores::UrlLogfileStore.new(ActiveSupport::BufferedLogger, "#{Rails.root}/log/memtracker_urls.log"))
+      MemoryTracker.instance.add_store(Stores::GcstatLogfileStore.new(ActiveSupport::BufferedLogger, "#{Rails.root}/log/memtracker_gcstat.log"))
+      MemoryTracker.instance.add_store(Stores::InMemoryStore::Manager.new)
+    end
+  end
+end
+

data/lib/memory_tracker/env.rb

@@ -0,0 +1,14 @@
+module MemoryTracker
+  class Env
+    attr_reader :path, :controller, :action
+
+    def initialize(env)
+      @path = env['PATH_INFO']
+
+      routes_env = { :method => env['REQUEST_METHOD'] }
+      request = Rails.application.routes.recognize_path(env['REQUEST_URI'], routes_env)
+      @controller = request[:controller]
+      @action     = request[:action]
+    end
+  end
+end