derailed_benchmarks 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e444f3e6c00f95138b3df5c86995b4126fd89121
-  data.tar.gz: cae797098b186ef45c23fb1cdc525c98ecc4cd87
+  metadata.gz: f00460799a696f7a1779ea6bbb4a6d0bbb4e0612
+  data.tar.gz: 96d81116a29b5211015581af27c3b69ede4fd125
 SHA512:
-  metadata.gz: 54796bcc3efc7773af0705cf38fa21f93c1602c5661626a1643b0b425be14eed042bfd5455ea25dcecde47ce7d95837c17549f85dd0026cbb19365efec89a9ba
-  data.tar.gz: 398783116407326acf4622869abc85420be8ddb7468e33d7267d1695de63f87ca21f577627d0145fb9ec3f82ec2dc0bc0fda32b1eedb8fee909d04551df86622
+  metadata.gz: b8d8d3c5a56696af7327a6ef4fbb927c04956a38dfced8d07ee229209eeb68beb00c047dbc317e0c6cff7a2685170305b65895e8a3d3ddb1c53ee93e4cf1a221
+  data.tar.gz: fdd8db66a4a0f2937b32d31a1ec3dca308c76d80ef337e6a0e817666bf0e127849083e0b594974324627a09dd86fec93e4c0443f89051018a2d02e6047a0e3ca

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # A Log of Changes!
 
