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.

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
  • 1.7.x or earlier: Last supported agent was 3.18.1.330.
MRI
  • 2.0.x
  • 2.1.x
  • 2.2.x
  • 2.3.x
  • 2.4.x
  • 2.5.x
  • 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 New Relic Ruby agent include:

Web servers Supported Deprecated Experimental
Passenger
  • 2.2.x
  • 3.0.x
  • 4.0.x
Puma
  • 2.0.x
  • 1.0.x
Rainbows!
  • 4.5.0
Thin
  • 1.0.x
Unicorn
  • 4.0.x
  • 1.0.x
  • 2.0.x
  • 3.0.x
Webrick Supported for all agent-supported versions of Ruby

Web frameworks

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

Web frameworks Supported Deprecated
Grape
  • 0.2.0 or higher
Padrino
  • 0.14.x
Rack
  • 1.1.0 or higher
  • 1.0.x
Rails
  • 3.0.x
  • 3.1.x
  • 3.2.x
  • 4.0.x
  • 4.1.x
  • 4.2.x
  • 5.0.x
  • 5.1.x
  • 5.2.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.
Sinatra
  • 1.2.x
  • 1.3.x
  • 1.4.x
  • 2.0.x

Databases

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

Databases Supported Deprecated
ActiveRecord
  • 3.0.x
  • 3.1.x
  • 3.2.x
  • 4.0.x
  • 4.1.x
  • 4.2.x
  • 5.0.x
  • 5.1.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.
DataMapper
  • 1.0
Mongo
  • 1.8.x
  • 2.1.x
Redis
  • 3.x
  • 4.0.x
Sequel
  • 3.37.x
  • 4.0.x
  • 5.5.x

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 New Relic 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 Dalli 2.6.4 3.17.1
Mongo DB mongo 2.1.0 3.17.1
Redis redis-rb 3.0.0 3.17.1

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 Experimental
Delayed_Job
  • 2.0.x
  • 3.0.x
  • 4.0.x
  • 4.1.x
Rake
  • 10.x
  • 11.x
  • 12.x
Resque
  • 1.23.x
  • 1.22.x
  • 2.0 or higher
Sidekiq
  • 2.8.x
  • 3.4.2.x
  • 4.0.x
  • 4.1.x
  • 5.0.x

HTTP clients

HTTP clients supported by the New Relic 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

Other

New Relic 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

Connect the agent to other New Relic products

New Relic APM's Ruby agent integrates with other New Relic products to give you end-to-end visibility.

Product Integration
New Relic Browser 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 Overview page and quickly switch between the APM and Browser data for a particular app. For configuration options and manual instrumentation, see New Relic Browser and the Ruby agent.
New Relic Infrastructure 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 New Relic APM data in Infrastructure.
New Relic Insights The Ruby agent sends default events and attributes to Insights for NRQL queries. You can also record custom events for advanced analysis.
New Relic Synthetics Synthetic transaction traces connect requests from Synthetics monitors to the underlying APM transaction.

For more help

Recommendations for learning more: