memory_tracker 1.0.0

data/spec/lib/memory_tracker_spec.rb

@@ -0,0 +1,47 @@
+require 'spec_helper'
+
+module MemoryTracker
+  describe MemoryTracker do
+    before :each do
+      @env = double('env')
+      allow(@env).to receive(:controller) { 'Boat' }
+      allow(@env).to receive(:action)     { 'sail' }
+
+      @memory_store         = double('memory_store')
+      @logfile_store        = double('logfile_store')
+      @tracker = MemoryTracker.instance
+      @tracker.stores.clear
+    end
+
+    it 'should be a singleton' do
+      lambda { MemoryTracker.new }.should raise_error(NoMethodError)
+    end
+
+    it 'should push requests to all stores' do
+      allow(@memory_store).to         receive(:name) { :memory }
+      allow(@logfile_store).to        receive(:name) { :gcstat_logfile }
+      expect(@memory_store).to         receive(:push)
+      expect(@logfile_store).to        receive(:push)
+
+      @tracker.add_store(@memory_store)
+      @tracker.add_store(@logfile_store)
+
+      @tracker.start_request(@env)
+      @tracker.end_request
+    end
+
+    it 'should populate livestore' do
+      @tracker.add_store(Stores::InMemoryStore::Manager.new)
+
+      Request.stub(:rss) { 100 }
+      @tracker.start_request(@env)
+      Request.stub(:rss) { 108 }
+      @tracker.end_request
+
+      stats = @tracker.stats(:memory)
+      stats.count('Boat', 'sail').should == 1
+      stats.count('Boat', 'moor').should == 0
+      stats.fetch('Boat', 'sail', :rss).should == 8
+    end
+  end
+end

data/spec/lib/request_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+
+module MemoryTracker
+  describe Request do
+    before :each do
+      @env = double('env')
+      @request = Request.new(@env)
+    end
+
+    it 'should initalize start_gcstat' do
+      @request.start_gcstat.should be_a(GcStat)
+      @request.start_gcstat.stats.keys.should include :rss
+      @request.start_gcstat.stats.keys.should include :vsize
+    end
+
+    it 'should have a controller' do
+      allow(@env).to receive(:controller) { 'Foo' }
+      allow(@env).to receive(:action)     { :bar }
+      @request.controller.should == 'Foo'
+      @request.action.should == :bar
+    end
+
+    context :close do
+      it 'should initialize end_gcstat' do
+        @request.close
+        @request.end_gcstat.should be_a(GcStat)
+      end
+    end
+  end
+end

data/spec/lib/stores/gcstat_logfile_store_spec.rb

@@ -0,0 +1,17 @@
+module MemoryTracker
+  module Stores
+    describe GcstatLogfileStore do
+      before :each do
+        logger_class = double("logger_class")
+        allow(logger_class).to receive(:new)
+        @logstore = GcstatLogfileStore.new logger_class, "foo/log"
+      end
+
+      it 'implements the store role' do
+        @logstore.should respond_to(:name)
+        @logstore.should respond_to(:push)
+        @logstore.should respond_to(:stats)
+      end
+    end
+  end
+end

data/spec/lib/stores/in_memory_store_spec.rb

