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 |
|
|
MRI |
|
|
Web servers
Web servers supported by the Ruby agent include:
Web servers | Supported | Deprecated | Experimental |
---|---|---|---|
Passenger |
| ||
Puma |
|
| |
Rainbows! |
| ||
Thin |
| ||
Unicorn |
|
| |
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 |
| |
Padrino |
| |
Rack |
|
|
Rails |
|
|
Sinatra |
|
|
Databases
The Ruby agent does not support experimental versions. Databases supported by the Ruby agent include:
Databases | Supported | Deprecated |
---|---|---|
ActiveRecord |
|
|
DataMapper |
| |
Mongo |
| |
Redis |
| |
Sequel |
|
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 | 3.17.0 | ||
3.17.0 | |||
ActiveRecord 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 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
- 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 |
---|---|
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. | |
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 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:
- Browse the Explorers Hub to get help from the community and join in discussions.
- Find answers on our sites and learn how to use our support portal.
- Run New Relic Diagnostics, our troubleshooting tool for Linux, Windows, and macOS.
- Review New Relic's and and documentation.