Ruby agent requirements and supported frameworks

This document lists compatible operating systems, security requirements, and supported frameworks for the New Relic Ruby agent.

Operating systems

The Ruby agent is supported on UNIX-like operating systems such as Linux, Solaris, and Mac OS X.

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

Name Supported Deprecated Experimental
JRuby ~> 1.6.0, ~> 1.7.0, ~> 9.0 - -
MRI 1.8.7, 1.9.2, 1.9.3, 2.0.0, ~> 2.1.0, ~> 2.2.0, ~> 2.3.0 - 2.4.0-preview3
1.8.7 includes support for Ruby Enterprise Edition (REE).
1.8.7 & REE require the json gem to be present in your Gemfile/operating environment.
Last supported agent on 1.8.6 was 3.6.8.168.
Rubinius ~> 2.2.1 - -

Web servers

Name Supported Deprecated Experimental
passenger ~>2.2, ~>3.0, ~>4.0 - -
puma ~>2.0 ~>1.0 -
rainbows! - - 4.5.0
thin ~>1.0 - -
unicorn ~>4.0 ~>1.0, ~>2.0, ~>3.0 -
webrick - - -
Supported for all Ruby agent-supported versions.

Web frameworks

Name Supported Deprecated Experimental
grape >= 0.2.0 - -
padrino ~>0.10 - -
rack >= 1.1.0 ~>1.0.0 -
rails

~>2.1.0, ~>2.2.0, ~>2.3.0, ~3.0.0, ~>3.1.0, ~>3.2.0, ~>4.0.0, ~>4.1.0, ~>4.2.0, ~>5.0.0

~>2.0.0
Last supported agent for 2.0.x was 3.6.8.168
sinatra ~>1.2.0, ~>1.3.0, ~>1.4.0 - -

Databases

Name Supported Deprecated Experimental
activerecord ~>2.1.0, ~>2.2.0, ~>2.3.0, ~>3.0.0, ~>3.1.0, ~>3.2.0, ~>4.0.0, ~>4.1.0, ~>4.2.0 ~>2.0.0 -
Last supported agent for 2.0.x was 3.6.8.168
datamapper ~>1.0 - -
mongo ~>1.8, ~>2.1 - -
redis ~> 3.0 - -
sequel ~>3.37, ~>4.0 - -

In some cases, the agent captures instance-level database information. For more information, see the compatibility matrix for instance-level database information.

Background jobs

Name Supported Deprecated Experimental
delayed_job ~>2.0, ~>3.0, ~>4.0 - -
rake ~> 10.0 - -
resque ~>1.23.0 ~>1.22.0 >= 2.0
sidekiq ~>2.8, ~>3.4.2, ~>4.0 - -

HTTP clients

Name Supported Deprecated Experimental
Net::HTTP - - -
Supported for all Ruby agent-supported versions.
curb >= 0.8.1 - -
excon >= 0.10.1 - -
httpclient >= 2.2.0 - -
typhoeus >= 0.5.3 -

-

http.rb >= 0.9.9 -

-

Other

Name Supported Deprecated Experimental
activemerchant >= 1.25.0 - -
acts_as_solr - - -
authlogic - - -
dalli - - -
memcache-client - - -
sunspot - - -

For more help

Additional documentation resources include:

  • New Relic for Ruby (compatibility and requirements, general information about installation, configuration, troubleshooting, and known issues)
  • Ruby agent installation (using the New Relic Ruby gem and configuration file)

Join the discussion about Ruby in the New Relic Online Technical Community! The Technical Community is a public platform to discuss and troubleshoot your New Relic toolset.

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