newrelic_rpm 2.9.9 → 2.10.3

data/lib/newrelic_rpm.rb

@@ -10,15 +10,15 @@
 #    dependency 'newrelic_rpm'
 # in the Merb config/init.rb
 #
+# For Sinatra, do
+#    require 'newrelic_rpm'
+# after requiring 'sinatra'.
+#
 # For other frameworks, or to manage the agent manually, invoke NewRelic::Agent#manual_start
 # directly.
 #
 require 'new_relic/control'
 
-def log!(message)
-  STDERR.puts "[NewRelic] #{message}"
-end
-
 # 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
@@ -34,7 +34,7 @@ elsif defined? Merb
         NewRelic::Control.instance.init_plugin
       end
     end
-  end  
+  end
 else
   NewRelic::Control.instance.init_plugin
 end

data/lib/tasks/tests.rake

@@ -1,4 +1,5 @@
 # run unit tests for the NewRelic Agent
+
 if defined? Rake::TestTask
   namespace :test do
     AGENT_HOME = File.expand_path(File.join(File.dirname(__FILE__), "..",".."))
@@ -9,5 +10,6 @@ if defined? Rake::TestTask
       t.verbose = true
     end
     Rake::Task['test:newrelic'].comment = "Run the unit tests for the Agent"
+    task :default => :newrelic
   end
 end

data/newrelic.yml

@@ -14,7 +14,7 @@ common: &default_settings
   # New Relic RPM service.
   license_key: '<%= license_key %>'
   
-  # Agent Enabled
+  # Agent Enabled (Rails Only)
   # Use this setting to force the agent to run or not run.
   # Default is 'auto' which means the agent will install and run only
   # if a valid dispatcher such as Mongrel is running.  This prevents
@@ -29,15 +29,19 @@ common: &default_settings
   # into a RPM "application" on your home dashboard page. If you want
   # to map this instance into multiple apps, like "AJAX Requests" and
   # "All UI" then specify a semicolon separated list of up to three
-  # distinct names.  This setting does not prevent you from manually
-  # defining applications.
+  # distinct names.  If you comment this out, it defaults to the 
+  # capitalized RAILS_ENV (i.e., Production, Staging, etc)
   app_name: My Application
 
-  # When 'enabled' is turned on, the agent collects performance data
-  # by inserting lightweight tracers on key methods inside the rails
-  # framework and asynchronously aggregating and reporting this
-  # performance data to the NewRelic RPM service at newrelic.com.
-  enabled: false
+  # When "true", the agent collects performance data about your 
+  # application and reports this data to the NewRelic RPM service at 
+  # newrelic.com. This global switch is normally overridden for each 
+  # environment below. (formerly called 'enabled')
+  monitor_mode: true
+
+  # Developer mode should be off in every environment but
+  # development as it has very high overhead in memory.
+  developer_mode: false
 
   # The newrelic agent generates its own log file to keep its logging
   # information separate from that of your application.  Specify its
@@ -88,9 +92,12 @@ common: &default_settings
 
   
   # Tells transaction tracer and error collector (when enabled)
-  # whether or not to capture HTTP params.  When true, the RoR
-  # filter_parameter_logging mechanism is used so that sensitive
-  # parameters are not recorded
+  # whether or not to capture HTTP params.  When true, frameworks can
+  # exclude HTTP parameters from being captured.
+  # Rails: the RoR filter_parameter_logging excludes parameters
+  # Java: create a config setting called "ignored_params" and set it to
+  #     a comma separated list of HTTP parameter names.
+  #     ex: ignored_params: credit_card, ssn, password 
   capture_params: false
 
 
@@ -124,6 +131,15 @@ common: &default_settings
     # then capture and send to RPM the current stack trace. This is
     # helpful for pinpointing where long SQL calls originate from
     stack_trace_threshold: 0.500
+
+    # Determines whether the agent will capture query plans for slow
+    # SQL queries.  Only supported in mysql and postgres.  Should be
+    # set to false when using other adapters.
+    # explain_enabled: true
+
+    # Threshold for query execution time below which query plans will not 
+    # not be captured.  Relevant only when `explain_enabled` is true.
+    # explain_threshold: 0.5
   
   # Error collector captures information about uncaught exceptions and
   # sends them to RPM for viewing
@@ -134,43 +150,67 @@ common: &default_settings
     # product levels
     enabled: true
     
-    # Tells error collector whether or not to capture a source snippet
-    # around the place of the error when errors are View related.
+    # Rails Only - tells error collector whether or not to capture a 
+    # source snippet around the place of the error when errors are View 
+    # related.
     capture_source: true    
     
     # To stop specific errors from reporting to RPM, set this property
