0.0
No commit activity in last 3 years
No release in over 3 years
SpeedUpRails is written in hope it will help develop faster rails applications.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
 Dependencies
 Project Readme

SpeedupRails

Gem Version Build Status

Overview

SpeedUpRails is a development helper for a rails application. It collects performance data in Rails application. For longterm vizualization you can use a counterpart engine called speedup-dashboard. But you can use 3rd party vizualization as well, Grafana with InfluxDB engine is a good example.

Install

The easiest way to install speedup-rails is by using Ruby Gems. To install put in your Gemfile:

gem 'speedup-rails'

Messurements

Usage

Configuration

You can configure speedup-rails trough the environment files, or yml file in Rails.root/config/speedup-rails.yml with format:

development:
  disabled_collectors:
    - bullet

In file you can disable collector like:

Choosing a storage

In development environment all you have to do is include a gem in your Gemfile. But you can wish to choose an adapter for storing a request data. Available adapters are:

  • Memory - default in development
  • File - default in all but development
  • Redis
  • Memcached (via Dalli)
  • InfluxDB
  • Server - send via asynchronous HTTP request

Adapter can be chosen in config file:

  Rails.application.configure do
    config.speedup.adapter = :server, {url: 'http://path/to/server', api_key: '<your_key_generated_by_server>'}
  end

Server adapter

There is implemented server side application as Engine, so best is to use it: https://github.com/ezrondre/perfdashboard

Speedup toolbar

In developement you can see the speedup toolbar at bottom of your page. It is available for all your request ( even for redirected and ajax ones ) and shows information from all allowed collectors.

You can disable it by, or set some css styles - for now just an zindex, but there are expected more options.

  config.speedup.show_bar = false

  config.speedup.css[:zindex] = 10

What information you get?

Well that depends on what collectors you allow.

This is your options:

  • Request - prety mandatory, without performance impact
  • Queries - not as mandatory. Impact is pretty low, but if you have a lot of queries in your request, you can consider it.
  • Partials - same as queries, but watching over rendered partials.
  • Bullet - Using a bullet and vizualize its results.
  • Profiler - Using a rubyprofiler to profile full request or

every option is in form of collector

Selecting a collector

Collectors are defined by a configuration ( in environment file or in application.rb)

Add Profiler collector:

  Rails.application.configure do
    # config.speedup.collectors << :rubyprof
    config.speedup.collectors << {rubyprof: {profile_request: true} } #collector with options
  end

default collecotors are :request, :queries, :partials ( + :bullet and :rubyprof in developement )

Profiling

Everything you need to do is enable rubyprof collector ( default in developement ) and wrap profiled code in block:

  Speedup.profile do
    ...
  end

if you want to profile full request, just set

  { profile_request: true }

in rubyprof options

License

See MIT-LICENSE for license information.

Development

Code is located at https://github.com/ezrondre/speedup-rails

Any contribution, or feedback will be appreciated.