Permalink
Browse files

update docs, log messages, and tests to remove usage of RPM

  • Loading branch information...
jaggederest committed May 14, 2011
1 parent 3d81eed commit 99f6994daed98eb58cdf8d720de3b5d5f97b2409
View
@@ -3,7 +3,7 @@ PLEASE NOTE:
Developer Mode is now a Rack middleware.
-RPM Developer Mode is no longer available in Rails 2.1 and earlier.
+Developer Mode is no longer available in Rails 2.1 and earlier.
However, starting in version 2.12 you can use Developer Mode in any
Rack based framework, in addition to Rails. To install developer mode
in a non-Rails application, just add NewRelic::Rack::DeveloperMode to
View
@@ -1,15 +1,13 @@
-= New Relic RPM
+= New Relic Ruby Agent
-
-
-New Relic RPM is a Ruby performance management system, developed by
-New Relic, Inc (http://www.newrelic.com). RPM provides you with deep
-information about the performance of your Ruby on Rails or Merb
-application as it runs in production. The New Relic Agent is
+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. The New Relic Ruby Agent is
dual-purposed as a either a Rails plugin or a Gem, hosted on
github[http://github.com/newrelic/rpm/tree/master].
-The New Relic Agent runs in one of two modes:
+The New Relic Ruby Agent runs in one of two modes:
==== Production Mode
@@ -25,17 +23,16 @@ automatically in Rails applications.
== Supported Environments
-* Ruby 1.8.6, 1.8.7, 1.9.1, or 1.9.2, including REE
-* JRuby 1.4 minimum
+* Ruby 1.8.7, 1.9.1, or 1.9.2, including REE
+* JRuby 1.4 or higher
* Rails 2.0 or later for Production Mode
-* Rails 2.2 or later for Developer Mode
-* Merb 1.0 or later
+* Rails 2.3 or later for Developer Mode
* Sinatra
* Rack
Any Rack based framework should work but may not be tested. Install
-RPM as a gem and add the Developer Mode middleware if desired. Report
-any problems to support@newrelic.com.
+the Ruby Agent as a gem and add the Developer Mode middleware if
+desired. Report any problems to support@newrelic.com.
You can also monitor non-web applications. Refer to the "Other
Environments" section under "Getting Started".
@@ -48,7 +45,7 @@ install the gem as a plug-in--details below.
gem install newrelic_rpm
To monitor your applications in production, create an account at
-http://newrelic.com/get-RPM.html. There you can
+http://newrelic.com/ . There you can
sign up for a free Lite account or one of our paid subscriptions.
Once you receive the welcome e-mail with a license key and
@@ -86,7 +83,7 @@ to your init.rb file.
=== Sinatra Installation
-To use RPM with a Sinatra app, add
+To use the Ruby Agent with a Sinatra app, add
require 'newrelic_rpm'
in your Sinatra app, below the Sinatra require directive.
@@ -99,23 +96,23 @@ the middleware stack. See the +config.ru+ sample below.
=== Other Environments
-You can use RPM to monitor any Ruby application. Add
+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
To instrument Rack based applications, refer to the docs in
NewRelic::Agent::Instrumentation::Rack.
-Refer to the docs in NewRelic for details on how to monitor other web
+Refer to the docs in New Relic for details on how to monitor other web
frameworks, background jobs, and daemons.
Also, see if your environment is already supported by the
rpm_contrib[http://newrelic.github.com/rpm_contrib] gem.
== Developer Mode
-When running the RPM Developer Mode, the RPM Agent will track the
+When running the Developer Mode, the Ruby Agent will track the
performance of every HTTP request serviced by your application, and
store in memory this information for the last 100 HTTP transactions.
@@ -132,9 +129,10 @@ all environments but +development+.
==== Developer Mode in Rails
-Developer Mode is available automatically in Rails Applications
-based on Rails 2.3 and later. No additional configuration is
-required.
+Developer Mode is available automatically in Rails Applications based
+on Rails 2.3 and later. No additional configuration is required. When
+your application starts and +developer_mode+ is enabled, the Ruby
+Agent injects a middleware into your Rails middleware stack.
For earlier versions of Rails that support Rack, you can use
a +config.ru+ as below.
@@ -148,15 +146,14 @@ middleware. This middleware passes all requests that do not start with
Here's an example entry for Developer Mode in a +config.ru+ file:
- require 'new_relic/rack_app'
+ require 'new_relic/rack/developer_mode'
use NewRelic::Rack::DeveloperMode
-
== Production Mode
When your application runs in the production environment, the New
-Relic agent runs in production mode. It connects to the New Relic RPM
-service and sends deep performance data to the RPM service for your
+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
@@ -165,10 +162,13 @@ online. Refer to instructions in *Getting Started*, below.
= Support
-Reach out to us--and to fellow RPM users--at
+Reach out to us--and to fellow users--at
support.newrelic.com[http://support.newrelic.com/discussions/support].
There you'll find documentation, FAQs, and forums where you can submit
-suggestions and discuss RPM with New Relic staff and other users.
+suggestions and discuss New Relic with staff and other users.
+
+Also available is community support on IRC: we generally use #newrelic
+on irc.freenode.net
Find a bug? E-mail support@newrelic.com, or post it to
support.newrelic.com[http://support.newrelic.com/discussions/support].
View
@@ -8,30 +8,24 @@ GEM_VERSION = NewRelic::VERSION::STRING
AUTHORS = "Bill Kayser", "Justin George"
EMAIL = "support@newrelic.com"
HOMEPAGE = "http://www.github.com/newrelic/rpm"
-SUMMARY = "New Relic Ruby Performance Monitoring Agent"
+SUMMARY = "New Relic Ruby Agent"
INSTALLATION_NOTES = "InstallationNotes.md"
RDOC_FILES = FileList['README*','LICENSE','newrelic.yml', 'CHANGELOG']
DESCRIPTION = <<-EOF
-New Relic RPM is a Ruby performance management system, developed by
-New Relic, Inc (http://www.newrelic.com). RPM provides you with deep
-information about the performance of your Ruby on Rails or Merb
-application as it runs in production. The New Relic Agent is
-dual-purposed as a either a Rails plugin or a Gem, hosted on
-http://github.com/newrelic/rpm/tree/master.
-EOF
+New Relic is a performance management system, developed by New Relic,
+Inc (http://www.newrelic.com). New Relic provides you with deep
+information about the performance of your web application as it runs
+in production. The New Relic Ruby Agent is dual-purposed as a either a
+Gem or plugin, hosted on
+http://github.com/newrelic/rpm/ EOF
INSTALLATION_POSTSCRIPT = <<-EOF
-Please see http://support.newrelic.com/faqs/docs/ruby-agent-release-notes
+Please see http://github.com/newrelic/rpm/blob/master/CHANGELOG
for a complete description of the features and enhancements available
in version #{GEM_VERSION.split('.')[0..1].join('.')} of the Ruby Agent.
-
-For details on this specific release, refer to the CHANGELOG file.
-
-Notice: Developer Mode now supports only Rails 2.3+ - refer to README
-for instructions for previous versions
-
+
EOF
# See http://www.rubygems.org/read/chapter/20
View
@@ -11,7 +11,7 @@ OptionParser.new do |opts|
opts.banner = "Usage: #{File.basename($0)} [options] [app_name]"
opts.on("-p", "--port=port", Integer, "default: #{port}") { | port | }
opts.on("--[no-]logging", "turn off request logging" ) { | l | options[:logging] = l }
- opts.on("--license=rpm_license_key", "override license key" ) { | l | options[:license_key] = l }
+ opts.on("--license=license_key", "override license key" ) { | l | options[:license_key] = l }
opts.on("--install", "install a newrelic.yml template" ) { | l | options[:install] = true }
opts.separator ""
opts.separator "app_name is the name of the application where the metrics will be stored"
View
@@ -1,16 +1,17 @@
-# This is the initialization for the RPM Rails plugin
+# This is the initialization for the New Relic Ruby Agent when used as
+# a plugin
require 'new_relic/control'
# If you are having problems seeing data, be sure and check the
-# newrelic_agent log files.
+# newrelic_agent.log files in the log diretory of your application
#
# If you can't find any log files and you don't see anything in your
# application log files, try uncommenting the two lines at the
# bottom of this file to verify the plugin is being loaded,
# then send the output to support@newrelic.com if you are unable to
# resolve the issue.
-# Initializer for the NewRelic Agent
+# Initializer for the NewRelic Ruby Agent
# After verison 2.0 of Rails we can access the configuration directly.
# We need it to add dev mode routes after initialization finished.
@@ -33,5 +34,5 @@
#ClassLoadingWatcher.flag_const_missing = nil
#
-# ::RAILS_DEFAULT_LOGGER.warn "RPM detected environment: #{NewRelic::Control.instance.local_env.to_s}, RAILS_ENV: #{RAILS_ENV}"
+# ::RAILS_DEFAULT_LOGGER.warn "New Relic detected environment: #{NewRelic::Control.instance.local_env.to_s}, RAILS_ENV: #{RAILS_ENV}"
# ::RAILS_DEFAULT_LOGGER.warn "Enabled? #{NewRelic::Control.instance.agent_enabled?}"
View
@@ -1,16 +1,16 @@
require 'new_relic/control'
require 'new_relic/data_serialization'
-# = New Relic RPM Agent
+# = New Relic Ruby Agent
#
-# New Relic RPM is a performance monitoring application for Ruby
-# applications running in production. For more information on RPM
-# please visit http://www.newrelic.com.
+# New Relic is a performance monitoring application for applications
+# running in production. For more information on New Relic please visit
+# http://www.newrelic.com.
#
-# The New Relic Agent can be installed in Rails applications to gather
-# runtime performance metrics, traces, and errors for display in a
-# Developer Mode UI (mapped to /newrelic in your application server)
-# or for monitoring and analysis at http://rpm.newrelic.com with just
-# about any Ruby application.
+# The New Relic Ruby Agent can be installed in Rails applications to
+# gather runtime performance metrics, traces, and errors for display
+# in a Developer Mode middleware (mapped to /newrelic in your application
+# server) or for monitoring and analysis at http://rpm.newrelic.com
+# with just about any Ruby application.
#
# == Getting Started
# For instructions on installation and setup, see
@@ -21,26 +21,26 @@
# To instrument Rack middlwares or Metal apps, refer to the docs in
# NewRelic::Agent::Instrumentation::Rack.
#
-# == Agent API
+# == Ruby Agent API
#
-# For details on the Agent API, refer to NewRelic::Agent.
+# For details on the Ruby Agent API, refer to NewRelic::Agent.
#
-# == Customizing RPM
+# == Customizing the Ruby Agent
#
-# For detailed information on customizing the RPM Agent
+# For detailed information on customizing the Ruby Agent
# please visit our {support and documentation site}[http://support.newrelic.com].
#
module NewRelic
- # == Agent APIs
- # This module contains the public API methods for the Agent.
+ # == Ruby Agent APIs
+ # This module contains the public API methods for the Ruby Agent.
#
# For adding custom instrumentation to method invocations, refer to
# the docs in the class NewRelic::Agent::MethodTracer.
#
# For information on how to customize the controller
# instrumentation, or to instrument something other than Rails so
# that high level dispatcher actions or background tasks show up as
- # first class operations in RPM, refer to
+ # first class operations in New Relic, refer to
# NewRelic::Agent::Instrumentation::ControllerInstrumentation and
# NewRelic::Agent::Instrumentation::ControllerInstrumentation::ClassMethods.
#
@@ -156,10 +156,10 @@ def logger
# not auto-start.
#
# When the app environment loads, so does the Agent. However, the
- # Agent will only connect to RPM if a web front-end is found. If
+ # Agent will only connect to the service if a web front-end is found. If
# you want to selectively monitor ruby processes that don't use
# web plugins, then call this method in your code and the Agent
- # will fire up and start reporting to RPM.
+ # will fire up and start reporting to the service.
#
# Options are passed in as overrides for values in the
# newrelic.yml, such as app_name. In addition, the option +log+
@@ -314,10 +314,10 @@ def is_sql_recorded?
Thread::current[:record_sql] != false
end
- # Set a filter to be applied to errors that RPM will track. The
- # block should evalute to the exception to track (which could be
- # different from the original exception) or nil to ignore this
- # exception.
+ # Set a filter to be applied to errors that the Ruby Agent will
+ # track. The block should evalute to the exception to track
+ # (which could be different from the original exception) or nil to
+ # ignore this exception.
#
# The block is yielded to with the exception to filter.
#
@@ -327,7 +327,7 @@ def ignore_error_filter(&block)
agent.error_collector.ignore_error_filter(&block)
end
- # Record the given error in RPM. It will be passed through the
+ # Record the given error. It will be passed through the
# #ignore_error_filter if there is one.
#
# * <tt>exception</tt> is the exception which will be recorded. May also be
Oops, something went wrong.

0 comments on commit 99f6994

Please sign in to comment.