flameboyant

Flameboyant

Generate an interactive SVG flame chart.

Thanks

• https://github.com/oozou/ruby-prof-flamegraph
• https://github.com/brendangregg/FlameGraph

Usage

Example basic ruby

Flameboyant.profile(name: 'foo', width: 1024) do
  # interesting code here
end

Files are written to current directory.

Example Rails Console

Flameboyant.profile do
  app.get '/interesting/api/call'
end

If you're profiling in development mode, we recommend turning on cache_classes and eager_load in RAILS_ROOT/config/environments/development.rb.

config.cache_classes = true
config.eager_load = true

profile Options

• name (String, optional) :: The output file will be prefixed with this name.
• width (Integer, optional) :: defaults to 1920.

When running under Rails, SVG files are written to Rails.root/tmp/flames

Installation

Requires Perl! This Rubygem requires Perl. Data is recorded via Ruby and sent to a Perl script to generate the CSV. One day, maybe we'll convert the Perl script into a Ruby or Crystal script. Until then make sure you have Perl installed in your system. OSX already has Perl installed. If you're on another operating system, please search online for "install Perl on YOUR_OS" to get further instructions.

Add this line to your application's Gemfile:

gem 'flameboyant'

And then execute:

$ bundle

Or install it yourself as:

$ gem install flameboyant

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/ddrscott/flameboyant.

License

The gem is available as open source under the terms of the MIT License.