memory_tracker 1.0.6 → 1.1.0

data/Gemfile

@@ -5,9 +5,6 @@ source "https://rubygems.org"
 # development dependencies will be added by default to the :development group.
 gemspec
 
-# jquery-rails is used by the dummy application
-gem "jquery-rails"
-
 # Declare any dependencies that are still in development here instead of in
 # your gemspec. These might include edge Rails or gems from your path or
 # Git. Remember to move these dependencies to your gemspec before releasing

data/Gemfile.lock

@@ -1,8 +1,20 @@
+PATH
+  remote: .
+  specs:
+    memory_tracker (1.0.6)
+      activesupport
+      sys-proctable
+
 GEM
-  remote: http://rubygems.org/
+  remote: https://rubygems.org/
   specs:
-    addressable (2.3.5)
-    builder (3.2.2)
+    activesupport (4.0.1)
+      i18n (~> 0.6, >= 0.6.4)
+      minitest (~> 4.2)
+      multi_json (~> 1.3)
+      thread_safe (~> 0.1)
+      tzinfo (~> 0.3.37)
+    atomic (1.1.14)
     columnize (0.3.6)
     debugger (1.6.2)
       columnize (>= 0.3.1)
@@ -11,44 +23,10 @@ GEM
     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
+    i18n (0.6.5)
     json (1.8.1)
-    jwt (0.1.8)
-      multi_json (>= 1.5)
+    minitest (4.7.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)
@@ -60,6 +38,9 @@ GEM
       diff-lcs (>= 1.1.3, < 2.0)
     rspec-mocks (2.14.4)
     sys-proctable (0.9.3)
+    thread_safe (0.1.3)
+      atomic
+    tzinfo (0.3.38)
 
 PLATFORMS
   ruby
@@ -67,7 +48,6 @@ PLATFORMS
 DEPENDENCIES
   bundler (~> 1.0)
   debugger
-  jeweler (~> 1.8.7)
+  memory_tracker!
   rdoc (~> 3.12)
   rspec (~> 2.14.0)
-  sys-proctable

data/README.md

@@ -7,8 +7,18 @@ MemoryTracker collects, analyzes and reports memory usage data of each controlle
 * Display stats on every controller action of the application in a engine webpage embedded in the gem.
 
 # Dashboard
+## Screenshot
 The dashboard is at /memtracker in the host application (but you need to mount the engine in the app first, see below).
