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 |
|
|
CRuby |
|
|
Web servers
Web servers supported by the Ruby agent include:
Web servers | Supported | Deprecated |
|---|---|---|
Passenger |
|
|
Puma |
|
|
Rainbows! |
| 4.5.0: Last supported agent was 8.16.0. |
Thin |
| |
Unicorn |
|
|
Webrick | Supported for all agent-supported versions of Ruby |
Web frameworks
The Ruby agent doesn't support experimental versions. Web frameworks supported by the Ruby agent are listed below. Please note that Grape, Padrino, and Sinatra aren't supported for Ruby 3.0+.
Web frameworks | Supported | Deprecated |
|---|---|---|
Grape |
|
|
Padrino |
|
|
Rack |
|
|
Rails |
|
|
Roda |
| |
Sinatra |
|
|
Databases
The Ruby agent doesn't support experimental versions. Databases supported by the Ruby agent include:
Databases | Supported | Deprecated |
|---|---|---|
Active Record |
|
|
DataMapper |
|
|
Elasticsearch |
| |
Mongo |
|
|
Redis |
| |
Sequel |
|
|
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:
ORM | Database | Adapter name | Minimum agent version |
|---|---|---|---|
Active Record 5 or higher | 3.17.0 | ||
3.17.0 | |||
Active Record 2.1 to 4 | 3.17.0 | ||
3.17.0 | |||
3.17.0 |
The Ruby agent also supports these gem databases:
Gem database | Gem name | Minimum gem version | Minimum agent version |
|---|---|---|---|
| 3.17.0 | ||
1.8.6 | 3.17.0 | ||
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 |
|
|
Rake |
|
|
Resque |
|
|
Sidekiq |
|
|
HTTP and network clients
HTTP clients supported by the Ruby agent include:
- Async::HTTP: 0.59.0 or higher
- Curb: 0.8.1 or higher
- Ethon: 0.12.0 or higher
- Excon: 0.19.0 or higher (Versions lower than 0.55.0 last supported in agent version 8.16.0)
- gRPC: 1.0.0 or higher
- HttpClient: 2.2.0 or higher (Versions 2.2.0 - 2.8.0 last supported in agent version 8.16.0)
- HttpRb: 0.9.9 or higher (Versions 0.9.9 - 2.2.1 last supported in agent version 8.16.0)
- HTTPX: 1.0.0 or higher
- Net::HTTP: Supported for all agent-supported versions of Ruby.
- Typhoeus: 0.5.3 or higher (Versions 0.5.3 - 1.2.x last supported in agent version 8.16.0)
Message queuing
Message queue instrumentation is only available with the Ruby agent version 4.3.0 or higher. Currently supported message brokers:
- RabbitMQ
Currently supported gems that facilitate message brokers:
- Bunny: 2.0 or higher (Versions 2.0.x - 2.6.x last supported in agent version 8.16.0)
Other
APM's Ruby agent also supports:
- ActiveMerchant: 1.25.0 or higher (Versions 1.25.0 - 1.64.x last supported in agent version 8.16.0)
- Acts_as_Solr: Last supported in agent version 8.16.0
- authlogic: Last supported in agent version 8.16.0
- concurrent-ruby: 1.1.5 or higher
- Stripe: 5.38.0 or higher
- Sunspot: Last supported in agent version 8.16.0
- 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 | Capability |
|---|---|
You can collect AI data using the Ruby agent and the | |
The Ruby agent automatically injects the browser JavaScript agent when you enable auto-instrumentation. After enabling browser injection, you can view 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. | |
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 hosts by APM app in the infrastructure UI. For more information, see APM data in the infrastructure UI. | |
Synthetic transaction traces connect requests from synthetic monitors to the underlying APM transaction. |