heap_inspect 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3214d781e181baf1e797e224b047f6230795d8d6
+  data.tar.gz: c584ac953a48882b2f3899c79d8b6db0bea32f90
+SHA512:
+  metadata.gz: 801576c0ce7cd8ff9c1b995bad59accecf9709d4a47c6f5b0cf281523b89039d1bc7d0aaf6879cf891bb2d9992e08f372b54b27667e9d566428ef5d2a142fe0a
+  data.tar.gz: 955311f1133ca21286dad1f11e950ac03db9b6b5f0e085e41038ab6e9916b4d39408ad76229a24272824c3c163a6e063b6830a0a319ea7705fa62a50bc54103c

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.3
+before_install: gem install bundler -v 1.10.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in heap_inspect.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 schneems
+
+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.md

@@ -0,0 +1,70 @@
+# HeapInspect
+
+A CLI for analyzing Ruby Heap dumps. Thanks to [Sam Saffron](http://samsaffron.com/archive/2015/03/31/debugging-memory-leaks-in-ruby) for the idea and initial code.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'heap_inspect'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install heap_inspect
+
+## Usage
+
+Step 1) Generate a heap dump. You could [do this manually](http://samsaffron.com/archive/2015/03/31/debugging-memory-leaks-in-ruby). Or you can use a tool like [derailed_benchmarks](https://github.com/schneems/derailed_benchmarks)
+
+Step 2) Once you've got the heap dump, you can analyze it using this CLI:
+
+```
+$ heap_inspect read tmp/2015-10-01T10:18:59-05:00-heap.dump
+
+Generation:  0 object count: 209191
+Generation: 14 object count: 407
+Generation: 15 object count: 638
+Generation: 16 object count: 748
+Generation: 17 object count: 1023
+Generation: 18 object count: 805
+# ...
+```
+
+Generally early generations will have a high object count as an app is initialized. Over time however, the object count should stabalize. If however you see it spike up, you can drill down into a specific generation. In the previous example, the 17'th generation looks strangely large, you can drill into it:
+
+
+```
+$ heap_inspect read tmp/2015-10-01T10:18:59-05:00-heap.dump 17
+    Analyzing Heap (Generation: 17)
+    -------------------------------
+
+    allocated by memory (in bytes)
+    ==============================
+    /Users/richardschneeman/Documents/projects/codetriage/app/views/layouts/application.html.slim:1 (Memory: 377065, Count: 1 )
+    /Users/richardschneeman/.gem/ruby/2.2.3/gems/actionview-4.2.3/lib/action_view/template.rb:296 (Memory: 35814, Count: 67 )
+    /Users/richardschneeman/.gem/ruby/2.2.3/gems/activerecord-4.2.3/lib/active_record/attribute.rb:5 (Memory: 30672, Count: 426 )
+```
+
+You can also use T-Lo's online JS based [Heap Analyzer](http://tenderlove.github.io/heap-analyzer/) for visualizations.
+
+## Development
+
+After checking out the repo, run `$ bundle install` to install dependencies. Then, run `rake spec` to run the tests.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/heap_inspect. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/heap_inspect

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "heap_inspect"
+
+
+HeapInspect::CLI.new(ARGV).run

