rbtrace 0.4.9 → 0.4.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: a8cd3dd5d2826625fbf017e93f76f52edbaa0b83
-  data.tar.gz: 50b49986ffdeab614a9076c5f861738c9d4e4a70
+SHA256:
+  metadata.gz: 574f273f971a108d9e994a3f236c3722a649d13093f75a371249dbe6556bc6f0
+  data.tar.gz: 2aa00597a8016c8359276314b61d3bc43948f8db343423821b3015dcbe1be60b
 SHA512:
-  metadata.gz: ab75bcf6469ae23f80ec62e520e840710ef912e7080ef69474821e38077a9893a1a16d812048d3d47d990ffbe79e4d2dc075ed9367484835e240b35257f22dee
-  data.tar.gz: 9a2ce4b26b191f1064ba30601a37f4b0f8e6490bb1dec9776720bbcd4935653c823db45f1381d09d0f00b9735a8c0bab31e772985da0524c7f72b7ed17d4ebf1
+  metadata.gz: 1c79741a8c653395f4b371caf63f1e1e2c67aa109446ee6365543aad68bd58508808768c5c28ba96eae3db5fa760c2914dc68e66d095bf6806e130ea50511577
+  data.tar.gz: 7d4d8f89d2d6c63f635db87801d592a7bfffb2aa48f415e534a1ec3f9c30c55046315dd4394a804b91f7c81599d411ebab8f8168b3cbd8041b547d2b0c04a4ae

data/.gitignore

@@ -1,3 +1,4 @@
 *.gem
 .bundle
 ext/src/msgpack*
