genki-newrelic_rpm 2.10.1

data/recipes/newrelic.rb

@@ -0,0 +1,6 @@
+# The capistrano recipes in plugins are automatically
+# loaded from here.  From gems, they are available from
+# the lib directory.  We have to make them available from
+# both locations
+
+require File.join(File.dirname(__FILE__),'..','lib','new_relic','recipes')

data/test/active_record_fixtures.rb

@@ -0,0 +1,55 @@
+# Some test models
+# These will get created and dropped during the active record tests
+# Be sure and call setup and teardown
+module ActiveRecordFixtures
+  extend self
+  def setup
+    ActiveRecordFixtures::Order.setup
+    ActiveRecordFixtures::Shipment.setup
+  end
+  def teardown
+    ActiveRecordFixtures::Shipment.teardown
+    ActiveRecordFixtures::Order.teardown
+  end
+  class Order < ActiveRecord::Base
+    self.table_name = 'newrelic_test_orders'
+    has_and_belongs_to_many :shipments, :class_name => 'ActiveRecordFixtures::Shipment'
+    def self.setup
+      connection.create_table self.table_name, :force => true do |t|
+        t.column :name, :string
+      end
+    end
+    def self.add_delay
+      # Introduce a 500 ms delay into db operations on Orders
+      def connection.log_info *args
+        sleep 0.5
+        super *args
+      end
+    end
+    def self.teardown
+      connection.drop_table table_name
+      def connection.log_info *args
+        super *args
+      end
+    end
+  end
+  
+  class Shipment < ActiveRecord::Base
+    self.table_name = 'newrelic_test_shipment'
+    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 
+      end
+      connection.create_table 'orders_shipments', :force => true, :id => false do |t|
+        t.column :order_id, :integer 
+        t.column :shipment_id, :integer 
+      end
+    end
+    
+    def self.teardown
+      connection.drop_table 'orders_shipments'
+      connection.drop_table self.table_name
+    end
+  end    
+end

data/test/config/newrelic.yml

@@ -0,0 +1,46 @@
+# This is the config file loaded when running unit tests locally.
+common: &default_settings
+  transaction_tracer:
+    enabled: true
+    record_sql: raw
+
+test:
+  <<: *default_settings
+  host: localhost
+  port: 3000
+  log_level: debug
+  capture_params: true
+  enabled: false
+  developer: true
+  monitor_daemons: false
+  disable_samplers: true
+  api_host: 127.0.0.1
+  api_port: 443
+  message: '<%= generated_for_user %>'
+  license_key: '<%= license_key %>'
+  agent_enabled: auto
+  apdex_t: 1.1
+
+  # Some fixtures for newrelic.yml parsing tests
+  erb_value: <%= 'hey'*3 %>
+  tval: true
+  tstring: 'true'
+  fval: false
+  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
+    explain_threshold: 0.1
+    explain_enabled: true
+    stack_trace_threshold: 0.1
+    
+  error_collector:
+    enabled: true
+    capture_source: true
+    
+  

data/test/config/test_control.rb

@@ -0,0 +1,39 @@
+require 'new_relic/control/rails'
+require 'new_relic/agent/agent_test_controller'
+
+class NewRelic::Control::Test < NewRelic::Control::Rails #:nodoc:
+  def env
+    'test'
+  end
+  def app
+    :rails
+  end
+  def config_file
+    File.join(File.dirname(__FILE__), "newrelic.yml")
+  end
+  def initialize local_env
+    super local_env
+    setup_log 
+  end
+  # when running tests, don't write out stderr
+  def log!(msg, level=:info)
+    log.send level, msg if log
+  end
+
+  # Add the default route in case it's missing.  Need it for testing.
+  def install_devmode_route
+    super
+    ActionController::Routing::RouteSet.class_eval do
+      return if defined? draw_without_test_route
+      def draw_with_test_route
+        draw_without_test_route do | map |
+          map.connect ':controller/:action/:id'
+          yield map        
+        end
+      end
+      alias_method_chain :draw, :test_route
+    end
+    # Force the routes to be reloaded
+    ActionController::Routing::Routes.reload!
+  end
+end

data/test/new_relic/agent/active_record_instrumentation_test.rb

