rbkit 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9c98d007ffcab15624f4463ba9220cfe0b02635f
+  data.tar.gz: 4de1af44a5313d96dc359dac2e5929616c8362af
+SHA512:
+  metadata.gz: 3b867812d99bcc5b41da934789e26f0053419757928db46d9f23f0faaac30757ef1eec6083d3b28e21277d99f5b8d4cf0e566fffc89c80b790005916492689f4
+  data.tar.gz: 001c0549d008515fc411499c94b4fe72768d801e1040ff44ab39e1ee0e79f7830de0aa3816be738a90a66aff728b2c34c9630a3e27231a163aee06af8200a09f

data/.bundle/config

@@ -0,0 +1,3 @@
+---
+BUNDLE_PATH: vendor/
+BUNDLE_DISABLE_SHARED_GEMS: '1'

data/.gitignore

@@ -0,0 +1,16 @@
+/vendor/ruby/
+/ext/Makefile
+/ext/mkmf.log
+/ext/rbkit_tracer.bundle
+/ext/*.o
+/lib/rbkit_tracer.bundle
+/tmp
+Gemfile.lock
+*.so
+*.gem
+.ruby-version
+/ext/.kdev4/
+/ext/ext.kdev4
+/mkmf.log
+/coverage
+*.xcodeproj

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+gem "rbczmq"
+gem "msgpack"
+gem "rake-compiler"
+
+gemspec

data/README.md

@@ -0,0 +1,91 @@
+Rbkit
+=====
+
+`rbkit` is a Ruby gem that plugs into your ruby process, taps profiling data
+in realtime and sends it across the wire to the [rbkit-client](https://github.com/code-mancers/rbkit-client)
+as packed messages.
+
+## Usage
+
+Rbkit is not ready for production yet. To use the development version of Rbkit
+in your Ruby project, follow the instructions under `Development` section and
+then follow these steps :
+
+#### Add `rbkit` to Gemfile
+
+Add the following to the project's Gemfiles
+
+```
+gem 'rbkit', path: <RBKIT_PATH>`
+```
+and run `bundle install`
+
+#### Inject `rbkit` into code
+
+Wherever you want to start profiling, add the following :
+```
+require 'rbkit'
+Rbkit.start_profiling
+```
+If using Rails, and you want to measure everything from the boot process,
+a good place to put this would be at the end of `config/boot.rb`.
+
+## Development
+
+#### Install zmq and msgpack
+
+On OSX - Using `homebrew` following command should suffice:
+
+```
+~> brew install zeromq
+~> brew install msgpack
+```
+
+On Linux - we recommend to download these libraries
+from their respective home pages and manually compiling
+and installing.
+
+At some point, we will bundle these two C libraries during gem installations
+but for now, this has to suffice.
+
+#### Clone the repo
+
+`git clone git@github.com:code-mancers/rbkit.git`
+
+We'll call this `<RBKIT_PATH>`.
+
+#### Set RBKIT_DEV environment flag
+
+Set the environment variable `RBKIT_DEV` to true.
+If using bash, put `export RBKIT_DEV=true` in your `~/.bashrc`.
+
+This compiles the C extension with debug flag and also sets a macro named
+`RBKIT_DEV` inside the C extension.
+
+#### Compile the C extension
+
+Two ways to do this :
+
+##### Using rake-compiler
+
+```
+cd <RBKIT_PATH>
+bundle install
+bundle exec rake compile
+
+```
+
+##### Or do it manually
+
+```
+cd <RBKIT_PATH/ext>
+ruby extconf.rb
+make
+# Create a symlink at `lib/rbkit_tracer.bundle`
+# that points to `ext/rbkit_tracer.bundle`
+# (in order to use `rbkit` gem in Gemfiles using `path` option)
+```
+
+## TODO
+
+TODOs are tracked as github issues.

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+
+require 'rake/extensiontask'
+
+Rake::ExtensionTask.new('rbkit_tracer') do |ext|
+  ext.ext_dir = 'ext'
+end

data/docs/debugging.md

@@ -0,0 +1,27 @@
+### How to debug a extension coming from C extension ###
+
+1. Build a Ruby which is compiled with debug symbols:
+
+        ./configure --prefix="$HOME/.rbenv/versions/debug_ruby" --enable-shared --disable-install-doc debugflags="-g" --with-opt-dir="$(brew --prefix openssl):$(brew --prefix libyaml):$(brew --prefix gdbm):$(brew --prefix libffi)"
+
+I used above configure command to compile a debug symbol enabled Ruby.
+
+2. Build your extension with debug enabled.
+
+        1. delete existing Makefile and object/bundle/so files.
+        2. export CFLAGS=-g
+        3. ruby extconf.rb
+        4. make
+
+3. Run your program that makes use of C extension with:
+
+        ~> lldb /Users/gnufied/.rbenv/versions/debug_ruby/bin/ruby -> needs absolute path
+        lldb> process launch -- experiments/using_rbkit.rb
+
+4. LLDB is slightly different from `GDB` and more information about it can be found on,
+http://lldb.llvm.org/tutorial.html . I specially found following commands useful:
+
+        1. expr
+        2. frame variable
+        3. frame variable <variable_name>
+

data/docs/design.md

@@ -0,0 +1,3 @@
+## Design of Rbkit profiler ##
+
+1.

data/experiments/benchmark.rb

@@ -0,0 +1,37 @@
+$:<< File.join(File.dirname(__FILE__), "../lib")
+$:<< File.join(File.dirname(__FILE__), "../ext")
+
+require 'benchmark'
+require 'rbkit'
+
+
+def do_stuff
+  hash = {}
+  10_00_000.times do |i|
+    hash[:"key#{i}"] = "value#{i}"
+  end
+end
+
+Benchmark.bm do |bm|
+  bm.report('Running code without Rbkit :') do
+    do_stuff
+  end
+
+  Rbkit.start_profiling
+  bm.report('Running code with Rbkit tracing :') do
+    do_stuff
+  end
+
+  bm.report('Time taken for objectspace snapshot :') do
+    Rbkit.send_objectspace_dump
+  end
+
+  bm.report('Running code after objectspace snapshot :') do
+    do_stuff
+  end
+
+  Rbkit.stop_server
+  bm.report('Running code after disabling rbkit :') do
+    do_stuff
+  end
+end

data/experiments/mspack_to_file.rb

@@ -0,0 +1,10 @@
+require 'msgpack'
+
+message = {
+  'event_type' => 'gc_start',
+  'timestamp' => Time.now.to_f
+}
+
+File.open("/tmp/msgpack.dat", "w") do |fl|
+  fl.write(message.to_msgpack)
+end

data/experiments/no_growth.rb

@@ -0,0 +1,20 @@
+$:<< File.join(File.dirname(__FILE__), "../lib")
+$:<< File.join(File.dirname(__FILE__), "../ext")
+
+require 'rbkit'
+
+Rbkit.start_profiling(5555)
+
+class Foo
+  def initialize(name)
+    @name = name
+  end
+end
+
+stuff = {}
+100.times do |i|
+  foo = Foo.new("hemant-#{i}")
+  stuff["name#{i}"] = "hemant-#{i}"
+end
+
+gets

data/experiments/object_dump.rb

@@ -0,0 +1,21 @@
+$:<< File.join(File.dirname(__FILE__), "../lib")
+$:<< File.join(File.dirname(__FILE__), "../ext")
+
+require 'rbkit'
+
+Rbkit.start_profiling(5555)
+
+class Foo
+  def initialize(name)
+    @name = name
+  end
+end
+
+stuff = {}
+100.times do |i|
+  sleep 0.01
+  foo = Foo.new("hemant-#{i}")
+  stuff["name#{i}"] = "hemant-#{i}"
+end
+
+Rbkit.dump_objects

data/experiments/rbkit_client.rb

@@ -0,0 +1,25 @@
+# encoding: utf-8
+# To use this client install following gems
+# gem install msgpack
+# gem install rbczmq
+
+require 'zmq'
+require 'pp'
+require "msgpack"
+
+# PUB / SUB topology
+
+Thread.abort_on_exception = true
+fl = File.open("foo.dat", "w")
+
+ctx = ZMQ::Context.new
+socket = ctx.socket(:SUB)
+socket.verbose = true
+socket.subscribe("")
+socket.connect("tcp://localhost:5555")
+loop do
+  message = socket.recv
+  unpacked_message = MessagePack.unpack(message)
+  p unpacked_message
+end
+fl.close()

data/experiments/rbkit_command_test.rb

@@ -0,0 +1,54 @@
+require 'zmq'
+require 'msgpack'
+require 'pp'
+
+Thread.abort_on_exception = true
+
+
+commands = [
+  'start_memory_profile',
+  'stop_memory_profile',
+  'objectspace_snapshot',
+  'trigger_gc'
+]
+
+output_file = File.open("/tmp/rbkit.log", "w")
+puts "Writing output to file #{output_file.path}"
+ctx = ZMQ::Context.new
+
+puts "Enter IPv4 address of Rbkit server. (Blank for localhost) :"
+server_ip = gets.strip
+server_ip = "127.0.0.1" if server_ip.empty?
+
+Thread.new do
+  request_socket = ctx.socket(:REQ)
+  request_socket.connect("tcp://#{server_ip}:5556")
+  loop do
+    puts "Available commands :"
+    commands.each_with_index do |c, i|
+      puts "#{i+1}. #{c}"
+    end
+    command = commands[gets.strip.to_i - 1] rescue ''
+    unless command.empty?
+      request_socket.send(command)
+      puts "sent #{command}"
+      response = request_socket.recv()
+      puts "received #{response}"
+    end
+  end
+end
+
+socket = ctx.socket(:SUB)
+socket.subscribe("")
+socket.connect("tcp://#{server_ip}:5555")
+
+begin
+  loop do
+    message = socket.recv
+    unpacked_message = MessagePack.unpack(message)
+    PP.pp(unpacked_message, output_file)
+    output_file.flush
+  end
+ensure
+  output_file.close
+end

data/experiments/using_new_client.rb

@@ -0,0 +1,22 @@
+require 'zmq'
+require 'pp'
+require "msgpack"
+
+Thread.abort_on_exception = true
+
+ctx = ZMQ::Context.new
+socket = ctx.socket(:SUB)
+socket.subscribe("")
+socket.connect("tcp://127.0.0.1:5555")
+
+request_socket = ctx.socket(:REQ)
+request_socket.connect("tcp://127.0.0.1:5556")
+request_socket.send("start_memory_profile")
+response = request_socket.recv()
+puts "received #{response}"
+
+loop do
+  message = socket.recv
+  unpacked_message = MessagePack.unpack(message)
+  p unpacked_message
+end

data/experiments/using_object_tracer.rb

@@ -0,0 +1,11 @@
+class Foo
+  def initialize
+    @names = {}
+  end
+
+  def run
+    1000.times do |i|
+      @names[i] = "allocating #{i}"
+    end
+  end
+end

data/experiments/using_rbkit.rb

@@ -0,0 +1,19 @@
+$:<< File.join(File.dirname(__FILE__), "../lib")
+$:<< File.join(File.dirname(__FILE__), "../ext")
+
+require 'rbkit'
+
+Rbkit.start_profiling(5555)
+
+class Foo
+  def initialize(name)
+    @name = name
+  end
+end
+
+stuff = {}
+10_00_0000.times do |i|
+  sleep 0.01
+  foo = Foo.new("hemant-#{i}")
+  stuff["name#{i}"] = "hemant-#{i}"
+end

data/experiments/zmq_client.rb

@@ -0,0 +1,46 @@
+require "zmq"
+require "pp"
+
+$ctx = ZMQ::Context.new
+
+ENDPOINT = "tcp://127.0.0.1:5555"
+Thread.abort_on_exception = true
+
+class Client
+  @@publish_topic = "bar"
+
+  def start_publisher
+    pub_socket = $ctx.socket(:PUB)
+    pub_socket.verbose = true
+    pub_socket.connect(ENDPOINT)
+    loop do
+      pub_socket.send("#{@@publish_topic} client#{Time.now}")
+      sleep(1)
+    end
+  end
+
+  def start_subscriber
+    sub_socket = $ctx.socket(:SUB)
+    # sub_socket.verbose = true
+    sub_socket.subscribe("foo")
+    sub_socket.connect(ENDPOINT)
+    loop do
+      data = sub_socket.recv
+      puts "********** Received from server #{data}"
+    end
+  end
+end
+
+
+client = Client.new()
+threads = []
+
+threads << Thread.new do
+  client.start_publisher
+end
+
+threads << Thread.new do
+  client.start_subscriber
+end
+
+threads.each { |thr| thr.join }