• /
  • Log in
  • Free account

Ruby agent requirements and supported frameworks

Before you install New Relic's Ruby agent, make sure you meet these requirements for compatible operating systems, security requirements, and supported frameworks.

If you don't have one already, start by creating a New Relic account. It's free, forever.

Operating systems

The Ruby agent supports UNIX-like operating systems such as Linux, Solaris, FreeBSD, and macOS.

Security requirements

As a standard security measure for data collection, your app server must support SHA-2 (256-bit). SHA-1 is not supported.

Ruby versions

The New Relic Ruby agent does not support experimental versions. Ruby versions supported by the Ruby agent include:

Ruby versions

Supported

Deprecated

JRuby

  • 9.0.x
  • 9.1.x
  • 9.2.x
  • 1.7.x or earlier: Last supported agent was 3.18.1.330.

MRI

  • 1.8.7
  • 1.9.x
  • 2.0.x
  • 2.1.x
  • 2.2.x
  • 2.3.x
  • 2.4.x
  • 2.5.x
  • 2.6.x
  • 2.7.x
  • 3.0.x
  • 2.0.x, 2.1.x Last supported agent: 6.15.0.
  • 1.8.7, 1.9.2, 1.9.3: Last supported agent was 3.18.1.330.
  • 1.8.6: Last supported agent was 3.6.8.168.

Web servers

Web servers supported by the Ruby agent include:

Web servers

Supported

Deprecated

Experimental

Passenger

  • 2.2.x
  • 3.0.x
  • 4.0.x
  • 5.x.x
  • 6.0.x

Puma

  • 2.0.x
  • 3.x.x
  • 1.0.x

Rainbows!

  • 4.5.0

Thin

  • 1.x.x

Unicorn

  • 4.x.x
  • 5.x.x
  • 6.0.x
  • 1.0.x
  • 2.0.x
  • 3.0.x

Webrick

Supported for all agent-supported versions of Ruby

Web frameworks

The Ruby agent does not support experimental versions. Web frameworks supported by the Ruby agent are listed below. Please note that Grape, Padrino, and Sinatra are not supported for Ruby 3.0+.

Web frameworks

Supported

Deprecated

Grape

  • 0.2.0
  • 1.2.x
  • 1.3.x
  • 1.4.x

Padrino

  • 0.14.x
  • 0.15.x

Rack

  • 1.1.0 or higher
  • 2.0.3 or higher
  • 1.0.x

Rails

  • 3.2.x
  • 4.0.x
  • 4.1.x
  • 4.2.x
  • 5.0.x
  • 5.1.x
  • 5.2.x
  • 6.0.x
  • 2.1.x, 2.2.x, 2.3.x: Last supported agent was 3.18.1.330.
  • 2.0.x: Last supported agent was 3.6.8.168.
  • 3.0.x, 3.1.x: Last supported agent was 6.15.0.

Sinatra

  • 1.4.x
  • 1.5.x
  • 2.0.x
  • 2.1.x
  • 1.2.x, 1.3.x: Last supported in agent version 6.15.0

Databases

The Ruby agent does not support experimental versions. Databases supported by the Ruby agent include:

Databases

Supported

Deprecated

ActiveRecord

  • 3.2.x
  • 4.0.x
  • 4.1.x
  • 4.2.x
  • 5.0.x
  • 5.1.x
  • 5.2.x
  • 6.0.x
  • 6.1.x
  • 3.0.x, 3.1.x: Last supported in agent version 6.15.0.
  • 2.1.x, 2.2.x, 2.3.x: Last supported agent was 3.18.1.330.
  • 2.0.x Last supported agent was 3.6.8.168.

DataMapper

  • 1.0

Mongo

  • 1.8.x or higher
  • 1.9.x
  • 2.0.x or higher

Redis

  • 3.x
  • 4.0.x
  • 4.1.x
  • 4.2.x

