New Relic for Ruby

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

Find errors and problems quickly

Drill down into performance details

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.

Install the agent

The Ruby agent is available as a gem or a Rails plugin. New Relic highly recommends installing the gem.

To install the Ruby agent:

  1. Create a New Relic account.
  2. Install the gem (recommended) or the Rails plugin.
  3. Give your application a meaningful name.
  4. 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.

Troubleshooting

If you encounter issues with the Ruby agent, see our full list of troubleshooting documentation. Common issues include:

For more help

Additional documentation resources include:

Join the discussion about Ruby in the New Relic Community Forum! The Community Forum is a public platform to discuss and troubleshoot your New Relic toolset.

If you need additional help, get support at support.newrelic.com.