Ruby agent requirements and supported frameworks (original) (raw)

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. New Relic requires TLS 1.2 or above for all inbound connections.

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.x9.1.x9.2.x9.3.x 1.7.x or earlier: Last supported agent was 3.18.1.330.
CRuby 1.8.7 1.9.x 2.0.x 2.1.x 2.2.x 2.3.x2.4.x2.5.x2.6.x2.7.x3.0.x3.1.x3.2.x 2.2.x, 2.3.x Last supported agent: 8.16.0.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
Passenger 2.2.x 3.0.x 4.0.x5.x.x6.0.x 2.2.x, 3.0.x, 4.0.x: Last supported in agent version 8.16.0
Puma 2.0.x3.x.x4.x.x5.x.x6.x.x 1.0.x, 2.0.x: Last supported in agent version 8.16.0
Rainbows! 4.5.0 4.5.0: Last supported agent was 8.16.0.
Thin 1.x.x
Unicorn 4.x.x5.x.x6.0.x 1.0.x2.0.x3.0.x
Webrick Supported for all agent-supported versions of Ruby

Web frameworks

The Ruby agent doesn't support experimental versions. The Ruby agents supports the following Web frameworks:

Web frameworks Supported Deprecated
Grape 0.2.00.19.21.2.x1.3.x1.4.x1.5.x1.6.x1.7.x 0.2.0: Last supported in agent version 8.16.0
Padrino 0.14.x0.15.10.15.2 0.14.x: Last supported in agent version 8.16.0
Rack 1.6.x2.x3.0.x 1.0.x
Rails 3.2.x4.0.x4.1.x4.2.x5.0.x5.1.x5.2.x6.0.x6.1.x7.0.x7.1.x7.2.x8.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.3.2.x: Last supported agent was 8.16.0.
Roda 3.19.0 and higher
Sinatra 1.4.x 1.5.x2.0.x2.1.x3.0.x 1.2.x, 1.3.x: Last supported agent was 6.15.01.4.x, 1.5.x: Last supported agent was 8.16.0

Databases

The Ruby agent doesn't support experimental versions. Databases supported by the Ruby agent include:

Databases Supported Deprecated
Active Record 3.2.x4.0.x4.1.x4.2.x5.0.x5.1.x5.2.x6.0.x6.1.x7.0.x7.1.x7.2.x8.0.x 3.2.x: Last supported in agent version 8.16.0.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 1.0.x: Last supported agent: 8.16.0.
Elasticsearch 7.x8.x
OpenSearch 2.x3.x
Mongo 1.8.x 1.9.x 2.0.x 2.1.x 2.2.x 2.3.x2.4.x or higher 1.8.x - 2.3.x: Last supported in agent version 8.16.0
Redis 3.x4.0.x4.1.x4.2.x5.0.x
Sequel 3.37.x 4.0.x4.45.x or higher5.x.x 3.37, 4.0.x: Last supported in agent version 8.16.0

Other APM software

If your application uses other application performance monitoring (APM) software besides our agent, we can't guarantee that our agent will work correctly and we can't 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:

The Ruby agent also supports these gem databases:

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.x4.1.x 2.0.x, 3.0.x, 4.0.x: Last supported in agent version 8.16.0
Rake 12.3.3 or higher13.x 10.x11.x12.3.2 or earlier. NOTE: Only 12.3.3 or higher tested due to exploit potential in earlier versions.
Resque 1.23.x1.27.x2.0.0 or higher 1.22.x and earlier
Sidekiq 4.2.x5.x6.x7.0.x 2.8.x, 3.4.x, 4.0.x, and 4.1.x: Last supported in agent version 6.15.04.2.x: Last supported in agent version 8.16.0

HTTP and network clients

HTTP clients supported by the Ruby agent include:

Message queuing

Currently supported gems that are instrumented:

Other

APM's Ruby agent also supports:

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.