Sequel

  • 3.37.x
  • 4.0.x
  • 5.5.x or higher

Other APM software

If your application uses other application performance monitoring (APM) software besides our agent, we cannot guarantee that our agent will work correctly and we cannot offer technical support. For more information, see Errors when using other monitoring software.

Instance details

New Relic collects instance details for a variety of databases and database drivers. The ability to view specific instances and the types of database information in APM depends on your New Relic agent version.

New Relic's Ruby agent version 3.17.0 or higher supports the following ORM databases:

ORM

Database

Adapter name

Minimum agent version

ActiveRecord 5 or higher

PostgreSQL

pg

3.17.0

MySQL

mysql2

3.17.0

ActiveRecord 2.1 to 4

PostgreSQL

pg

3.17.0

MySQL

mysql

3.17.0

MySQL

mysql2

3.17.0

The Ruby agent also supports these gem databases:

Gem database

Gem name

Minimum gem version

Minimum agent version

Memcached

  • 2.7.6
  • 1.8.0
  • 1.5.0

3.17.0

Mongo DB

mongo

1.8.6

3.17.0

Redis

redis-rb

3.0.7

3.17.0

To request instance-level information from datastores currently not listed for your New Relic agent, get support at support.newrelic.com.

Background jobs

Background jobs supported by the New Relic Ruby agent include:

Background jobs

Supported

Deprecated

Delayed_Job

  • 2.0.x
  • 3.0.x
  • 4.0.x
  • 4.1.x

Rake

  • 12.3.3 or higher
  • 13.x
  • 10.x
  • 11.x
  • 12.3.2 or earlier. NOTE: Only 12.3.3 or higher tested due to exploit potential in earlier versions.

Resque

  • 1.23.x
  • 1.27.x
  • 2.0.0 or higher
  • 1.22.x and earlier

Sidekiq

  • 4.2.x
  • 5.0.x
  • 6.0.x
  • 6.1.x
  • 2.8.x, 3.4.x, 4.0.x, and 4.1.x: Last supported in agent version 6.15.0

HTTP clients

HTTP clients supported by the Ruby agent include:

  • Net::HTTP: Supported for all agent-supported versions of Ruby.
  • Curb: 0.8.1 or higher
  • Excon: 0.10.1 or higher
  • HttpClient: 2.2.0 or higher
  • HttpRb: 0.9.9 or higher
  • Typhoeus: 0.5.3 or higher

Message queuing

Message queue instrumentation is only available with the Ruby agent version 4.3.0 or higher. Currently supported message brokers:

  • RabbitMQ

Other

APM's Ruby agent also supports:

  • ActiveMerchant: 1.25.0 or higher
  • Acts_as_Solr
  • authlogic
  • Bunny: 2.0 or higher
  • Dalli
  • Memcache-Client
  • Sunspot
  • Tilt: 2.x for Ruby 2.2 or higher; 1.x for Ruby 2.7 or lower
  • Yajl-Ruby: 1.1.0 or higher

Connect the agent to other parts of New Relic

The Ruby agent integrates with other New Relic capabilities to give you end-to-end visibility.

Capability

Integration

Browser monitoring

The Ruby agent automatically injects the browser JavaScript agent when you enable auto-instrumentation. After enabling browser injection, you can view browser data in the APM Summary page and quickly switch between the APM and browser data for a particular app. For configuration options and manual instrumentation, see the browser and Ruby agent documentation.

Infrastructure monitoring

When you install the Infrastructure and APM agents on the same host, they automatically detect one another. You can then view a list of hosts in the APM UI, and filter your Infrastructure hosts by APM app in the Infrastructure UI. For more information, see APM data in infrastructure monitoring.

Synthetic monitoring

Synthetic transaction traces connect requests from Synthetics monitors to the underlying APM transaction.

For more help

If you need more help, check out these support and learning resources:

Create issueEdit page
Copyright © 2021 New Relic Inc.