RbProf - The AspectR profiler

Version:          0.2.1
Release date:     2002-01-29
Home page:        http://aspectr.sf.net/rbprof
Tarball:          RbProf is included in the AspectR tarball below
AspectR tarball:  http://prdownloads.sf.net/aspectr/aspectr-0-3-5.tar.gz
Author:           Robert Feldt
Email:            feldt@ce.chalmers.se

What is it?

A profiler for Ruby programs. It's faster than the standard profiler and gives you information tailored to your needs.

Main features:

Limitations:

Installation?

  1. Install aspectr (by following the instruction in the AspectR README)
  2. Go into the aspects/profiler directory (where this file resides)
  3. install RbProf: ruby ../../install.rb

Why is it needed?

Example of using RbProf on the command line?

$ ruby -r rbprof your_program.rb

will print the profile to stderr (and as a binary to your_program.profile).

Example of using RbProf from within a program?

        require 'rbprof'
        $profiler.profile_methods(:<<, Bignum)
        #... rest of your program ...

will profile the methods defined in your program and Bignum#<<. The profile will be printed to stderr (and as a binary to your_program.profile). Be sure to require rbprof in the first file in your program since it will only profile methods defined after the require.

Requirements?

AspectR (but you probably already have it since RbProf is part of AspectR).

Otherwise it should work with any Ruby >= 1.6.

I've successfully used RbProf with Ruby 1.7.2 (2002-01-08) and cygwin 1.1.8 (gcc version 2.95.2-6) on Windows 2000 Professional.

NOTE THAT THIS IS AN ALPHA RELEASE SO THERE WILL LIKELY BE BUGS AND THE API MIGHT CHANGE.

Documentation?

None yet. Examples of how to use RbProf is part of chapter 8 in the book "Ruby Developer's Guide", ISBN 1-928994-64-4.

License and legal issues?

RbProf is Copyright (c) 2001, 2002 Robert Feldt, feldt@ce.chalmers.se. All rights reserved.

RbProf is distributed under GPL. See LICENSE.

Special things to note?

Plans for the future?

See TODO.

Do you have comments or questions?

I'd appreciate if you drop me a note if you're using RbProf. If there are some known users I'll be more motivated to packing up additions / new versions and post them to RAA.

Please give feedback!

Happy coding!

Robert Feldt, feldt@ce.chalmers.se