memprof 0.3.3 → 0.3.5

data/README.rdoc

@@ -0,0 +1,118 @@
+= memprof (c) Joe Damato  @joedamato   http://timetobleed.com
+
+Memprof is a Ruby level memory profiler that can help you find reference leaks in your application.
+Memprof can also do very lightweight function call tracing to help you figure out which system calls, and library calls your code causes. 
+
+== Installing
+
+  gem install memprof
+
+== Usage
+
+== Memory Tracking
+
+== Blocks (memory tracking)
+
+  Memprof.track {
+    100.times{ "abc" }
+    100.times{ 1.23 + 1 }
+    100.times{ Module.new }
+  }
+
+Outputs:
+
+  100   file.rb:2:String
+  100   file.rb:3:Float
+  100   file.rb:4:Module
+
+== Rails requests (memory tracking)
+
+Use the Memprof::Middleware
+
+== Dump objects
+
+  Memprof.dump {
+    "hello" + "world"
+  }
+
+Outputs:
+
+  {
+  "_id": "0x19c610",
+  "file": "file.rb",
+  "line": 2,
+  "type": "string",
+  "class": "0x1ba7f0",
+  "class_name": "String",
+  "length": 10,
+  "data": "helloworld"
+  }
+
+You can dump any Ruby object you want.
+
+== Dumping the entire heap
+
+  Memprof.dump_all("file.json")
+
+This will dump out every single live object as json to /tmp/file.json
+
+== Less elegant tracking usage:
+
+  require 'memprof'
+  Memprof.start
+
+  # ruby code
+
+  Memprof.stats
+
+  # more ruby code
+
+  Memprof.stats
+  Memprof.stop
+
+The above code will output 2 summaries, allowing you to compare which objects were
+destroyed and which are still around.
+
+Memprof.stats also takes an (optional) file name to write the output to a file.
+
+== Function call tracing
+
+This system is under development and the API may change without warning.
+
+You can use the middleware Memprof::Tracer to output function tracing and request information for
+each request that comes in to your app.
+
+== Compatibility
+
+You must have debug symbols installed or a an unstripped version of Ruby.
+
+To install debug symbols on Debian-like systems:
+
+  apt-get install libruby1.8-dbg
+
+Not supporting:
+  * OSX default Ruby
+  * Stripped Ruby binaries without debug symbols
+  * Any and all Windows Ruby builds
+  * Ruby 1.9+ on all systems
+  * 32bit systems
+
+Supporting:
+  * Linux (enable-shared AND disable-shared):
+    * x86_64 builds of Ruby Enterprise Edition 1.8.6/1.8.7
+    * x86_64 builds of MRI Ruby
+
+  * Snow Leopard (enable-shared AND disable-shared):
+    * x86_64 builds of Ruby Enterprise Edition 1.8.6/1.8.7
+    * x86_64 builds of MRI Ruby
+
+Coming soon:
+
+  Official support for Ruby 1.9
+  Official support for i386/i686
+
+== Special Thanks
+  * Jake Douglas for the Mach O/snow leopard support.
+  * Aman Gupta for various bug fixes and other cleanup.
+  * Rob Benson for 1.9 support and cleanup.
+  * Paul Barry for force_gc support in Memprof::Middleware

data/ext/memprof.c

@@ -1906,7 +1906,11 @@ init_memprof_config_extended() {
     /* who knows what could happen */
     if (TYPE(ruby_build_info) == T_STRING)
       fprintf(stderr, "%s\n", StringValuePtr(ruby_build_info));
-    errx(EX_SOFTWARE, "Memprof does not have enough data to run. Please email this output to bugs@memprof.com");
+
+    fprintf(stderr, "\nTry installing debug symbols (apt-get install libruby1.8-dbg or similar), or using a "
+                    "Ruby built with RVM (http://rvm.beginrescueend.com/)\n\n");
+
+    errx(EX_SOFTWARE, "If that doesn't work, please email this output to bugs@memprof.com");
   }
 }
 

data/lib/memprof/middleware.rb

@@ -11,6 +11,10 @@ module Memprof
         puts
         puts '-' * 80
         puts '-' * 80
+        if @options[:force_gc]
+          puts "Forcing GC...."
+          GC.start
+        end
       }
       ret
     end

data/memprof.gemspec

@@ -1,6 +1,6 @@
 spec = Gem::Specification.new do |s|
   s.name = 'memprof'
-  s.version = '0.3.3'
+  s.version = '0.3.5'
   s.date = '2010-04-13'
   s.summary = 'Ruby Memory Profiler'
   s.description = "Ruby memory profiler similar to bleak_house, but without patches to the Ruby VM"

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 3
-  - 3
-  version: 0.3.3
+  - 5
+  version: 0.3.5
 platform: ruby
 authors: 
 - Joe Damato
@@ -17,7 +17,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-04-13 00:00:00 -07:00
+date: 2010-04-13 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -59,7 +59,7 @@ extra_rdoc_files: []
 
 files: 
 - .gitignore
-- README
+- README.rdoc
 - Rakefile
 - bin/memprof
 - ext/arch.h

data/README

@@ -1,72 +0,0 @@
-memprof (c) Joe Damato  @joedamato   http://timetobleed.com
-
-What is memprof?
-================
-Memprof is a memory profiler for Ruby that requires no patches to the Ruby VM.
-It can help you find Ruby level memory leaks in your application.
-
-How to use
-==========
-
-require 'memprof'
-Memprof.start
-
-# ruby code
-
-Memprof.stats
-
-# more ruby code
-
-Memprof.stats
-Memprof.stop
-
-
-The above code will output 2 summaries, allowing you to compare which objects were
-destroyed and which are still around.
-
-Memprof.stats also takes an (optional) file name to write the output to a file.
-
-Supported systems
-=================
-Currently supporting:
-
-  Linux (enable-shared AND disable-shared):
-    x86_64 builds of Ruby Enterprise Edition 1.8.6/1.8.7
-    x86_64 builds of MRI Ruby
-
-  Snow Leopard (enable-shared AND disable-shared):
-    x86_64 builds of Ruby Enterprise Edition 1.8.6/1.8.7
-    x86_64 builds of MRI Ruby
-
-    Support for unstripped binaries and stripped binaries if (and only if) the
-    symbol files live in /usr/lib/debug/
-
-    You can get symbol files for system Rubies by installing -dbg packages.
-
-    For example, on ubuntu: apt-get install libruby1.8-dbg
-
-  Snow Leopard:
-    x86_64 builds of Ruby Enterprise Edition 1.8.7
-    x86_64 builds of MRI Ruby  (enable-shared and disable-shared)
-    Unstripped binaries only!
-
-Experimental (somewhat broken) support:
-
-  Linux and OSX:
-    i386/i686 support.
-
-  Snow Leopard:
-    OSX system Ruby, distributed with Snow Leopard
-
-Coming soon:
-
-  Official support for Ruby 1.9
-  Official support for i386/i686
-
-CREDITS
-=======
-Jake Douglas for the Mach O/snow leopard support.
-
-Aman Gupta for various bug fixes and other cleanup.
-
-Rob Benson for 1.9 support and cleanup.