-![Dashboard snapshot](https://github.com/plerohellec/memory_tracker/tree/master/docs/memory_tracker_dashboard.png?raw=true)
+
+[Dashboard snapshot](https://raw.github.com/plerohellec/memory_tracker/master/docs/memory_tracker_dashboard.png)
+
+That's where the collected statistics are displayed.
+
+## What to look for?
+* Controller actions that have a non zero "heap used" value. Those actions required more memory than was available in the currently allocated heaps.
+* Controller actions that have a "total_allocated_object" value N times higher than the average.
+* Controller actions that trigger the garbage collector frequently. That the "count" value in the dashboard.
+
 
 # How?
 MemoryTracker uses system memory data and Ruby garbage collector statistics to find the memory currently used by The Rails processes, how many objects were allocated in Ruby heaps, how many heaps were created and how many times the garbage collector ran. The MemoryTracker middleware captures the data before and after each HHTP request and saves the deltas per controller/action in a variety of stores.
@@ -20,10 +30,34 @@ MemoryTracker currently comes with 3 stores.
 
 * The InMemoryStore keeps counters in memory for the process where it runs. This store in itself uses very little memory as it only keeps a set of counters per controller/action in the application. Since it doesn't do any IO, it is also extremely fast. The data is immediately available without any need for a background aggregation tasks.
 
-* The GcStatLogfile store simply write memory stats to a log file called '#{Rails.root}/log/memtracker_gcstat.log' after each HTTP request.
+* The GcStatLogfile store simply writes memory stats to a log file called '#{Rails.root}/log/memtracker_gcstat.log' after each HTTP request.
 
 * The UrlLogfileStore also stores data in a log file ('#{Rails.root}/log/memtracker_urls.log') but instead of writing the raw memory data, it records the URL that was requested along with the memory deltas between the current request and the previous one. It also highlights the urls where the deltas were the greatest. It's sometimes interesting to browse through this file URLs that are particularly greedy.
 
+# Config file
+[memory_tracker.yml](https://github.com/plerohellec/memory_tracker/blob/master/config/memory_tracker.yml)
+
+The config file is optional. If you choose to write one, place it in "#{Rails.root}/config".
+In the absence of a custom config file, memory_tracker will fallback to the file linked above in the gem.
+
+By creating you own config file, you can choose which stores are enabled and tune them. By default all stores are enabled. Here is a sample config file that enables only the InMemoryStore with a 4 hour long data window:
+
+```yml
+defaults:   &defaults
+  stores:
+    - name: memory
+      window_length: 14400
+
+
+production:
+  <<: *defaults
+
+development:
+  <<: *defaults
+
+test:
+  <<: *defaults
+```
 
 # Enabling MemoryTracker
 Add it to your Gemfile:
@@ -39,6 +73,7 @@ Once the app is running, go to /memtracker to review the list of controller acti
 # Requirements
 The gem has been tested and is compatible with:
 * Ruby 2.0
+* Ruby 1.9 but 1.9 GC.stat does not include the total_allocated_object number so its value remains at 0 in MemoryTracker.
 * Rails 3.2
 
 # Tips
@@ -52,7 +87,7 @@ The gem has been tested and is compatible with:
 # Coming soon
 * Redis store.
 * Store and report the most expensive URLs.
-* Support for Ruby 1.9 and Rails 4.
+* Support for Rails 4 (it might already work, it's just not been tested yet).
 
 # Contributing to memory_tracker
  

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

@@ -32,7 +32,7 @@
 </table>
 
 <h2>Legend</h2>
-<p>All numbers are average per controller action.</p>
+<p>All numbers are average per controller action HTTP request served.</p>
 <i>
 <ul>
 <li>num: number of HTTP requests</li>

data/lib/memory_tracker/engine.rb

@@ -5,17 +5,40 @@ module 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_base_dir = File.expand_path("../../../config", __FILE__)
 
     config.autoload_paths << lib_base_dir
 
+
+    initializer "memory_tracker.load_config" do |app|
+      app_config_file_path = "#{app.root}/config/memory_tracker.yml"
+      gem_config_file_path = "#{config_base_dir}/memory_tracker.yml"
+      if File.exist?(app_config_file_path)
+        config_file_path = app_config_file_path
+      elsif File.exist?(gem_config_file_path)
+        config_file_path = gem_config_file_path
+      end
+
+      if config_file_path
+        Rails.logger.debug "Reading #{config_file_path}"
+        config = YAML.load_file(config_file_path)
+        config = config.fetch(Rails.env) { raise "#{Rails.env} environment key is missing from #{config_file_path}" }
+        MemoryTracker.instance.config = ActiveSupport::HashWithIndifferentAccess.new(config)
+      end
+    end
+
     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)
+      if MemoryTracker.instance.config
+        MemoryTracker.instance.config[:stores].each do |store|
+          Stores::Loader.enable_store(MemoryTracker.instance, store)
+        end
+      else
+        Stores::Loader.enable_all(MemoryTracker.instance)
+      end
     end
   end
 end

data/lib/memory_tracker/memory_tracker.rb

@@ -3,12 +3,12 @@ module MemoryTracker
     include Singleton
     include Enumerable
 
-    attr_accessor :gcstat_logger
-    
+    attr_accessor :config
+
     def stores
       @stores ||= {}
     end
-    
+
     def add_store(store)
       stores[store.name] = store
     end
@@ -29,19 +29,6 @@ module MemoryTracker
       stores[store_name].stats
     end
 
-    def self.track_block(*args)
-      self.instance.track_block(*args)
-    end
-
-    def track_block(name, &block)
-      raise ArgumentError unless block_given?
-      before = GC.stat
-      ret = yield
-      after = GC.stat
-      gcstat_logger.debug "gcstat diff for #{name}: #{GcStat.gcdiff(before, after)}"
-      ret
-    end
-
     private
     
     def each_store

data/lib/memory_tracker/stores/gcstat_logfile_store.rb

@@ -1,13 +1,14 @@
 module MemoryTracker
   module Stores
-    class GcstatLogfileStore
-      def initialize(logger_class, logfile_path)
-        @logger = logger_class.new(logfile_path)
-        @num_lines = 0
-      end
+    class GcstatLogfileStore < Base
+      register_store :gcstat_logfile
 
-      def name
-        :gcstat_logfile
+      def initialize(opts)
+        logger_class = opts.fetch(:logger_class, 'ActiveSupport::BufferedLogger')
+        filename     = opts.fetch(:filename, "#{Rails.root}/log/memtracker_gcstat.log")
+
+        @logger = logger_class.constantize.new(filename)
+        @num_lines = 0
       end
 
       def push(request)

data/lib/memory_tracker/stores/in_memory_store.rb

@@ -1,16 +1,16 @@
 module MemoryTracker
   module Stores
     module InMemoryStore
-      class Manager
-        def initialize(window_length = 60*60*4)
-          @length  = window_length
+      class Manager < Base
+        register_store :memory
+
+        def initialize(opts = {})
+          @length  = opts.fetch(:window_length, 60*60*4)
+
           @window1 = StatInterval.new(Time.now - @length/2, @length)
           @window2 = StatInterval.new(Time.now, @length)
         end
 
-        def name
-          :memory
-        end
 
         def push(request)
           rotate_windows

data/lib/memory_tracker/stores/url_logfile_store.rb

@@ -1,17 +1,17 @@
 module MemoryTracker
   module Stores
-    class UrlLogfileStore
-      def initialize(logger_class, logfile_path)
-        @logger = logger_class.new(logfile_path)
-      end
+    class UrlLogfileStore < Base
+      register_store :url_logfile
+
+      def initialize(opts)
+        logger_class = opts.fetch(:logger_class, 'ActiveSupport::BufferedLogger')
+        filename     = opts.fetch(:filename, "#{Rails.root}/log/memtracker_urls.log")
 
-      def name
-        :url_logfile
+        @logger = logger_class.constantize.new(filename)
       end
 
       def push(request)
         @request = request
-
         write_request_log
       end
 

data/lib/memory_tracker/version.rb

@@ -1,3 +1,3 @@
 module MemoryTracker
-  VERSION = "1.0.6"
+  VERSION = "1.1.0"
 end

data/memory_tracker.gemspec

@@ -57,6 +57,7 @@ Gem::Specification.new do |s|
       s.add_development_dependency(%q<rspec>, ["~> 2.14.0"])
       s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
       s.add_development_dependency(%q<bundler>, ["~> 1.0"])
+      s.add_dependency('activesupport')
 
     else
       s.add_dependency(%q<sys-proctable>, [">= 0"])
@@ -64,6 +65,7 @@ Gem::Specification.new do |s|
       s.add_dependency(%q<rspec>, ["~> 2.14.0"])
       s.add_dependency(%q<rdoc>, ["~> 3.12"])
       s.add_dependency(%q<bundler>, ["~> 1.0"])
+      s.add_dependency('activesupport')
 
     end
   else
@@ -72,5 +74,6 @@ Gem::Specification.new do |s|
     s.add_dependency(%q<rspec>, ["~> 2.14.0"])
     s.add_dependency(%q<rdoc>, ["~> 3.12"])
     s.add_dependency(%q<bundler>, ["~> 1.0"])
+    s.add_dependency('activesupport')
   end
 end

data/spec/lib/stores/gcstat_logfile_store_spec.rb

@@ -1,10 +1,14 @@
+require 'spec_helper'
+
 module MemoryTracker
   module Stores
     describe GcstatLogfileStore do
       before :each do
-        logger_class = double("logger_class")
+        logger_class_name = double("logger_class_name")
+        logger_class      = double("logger_class")
+        allow(logger_class_name).to receive(:constantize) { logger_class }
         allow(logger_class).to receive(:new)
-        @logstore = GcstatLogfileStore.new logger_class, "foo/log"
+        @logstore = GcstatLogfileStore.new(:logger_class => logger_class_name, :filename => "foo/log")
       end
 
       it 'implements the store role' do

data/spec/lib/stores/in_memory_store_spec.rb

@@ -38,13 +38,13 @@ module MemoryTracker
         end
 
         it 'should respond to name' do
-          manager = Manager.new(60)
+          manager = Manager.new(:window_length => 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)
+          manager = Manager.new(:window_length => 60)
           request = Request.new(@env)
           stub_gcstat_delta('Boat', 'sail')
           manager.push(request.close)
@@ -64,7 +64,7 @@ module MemoryTracker
 
         it 'should rotate windows' do
           Time.stub(:now).and_return(start_time)
-          manager = Manager.new(60)
+          manager = Manager.new(:window_length => 60)
           request = Request.new(@env)
           stub_gcstat_delta('Boat', 'sail')
           manager.push(request.close)

data/spec/lib/stores/loader_spec.rb

@@ -0,0 +1,28 @@
+require 'spec_helper'
+
+module MemoryTracker
+  module Stores
+    describe Loader do
+      context :register_store do
+        it 'should record stores by name' do
+          store_class = double('my_store_class')
+          Loader.register_store :my_store, store_class
+          Loader.store_classes.should include(:my_store)
+        end
+      end
+
+      context :enable_store do
+        it 'should send add_store to memory_tracker' do
+          store_class = double('my_store_class')
+          store       = double('my_store')
+          allow(store_class).to receive(:new) { store }
+          memory_tracker = double('memory_tracker')
+          memory_tracker.should_receive(:add_store).with(store)
+
+          Loader.register_store :my_store, store_class
+          Loader.enable_store(memory_tracker, :name => :my_store)
+        end
+      end
+    end
+  end
+end

data/spec/lib/stores/url_logfile_store_spec.rb

@@ -1,10 +1,14 @@
+require 'spec_helper'
+
 module MemoryTracker
   module Stores
     describe UrlLogfileStore do
       before :each do
-        logger_class = double("logger_class")
+        logger_class_name = double("logger_class_name")
+        logger_class      = double("logger_class")
+        allow(logger_class_name).to receive(:constantize) { logger_class }
         allow(logger_class).to receive(:new)
-        @logstore = UrlLogfileStore.new logger_class, "foo/log"
+        @logstore = UrlLogfileStore.new(:logger_class => logger_class_name, :filename => "foo/log")
       end
 
       it 'implements the store role' do

data/spec/spec_helper.rb

@@ -3,12 +3,15 @@ $LOAD_PATH.unshift(File.dirname(__FILE__))
 
 require 'singleton'
 
+require 'active_support/core_ext'
 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/base'
+require 'memory_tracker/stores/loader'
 require 'memory_tracker/stores/in_memory_store'
 require 'memory_tracker/stores/gcstat_logfile_store'
 require 'memory_tracker/stores/url_logfile_store'
@@ -33,3 +36,10 @@ RSpec.configure do |config|
   # config.mock_with :rr
 #   config.mock_with :rspec
 end
+
+class Rails
+  def self.root
+    ''
+  end
+end
+

metadata

@@ -1,7 +1,8 @@
 --- !ruby/object:Gem::Specification
 name: memory_tracker
 version: !ruby/object:Gem::Version
-  version: 1.0.6
+  version: 1.1.0
+  prerelease: 
 platform: ruby
 authors:
 - Philippe Le Rohellec
@@ -13,34 +14,39 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: sys-proctable
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: debugger
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -48,6 +54,7 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -55,6 +62,7 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rdoc
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -62,6 +70,7 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -69,6 +78,7 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -76,10 +86,27 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Collect and analyze memory usage data for each individual Rails action
   controller.
 email: philippe@lerohellec.com
@@ -115,30 +142,32 @@ files:
 - spec/spec_helper.rb
 - spec/lib/stores/gcstat_logfile_store_spec.rb
 - spec/lib/stores/in_memory_store_spec.rb
+- spec/lib/stores/loader_spec.rb
 - spec/lib/stores/url_logfile_store_spec.rb
 - spec/lib/request_spec.rb
 - spec/lib/memory_tracker_spec.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
+  none: false
   requirements:
-  - - '>='
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
-  - - '>='
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 1.8.25
 signing_key: 
 specification_version: 4
 summary: Rails memory allocations tracker
@@ -146,6 +175,7 @@ test_files:
 - spec/spec_helper.rb
 - spec/lib/stores/gcstat_logfile_store_spec.rb
 - spec/lib/stores/in_memory_store_spec.rb
+- spec/lib/stores/loader_spec.rb
 - spec/lib/stores/url_logfile_store_spec.rb
 - spec/lib/request_spec.rb
 - spec/lib/memory_tracker_spec.rb

checksums.yaml

@@ -1,7 +0,0 @@
----
-SHA1:
-  metadata.gz: adeca7dfc23c7e1fc6ba5c3411ed54639ca30b87
-  data.tar.gz: b94c7d23aa9f03912cdc4be6c025860428e97aa7
-SHA512:
-  metadata.gz: 67c83299b9e960365b3a8429402b2b05f63c8b4baeb589ceef5385d2f24c63be1d3d285629b35f718a3c0bac93953e88a65d732c31d73df6cae1498a126a6f22
-  data.tar.gz: d7d17859238f52bfac1cb69a4c00761444f64a08f339bed9c0c7c45f941edc5db05e6b058e1f9c9f2008ccb771b9b547e5f07da9a9ce7dbe68dcb85dda65c0a7