-    # to comma separated values
+    # to comma separated values.  Default is to ignore routing errors
+    # which are how 404's get triggered.
     #
-    #ignore_errors: ActionController::RoutingError, ...
+    ignore_errors: ActionController::RoutingError
 
   # (Advanced) Uncomment this to ensure the cpu and memory samplers
   # won't run.  Useful when you are using the agent to monitor an
   # external resource
   # disable_samplers: true
+  
+  # If you aren't interested in visibility in these areas, you can disable
+  # the instrumentation to reduce overhead.
+  #
+  # disable_view_instrumentation: true
+  # disable_activerecord_instrumentation: true
+  # disable_memcache_instrumentation: true
+  # disable_dj: true
+  
+  # Certain types of instrumentation such as GC stats will not work if 
+  # you are running multi-threaded.  Please let us know.
+  # multi_threaded = false
 
-# override default settings based on your application's environment
+# Application Environments
+# ------------------------------------------
+# Environment specific settings are in this section.
+# For Rails applications, RAILS_ENV is used to determine the environment
+# For Java applications, pass -Dnewrelic.environment <environment> to set
+# the environment
 
 # NOTE if your application has other named environments, you should
 # provide newrelic conifguration settings for these enviromnents here.
 
 development:
   <<: *default_settings
-  # Turn off communication to RPM service in development mode.  
+  # Turn off communication to RPM service in development mode (also 
+  # 'enabled').
   # NOTE: for initial evaluation purposes, you may want to temporarily 
   # turn the agent on in development mode.
-  enabled: false
-
-  # When running in Developer Mode, the New Relic Agent will present
-  # performance information on the last 100 transactions you have
-  # executed since starting the mongrel.  to view this data, go to
-  # http://localhost:3000/newrelic
-  developer: true
+  monitor_mode: false
+
+  # Rails Only - when running in Developer Mode, the New Relic Agent will 
+  # present performance information on the last 100 transactions you have
+  # executed since starting the mongrel.
+  # NOTE: There is substantial overhead when running in developer mode.
+  # Do not use for production or load testing.  
+  developer_mode: true
+  
+  # Enable textmate links
+  # textmate: true
 
 test:
   <<: *default_settings
-  # it almost never makes sense to turn on the agent when running
+  # It almost never makes sense to turn on the agent when running
   # unit, functional or integration tests or the like.
-  enabled: false
+  monitor_mode: false
 
 # Turn on the agent in production for 24x7 monitoring.  NewRelic
 # testing shows an average performance impact of < 5 ms per
@@ -178,12 +218,12 @@ test:
 # incurring any user-visible performance degredation.
 production:
   <<: *default_settings
-  enabled: true
+  monitor_mode: true
 
-# many applications have a staging environment which behaves
+# Many applications have a staging environment which behaves
 # identically to production.  Support for that environment is provided
 # here.  By default, the staging environment has the agent turned on.
 staging:
   <<: *default_settings
-  enabled: true
+  monitor_mode: true
   app_name: My Application (Staging)

data/test/active_record_fixtures.rb

@@ -39,9 +39,9 @@ module ActiveRecordFixtures
     has_and_belongs_to_many :orders, :class_name => 'ActiveRecordFixtures::Order'
     def self.setup
       connection.create_table self.table_name, :force => true do |t|
-        t.column :order_id, :integer 
+        # no other columns
       end
-      connection.create_table 'orders_shipments', :force => true do |t|
+      connection.create_table 'orders_shipments', :force => true, :id => false do |t|
         t.column :order_id, :integer 
         t.column :shipment_id, :integer 
       end

data/test/config/newrelic.yml

@@ -8,11 +8,11 @@ test:
   <<: *default_settings
   host: localhost
   port: 3000
-  log_level: debug
+  log_level: info
   capture_params: true
-  enabled: false
-  developer: true
-  monitor_daemons: false
+  agent_enabled: false
+  monitor_mode: false
+  developer_mode: true
   disable_samplers: true
   api_host: 127.0.0.1
   api_port: 443
@@ -29,9 +29,6 @@ test:
   yval: yes
   sval: sure
     
-  # checks for loading classes on the background thread
-  check_bg_loading: true
-
   transaction_tracer:
     record_sql: raw
     transaction_threshold: Apdex_f # case insensitive

data/test/config/test_control.rb

@@ -1,7 +1,6 @@
 require 'new_relic/control/rails'
-require 'new_relic/agent/agent_test_controller'
 
-class NewRelic::Control::Test < NewRelic::Control::Rails
+class NewRelic::Control::Test < NewRelic::Control::Rails #:nodoc:
   def env
     'test'
   end

