New Relic RPM Ruby Agent
Ruby Other
Switch branches/tags
Latest commit 110fe19 May 18, 2017 @chrispine chrispine Merge pull request #1544 from ruby-agent/dev
4.2.0 RC 1
Permalink
Failed to load latest commit information.
bin Scarier warning on nrdebug Dec 2, 2013
cert RUBY-1350: Update certificate with update_ca_bundle rake task. Aug 19, 2014
config RUBY-945 Run Unit Tests in Standalone Mode Nov 14, 2012
lib bump version May 18, 2017
recipes Add license header to source files Feb 22, 2013
test RUBY-1741 Padrino 0.14.x requires Ruby 2.2.0+ May 16, 2017
.gitignore Added test/performance/script/log/ to .gitignore Aug 29, 2014
.project Aptana .project file change May 18, 2011
.travis.yml RUBY-1742 Add Rails 5.1 to travis.yml May 12, 2017
.yardopts RUBY-1698 Remove developer mode from documentation Feb 24, 2017
CHANGELOG.md RUBY-1771 update changelog May 17, 2017
CONTRIBUTING.md RUBY-1707 Remove references to old Ruby versions in CONTRIBUTING.md Jan 26, 2017
Gemfile move dep from Gemfile to gemspec, note possible bundler issue Nov 29, 2016
Guardfile Run orphaned config tests on changes to default_source.rb Sep 10, 2014
LICENSE Update LICENSE, gemspec, and license tests to reflect removal of vend… Mar 30, 2017
README.md RUBY-1698 Remove developer mode from documentation Feb 24, 2017
Rakefile RUBY-1695 cleanup/refactor multiverse lib code Jan 6, 2017
config.dot RUBY-1388: Remove unused config settings. Dec 3, 2014
init.rb Point customers to support.newrelic.com if they experience issues. Jan 17, 2014
install.rb Module namespace fixup Jul 22, 2014
newrelic.yml RUBY-1698 Remove unused code referencing developer mode Feb 24, 2017
newrelic_rpm.gemspec Stop packaging test files with the gem May 17, 2017

README.md

New Relic Ruby Agent

New Relic is a performance management system, developed by New Relic, Inc (http://www.newrelic.com). It provides you with deep information about the performance of your Rails or Ruby application as it runs in production and transmits them to newrelic.com where you can monitor them in real time. The New Relic Ruby Agent is dual-purposed as a either a Gem or a Rails plugin, hosted on github.

Supported Environments

An up-to-date list of Ruby versions and frameworks for the latest agent can be found on our docs site.

You can also monitor non-web applications. Refer to the "Other Environments" section under "Getting Started".

Contributing Code

We welcome code contributions (in the form of pull requests) from our user community. Before submitting a pull request please review these guidelines.

Following these helps us efficiently review and incorporate your contribution and avoid breaking your code with future changes to the agent.

Getting Started

Add the Ruby Agent to your project's Gemfile.

gem 'newrelic_rpm'

To monitor your applications in production, create an account at http://newrelic.com/ . There you can sign up for a free Lite account or one of our paid subscriptions.

Once you receive the welcome email with a license key and newrelic.yml file, you can copy the newrelic.yml file into your app config directory OR can generate the file manually with command:

newrelic install --license_key="YOUR_KEY" "My application"

The initial configuration is done in the newrelic.yml file. This file is by default read from the config directory of the application root and is subsequently searched for in the application root directory, and then in a ~/.newrelic directory. Once you're up and running you can enable Server Side Config and manage your newrelic configuration from the web UI.

Rails Installation

You can install the agent as a Gem:

For Bundler:

Add the following line to your Gemfile:

gem 'newrelic_rpm'

For Rails 2.x without Bundler:

edit environment.rb and add to the initalizer block:

config.gem "newrelic_rpm"

Sinatra Installation

To use the Ruby Agent with a Sinatra app, add:

require 'newrelic_rpm'

in your Sinatra app, below the Sinatra require directive.

Then make sure you set RACK_ENV to the environment corresponding to the configuration definitions in the newrelic.yml file; e.g., development, staging, production, etc.

Other Environments

You can use the Ruby Agent to monitor any Ruby application. Add:

require 'newrelic_rpm'

to your startup sequence and then manually start the agent using:

NewRelic::Agent.manual_start

For information about instrumenting pure Rack applications, see our Rack middlewares documentation.

Refer to the New Relic's Docs for details on how to monitor other web frameworks, background jobs, and daemons.

The Ruby Agent provides an API that allows custom instrumentation of additional frameworks. You can find a list of community created intrumentation plugins (e.g. newrelic-redis) in the extends_newrelic_rpm project.

Production Mode

When your application runs in the production environment, the New Relic agent runs in production mode. It connects to the New Relic service and sends deep performance data to the UI for your analysis. To view this data, log in to http://rpm.newrelic.com.

NOTE: You must have a valid account and license key to view this data online. Refer to instructions in Getting Started.

Recording Deploys

The Ruby Agent supports recording deployments in New Relic via a command line tool or Capistrano recipes. For more information on these features see our deployment documentation for more information.

Support

You can find more detailed documentation on our website, and specifically in the Ruby category.

If you can't find what you're looking for there, reach out to us on our support site or our community forum and we'll be happy to help you.

Also available is community support on IRC: we generally use #newrelic on irc.freenode.net

Find a bug? Contact us via support.newrelic.com, or email support@newrelic.com.

Thank you, and may your application scale to infinity plus one.

Lew Cirne, Founder and CEO

New Relic, Inc.