These instructions are for installing the Ruby agent as a Rails plugin. For most use cases, you should instead install the agent gem.
We strongly recommend installing the Ruby agent as a gem in order to have better control over versions and dependencies.
To install the Rails plugin from Github, use the following commands for Rails versions 2 or higher:
script/plugin install git://github.com/newrelic/newrelic-ruby-agent.gitmv vendor/plugins/rpm vendor/plugins/newrelic-ruby-agent
This will export the Rails plugin into your application's
vendor/plugins directory. If you cannot install the Rails plugin directly from the git URL, you can clone the repository into the vendor/plugins directory.
After installing the agent, copy the
newrelic.yml file into the
config subdirectory of your application. You can download a fresh
newrelic.yml that includes your license key from the Account settings when logged in to New Relic.
As part of the installation process, change the default application name to a meaningful name.
Whenever you update the agent, double-check that your Ruby agent configuration file (
config/newrelic.yml) is up to date: Open the default
newrelic.yml file that lives in the Ruby agent's plugin folder (
vendor/plugins/newrelic-ruby-agent/newrelic.yml). Look for new configuration options that are not in your
You can also bring your logs and application's data together to make troubleshooting easier and faster. With logs in context, you can see log messages related to your errors and traces directly in your app's UI. You can also see logs in context of your infrastructure data, such as Kubernetes clusters. No need to switch to another UI page in New Relic One.
When using Subversion with the Rails plugin, be sure to remove the old agent plugin before reinstalling.
Use the gem if possible.
svn rm vendor/plugins/newrelic-ruby-agent svn commit vendor/plugins -m "removing old version of newrelic"
Then, to install the latest Ruby agent plugin:
script/rails plugin install git://github.com/newrelic/newrelic-ruby-agent.git vendor/plugins/newrelic-ruby-agentmv vendor/plugins/rpm vendor/plugins/newrelic-ruby-agentsvn add vendor/plugins/newrelic-ruby-agentsvn commit vendor/plugins -m "upgrading newrelic to version X.X.X"
To uninstall the Rails plugin:
svn rm vendor/plugins/newrelic-ruby-agent svn commit vendor/plugins
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 data security and licenses documentation.