Getting Started with Rbkit

This page will help you get started with Rbkit. You'll be up and running in a jiffy!

Installing and using Rbkit is really simple, follow instructions below to get started.

Installing Rbkit Desktop app

Rbkit desktop app is released as pre-built executables for the Linux and Mac OSX platforms.

You can visit Downloads page to download Rbkit desktop applications.

Installing Rbkit library

1. Rbkit Install prerequisites

Since Rbkit is a C extension it requires a C compiler and following tools:

  • libtool
  • autoconf
  • automake

Installing build-essential package on Ubuntu should install these tools and on OSX you can use homebrew to install them.

2. Installing via Rubygems or Bundler

You can start by installing rbkit gem via:

gem install rbkit

You can also add it to your Gemfile such as:

gem 'rbkit'

3. Installation without Rubygems

You can also install rbkit without Rubygems. This can be useful, if you are profiling a Ruby app where you want to measure overhead of Rubygems/Bundler.

You can download latest version of rbkit library from Downloads Page

# Run from root of rbkit directory.
~> ruby setup.rb

This should install rbkit in ruby's site_dir and then you don't need rbkit added to your Gemfile for requiring rbkit.

Using Rbkit

Start Rbkit server

Wherever you want to start profiling, add the following to your code:

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 config/boot.rb.

Now run your Ruby process (or Rails server if you are profiling a Rails app).

Start Rbkit Desktop app

  1. Start the Rbkit desktop application.
  2. Click Connect on the toolbar and follow instructions.
434434 396396

📘

What are 5555 and 5556 ?

These are the default ports which Rbkit uses to communicate between the server and client. If you are trying to connect the client to a server running on the cloud and it's not able to, check if the server is behind a firewall that blocks communications through these ports.