Skip to content

Commit

Permalink
admin changes for resque
Browse files Browse the repository at this point in the history
  • Loading branch information
Bill Kayser committed Mar 26, 2010
1 parent 935b3d2 commit f468d60
Show file tree
Hide file tree
Showing 3 changed files with 40 additions and 14 deletions.
4 changes: 4 additions & 0 deletions CHANGELOG
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
* Version 1.0.4

Resque support

* Version 1.0.3

MongoDB instrumentation contributed by John Nunemaker
Expand Down
48 changes: 35 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,28 +1,50 @@
# The RPM Contrib Gem

The `rpm_contrib` gem contains instrumentation for the New Relic RPM agent
contributed by the community of RPM users. It requires the RPM Agent
to run.
The `rpm_contrib` gem contains instrumentation for the New Relic RPM
agent contributed by the community of RPM users. It requires the RPM
Agent to run.

To use the contrib gem, install the `rpm_contrib` gem off gemcutter. It will
also install the required version of the `newrelic_rpm` gem if it's not
already installed.
To use the contrib gem, install the `rpm_contrib` gem off gemcutter.
It will also install the required version of the `newrelic_rpm` gem if
it's not already installed.

For Rails 2.1 and later, add the dependency in your initializer:
For Rails 2.1 and later, add these dependencies in this order to your
in your environment.rb:

config.gem 'rpm_contrib'
config.gem 'newrelic_rpm'

For other frameworks, make sure you load rubygems if it isn't already, then
just require the contrib gem:
For other frameworks, make sure you load rubygems if it isn't already,
then just require the contrib gem:

require 'rubygems'
require 'rpm_contrib'

When you load the rpm_contrib gem, the `newrelic_rpm` gem will also be initialized.
No need for a separate require statement for `newrelic_rpm`.
When you load the rpm_contrib gem, the `newrelic_rpm` gem will also be
initialized. No need for a separate require statement for
`newrelic_rpm`. The `rpm_contrib` gem must be loaded before the
`newrelic_rpm` gem initializes.

# Supported Frameworks

A number of frameworks are supported in the contrib gem. They are all
turned on by default but you can add settings to your newrelic.yml to
disable any of them.

### Camping

### Paperclip

### Authlogic

### MongoDB

### Resque

To disable resque, add this to your newrelic.yml:

disable_resque: true

**It's important that you don't load the newrelic_rpm gem separately.** The
`rpm_contrib` gem must be loaded before the `newrelic_rpm` gem initializes.

# How to Add Custom Instrumentation

Expand Down
2 changes: 1 addition & 1 deletion Rakefile
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ begin
gem.email = "support@newrelic.com"
gem.homepage = "http://github.com/newrelic/rpm_contrib"
gem.author = "Bill Kayser"
gem.add_dependency 'newrelic_rpm', '>= 2.10.6'
gem.add_dependency 'newrelic_rpm', '>= 2.11.0'
gem.version = version
gem.files = FileList['LICENSE', 'README*', 'lib/**/*.rb', 'bin/*', '[A-Z]*', 'test/**/*'].to_a
end
Expand Down

0 comments on commit f468d60

Please sign in to comment.