Browse files

Improved doc output

  • Loading branch information...
1 parent d91b6a0 commit 7cba0fc797667702fbd71e79016fc536fffef042 @bkayser bkayser committed Apr 13, 2010
Showing with 26 additions and 18 deletions.
  1. +19 −18 → README.rdoc
  2. +7 −0 Rakefile
@@ -1,4 +1,4 @@
-# The RPM Contrib Gem
+= 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
@@ -24,28 +24,28 @@ 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
+= 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
+=== Camping
-### Paperclip
+=== Paperclip
-### Authlogic
+=== Authlogic
-### MongoDB
+=== MongoDB
-### Resque
+=== Resque
To disable resque, add this to your newrelic.yml:
disable_resque: true
-# How to Add Custom Instrumentation
+= How to Add Custom Instrumentation
We encourage contributions to this project and will provide whatever
assistance we can to those wishing to develop instrumentation for
@@ -66,7 +66,7 @@ with this gem.
web dispatcher, or be [started manually](
* Framework support, for alternatives to Rails like Camping or Ramaze
-## Custom Tracers
+== Custom Tracers
Custom tracers for frameworks should be added to the `lib/rpm_contrib/instrumentation`
directory. These files are loaded at the time the Agent starts. **They will not
@@ -86,7 +86,7 @@ docs.
A good example can be found in `lib/rpm_contrib/instrumentation/paperclip.rb`.
-## Samplers
+== Samplers
You can add samplers which will record metrics approximately once a minute. Samplers
are useful for capturing generic instrumentation for display in
@@ -97,7 +97,7 @@ class. They should be placed in the `samplers` directory.
Refer to examples in the RPM agent to see how to get started.
-## Supporting New Dispatchers
+== Supporting New Dispatchers
If you want to add support for a new dispatcher which is not being recognized by default
by the RPM agent, add code to the `rpm_contrib/detection` directory. This code needs
@@ -108,7 +108,7 @@ This module should define the method `discover_dispatcher` and return the name o
dispatcher if detected, or defer to super. See `rpm_contrib/detection/camping.rb`
for a good example.
-## Supporting New Frameworks
+== Supporting New Frameworks
Supporting new frameworks can be pretty involved and generally involves both
adding custom instrumentation as well as framework and dispatcher detection.
@@ -121,7 +121,7 @@ Refer to the camping example in this gem to see how this is done in general.
If you decide to tackle any new frameworks, contact and
we'll be happy to help you work through it.
-# Note on Patches/Pull Requests
+= Note on Patches/Pull Requests
* Fork the project.
* Add instrumentation files to `lib/rpm_contrib/instrumentation`. These
@@ -134,14 +134,15 @@ we'll be happy to help you work through it.
commit by itself I can ignore when I pull)
* Send me a pull request. Bonus points for topic branches.
-# Further Information
+= Further Information
-Refer to the [Agent API Documentation](
+Refer to the Agent API Documentation at
-See [the support site]( for additional tips and documentation.
+See the support site faqs at for
+additional tips and documentation.
Contact for help.
-### Copyright
+=== Copyright
-Copyright (c) 2010 New Relic. See LICENSE for details.
+Copyright (c) 2009-2010 New Relic. See LICENSE for details.
@@ -55,8 +55,15 @@ require 'rake/rdoctask' do |rdoc|
rdoc.rdoc_dir = 'rdoc'
rdoc.title = "rpm_contrib #{version}"
+ rdoc.main = "README.rdoc"
+ require 'sdoc_helpers'
+rescue LoadError
+ puts "sdoc support not enabled. Please gem install sdoc-helpers."

0 comments on commit 7cba0fc

Please sign in to comment.