+## [1.0.1] - 2015-20-06
+
+- `bundle:mem` and similar tasks now keep track of duplicate requires and display them along side of memory requirements. This makes it easier to identify where components are used by multiple libraries
+- Add rake to gemspec which gets rid of `Unresolved specs during Gem::Specification.reset:` warning
+- Outputs of memory are now done in [mebibytes](https://en.wikipedia.org/wiki/Mebibyte), a more accurate unit for the value we're measuring (hint: it's what you think MB is).
 
 ## [1.0.0] - 2015-15-05
 

data/Gemfile.lock

@@ -1,12 +1,12 @@
 PATH
   remote: .
   specs:
-    derailed_benchmarks (1.0.0)
+    derailed_benchmarks (1.0.1)
       benchmark-ips (~> 2)
       get_process_mem (~> 0)
       memory_profiler (~> 0)
       rack (~> 1)
-      rake (~> 10.4)
+      rake (~> 10)
 
 GEM
   remote: https://rubygems.org/
@@ -40,7 +40,7 @@ GEM
       multi_json (~> 1.0)
     arel (3.0.3)
     bcrypt (3.1.10)
-    benchmark-ips (2.1.1)
+    benchmark-ips (2.2.0)
     builder (3.0.4)
     capybara (2.4.4)
       mime-types (>= 1.16)
@@ -64,7 +64,7 @@ GEM
     mail (2.5.4)
       mime-types (~> 1.16)
       treetop (~> 1.4.8)
-    memory_profiler (0.9.0)
+    memory_profiler (0.9.1)
     mime-types (1.25.1)
     mini_portile (0.6.2)
     multi_json (1.11.0)

data/README.md

@@ -40,7 +40,7 @@ You must be using Ruby 2.1+ to install these libraries. If you're on an older ve
 
 ## Use
 
-There are two ways to use benchmark an app. Derailed can either try to boot your web app and run requests against it while benchmarking, or it can also staically give you more information about your dependencies that are in your your Gemfile. Booting your app will always be more accurate, but if you cannot get your app to run in production locally, you'll still find the static information useful.
+There are two ways to use benchmark an app. Derailed can either try to boot your web app and run requests against it while benchmarking, or it can statically give you more information about the dependencies that are in your Gemfile. Booting your app will always be more accurate, but if you cannot get your app to run in production locally, you'll still find the static information useful.
 
 ## Static Benchmarking
 
@@ -62,16 +62,21 @@ This will load each of your gems in your Gemfile and see how much memory they co
 
 ```
 $ derailed bundle:mem
-TOP: 54.1836 mb
-  mail: 18.9688 mb
-    mime/types: 17.4453 mb
-    mail/field: 0.4023 mb
-    mail/message: 0.3906 mb
-  action_view/view_paths: 0.4453 mb
-    action_view/base: 0.4336 mb
+TOP: 54.1836 MiB
+  mail: 18.9688 MiB
+    mime/types: 17.4453 MiB
+    mail/field: 0.4023 MiB
+    mail/message: 0.3906 MiB
+  action_view/view_paths: 0.4453 MiB
+    action_view/base: 0.4336 MiB
 ```
 
-Here we can see that `mail` uses 18mb, with the majority coming from `mime/types`. You can use this information to prune out large dependencies you don't need. Also if you see a large memory use by a gem that you do need, please open up an issue with that library to let them know (be sure to include reproduction instructions). Hopefully as a community we can identify memory hotspots and reduce their impact. Before we can fix performance problems, we need to know where those problems exist.
+_Aside: A "MiB", which is the [IEEE] and [IEC] symbol for Mebibyte, is 2<sup>20</sup> bytes / 1024 Kibibytes (which are in turn 1024 bytes)._
+
+[IEEE]: http://en.wikipedia.org/wiki/IEEE_1541-2002
+[IEC]: http://en.wikipedia.org/wiki/IEC_80000-13
+
+Here we can see that `mail` uses 18MiB, with the majority coming from `mime/types`. You can use this information to prune out large dependencies you don't need. Also if you see a large memory use by a gem that you do need, please open up an issue with that library to let them know (be sure to include reproduction instructions). Hopefully as a community we can identify memory hotspots and reduce their impact. Before we can fix performance problems, we need to know where those problems exist.
 
 By default this task will only return results from the `:default` and `"production"` groups. If you want a different group you can run with.
 
@@ -83,6 +88,35 @@ You can use `CUT_OFF=0.3` to only show files that have above a certain memory us
 
 Note: This method won't include files in your own app, only items in your Gemfile. For that you'll need to use `derailed exec mem`. See below for more info.
 
+The same file may be required by several libraries, since Ruby only requires files once, the cost is only associated with the first library to require a file. To make this more visible duplicate entries will list all the parents they belong to. For example both `mail` and `fog` require `mime/types. So it may show up something like this in your app:
+
+```
+$ derailed bundle:mem
+TOP: 54.1836 MiB
+  mail: 18.9688 MiB
+    mime/types: 17.4453 MiB (Also required by: fog/storage)
+    mail/field: 0.4023 MiB
+    mail/message: 0.3906 MiB
+```
+
+That way you'll know that simply removing the top level library (mail) would not result in a memory reduction. The output is trucated after the first two entries:
+
+
+```
+fog/core: 0.9844 MiB (Also required by: fog/xml, fog/json, and 48 others)
+fog/rackspace: 0.957 MiB
+fog/joyent: 0.7227 MiB
+  fog/joyent/compute: 0.7227 MiB
+```
+
+If you want to see everything that requires `fog/core` you can run `CUT_OFF=0 bundle exec derailed bundle:mem` to get the full output that you can then grep through manually.
+
+Update: While `mime/types` looks horible in these examples, it's been fixed. You can add this to the top of your gemfile for free memory:
+
+```ruby
+gem 'mime-types', '~> 2.4.3', require: 'mime/types/columnar'
+```
+
 ### Objects created at Require time
 
 To get more info about the objects, using [memory_profiler](https://github.com/SamSaffron/memory_profiler), created when your dependencies are required you can run:
@@ -105,7 +139,7 @@ allocated memory by gem
    8103432  json-1.8.2
 ```
 
-Once you identify a gem that creates a large amout of memory using `$ derailed bundle:mem` you can pull that gem into it's own Gemfile and run `$ derailed bundle:objects` to get detailed information about it. This information can be used by contributors and library authors to identify and eliminate object creation hotspots.
+Once you identify a gem that creates a large amount of memory using `$ derailed bundle:mem` you can pull that gem into it's own Gemfile and run `$ derailed bundle:objects` to get detailed information about it. This information can be used by contributors and library authors to identify and eliminate object creation hotspots.
 
 
 By default this task will only return results from the `:default` and `"production"` groups. If you want a different group you can run with.
@@ -202,7 +236,7 @@ PID: 78675
 183.62109375
 ```
 
-Here we can see that while the memory use is increasing, it levels off around 183 MB. You'll want to run this task using ever increasing values of `TEST_COUNT=` for example
+Here we can see that while the memory use is increasing, it levels off around 183 MiB. You'll want to run this task using ever increasing values of `TEST_COUNT=` for example
 
 ```
 $ TEST_COUNT=5000 derailed exec perf:ram_over_time
@@ -246,13 +280,13 @@ This task does essentially the same thing, however it hits your app with one req
 ```
 $ derailed exec perf:mem
 
-TOP: 54.1836 mb
-  mail: 18.9688 mb
-    mime/types: 17.4453 mb
-    mail/field: 0.4023 mb
-    mail/message: 0.3906 mb
-  action_view/view_paths: 0.4453 mb
-    action_view/base: 0.4336 mb
+TOP: 54.1836 MiB
+  mail: 18.9688 MiB
+    mime/types: 17.4453 MiB
+    mail/field: 0.4023 MiB
+    mail/message: 0.3906 MiB
+  action_view/view_paths: 0.4453 MiB
+    action_view/base: 0.4336 MiB
 ```
 
 You can use `CUT_OFF=0.3` to only show files that have above a certain memory useage, this can be used to help eliminate noise.

data/bin/derailed

@@ -13,7 +13,7 @@ $: << lib
 
 
 require File.join(lib, 'derailed_benchmarks.rb')
-require 'bundler'
+
 Bundler.setup
 
 require 'thor'
@@ -22,6 +22,7 @@ class DerailedBenchmarkCLI < Thor
 
   desc "exec", "executes given derailed benchmark"
   def exec(task = nil)
+    setup_bundler!
     require 'derailed_benchmarks'
     require 'rake'
     Rake::TaskManager.record_task_metadata = true

data/derailed_benchmarks.gemspec

@@ -22,7 +22,7 @@ Gem::Specification.new do |gem|
   gem.add_dependency "get_process_mem", "~> 0"
   gem.add_dependency "benchmark-ips",   "~> 2"
   gem.add_dependency "rack",            "~> 1"
-  gem.add_dependency "rake",            "~> 10.4"
+  gem.add_dependency "rake",            "~> 10"
 
   gem.add_development_dependency "capybara", "~> 2"
   gem.add_development_dependency "rails",    "~> 3"

data/lib/derailed_benchmarks.rb

@@ -1,10 +1,7 @@
 require 'time'
+require 'bundler'
 
-require 'rack/test'
-require 'rack/file'
-require 'benchmark/ips'
 require 'get_process_mem'
-require 'bundler'
 
 module DerailedBenchmarks
   def self.gem_is_bundled?(name)

data/lib/derailed_benchmarks/require_tree.rb

@@ -2,8 +2,11 @@
 # RequireTree.new('get_process_mem')
 module DerailedBenchmarks
   class RequireTree
+    REQUIRED_BY = {}
+
     attr_reader   :name
     attr_accessor :cost
+    attr_accessor :parent
 
     def initialize(name)
       @name     = name
@@ -12,6 +15,8 @@ module DerailedBenchmarks
 
     def <<(tree)
       @children[tree.name.to_s] = tree
+      tree.parent = self
+      (REQUIRED_BY[tree.name.to_s] ||= []) << self.name
     end
 
     def [](name)
@@ -32,10 +37,23 @@ module DerailedBenchmarks
       children.sort { |c1, c2| c2.cost <=> c1.cost }
     end
 
+    def to_string
+      str = "#{name}: #{cost.round(4)} MiB"
+      if parent && REQUIRED_BY[self.name.to_s]
+        names = REQUIRED_BY[self.name.to_s].uniq - [parent.name.to_s]
+        if names.any?
+          str << " (Also required by: #{ names.first(2).join(", ") }"
+          str << ", and #{names.count - 2} others" if names.count > 3
+          str << ")"
+        end
+      end
+      str
+    end
+
     # Recursively prints all child nodes
     def print_sorted_children(level = 0, out = STDOUT)
       return if cost < ENV['CUT_OFF'].to_f
-      out.puts "  " * level + "#{name}: #{cost.round(4)} mb"
+      out.puts "  " * level + self.to_string
       level += 1
       sorted_children.each do |child|
         child.print_sorted_children(level, out)

data/lib/derailed_benchmarks/tasks.rb

@@ -1,4 +1,3 @@
-
 namespace :perf do
   task :rails_load do
     ENV["RAILS_ENV"] ||= "production"
@@ -67,6 +66,9 @@ namespace :perf do
     PATH_TO_HIT = ENV["PATH_TO_HIT"] || ENV['ENDPOINT'] || "/"
     puts "Endpoint: #{ PATH_TO_HIT.inspect }"
 
+    require 'rack/test'
+    require 'rack/file'
+
     DERAILED_APP = DerailedBenchmarks.add_auth(DERAILED_APP)
     if server = ENV["USE_SERVER"]
       @port = (3000..3900).to_a.sample
@@ -130,7 +132,7 @@ namespace :perf do
   task :mem => [:kernel_require_patch, :setup] do
     puts "## Impact of `require <file>` on RAM"
     puts
-    puts "Showing all `require <file>` calls that consume #{ENV['CUT_OFF']} mb or more of RSS"
+    puts "Showing all `require <file>` calls that consume #{ENV['CUT_OFF']} MiB or more of RSS"
     puts "Configure with `CUT_OFF=0` for all entries or `CUT_OFF=5` for few entries"
 
     puts "Note: Files only count against RAM on their first load."
@@ -145,6 +147,7 @@ namespace :perf do
 
   desc "outputs ram usage over time"
   task :ram_over_time => [:setup] do
+    require 'get_process_mem'
     puts "PID: #{Process.pid}"
     ram = GetProcessMem.new
     @keep_going = true
@@ -177,6 +180,8 @@ namespace :perf do
 
   desc "iterations per second"
   task :ips => [:setup] do
+    require 'benchmark/ips'
+
     Benchmark.ips do |x|
       x.report("ips") { call_app }
     end

data/lib/derailed_benchmarks/version.rb

@@ -1,3 +1,3 @@
 module DerailedBenchmarks
-  VERSION = "1.0.0"
+  VERSION = "1.0.1"
 end

data/test/derailed_benchmarks/require_tree_test.rb

@@ -6,6 +6,10 @@ class RequireTree < ActiveSupport::TestCase
     DerailedBenchmarks::RequireTree.new(name)
   end
 
+  def teardown
+    DerailedBenchmarks::RequireTree.const_set("REQUIRED_BY",  {})
+  end
+
   test "default_cost" do
     parent =  tree("parent")
     assert_equal 0,       parent.cost
@@ -43,9 +47,44 @@ class RequireTree < ActiveSupport::TestCase
     assert_equal expected, parent.sorted_children
 
     expected = <<-OUT
-parent: #{ parent.cost.round(4) } mb
-  large: #{ large.cost.round(4) } mb
-  small: #{ small.cost.round(4) } mb
+parent: #{ parent.cost.round(4) } MiB
+  large: #{ large.cost.round(4) } MiB
+  small: #{ small.cost.round(4) } MiB
+OUT
+    capture  = StringIO.new
+
+    parent.print_sorted_children(0, capture)
+
+    assert_equal expected, capture.string
+  end
+
+  test "attributes duplicate children" do
+    parent = tree("parent")
+    parent.cost = rand(5..10)
+    small  = tree("small")
+    small.cost = rand(10..100)
+
+    large  = tree("large")
+    large.cost = small.cost + 1
+
+    dup    = tree("large")
+    dup.cost = 0.4
+    small << dup
+
+    parent << small
+    parent << large
+
+    expected = [large, small]
+    assert_equal expected, parent.sorted_children
+
+    expected = [dup]
+    assert_equal expected, small.sorted_children
+
+    expected = <<-OUT
+parent: #{ parent.cost.round(4) } MiB
+  large: #{ large.cost.round(4) } MiB (Also required by: small)
+  small: #{ small.cost.round(4) } MiB
+    large: #{ dup.cost.round(4) } MiB (Also required by: parent)
 OUT
     capture  = StringIO.new
     parent.print_sorted_children(0, capture)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: derailed_benchmarks
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Richard Schneeman
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-18 00:00:00.000000000 Z
+date: 2015-06-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: memory_profiler
@@ -72,14 +72,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.4'
+        version: '10'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.4'
+        version: '10'
 - !ruby/object:Gem::Dependency
   name: capybara
   requirement: !ruby/object:Gem::Requirement