Before you install New Relic's Ruby agent, make sure you meet these requirements for compatible operating systems, security requirements, and supported frameworks.
The Ruby agent supports UNIX-like operating systems such as Linux, Solaris, FreeBSD, and macOS.
As a standard security measure for data collection, your app server must support SHA-2 (256-bit). SHA-1 is not supported.
The New Relic Ruby agent does not support experimental versions. Ruby versions supported by the Ruby agent include:
Web servers supported by the New Relic Ruby agent include:
|Webrick||Supported for all agent-supported versions of Ruby|
The New Relic Ruby agent does not support experimental versions. Web frameworks supported by the Ruby agent include:
The New Relic Ruby agent does not support experimental versions. Databases supported by the Ruby agent include:
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.
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|
|ActiveRecord 2.1 to 4||PostgreSQL||pg||3.17.0|
The Ruby agent also supports these
|Gem database||Gem name||Minimum gem version||Minimum agent version|
To request instance-level information from datastores currently not listed for your New Relic agent, get support at support.newrelic.com.
Background jobs supported by the New Relic Ruby agent include:
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
New Relic APM's Ruby agent also supports:
- ActiveMerchant:1.25.0 or higher
- Bunny: 2.0 or higher
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.
|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.|