The New Relic Ruby agent monitors your application to help you identify and solve performance issues. You can also extend the agent's performance monitoring to collect and analyze business data to help you improve the customer experience and make data-driven business decisions.
Compatibility and requirements
Before you install the Ruby agent, ensure your system meets the system requirements.
The Ruby agent supports many of the most common Ruby frameworks and platforms.
Monitor app performance
View the big picture of your app
- Monitor your app's Apdex (user satisfaction)
- Get a high-level summary of your app
- Create architectural maps of your app
- Install New Relic Servers and view detailed server data for your app
Find errors and problems quickly
- Track key transactions
- Create custom dashboards for important metrics
- Alert your team when errors or problems occur before they affect your users
- Track performance after a deploy
Drill down into performance details
- Examine code-level transaction traces and cross-application traces
- Examine database query traces
- Examine error traces
- Monitor Ruby background processes and daemons
Analyze business data
Use the Ruby agent with Insights to organize, query, and visualize your data to answer key questions about application performance and customer experience.
- Use default transaction attributes or add your own
- Query your data using NRQL
- Send your own event data
- Create and share customizable, interactive dashboards
Install the agent
To install the Ruby agent:
- Create a New Relic account.
- Install the gem (recommended) or the Rails plugin.
- Give your application a meaningful name.
- Wait a few minutes for your application to send data to New Relic.
To uninstall, see Uninstall the Ruby agent.
Extend agent instrumentation
After installing the agent, go further and extend the agent's instrumentation:
- Page load timing: Integrate the Ruby agent with New Relic Browser to gain visibility into end-user activity.
- Custom instrumentation: Instrument transactions not captured as part of our framework instrumentation.
- Agent API: Use the agent API to fully customize the agent's behavior. For example, you can collect custom metrics, flag an error, or ignore a particular transaction entirely.
- Custom metrics: Record additional metrics as part of a transaction to gain more insights into your app's performance and business data.
- Agent attributes: Customize the attributes attached to transactions. Customizing attributes allows you to avoid sending sensitive attributes, or to collect additional attributes for deeper visibility into your transactions.
If you encounter issues with the Ruby agent, see our full list of troubleshooting documentation. Common issues include:
- No data appears (Ruby)
- Gems incompatible with the Ruby agent
- Sending handled errors to New Relic
- Controlling when the Ruby agent starts
For more help
Additional documentation resources include:
- Ruby agent installation (how to install the Ruby agent gem)
- The Ruby agent API (overview information)
- Developer mode (installation, known issues, procedures, and troubleshooting)
- Github repository (overview of New Relic's Ruby repository on Github)
- Blocking controller instrumentation (how to prevent specific controllers or actions from being instrumented)