@@ -0,0 +1,234 @@
+require File.expand_path(File.join(File.dirname(__FILE__),'..','..','test_helper')) 
+require 'active_record_fixtures'
+
+class ActiveRecordInstrumentationTest < Test::Unit::TestCase
+  
+  def setup
+    super
+    NewRelic::Agent.manual_start
+    NewRelic::Agent.instance.stats_engine.clear_stats
+    ActiveRecordFixtures.setup
+    NewRelic::Agent.instance.transaction_sampler.harvest
+  rescue
+    puts e
+    puts e.backtrace.join("\n")
+  end
+  
+  def teardown
+    super
+    ActiveRecordFixtures.teardown
+  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)
+    s = NewRelic::Agent.get_stats("ActiveRecord/ActiveRecordFixtures::Order/find")
+    assert_equal 1, s.call_count
+    ActiveRecordFixtures::Order.find_all_by_name "jeff"
+    s = NewRelic::Agent.get_stats("ActiveRecord/ActiveRecordFixtures::Order/find")
+    assert_equal 2, s.call_count
+  end
+  
+  # multiple duplicate find calls should only cause metric trigger on the first
+  # call.  the others are ignored.
+  def test_query_cache
+    ActiveRecordFixtures::Order.cache do
+      m = ActiveRecordFixtures::Order.create :id => 0, :name => 'jeff'
+      ActiveRecordFixtures::Order.find(:all)
+      s = NewRelic::Agent.get_stats("ActiveRecord/ActiveRecordFixtures::Order/find")
+      assert_equal 1, s.call_count
+      
+      10.times { ActiveRecordFixtures::Order.find m.id }
+    end
+    s = NewRelic::Agent.get_stats("ActiveRecord/ActiveRecordFixtures::Order/find")
+    assert_equal 2, s.call_count    
+  end
+  
+  def test_metric_names
+    m = ActiveRecordFixtures::Order.create :id => 0, :name => 'jeff'
+    m = ActiveRecordFixtures::Order.find(m.id)
+    m.id = 999
+    m.save!
+    
+    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
+    expected = %W[
+      ActiveRecord/all
+      ActiveRecord/create
+      ActiveRecord/find
+      ActiveRecord/ActiveRecordFixtures::Order/create
+      ActiveRecord/ActiveRecordFixtures::Order/find
+      ]
+    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
+  end
+  def test_join_metrics
+    m = ActiveRecordFixtures::Order.create :id => 0, :name => 'jeff'
+    m = ActiveRecordFixtures::Order.find(m.id)
+    s = m.shipments.create
+    m.shipments.to_a
+    m.destroy
+    
+    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[
+    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
+    ActiveRecord/ActiveRecordFixtures::Shipment/create
+    ], metrics
+    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/delete").call_count
+  end
+  def test_direct_sql
+    list = 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
+  end
+  
+  def test_blocked_instrumentation
+    ActiveRecordFixtures::Order.add_delay
+    NewRelic::Agent.disable_all_tracing do
+      ActiveRecordFixtures::Order.find(:all)
+    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
+    ActiveRecordFixtures::Order.add_delay
+    ActiveRecordFixtures::Order.find(:all)
+    
+    sample = NewRelic::Agent.instance.transaction_sampler.last_sample
+    
+    segment = sample.root_segment.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)
+    
+    sample = NewRelic::Agent.instance.transaction_sampler.last_sample
+    # 
+    sql_segment = sample.root_segment.called_segments.first.called_segments.first
+    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
+    assert_match /^SELECT /, sql_segment.params[:sql]
+    explanations = sql_segment.params[:explanation]
+    if isMysql? || isPostgres?
+      assert_not_nil explanations, "No explains in segment: #{sql_segment}"
+      assert_equal 1, explanations.size,"No explains in segment: #{sql_segment}" 
+      assert_equal 1, explanations.first.size
+    end
+  end
+  def test_transaction
+    ActiveRecordFixtures::Order.add_delay
+    ActiveRecordFixtures::Order.find(:all)
+    
+    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
+    assert_nil segment.params[:sql], "SQL should have been removed."
+    explanations = segment.params[:explanation]
+    if isMysql? || isPostgres?
+      assert_not_nil explanations, "No explains in segment: #{segment}"
+      assert_equal 1, explanations.size,"No explains in segment: #{segment}" 
+      assert_equal 1, explanations.first.size
+    end    
+    if isPostgres?
+      assert_equal Array, explanations.class
+      assert_equal Array, explanations[0].class
+      assert_equal Array, explanations[0][0].class
+      assert_match /Seq Scan on test_data/, explanations[0][0].join(";") 
+    elsif isMysql?
+      assert_equal "1;SIMPLE;#{ActiveRecordFixtures::Order.table_name};ALL;;;;;1;", explanations.first.first.join(";")
+    end
+    
+    s = NewRelic::Agent.get_stats("ActiveRecord/ActiveRecordFixtures::Order/find")
+    assert_equal 1, s.call_count
+  end
+  # These are only valid for rails 2.1 and later
+  if NewRelic::Control.instance.rails_version >= NewRelic::VersionNumber.new("2.1.0")
+    ActiveRecordFixtures::Order.class_eval do
+      named_scope :jeffs, :conditions => { :name => 'Jeff' }
+    end
+    def test_named_scope
+      ActiveRecordFixtures::Order.create :name => 'Jeff'
+      s = NewRelic::Agent.get_stats("ActiveRecord/ActiveRecordFixtures::Order/find")
+      before_count = s.call_count
+      x = ActiveRecordFixtures::Order.jeffs.find(:all)
+      assert_equal 1, x.size
+      se = NewRelic::Agent.instance.stats_engine
+      assert_equal before_count+1, s.call_count
+    end
+  end
+  
+  # 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 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(", ")}"
+  end
+  def isPostgres?
+    ActiveRecordFixtures::Order.configurations[RAILS_ENV]['adapter'] =~ /postgres/
+  end
+  def isMysql?
+    ActiveRecordFixtures::Order.connection.class.name =~ /mysql/i 
+  end
+end