+tmp/*

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rbtrace (0.4.7)
+    rbtrace (0.4.10)
       ffi (>= 1.0.6)
       msgpack (>= 0.4.3)
       trollop (>= 1.16.2)
@@ -9,12 +9,17 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    ffi (1.9.8)
-    msgpack (0.6.0)
+    ffi (1.9.18)
+    msgpack (1.2.2)
+    rake (10.5.0)
     trollop (2.1.2)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
+  rake (~> 10.0)
   rbtrace!
+
+BUNDLED WITH
+   1.16.1

data/README.md

@@ -14,6 +14,11 @@ in production.
     % gem install rbtrace
     % rbtrace --help
 
+## supported Rubies
+
+rbtrace supports all stable versions of Ruby MRI, as of 23-01-2018 this is
+Ruby version 2.2 and later.
+
 ## tracer types
 
 rbtrace has several different tracing modes.
@@ -34,6 +39,14 @@ rbtrace has several different tracing modes.
 
     % rbtrace -p <PID> --gc
 
+### memory: produce a basic memory report regarding process (including GC.stat and ObjectSpace stats)
+
+    % rbtrace -p <PID> --memory
+
+### backtraces: return backtraces for all active threads in a process
+
+    % rbtrace -p <PID> --backtraces
+
 ### notes
 
 `--firehose` is not reliable on osx.
@@ -193,6 +206,7 @@ for popular ruby libraries and functions.
 
 ## todo
 
+* correct irb implementation so it establishes a dedicated channel
 * add triggers to start tracing slow methods only inside another method
 * add watch expressions to fire tracers only when an expression is true
 * add special expressions for method args (_arg0_, _arguments_)

data/Rakefile

@@ -0,0 +1,14 @@
+require "bundler/gem_tasks"
+
+desc "Compile the c extension"
+task :compile do
+  if File.exist?("ext/Makefile")
+    system "(cd ext && make clean)"
+  end
+  system "(cd ext && ruby extconf.rb)"
+  system "(cd ext && make)"
+end
+
+task :build => :compile
+
+

data/lib/rbtrace/cli.rb

@@ -197,6 +197,12 @@ EOS
         :default => 'irb',
         :short => '-i'
 
+      opt :backtraces,
+        "get backtraces for all threads in current process, -1 denotes all frames",
+        :type => String,
+        :default => '-1',
+        :short => '-b'
+
       opt :backtrace,
         "get lines from the current backtrace in the process",
         :type => :int
@@ -209,6 +215,16 @@ EOS
       opt :timeout,
         "seconds to wait before giving up on attach/detach/eval",
         :default => 5
+
+      opt :memory,
+        "report on process memory usage"
+
+
+      opt :heapdump,
+        "generate a heap dump for the process in FILENAME",
+        :default => "AUTO",
+        :short => "-h"
+
     end
 
     opts = Trollop.with_standard_exception_handling(parser) do
@@ -224,8 +240,8 @@ EOS
       ARGV.clear
     end
 
-    unless %w[ fork eval interactive backtrace slow slowcpu firehose methods config gc ].find{ |n| opts[:"#{n}_given"] }
-      $stderr.puts "Error: --slow, --slowcpu, --gc, --firehose, --methods, --interactive or --config required."
+    unless %w[ fork eval interactive backtrace backtraces slow slowcpu firehose methods config gc memory heapdump].find{ |n| opts[:"#{n}_given"] }
+      $stderr.puts "Error: --slow, --slowcpu, --gc, --firehose, --methods, --interactive, --backtraces, --backtrace, --memory, --heapdump or --config required."
       $stderr.puts "Try --help for help."
       exit(-1)
     end
@@ -285,18 +301,32 @@ EOS
       if filtered.size > 0
         max_len = filtered.size.to_s.size
 
-        STDERR.puts "*** found #{filtered.size} processes matching #{opts[:ps].inspect}"
+        STDERR.puts "*** found #{filtered.size} process#{filtered.size == 1 ? "" : "es"} matching #{opts[:ps].inspect}"
         filtered.each_with_index do |line, i|
-          STDERR.puts "   [#{(i+1).to_s.rjust(max_len)}]   #{line.strip}"
+          prefix = "   [#{(i+1).to_s.rjust(max_len)}]   "
+          if filtered.length == 1
+            prefix = ""
+          end
+          STDERR.puts "#{prefix}#{line.strip}"
+        end
+
+        if filtered.length > 1
+          STDERR.puts   "   [#{'0'.rjust(max_len)}]   all #{filtered.size} processes"
         end
-        STDERR.puts   "   [#{'0'.rjust(max_len)}]   all #{filtered.size} processes"
 
         while true
           STDERR.sync = true
-          STDERR.print "*** trace which processes? (0/1,4): "
+
+          if filtered.length > 1
+            STDERR.print "*** trace which processes? (0/1,4): "
+          end
 
           begin
-            input = gets
+            if filtered.length == 1
+              input = "1"
+            else
+              input = gets
+            end
           rescue Interrupt
             exit 1
           end
@@ -372,9 +402,9 @@ EOS
             end
           rescue Interrupt, SignalException
             STDERR.puts "*** waiting on child tracers: #{tracers.inspect}"
-            tracers.each do |pid|
+            tracers.each do |pid1|
               begin
-                Process.kill 'INT', pid
+                Process.kill 'INT', pid1
               rescue Errno::ESRCH
               end
             end
@@ -413,6 +443,65 @@ EOS
           tracer.puts res[1..-2].split('|').join("\n  ")
         end
 
+      elsif opts[:backtraces_given]
+        num = opts[:backtraces].to_i
+        num = -1 if num == 0
+
+        delim = "146621c9d681409aa"
+
+        code = "Thread.list.map{|t| t.backtrace[0...#{num}].join(\"#{delim}\")}.join(\"#{delim*2}\")"
+
+        if res = tracer.eval(code)
+          tracer.puts res.split(delim).join("\n")
+        end
+
+      elsif opts[:memory_given]
+        memory_report = File.expand_path('../memory_report.rb', __FILE__)
+
+        require 'tempfile'
+        output = Tempfile.new("output")
+        output.close
+
+        begin
+          code = "Thread.new do; begin; output = '#{output.path}'; eval(File.read('#{memory_report}')); end; end"
+          tracer.eval(code)
+
+          File.open(output.path, 'r') do |f|
+            while true
+              begin
+                unless line = f.readline
+                  sleep 0.1
+                  next
+                end
+
+                if line.strip == "__END__"
+                  break
+                else
+                  print line
+                end
+              rescue EOFError
+                sleep 0.1
+              end
+            end
+          end
+        ensure
+          output.unlink
+        end
+
+      elsif opts[:heapdump_given]
+        filename = opts[:heapdump]
+
+        if filename == "AUTO"
+          require 'tempfile'
+          temp = Tempfile.new("dump")
+          filename = temp.path
+          temp.close
+          temp.unlink
+        end
+
+        tracer.eval("file = File.open('#{filename}', 'w'); ObjectSpace.dump_all(output: file); file.close")
+        puts "Heapdump being written to #{filename}"
+
       elsif opts[:eval_given]
         if res = tracer.eval(code = opts[:eval])
           tracer.puts ">> #{code}"

data/lib/rbtrace/memory_report.rb

@@ -0,0 +1,20 @@
+output
+fork do
+  file = File.new(output, 'w')
+
+  file.puts "GC Stats",""
+  GC.stat.each do |k, v|
+    file.puts "#{k}: #{v}"
+  end
+
+  file.puts "", "Object Stats", ""
+  require 'objspace'
+  ObjectSpace.count_objects.sort{|a,b| b[1] <=> a[1]}.each do |k, v|
+    file.puts "#{k}: #{v}"
+  end
+
+
+  file.puts "__END__"
+  file.flush
+  file.close
+end

data/lib/rbtrace/version.rb

@@ -1,3 +1,3 @@
 class RBTracer
-  VERSION = '0.4.9'
+  VERSION = '0.4.10'
 end

data/rbtrace.gemspec

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require File.expand_path('../lib/rbtrace/version', __FILE__)
 
 Gem::Specification.new do |s|
@@ -8,16 +10,21 @@ Gem::Specification.new do |s|
   s.authors = 'Aman Gupta'
   s.email   = 'aman@tmm1.net'
 
+  s.require_paths = ['lib', 'ext']
+
   s.files = `git ls-files`.split("\n")
   s.extensions = 'ext/extconf.rb'
 
   s.bindir = 'bin'
   s.executables << 'rbtrace'
 
+
   s.add_dependency 'ffi',     '>= 1.0.6'
   s.add_dependency 'trollop', '>= 1.16.2'
   s.add_dependency 'msgpack', '>= 0.4.3'
 
+  s.add_development_dependency "rake", "~> 10.0"
+
   s.license = "MIT"
   s.summary = 'rbtrace: like strace but for ruby code'
   s.description = 'rbtrace shows you method calls happening inside another ruby process in real time.'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rbtrace
 version: !ruby/object:Gem::Version
-  version: 0.4.9
+  version: 0.4.10
 platform: ruby
 authors:
 - Aman Gupta
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-03 00:00:00.000000000 Z
+date: 2018-01-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
@@ -52,6 +52,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.4.3
+- !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'
 description: rbtrace shows you method calls happening inside another ruby process
   in real time.
 email: aman@tmm1.net
@@ -66,6 +80,7 @@ files:
 - Gemfile.lock
 - LICENSE
 - README.md
+- Rakefile
 - bin/rbtrace
 - ext/.gitignore
 - ext/extconf.rb
@@ -75,6 +90,7 @@ files:
 - lib/rbtrace/core_ext.rb
 - lib/rbtrace/interactive/irb.rb
 - lib/rbtrace/interactive/rib.rb
+- lib/rbtrace/memory_report.rb
 - lib/rbtrace/msgq.rb
 - lib/rbtrace/rbtracer.rb
 - lib/rbtrace/version.rb
@@ -96,6 +112,7 @@ post_install_message:
 rdoc_options: []
 require_paths:
 - lib
+- ext
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -108,7 +125,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 2.7.3
 signing_key: 
 specification_version: 4
 summary: 'rbtrace: like strace but for ruby code'