data/heap_inspect.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'heap_inspect/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "heap_inspect"
+  spec.version       = HeapInspect::VERSION
+  spec.authors       = ["schneems"]
+  spec.email         = ["richard.schneeman@gmail.com"]
+
+  spec.summary       = %q{Inspects Ruby heap dumps}
+  spec.description   = %q{Got a heap dump? Great. Use this tool to see what's in it!}
+  spec.homepage      = "https://github.com/schneems/heap_inspect"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+end

data/lib/heap_inspect.rb

@@ -0,0 +1,133 @@
+require 'json'
+
+require "heap_inspect/version"
+
+module HeapInspect
+
+  class CLI
+    def initialize(argv)
+      @cmd    = argv.shift
+      @file   = argv.shift
+      @number = argv.shift
+      @args   = argv
+    end
+
+    def help
+      puts <<-HALP
+$ heap_inspect read <file|command> <number>
+
+When run with only a file, it will output the generation and count pairs:
+
+  $ heap_inspect read tmp/2015-09-30-heap.dump
+    Generation:  0 object count: 209191
+    Generation: 14 object count: 407
+    Generation: 15 object count: 638
+    Generation: 16 object count: 748
+    Generation: 17 object count: 1023
+    Generation: 18 object count: 805
+
+When run with a file and a number it will output detailed information for that
+generation:
+
+  $ heap_inspect read tmp/2015-09-30-heap.dump 17
+
+    Analyzing Heap (Generation: 17)
+    -------------------------------
+
+    allocated by memory (in bytes)
+    ==============================
+    /Users/richardschneeman/Documents/projects/codetriage/app/views/layouts/application.html.slim:1 (Memory: 377065, Count: 1 )
+    /Users/richardschneeman/.gem/ruby/2.2.3/gems/actionview-4.2.3/lib/action_view/template.rb:296 (Memory: 35814, Count: 67 )
+    /Users/richardschneeman/.gem/ruby/2.2.3/gems/activerecord-4.2.3/lib/active_record/attribute.rb:5 (Memory: 30672, Count: 426 )
+
+HALP
+    end
+
+    def run
+
+      case @cmd
+      when "--help"
+        help
+      when nil
+        help
+      when "read"
+        if @number
+          Analyzer.new(@file).drill_down(@number)
+        else
+          Analyzer.new(@file).analyze
+        end
+      else
+        help
+      end
+    end
+  end
+
+  class Analyzer
+    def initialize(filename)
+      @filename = filename
+    end
+
+    def drill_down(generation)
+      puts ""
+      puts "Analyzing Heap (Generation: #{generation})"
+      puts "-------------------------------"
+      puts ""
+
+      generation = Integer(generation)
+      data = []
+      File.open(@filename) do |f|
+        f.each_line do |line|
+          parsed = JSON.parse(line)
+          data << parsed if parsed["generation"] == generation
+        end
+      end
+
+
+      # /Users/richardschneeman/Documents/projects/codetriage/app/views/layouts/application.html.slim:1"=>[{"address"=>"0x7f8a4fbf2328", "type"=>"STRING", "class"=>"0x7f8a4d5dec68", "bytesize"=>223051, "capacity"=>376832, "encoding"=>"UTF-8", "file"=>"/Users/richardschneeman/Documents/projects/codetriage/app/views/layouts/application.html.slim", "line"=>1, "method"=>"new", "generation"=>36, "memsize"=>377065, "flags"=>{"wb_protected"=>true, "old"=>true, "long_lived"=>true, "marked"=>true}}]}
+
+      memsize_hash = {}
+      data.group_by { |row| "#{row["file"]}:#{row["line"]}" }.
+         each do |(k, v)|
+           memsize_hash[k] = {
+             count:   v.count,
+             memsize:  v.inject(0) { |sum, obj| sum + Integer(obj["memsize"]) }
+           }
+         end
+
+
+      puts "allocated by memory (in bytes)"
+      puts "=============================="
+      memsize_hash.sort {|(k1, v1), (k2, v2)| v2[:memsize] <=> v1[:memsize] }.
+         each do |k,v|
+           puts "#{k} (Memory: #{v[:memsize]}, Count: #{v[:count]} ) "
+         end
+
+      puts ""
+      puts "object count"
+      puts "============"
+      memsize_hash.sort {|(k1, v1), (k2, v2)| v2[:count] <=> v1[:count] }.
+         each do |k,v|
+           puts "#{k} (Memory: #{v[:memsize]}, Count: #{v[:count]} ) "
+         end
+    end
+
+    def analyze
+      puts ""
+      puts "Analyzing Heap"
+      puts "=============="
+
+      data = []
+      File.open(@filename) do |f|
+        f.each_line do |line|
+          data << JSON.parse(line)
+        end
+      end
+
+      data.group_by{ |row| row["generation"] }.
+        sort { |a, b| a[0].to_i <=> b[0].to_i }.
+        each do |k,v|
+          puts "Generation: #{k || " 0"} object count: #{v.count}"
+        end
+    end
+  end
+end

data/lib/heap_inspect/version.rb

@@ -0,0 +1,3 @@
+module HeapInspect
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: heap_inspect
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- schneems
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-10-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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'
+description: Got a heap dump? Great. Use this tool to see what's in it!
+email:
+- richard.schneeman@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".DS_Store"
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/heap_inspect
+- heap_inspect.gemspec
+- lib/heap_inspect.rb
+- lib/heap_inspect/version.rb
+homepage: https://github.com/schneems/heap_inspect
+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.4.5.1
+signing_key: 
+specification_version: 4
+summary: Inspects Ruby heap dumps
+test_files: []