New Relic for Ruby

The Ruby agent, as New Relic's flagship release, is our most mature, feature-laden product. For information about getting started with the Ruby agent, start here.

Compatibility and requirements

For full information on the Ruby agent's compatibility with various platforms and frameworks, see Supported frameworks.

Compatibility for... Requirements
Ruby 1.8.7 (including REE), 1.9.2, 1.9.3, 2.0.0, and 2.1.0; JRuby 1.6 and above; Rubinius 2.x
OS UNIX-like operating systems such as Linux, Solaris, Mac OS X
Frameworks Rails 2.1 to 4.x, Sinatra, Rack, Resque, Sidekiq, and many more
Dispatchers Nearly any Ruby web servers including Thin, Passenger, Unicorn, Puma, Glassfish, Rainbows, etc.

Installation

Before you can install the Ruby agent, you must have a New Relic account. The Ruby agent is available as a gem and also as a Rails plugin. New Relic highly recommends installing the gem. For more information, see:

Note: As part of the installation process, give your application a meaningful name.

Configuration

After installing the Ruby agent, follow the Ruby agent configuration procedures.

Troubleshooting

After sending a request to your web application, data should appear in the New Relic user interface within 2 to 3 minutes. If no data appears after a few minutes, see No data appears (Ruby).

Known issues

For more information about known issues with the Ruby agent, see Incompatible gems.

For more help

Additional documentation resources include:

If you need additional help, get support at support.newrelic.com.