• EnglishEspañol日本語한국어Português
  • Log inStart now

Install the New Relic Ruby agent

Our Ruby agent auto-instruments your code so you can start monitoring applications. You can use our launcher, or follow the instructions in this document to complete a basic Ruby agent installation.

Add Ruby data

Tip

Is your application running on a Kubernetes cluster? Try out our installation method using the Kubernetes agents operator.

Install the gem

Important

If you are using the agent in a Docker container, install the agent within each container.

  1. The Ruby agent's gem is available from rubygems.org as newrelic_rpm. For applications using Bundler, add this gem to the Gemfile:

    gem 'newrelic_rpm'
  2. To use Infinite Tracing, the Infinite Tracing gem is also available from rubygems.org as newrelic-infinite_tracing. For applications using Bundler, additionally include the Infinite Tracing gem in the Gemfile:

    gem 'newrelic-infinite_tracing'
  3. The next step varies depending on if you are using Rails, Roda, or Sinatra:

    Ruby installation

    Comments

    If using Rails, Roda, or Sinatra

    • Rails: Rails will automatically call Bundler.require and cause newrelic_rpm to be required during startup of your application.

    • Roda, Sinatra: If you're using Roda, Sinatra or another framework, you must manually call require 'newrelic_rpm'. Additionally, if you're using Infinite Tracing, manually call require 'newrelic/infinite_tracing'.

      Alternately, manually call Bundler.require, which also enables Infinite Tracing.

    If not using Rails, Roda or Sinatra

    In order to use automatic browser application monitoring in a Rack application that does not use Roda, Sinatra, or Rails, you must manually include additional Rack middlewares provided by the agent. Place the New Relic gem as low in the list as possible, allowing the frameworks above it to be instrumented when the gem initializes.

Install the configuration file

After installing the agent, you will need to install the newrelic.yml configuration file, and name your app:

  1. Download a copy of newrelic.yml from our GitHub repo.
  2. Copy the newrelic.yml file into the config sub-directory of your application.
  3. Edit the license_key value to include your .
  4. Edit the app_name value to a meaningful name.

Alternatively, you can generate a newrelic.yml file manually with the following command:

newrelic install --license_key="YOUR_LICENSE_KEY" "YOUR_APP_NAME"

You may also use the --force option with this command if you need to overwrite an existing newrelic.yml.

Did this doc help with your installation?

View logs for your APM and infrastructure data

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.

Update the agent

See Upgrade Ruby agent versions.

Install agent outside production environments

Typically you will install the Ruby agent in your production environment. If you want to try out the Ruby agent in a development or localhost environment, verify in the relevant environment: block of the newrelic.yml file that the monitor_mode config value has been set to true.

For example, to deploy New Relic in your development environment and still be able to view your app's performance metrics: In the development: block, set the monitor_mode config value to true.

Uninstall the Ruby agent gem

To uninstall the Ruby agent using Bundler, remove gem 'newrelic_rpm' from your Gemfile. If you are not using Bundler, remove all references to newrelic_rpm from your environment.rb file.

Copyright © 2024 New Relic Inc.

This site is protected by reCAPTCHA and the Google Privacy Policy and Terms of Service apply.