data/test/new_relic/agent/agent_controller_test.rb

@@ -0,0 +1,107 @@
+require File.expand_path(File.join(File.dirname(__FILE__),'..','..','test_helper')) 
+require 'action_controller/base'
+
+class AgentControllerTest < ActionController::TestCase
+  
+  self.controller_class = NewRelic::Agent::AgentTestController
+  
+  attr_accessor :agent
+  
+  # Normally you can do this with #setup but for some reason in rails 2.0.2
+  # setup is not called.
+  def initialize name
+    super name
+    Thread.current[:newrelic_ignore_controller] = nil
+    NewRelic::Agent.manual_start
+    @agent = NewRelic::Agent.instance
+    #    @agent.instrument_app
+    agent.transaction_sampler.harvest
+    NewRelic::Agent::AgentTestController.class_eval do
+      newrelic_ignore :only => [:action_to_ignore, :entry_action, :base_action]
+      newrelic_ignore_apdex :only => :action_to_ignore_apdex
+    end
+  end
+  
+  def teardown
+    Thread.current[:newrelic_ignore_controller] = nil
+    @agent.stats_engine.clear_stats
+    super
+  end
+  
+  def test_metric__ignore
+    engine = @agent.stats_engine
+    get :action_to_ignore
+    assert_equal true, Thread.current[:newrelic_ignore_controller]
+  end
+  def test_metric__ignore_base
+    engine = @agent.stats_engine
+    get :base_action
+    assert_equal true, Thread.current[:newrelic_ignore_controller]
+  end
+  def test_metric__no_ignore
+    engine = @agent.stats_engine
+    path = 'new_relic/agent/agent_test/index'
+    index_stats = engine.get_stats_no_scope("Controller/#{path}")
+    index_apdex_stats = engine.get_custom_stats("Apdex/#{path}", NewRelic::ApdexStats)
+    assert_difference 'index_stats.call_count' do
+      assert_difference 'index_apdex_stats.call_count' do
+        get :index
+      end
+    end
+    assert_nil Thread.current[:newrelic_ignore_controller]
+  end
+  def test_metric__ignore_apdex
+    engine = @agent.stats_engine
+    path = 'new_relic/agent/agent_test/action_to_ignore_apdex'
+    cpu_stats = engine.get_stats_no_scope("ControllerCPU/#{path}")
+    index_stats = engine.get_stats_no_scope("Controller/#{path}")
+    index_apdex_stats = engine.get_custom_stats("Apdex/#{path}", NewRelic::ApdexStats)
+    assert_difference 'index_stats.call_count' do
+      assert_no_difference 'index_apdex_stats.call_count' do
+        get :action_to_ignore_apdex
+      end
+    end
+    assert_nil Thread.current[:newrelic_ignore_controller]
+    
+  end
+  def test_metric__dispatched
+    engine = @agent.stats_engine
+    get :entry_action
+    assert_nil Thread.current[:newrelic_ignore_controller]
+    assert_nil engine.lookup_stat('Controller/agent_test/entry_action')
+    assert_nil engine.lookup_stat('Controller/agent_test_controller/entry_action')
+    assert_nil engine.lookup_stat('Controller/AgentTestController/entry_action')
+    assert_nil engine.lookup_stat('Controller/NewRelic::Agent::AgentTestController/internal_action')
+    assert_nil engine.lookup_stat('Controller/NewRelic::Agent::AgentTestController_controller/internal_action')
+    assert_not_nil engine.lookup_stat('Controller/NewRelic::Agent::AgentTestController/internal_traced_action')
+  end
+  def test_action_instrumentation
+    begin
+      get :index, :foo => 'bar'
+      assert_match /bar/, @response.body
+      #rescue ActionController::RoutingError
+      # you might get here if you don't have the default route installed.
+    end
+  end
+  
+  def test_controller_params
+    
+    assert agent.transaction_sampler
+    
+    num_samples = NewRelic::Agent.instance.transaction_sampler.samples.length
+    
+    assert_equal "[FILTERED]", @controller._filter_parameters({'social_security_number' => 'test'})['social_security_number']
+    
+    get :index, 'social_security_number' => "001-555-1212"
+    
+    samples = agent.transaction_sampler.samples
+    
+    agent.transaction_sampler.expects(:notice_transaction).never
+    
+    assert_equal num_samples + 1, samples.length
+    
+    assert_equal "[FILTERED]", samples.last.params[:request_params]["social_security_number"]
+    
+  end
+  
+end