data/test/new_relic/agent/active_record_instrumentation_test.rb

@@ -2,23 +2,28 @@ require File.expand_path(File.join(File.dirname(__FILE__),'..','..','test_helper
 require 'active_record_fixtures'
 
 class ActiveRecordInstrumentationTest < Test::Unit::TestCase
-  
+  include NewRelic::Agent::Instrumentation::ControllerInstrumentation
   def setup
+    super
     NewRelic::Agent.manual_start
-    NewRelic::Agent.instance.stats_engine.clear_stats
     ActiveRecordFixtures.setup
-    NewRelic::Agent.instance.transaction_sampler.harvest
+    NewRelic::Agent.instance.transaction_sampler.reset!
+    NewRelic::Agent.instance.stats_engine.clear_stats
   rescue
     puts e
     puts e.backtrace.join("\n")
   end
   
   def teardown
+    super
     ActiveRecordFixtures.teardown
+    NewRelic::Agent.shutdown
   end
+  
   def test_agent_setup
     assert NewRelic::Agent.instance.class == NewRelic::Agent::Agent
   end
+  
   def test_finder
     ActiveRecordFixtures::Order.create :id => 0, :name => 'jeff'
     ActiveRecordFixtures::Order.find(:all)
@@ -27,6 +32,9 @@ class ActiveRecordInstrumentationTest < Test::Unit::TestCase
     ActiveRecordFixtures::Order.find_all_by_name "jeff"
     s = NewRelic::Agent.get_stats("ActiveRecord/ActiveRecordFixtures::Order/find")
     assert_equal 2, s.call_count
+    ActiveRecordFixtures::Order.exists?(["name=?", 'jeff'])
+    s = NewRelic::Agent.get_stats("ActiveRecord/ActiveRecordFixtures::Order/find")
+    assert_equal 3, s.call_count if NewRelic::Control.instance.rails_version > '2.3.4'
   end
   
   # multiple duplicate find calls should only cause metric trigger on the first
@@ -55,18 +63,18 @@ class ActiveRecordInstrumentationTest < Test::Unit::TestCase
     #   metrics = NewRelic::Agent.instance.stats_engine.metrics.select { |mname| mname =~ /ActiveRecord\/ActiveRecordFixtures::Order\// }.sort
     expected = %W[
       ActiveRecord/all
-      ActiveRecord/create
       ActiveRecord/find
-      ActiveRecord/ActiveRecordFixtures::Order/create
       ActiveRecord/ActiveRecordFixtures::Order/find
       ]
+    expected += %W[Database/SQL/insert] if defined?(JRuby)      
+    expected += %W[ActiveRecord/create Database/SQL/other ActiveRecord/ActiveRecordFixtures::Order/create] unless defined?(JRuby)      
     expected += %W[ActiveRecord/save ActiveRecord/ActiveRecordFixtures::Order/save] if NewRelic::Control.instance.rails_version < '2.1.0'   
     compare_metrics expected, metrics
     assert_equal 1, NewRelic::Agent.get_stats("ActiveRecord/ActiveRecordFixtures::Order/find").call_count
-    assert_equal 1, NewRelic::Agent.get_stats("ActiveRecord/ActiveRecordFixtures::Order/create").call_count
+    assert_equal (defined?(JRuby) ? 0 : 1), NewRelic::Agent.get_stats("ActiveRecord/ActiveRecordFixtures::Order/create").call_count
   end
   def test_join_metrics
-    m = ActiveRecordFixtures::Order.create :id => 0, :name => 'jeff'
+    m = ActiveRecordFixtures::Order.create :name => 'jeff'
     m = ActiveRecordFixtures::Order.find(m.id)
     s = m.shipments.create
     m.shipments.to_a
@@ -75,57 +83,104 @@ class ActiveRecordInstrumentationTest < Test::Unit::TestCase
     metrics = NewRelic::Agent.instance.stats_engine.metrics
     #   This doesn't work on hudson because the sampler metrics creep in.    
     #   metrics = NewRelic::Agent.instance.stats_engine.metrics.select { |mname| mname =~ /ActiveRecord\/ActiveRecordFixtures::Order\// }.sort
-    compare_metrics %W[
+    expected_metrics = %W[
     ActiveRecord/all
     ActiveRecord/destroy
     ActiveRecord/ActiveRecordFixtures::Order/destroy
     Database/SQL/insert
     Database/SQL/delete
-    ActiveRecord/create
     ActiveRecord/find
-    ActiveRecord/ActiveRecordFixtures::Order/create
     ActiveRecord/ActiveRecordFixtures::Order/find
     ActiveRecord/ActiveRecordFixtures::Shipment/find
+    ]
+    
+    expected_metrics += %W[Database/SQL/other Database/SQL/show ActiveRecord/create
     ActiveRecord/ActiveRecordFixtures::Shipment/create
-    ], metrics
+    ActiveRecord/ActiveRecordFixtures::Order/create
+    ] unless defined? JRuby
+    
+    compare_metrics expected_metrics, metrics
+    # This number may be different with different db adapters, not sure
+    # assert_equal 17, NewRelic::Agent.get_stats("ActiveRecord/all").call_count
+    assert_equal NewRelic::Agent.get_stats("ActiveRecord/all").total_exclusive_time, NewRelic::Agent.get_stats("ActiveRecord/all").total_call_time unless defined?(RUBY_DESCRIPTION) && RUBY_DESCRIPTION =~ /Enterprise Edition/
     assert_equal 1, NewRelic::Agent.get_stats("ActiveRecord/ActiveRecordFixtures::Order/find").call_count
     assert_equal 1, NewRelic::Agent.get_stats("ActiveRecord/ActiveRecordFixtures::Shipment/find").call_count
-    assert_equal 1, NewRelic::Agent.get_stats("Database/SQL/insert").call_count
+    assert_equal 1, NewRelic::Agent.get_stats("Database/SQL/insert").call_count unless defined? JRuby
+    assert_equal 3, NewRelic::Agent.get_stats("Database/SQL/insert").call_count if defined? JRuby
     assert_equal 1, NewRelic::Agent.get_stats("Database/SQL/delete").call_count
   end
   def test_direct_sql
-    list = ActiveRecordFixtures::Order.connection.select_rows "select * from #{ActiveRecordFixtures::Order.table_name}"
+    assert_nil NewRelic::Agent::Instrumentation::MetricFrame.current
+    assert_equal nil, NewRelic::Agent.instance.stats_engine.scope_name 
+    assert_equal 0, NewRelic::Agent.instance.stats_engine.metrics.size, NewRelic::Agent.instance.stats_engine.metrics.inspect
+    ActiveRecordFixtures::Order.connection.select_rows "select * from #{ActiveRecordFixtures::Order.table_name}"
     metrics = NewRelic::Agent.instance.stats_engine.metrics
     compare_metrics %W[
     ActiveRecord/all
     Database/SQL/select
     ], metrics
-    assert_equal 1, NewRelic::Agent.get_stats("Database/SQL/select").call_count
+    assert_equal 1, NewRelic::Agent.instance.stats_engine.get_stats_no_scope("Database/SQL/select").call_count, NewRelic::Agent.instance.stats_engine.get_stats_no_scope("Database/SQL/select")
   end
   
-  def test_run_explains
+  def test_other_sql
+    list = ActiveRecordFixtures::Order.connection.execute "begin"
+    metrics = NewRelic::Agent.instance.stats_engine.metrics
+    compare_metrics %W[
+    ActiveRecord/all
+    Database/SQL/other
+    ], metrics
+    assert_equal 1, NewRelic::Agent.get_stats_no_scope("Database/SQL/other").call_count
+  end
+  
+  def test_show_sql
+    list = ActiveRecordFixtures::Order.connection.execute "show tables"
+    metrics = NewRelic::Agent.instance.stats_engine.metrics
+    compare_metrics %W[
+    ActiveRecord/all
+    Database/SQL/show
+    ], metrics
+    assert_equal 1, NewRelic::Agent.get_stats_no_scope("Database/SQL/show").call_count 
+  end
+
+  def test_blocked_instrumentation
     ActiveRecordFixtures::Order.add_delay
-    ActiveRecordFixtures::Order.find(:all)
-    
+    NewRelic::Agent.disable_all_tracing do
+      perform_action_with_newrelic_trace :name => 'bogosity' do
+        ActiveRecordFixtures::Order.find(:all)
+      end
+    end
+    assert_nil NewRelic::Agent.instance.transaction_sampler.last_sample
+    metrics = NewRelic::Agent.instance.stats_engine.metrics
+    compare_metrics [], metrics
+  end
+  def test_run_explains
+    perform_action_with_newrelic_trace :name => 'bogosity' do
+      ActiveRecordFixtures::Order.add_delay
+      ActiveRecordFixtures::Order.find(:all)
+    end    
     sample = NewRelic::Agent.instance.transaction_sampler.last_sample
     
-    segment = sample.root_segment.called_segments.first.called_segments.first
+    segment = sample.root_segment.called_segments.first.called_segments.first.called_segments.first
     assert_match /^SELECT \* FROM ["`]?#{ActiveRecordFixtures::Order.table_name}["`]?$/i, segment.params[:sql].strip
     NewRelic::TransactionSample::Segment.any_instance.expects(:explain_sql).returns([])
     sample = sample.prepare_to_send(:obfuscate_sql => true, :explain_enabled => true, :explain_sql => 0.0)
     segment = sample.root_segment.called_segments.first.called_segments.first
   end
   def test_prepare_to_send
-    ActiveRecordFixtures::Order.add_delay
-    ActiveRecordFixtures::Order.find(:all)
-    
+    perform_action_with_newrelic_trace :name => 'bogosity' do
+      ActiveRecordFixtures::Order.add_delay
+      ActiveRecordFixtures::Order.find(:all)
+    end
     sample = NewRelic::Agent.instance.transaction_sampler.last_sample
+    assert_not_nil sample
+    assert_equal 3, sample.count_segments, sample.to_s
     # 
-    sql_segment = sample.root_segment.called_segments.first.called_segments.first
+    sql_segment = sample.root_segment.called_segments.first.called_segments.first.called_segments.first rescue nil
+    assert_not_nil sql_segment, sample.to_s
     assert_match /^SELECT /, sql_segment.params[:sql]
     assert sql_segment.duration > 0.0, "Segment duration must be greater than zero."
     sample = sample.prepare_to_send(:record_sql => :raw, :explain_enabled => true, :explain_sql => 0.0)
-    sql_segment = sample.root_segment.called_segments.first.called_segments.first
+    sql_segment = sample.root_segment.called_segments.first.called_segments.first.called_segments.first
     assert_match /^SELECT /, sql_segment.params[:sql]
     explanations = sql_segment.params[:explanation]
     if isMysql? || isPostgres?
@@ -135,13 +190,16 @@ class ActiveRecordInstrumentationTest < Test::Unit::TestCase
     end
   end
   def test_transaction
-    ActiveRecordFixtures::Order.add_delay
-    ActiveRecordFixtures::Order.find(:all)
+    sample = NewRelic::Agent.instance.transaction_sampler.reset!
+    perform_action_with_newrelic_trace :name => 'bogosity' do
+      ActiveRecordFixtures::Order.add_delay
+      ActiveRecordFixtures::Order.find(:all)
+    end
     
     sample = NewRelic::Agent.instance.transaction_sampler.last_sample
     
     sample = sample.prepare_to_send(:obfuscate_sql => true, :explain_enabled => true, :explain_sql => 0.0)
-    segment = sample.root_segment.called_segments.first.called_segments.first
+    segment = sample.root_segment.called_segments.first.called_segments.first.called_segments.first
     assert_nil segment.params[:sql], "SQL should have been removed."
     explanations = segment.params[:explanation]
     if isMysql? || isPostgres?
@@ -177,12 +235,38 @@ class ActiveRecordInstrumentationTest < Test::Unit::TestCase
     end
   end
   
-  private
-  def compare_metrics expected_list, actual_list
-    actual = Set.new actual_list
-    expected = Set.new expected_list
-    assert_equal expected, actual, "extra: #{(actual - expected).to_a.join(", ")}; missing: #{(expected - actual).to_a.join(", ")}"
+  # This is to make sure the all metric is recorded for exceptional cases
+  def test_error_handling
+    # have the AR select throw an error
+    ActiveRecordFixtures::Order.connection.stubs(:log_info).with do | sql, x, y |
+      raise "Error" if sql =~ /select/
+      true
+    end
+    ActiveRecordFixtures::Order.connection.select_rows "select * from #{ActiveRecordFixtures::Order.table_name}" rescue nil
+    metrics = NewRelic::Agent.instance.stats_engine.metrics
+    compare_metrics %W[
+    ActiveRecord/all
+    Database/SQL/select
+    ], metrics
+    assert_equal 1, NewRelic::Agent.get_stats("Database/SQL/select").call_count
+    assert_equal 1, NewRelic::Agent.get_stats("ActiveRecord/all").call_count
   end
+  
+  def test_rescue_handling
+    begin
+      ActiveRecordFixtures::Order.transaction do
+        raise ActiveRecord::ActiveRecordError.new('preserve-me!') 
+      end
+    rescue ActiveRecord::ActiveRecordError => e
+      assert_equal 'preserve-me!', e.message
+    rescue
+      fail "Rescue2: Got something COMPLETELY unexpected: $!:#{$!.inspect}"
+    end
+    
+  end
+  
+  private
+  
   def isPostgres?
     ActiveRecordFixtures::Order.configurations[RAILS_ENV]['adapter'] =~ /postgres/
   end