@@ -0,0 +1,161 @@
+require 'spec_helper'
+
+def sample_stats(factor=1)
+  base = {
+      :rss                      => 1,
+      :vsize                    => 2,
+      :count                    => 4,
+      :heap_used                => 86,
+      :heap_length              => 138,
+      :heap_increment            =>52,
+      :heap_live_num             =>34768,
+      :heap_free_num             =>22099,
+      :heap_final_num            =>0,
+      :total_allocated_object    =>68540,
+      :total_freed_object        =>33772
+    }
+  sample = {}
+  base.each { |k,v| sample[k] = v * factor }
+  sample
+end
+
+def stub_gcstat_delta(controller, action, factor=1)
+  allow(@env).to receive(:controller) { controller }
+  allow(@env).to receive(:action)     { action }
+  MemoryTracker::GcStatDelta.any_instance.stub(:stats) { sample_stats(factor) }
+end
+
+module MemoryTracker
+  module Stores
+    module InMemoryStore
+      describe Manager do
+        def start_time
+          Time.new(2013,01,01,0,0,0)
+        end
+
+        before :each do
+          @env = double('env')
+        end
+
+        it 'should respond to name' do
+          manager = Manager.new(60)
+          manager.should respond_to(:name)
+        end
+
+        it 'should return stats from older window' do
+          Time.stub(:now).and_return(start_time)
+          manager = Manager.new(60)
+          request = Request.new(@env)
+          stub_gcstat_delta('Boat', 'sail')
+          manager.push(request.close)
+          Time.stub(:now).and_return(start_time + 10)
+          request = Request.new(@env)
+          stub_gcstat_delta('Car', 'drive', 2)
+          manager.push(request.close)
+          Time.stub(:now).and_return(start_time + 40)
+          request = Request.new(@env)
+          stub_gcstat_delta('Boat', 'sail', 3)
+          manager.push(request.close)
+
+          stats = manager.stats
+          stats.fetch('Boat', 'sail', :rss).should == 4
+          stats.fetch('Car', 'drive', :rss).should  == 2
+        end
+
+        it 'should rotate windows' do
+          Time.stub(:now).and_return(start_time)
+          manager = Manager.new(60)
+          request = Request.new(@env)
+          stub_gcstat_delta('Boat', 'sail')
+          manager.push(request.close)
+          Time.stub(:now).and_return(start_time + 10)
+          request = Request.new(@env)
+          stub_gcstat_delta('Car', 'drive', 2)
+          manager.push(request.close)
+          Time.stub(:now).and_return(start_time + 40)
+          request = Request.new(@env)
+          stub_gcstat_delta('Boat', 'sail', 3)
+          manager.push(request.close)
+          Time.stub(:now).and_return(start_time + 70)
+
+          stats = manager.stats
+          stats.fetch('Boat', 'sail', :rss).should == 3
+          stats.fetch('Car', 'drive', :rss).should be_nil
+        end
+      end
+
+      describe StatInterval do
+
+        before :each do
+          @interval = InMemoryStore::StatInterval.new(Time.now, 5*60)
+          @env = double('env')
+        end
+
+        it 'should accept requests' do
+          env = double('env')
+          request = Request.new(env)
+          allow(env).to receive(:controller) { :Foo }
+          allow(env).to receive(:action)     { :bar }
+          request.close
+          request.controller.should == :Foo
+          request.action.should == :bar
+          @interval.push(request)
+        end
+
+        it 'should accumulate one request' do
+          req1 = Request.new(@env)
+          req1.close
+          stub_gcstat_delta('Boat', 'sail')
+          @interval.push(req1)
+          @interval.stats.should be_a(Stats)
+          @interval.stats.fetch('Boat', 'sail', :rss).should == 1
+        end
+
+        it 'should accumulate several requests' do
+          req1 = Request.new(@env)
+          req1.close
+          stub_gcstat_delta('Boat', 'sail')
+          @interval.push(req1)
+          req2 = Request.new(@env)
+          req2.close
+          stub_gcstat_delta('Boat', 'sail', 2)
+          @interval.push(req2)
+          req3 = Request.new(@env)
+          req3.close
+          stub_gcstat_delta('Boat', 'moor', 5)
+          @interval.push(req3)
+          req4 = Request.new(@env)
+          req4.close
+          stub_gcstat_delta('Car', 'drive', 1)
+          @interval.push(req4)
+
+          stats = @interval.stats
+          stats.count('Boat', 'sail').should == 2
+          stats.fetch('Boat', 'sail', :rss).should   == 3
+          stats.fetch('Boat', 'sail', :count).should == 12
+          stats.count('Boat', 'moor').should == 1
+          stats.fetch('Boat', 'moor', :rss).should   == 5
+          stats.fetch('Boat', 'moor', :count).should == 20
+          stats.count('Car', 'drive').should == 1
+          stats.fetch('Car', 'drive', :rss).should   == 1
+          stats.fetch('Car', 'drive', :count).should == 4
+        end
+
+        it 'should be enumerable' do
+          req1 = Request.new(@env)
+          req1.close
+          stub_gcstat_delta('Boat', 'sail')
+          @interval.push(req1)
+          req2 = Request.new(@env)
+          req2.close
+          stub_gcstat_delta('Boat', 'moor')
+          @interval.push(req2)
+
+          @interval.size.should == 2
+          @interval.to_a.should include(['Boat', 'sail', { :num => 1, :gcstat => sample_stats} ])
+          @interval.to_a.should include(['Boat', 'moor', { :num => 1, :gcstat => sample_stats} ])
+        end
+      end
+    end
+  end
+end

