Skip to content
Browse files

Agent release 2.8.0

  • Loading branch information...
1 parent 4b48932 commit 404b1c0f3031a45c9a4ed6e8422eb94e006ad89e @bkayser bkayser committed
Showing with 62 additions and 36 deletions.
  1. +50 −25 README
  2. +1 −1 Rakefile
  3. +1 −1 lib/new_relic/config/rails.rb
  4. +7 −6 lib/newrelic_rpm.rb
  5. +3 −3 newrelic_rpm.gemspec
View
75 README
@@ -1,29 +1,26 @@
-= newrelic
+= New Relic RPM
* http://www.newrelic.com
-== DESCRIPTION:
-
-NewRelic RPM is a Ruby performance management system, developed by New Relic, Inc.
+New Relic RPM is a Ruby performance management system, developed by New Relic, Inc.
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 distributed as
-a either a Rails plugin or a Gem.
-
-Our testing shows that this agent introduces minimal overhead: in production, a
-typical controller action will be impacted by less than 5 milliseconds in
-response time. (That's significantly less time than is typically spent in mapping
-a request to the appropriate controller action.) So, you can run RPM all the
-time, and always have access to the information you need to resolve performance
-problems and ensure your application can scale to meet the demands of your
-business.
+a either a Rails plugin or a Gem, both hosted on RubyForge.
The New Relic Agent runs in one of two modes:
+* Developer Mode : Adds a web interface mapped to /newrelic to your application for
+ showing detailed performance metrics on a page by page basis.
+
+* Production Mode : Low overhead instrumentation that captures detailed information
+ on your application running in production and transmits them to rpm.newrelic.com
+ where you can monitor them in real time.
+
=== DEVELOPER MODE
Developer mode is on by default when you run your application in the development
-environment (but not when it runs in other environments.) When running in
-developer mode, the RPM will track the performance of every http request serviced
+environment (but not when it runs in other environments.) When running in
+developer mode, RPM will track the performance of every http request serviced
by your application, and store in memory this information for the last 100 http
transactions.
@@ -40,29 +37,57 @@ http://localhost:3000/newrelic
=== PRODUCTION MODE
-When your application runs in the production environment, the NewRelic agent
+To monitor your applications in production, create an account at
+http://newrelic.com/get-RPM.htm
+
+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 analysis. To view this data, login
to http://rpm.newrelic.com.
-NOTE: you must have a valid account and license key to view this data online.
-When you sign up for an account at newrelic.com, you will be provided with a
-license key, as well as a default configuration file for NewRelic RPM. You can
+NOTE: You must have a valid account and license key to view this data online.
+When you sign up for an account at www.newrelic.com, you will be provided with a
+license key, as well as a default configuration file for New Relic RPM. You can
either paste your license key into your existing configuration file,
config/newrelic.yml, or you can replace that config file with the one included in
your welcome email.
-Thank you, and may your application scale to infinity plus one.
-
-Lew Cirne, Founder and CEO
-New Relic, Inc.
-
== REQUIREMENTS:
Ruby 1.8.6
Rails 1.2.6 or above
Merb 1.0 or above
-== INSTALL:
+== RAILS PLUG-IN INSTALL:
script/plugin install http://newrelic.rubyforge.net/svn/newrelic_rpm
+
+== GEM INSTALL:
+
+ sudo gem install newrelic_rpm
+
+For Rails, edit environment.rb and add to the initalizer block:
+
+ config.gem "newrelic_rpm"
+
+The Developer Mode is unavailable when using the gem on Rails versions prior to 2.0.
+
+== MERB SUPPORT:
+
+To monitor a merb app install the newrelic_rpm gem and add <code>dependency 'newrelic_rpm'</code>
+to your init.rb file.
+
+Developer Mode not currently available in merb.
+
+== SUPPORT:
+
+Reach out to us - and to fellow RPM users - on our support forum at
+http://getsatisfaction.com/newrelic. We’ll share tips and tricks, answer all your
+questions, and announce product updates. Operators are standing by.
+
+For other support channels, see http://www.newrelic.com/support.
+
+Thank you, and may your application scale to infinity plus one.
+
+Lew Cirne, Founder and CEO
+New Relic, Inc.
View
2 Rakefile
@@ -7,7 +7,7 @@ GEM_VERSION = NewRelic::VERSION::STRING
AUTHOR = "Bill Kayser"
EMAIL = "bkayser@newrelic.com"
HOMEPAGE = "http://www.newrelic.com"
-SUMMARY = "Performance Monitoring Agent for New Relic Ruby Performance Monitoring Service"
+SUMMARY = "New Relic Ruby Performance Monitoring Agent"
spec = Gem::Specification.new do |s|
s.rubyforge_project = 'newrelic'
View
2 lib/new_relic/config/rails.rb
@@ -67,7 +67,7 @@ def draw_with_newrelic_map
else
current_paths = ActionController::Routing.controller_paths
if current_paths.nil? || current_paths.empty?
- to_stderr "ERROR: The controller paths has not been set. Make sure you are invoking newrelic after the Initializer finishes."
+ to_stderr "WARNING: Unable to modify the routes in this version of Rails. Developer mode not available."
end
current_paths << controller_path
end
View
13 lib/newrelic_rpm.rb
@@ -15,12 +15,13 @@ def log!(message)
if !NewRelic::Config.instance.tracers_enabled?
require 'new_relic/shim_agent'
else
- # if we are in the rails initializer, pass the config into the plugin
- # so we can set up dev mode
- if defined? config
- c = [ config ]
+ # After verison 2.0 of Rails we can access the configuration directly.
+ # We need it to add dev mode routes after initialization finished.
+ if defined? Rails.configuration
+ Rails.configuration.after_initialize do
+ NewRelic::Config.instance.start_plugin Rails.configuration
+ end
else
- c = []
+ NewRelic::Config.instance.start_plugin
end
- NewRelic::Config.instance.start_plugin *c
end
View
6 newrelic_rpm.gemspec
@@ -6,8 +6,8 @@ Gem::Specification.new do |s|
s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
s.authors = ["Bill Kayser"]
- s.date = %q{2009-01-12}
- s.description = %q{Performance Monitoring Agent for New Relic Ruby Performance Monitoring Service}
+ s.date = %q{2009-01-13}
+ s.description = %q{New Relic Ruby Performance Monitoring Agent}
s.email = %q{bkayser@newrelic.com}
s.extra_rdoc_files = ["README", "LICENSE"]
s.files = ["install.rb", "LICENSE", "README", "newrelic.yml", "Rakefile", "lib/new_relic", "lib/new_relic/agent", "lib/new_relic/agent/agent.rb", "lib/new_relic/agent/chained_call.rb", "lib/new_relic/agent/collection_helper.rb", "lib/new_relic/agent/error_collector.rb", "lib/new_relic/agent/instrumentation", "lib/new_relic/agent/instrumentation/active_record_instrumentation.rb", "lib/new_relic/agent/instrumentation/controller_instrumentation.rb", "lib/new_relic/agent/instrumentation/data_mapper.rb", "lib/new_relic/agent/instrumentation/dispatcher_instrumentation.rb", "lib/new_relic/agent/instrumentation/memcache.rb", "lib/new_relic/agent/instrumentation/merb", "lib/new_relic/agent/instrumentation/merb/controller.rb", "lib/new_relic/agent/instrumentation/merb/dispatcher.rb", "lib/new_relic/agent/instrumentation/merb/errors.rb", "lib/new_relic/agent/instrumentation/rails", "lib/new_relic/agent/instrumentation/rails/action_controller.rb", "lib/new_relic/agent/instrumentation/rails/action_web_service.rb", "lib/new_relic/agent/instrumentation/rails/dispatcher.rb", "lib/new_relic/agent/instrumentation/rails/errors.rb", "lib/new_relic/agent/instrumentation/rails/rails.rb", "lib/new_relic/agent/method_tracer.rb", "lib/new_relic/agent/patch_const_missing.rb", "lib/new_relic/agent/samplers", "lib/new_relic/agent/samplers/cpu.rb", "lib/new_relic/agent/samplers/memory.rb", "lib/new_relic/agent/samplers/mongrel.rb", "lib/new_relic/agent/stats_engine.rb", "lib/new_relic/agent/synchronize.rb", "lib/new_relic/agent/transaction_sampler.rb", "lib/new_relic/agent/worker_loop.rb", "lib/new_relic/agent.rb", "lib/new_relic/api", "lib/new_relic/api/deployments.rb", "lib/new_relic/config", "lib/new_relic/config/merb.rb", "lib/new_relic/config/rails.rb", "lib/new_relic/config/ruby.rb", "lib/new_relic/config.rb", "lib/new_relic/local_environment.rb", "lib/new_relic/merbtasks.rb", "lib/new_relic/metric_data.rb", "lib/new_relic/metric_spec.rb", "lib/new_relic/metrics.rb", "lib/new_relic/noticed_error.rb", "lib/new_relic/shim_agent.rb", "lib/new_relic/stats.rb", "lib/new_relic/transaction_analysis.rb", "lib/new_relic/transaction_sample.rb", "lib/new_relic/version.rb", "lib/new_relic_api.rb", "lib/newrelic_rpm.rb", "lib/tasks", "lib/tasks/agent_tests.rake", "lib/tasks/all.rb", "lib/tasks/install.rake", "recipes/newrelic.rb", "test/config", "test/config/newrelic.yml", "test/config/test_config.rb", "test/new_relic", "test/new_relic/agent", "test/new_relic/agent/mock_ar_connection.rb", "test/new_relic/agent/mock_scope_listener.rb", "test/new_relic/agent/model_fixture.rb", "test/new_relic/agent/tc_active_record.rb", "test/new_relic/agent/tc_agent.rb", "test/new_relic/agent/tc_collection_helper.rb", "test/new_relic/agent/tc_controller.rb", "test/new_relic/agent/tc_dispatcher_instrumentation.rb", "test/new_relic/agent/tc_error_collector.rb", "test/new_relic/agent/tc_method_tracer.rb", "test/new_relic/agent/tc_stats_engine.rb", "test/new_relic/agent/tc_synchronize.rb", "test/new_relic/agent/tc_transaction_sample.rb", "test/new_relic/agent/tc_transaction_sample_builder.rb", "test/new_relic/agent/tc_transaction_sampler.rb", "test/new_relic/agent/tc_worker_loop.rb", "test/new_relic/agent/testable_agent.rb", "test/new_relic/tc_config.rb", "test/new_relic/tc_deployments_api.rb", "test/new_relic/tc_environment.rb", "test/new_relic/tc_metric_spec.rb", "test/new_relic/tc_shim_agent.rb", "test/new_relic/tc_stats.rb", "test/test_helper.rb", "test/ui", "test/ui/tc_newrelic_helper.rb", "ui/controllers", "ui/controllers/newrelic_controller.rb", "ui/helpers", "ui/helpers/google_pie_chart.rb", "ui/helpers/newrelic_helper.rb", "ui/views", "ui/views/layouts", "ui/views/layouts/newrelic_default.rhtml", "ui/views/newrelic", "ui/views/newrelic/_explain_plans.rhtml", "ui/views/newrelic/_sample.rhtml", "ui/views/newrelic/_segment.rhtml", "ui/views/newrelic/_segment_row.rhtml", "ui/views/newrelic/_show_sample_detail.rhtml", "ui/views/newrelic/_show_sample_sql.rhtml", "ui/views/newrelic/_show_sample_summary.rhtml", "ui/views/newrelic/_sql_row.rhtml", "ui/views/newrelic/_stack_trace.rhtml", "ui/views/newrelic/_table.rhtml", "ui/views/newrelic/explain_sql.rhtml", "ui/views/newrelic/images", "ui/views/newrelic/images/arrow-close.png", "ui/views/newrelic/images/arrow-open.png", "ui/views/newrelic/images/blue_bar.gif", "ui/views/newrelic/images/gray_bar.gif", "ui/views/newrelic/index.rhtml", "ui/views/newrelic/javascript", "ui/views/newrelic/javascript/transaction_sample.js", "ui/views/newrelic/sample_not_found.rhtml", "ui/views/newrelic/show_sample.rhtml", "ui/views/newrelic/show_source.rhtml", "ui/views/newrelic/stylesheets", "ui/views/newrelic/stylesheets/style.css"]
@@ -16,7 +16,7 @@ Gem::Specification.new do |s|
s.require_paths = ["lib"]
s.rubyforge_project = %q{newrelic}
s.rubygems_version = %q{1.3.1}
- s.summary = %q{Performance Monitoring Agent for New Relic Ruby Performance Monitoring Service}
+ s.summary = %q{New Relic Ruby Performance Monitoring Agent}
if s.respond_to? :specification_version then
current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION

0 comments on commit 404b1c0

Please sign in to comment.
Something went wrong with that request. Please try again.