README.md

RorVsWild

RoRvsWild is a ruby gem to monitor performances and quality in Ruby on Rails applications.

This gem has a double mode, development and production.
It can be used without an account to monitor your requests performances in your development environment.
It can also be used in your production and staging environments with an account on https://rorvswild.com. With such an account you also get extra benefits such as 30 day trace, background jobs monitoring, errors monitoring and notifications.

Installation

Install the gem

Add in your Gemfile gem "rorvswild"

Run bundle install in you terminal

Restart your local server and you’ll see a small button in the bottom left corner of your page.

This is all what you need to do to monitor your local environment requests.

API key

To monitor your production or staging environment, you need an API key.
Signup on https://www.rorvswild.com and create an app to get one.

Add in your Gemfile gem "rorvswild"

Run bundle install in you terminal

Run rorvswild-setup API_KEY in you terminal

Deploy/Restart your app

Make a few requests and refresh your app page on rorvswild.com to view the dashboard.

The rorvswild-setup command creates a config/rorvswild.yml file.

If you prefer to use an initializer, you can do the following:

# config/initializers/rorvswild.rbRorVsWild.start(api_key:API_KEY)

You can create unlimited apps on rorvswild.com. If you want to monitor your staging environment, create a new app and edit your rorvswild.yml to add the API key.

Development mode: RoRvsWild Local

RorVsWild Local monitors the performances of requests in development environment.
It shows most of the requests performances insights RoRvsWild.com displays. A big difference is everything works locally and no data is sent and recorded on our servers. You don’t even need an account to use it.

RoRvsWild Local renders a small button in the bottom left corner of your page showing the runtime of the current request. If you click on it, you get all the profiled sections ordered by impact, which is depending on the sections average runtime and the calls count. As on RoRvsWild.com, the bottleneck is always on the top of the list.

Be aware that the performances on your development machine may vary from the production server. Obviously because of the different hardware and database size. Also, Rails is reloading all the code in development environment and this takes quite a lot of time.
To prevent this behaviour and better match the production, turn on cache_classes in your config/environments/development.rb:

Rails.application.configure do
config.cache_classes = true
end

If you are using Rack::Deflater middleware you won't see the small button in the corner. Because of the compression it is not possible to inject some JavaScript into the page. In that case visit http://localhost:3000/rorvswild to see the profiler.

Production mode: RoRvsWild.com

RoRvsWild.com makes it easy to monitor requests, background jobs and errors in your production and staging environment.
It also comes with some extra options listed below.