data/spec/lib/stores/url_logfile_store_spec.rb

@@ -0,0 +1,17 @@
+module MemoryTracker
+  module Stores
+    describe UrlLogfileStore do
+      before :each do
+        logger_class = double("logger_class")
+        allow(logger_class).to receive(:new)
+        @logstore = UrlLogfileStore.new logger_class, "foo/log"
+      end
+
+      it 'implements the store role' do
+        @logstore.should respond_to(:name)
+        @logstore.should respond_to(:push)
+        @logstore.should respond_to(:stats)
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,35 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require 'singleton'
+
+require 'rspec'
+require 'sys/proctable'
+require 'memory_tracker'
+require 'memory_tracker/gc_stat'
+require 'memory_tracker/request'
+require 'memory_tracker/memory_tracker'
+require 'memory_tracker/stores/in_memory_store'
+require 'memory_tracker/stores/gcstat_logfile_store'
+require 'memory_tracker/stores/url_logfile_store'
+
+# This file is copied to spec/ when you run 'rails generate rspec:install'
+ENV["RAILS_ENV"] ||= 'test'
+# require 'rspec/rails'
+# require 'rspec/mocks/standalone'
+
+# Requires supporting ruby files with custom matchers and macros, etc,
+# in spec/support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+
+RSpec.configure do |config|
+  # == Mock Framework
+  #
+  # If you prefer to use mocha, flexmock or RR, uncomment the appropriate line:
+  #
+  # config.mock_with :mocha
+  # config.mock_with :flexmock
+  # config.mock_with :rr
+#   config.mock_with :rspec
+end

metadata

@@ -0,0 +1,173 @@
+--- !ruby/object:Gem::Specification
+name: memory_tracker
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Philippe Le Rohellec
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sys-proctable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: debugger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.14.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.14.0
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.7
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.7
+- !ruby/object:Gem::Dependency
+  name: sys-proctable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Collect and analyze memory usage data for each individual Rails action
+  controller.
+email: philippe@lerohellec.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.rdoc
+files:
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- app/controllers/memory_tracker/dashboards_controller.rb
+- app/helpers/memory_tracker/dashboards_helper.rb
+- app/views/layouts/memory_tracker.html.erb
+- app/views/memory_tracker/dashboards/index.html.erb
+- config/routes.rb
+- docs/design.rb
+- lib/memory_tracker.rb
+- lib/memory_tracker/engine.rb
+- lib/memory_tracker/env.rb
+- lib/memory_tracker/gc_stat.rb
+- lib/memory_tracker/memory_tracker.rb
+- lib/memory_tracker/middleware.rb
+- lib/memory_tracker/request.rb
+- lib/memory_tracker/stores/gcstat_logfile_store.rb
+- lib/memory_tracker/stores/in_memory_store.rb
+- lib/memory_tracker/stores/url_logfile_store.rb
+- memory_tracker.gemspec
+- spec/lib/memory_tracker_spec.rb
+- spec/lib/request_spec.rb
+- spec/lib/stores/gcstat_logfile_store_spec.rb
+- spec/lib/stores/in_memory_store_spec.rb
+- spec/lib/stores/url_logfile_store_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/plerohellec/memory_tracker
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Rails memory allocations tracker
+test_files: []