techarch-newrelic_rpm 2.10.2

data/test/new_relic/agent/dispatcher_instrumentation_test.rb

@@ -0,0 +1,76 @@
+require File.expand_path(File.join(File.dirname(__FILE__),'..','..','test_helper')) 
+
+class NewRelic::Agent::DispatcherInstrumentationTest < Test::Unit::TestCase
+  
+  class FunnyDispatcher
+    include NewRelic::Agent::Instrumentation::DispatcherInstrumentation
+    def newrelic_response_code; end
+  end
+  def setup
+    super
+    NewRelic::Agent.manual_start
+    NewRelic::Agent.instance.stats_engine.clear_stats
+    @instance_busy = NewRelic::Agent.agent.stats_engine.get_stats 'Instance/Busy'
+    @dispatch_stat = NewRelic::Agent.agent.stats_engine.get_stats 'HttpDispatcher'
+    @mongrel_queue_stat = NewRelic::Agent.agent.stats_engine.get_stats 'WebFrontend/Mongrel/Average Queue Time'
+  end
+  
+  def test_normal_call
+    d = FunnyDispatcher.new
+    assert_equal 0, NewRelic::Agent::Instrumentation::DispatcherInstrumentation::BusyCalculator.busy_count
+    d.newrelic_dispatcher_start
+    sleep 1.0
+    assert_equal 1, NewRelic::Agent::Instrumentation::DispatcherInstrumentation::BusyCalculator.busy_count
+    d.newrelic_dispatcher_finish
+    assert_equal 0, NewRelic::Agent::Instrumentation::DispatcherInstrumentation::BusyCalculator.busy_count
+    assert_nil Thread.current[:newrelic_t0]
+    NewRelic::Agent::Instrumentation::DispatcherInstrumentation::BusyCalculator.harvest_busy
+
+    assert_equal 1, @instance_busy.call_count
+    assert_equal 1, @dispatch_stat.call_count
+    assert_equal 0, @mongrel_queue_stat.call_count
+    assert @dispatch_stat.total_call_time >= 1.0, "Total call time must be at least one second"
+    assert @instance_busy.total_call_time > 0.9 && @instance_busy.total_call_time <= 1.0, "instance busy = #{@instance_busy.inspect}"
+  end
+  def test_histogram
+    d = FunnyDispatcher.new
+    d.newrelic_dispatcher_start
+    d.newrelic_dispatcher_finish
+    bucket = NewRelic::Agent.instance.stats_engine.metrics.find { | m | m =~ /^Response Times/ }
+    assert_not_nil bucket
+    bucket_stats = NewRelic::Agent.instance.stats_engine.get_stats(bucket)
+    assert_equal 1, bucket_stats.call_count
+  end
+  def test_ignore_zero_counts
+    assert_equal 0, @instance_busy.call_count, "Problem with test--instance busy not starting off at zero."
+    NewRelic::Agent::Instrumentation::DispatcherInstrumentation::BusyCalculator.harvest_busy
+    NewRelic::Agent::Instrumentation::DispatcherInstrumentation::BusyCalculator.harvest_busy
+    NewRelic::Agent::Instrumentation::DispatcherInstrumentation::BusyCalculator.harvest_busy
+    assert_equal 0, @instance_busy.call_count  
+  end
+  def test_recursive_call
+    d0 = FunnyDispatcher.new
+    d1 = FunnyDispatcher.new
+
+    assert_equal 0, @instance_busy.call_count, "Problem with test--instance busy not starting off at zero."
+
+    NewRelic::Agent::Instrumentation::DispatcherInstrumentation::BusyCalculator.harvest_busy
+    NewRelic::Agent::Instrumentation::DispatcherInstrumentation::BusyCalculator.harvest_busy
+    assert_equal 0, @instance_busy.call_count  
+
+    assert_equal 0, NewRelic::Agent::Instrumentation::DispatcherInstrumentation::BusyCalculator.busy_count
+    d0.newrelic_dispatcher_start
+    assert_equal 1, NewRelic::Agent::Instrumentation::DispatcherInstrumentation::BusyCalculator.busy_count
+    d1.newrelic_dispatcher_start
+    assert_equal 1, NewRelic::Agent::Instrumentation::DispatcherInstrumentation::BusyCalculator.busy_count
+    sleep 1
+    d0.newrelic_dispatcher_finish
+    assert_equal 0, NewRelic::Agent::Instrumentation::DispatcherInstrumentation::BusyCalculator.busy_count
+    d1.newrelic_dispatcher_finish
+    assert_equal 0, NewRelic::Agent::Instrumentation::DispatcherInstrumentation::BusyCalculator.busy_count
+    assert_nil Thread.current[:newrelic_t0]
+    NewRelic::Agent::Instrumentation::DispatcherInstrumentation::BusyCalculator.harvest_busy
+    assert_equal 1, @instance_busy.call_count  
+    assert @instance_busy.total_call_time.between?(0.8, 1.1), "Should be about 100%: #{@instance_busy.total_call_time}"
+  end
+end

data/test/new_relic/agent/error_collector_test.rb

@@ -0,0 +1,172 @@
+require File.expand_path(File.join(File.dirname(__FILE__),'..','..','test_helper')) 
+require 'test/unit'
+
+class FakeRequest
+  attr_reader :path
+  
+  def initialize(path)
+    @path = path
+  end
+  
+  def referer
+    "test_referer"
+  end
+end
+
+class NewRelic::Agent::ErrorCollectorTest < Test::Unit::TestCase
+  
+  def setup
+    @error_collector = NewRelic::Agent::ErrorCollector.new(nil)
+  end
+  def teardown
+    
+  end
+  def test_empty
+    @error_collector.harvest_errors([])
+    @error_collector.notice_error(nil, nil, 'path', {:x => 'y'})
+    errors = @error_collector.harvest_errors([])
+    
+    assert_equal errors.length, 1
+    
+    err = errors.first
+    assert_equal '<no message>', err.message 
+    assert_equal 'y', err.params[:request_params][:x]
+    assert_equal '', err.params[:request_uri]
+    assert_equal '', err.params[:request_referer]
+    assert_equal 'path', err.path 
+    assert_equal '<no exception>', err.exception_class
+
+  end
+  def test_simple
+    @error_collector.notice_error(Exception.new("message"), FakeRequest.new('/myurl/'), 'path', {:x => 'y'})
+    
+    old_errors = []
+    errors = @error_collector.harvest_errors(old_errors)
+    
+    assert_equal errors.length, 1
+    
+    err = errors.first
+    assert_equal 'message', err.message 
+    assert_equal 'y', err.params[:request_params][:x]
+    assert err.params[:request_uri] == '/myurl/'
+    assert err.params[:request_referer] == "test_referer"
+    assert err.path == 'path'
+    assert err.exception_class == 'Exception'
+    
+    # the collector should now return an empty array since nothing
+    # has been added since its last harvest
+    errors = @error_collector.harvest_errors(nil)
+    assert errors.length == 0
+  end
+
+  def test_long_message
+    #yes, times 500. it's a 5000 byte string. Assuming strings are
+    #still 1 byte / char.
+    @error_collector.notice_error(Exception.new("1234567890" * 500), FakeRequest.new('/myurl/'), 'path', {:x => 'y'})
+    
+    old_errors = []
+    errors = @error_collector.harvest_errors(old_errors)
+    
+    assert_equal errors.length, 1
+    
+    err = errors.first
+    assert_equal 4096, err.message.length
+    assert_equal ('1234567890' * 500)[0..4095], err.message
+  end
+  
+  def test_collect_failover
+    @error_collector.notice_error(Exception.new("message"), nil, 'first', {:x => 'y'})
+    
+    errors = @error_collector.harvest_errors([])
+    
+    @error_collector.notice_error(Exception.new("message"), nil, 'second', {:x => 'y'})
+    @error_collector.notice_error(Exception.new("message"), nil, 'path', {:x => 'y'})
+    @error_collector.notice_error(Exception.new("message"), nil, 'path', {:x => 'y'})
+    
+    errors = @error_collector.harvest_errors(errors)
+    
+    assert_equal 1, errors.length
+    assert_equal 'first', errors.first.path
+    
+    # add two more
+    @error_collector.notice_error(Exception.new("message"), nil, 'path', {:x => 'y'})
+    @error_collector.notice_error(Exception.new("message"), nil, 'last', {:x => 'y'})
+    
+    errors = @error_collector.harvest_errors(nil)
+    assert_equal 5, errors.length
+    assert_equal 'second', errors.first.path
+    assert_equal 'last', errors.last.path
+    
+  end
+  
+  def test_queue_overflow
+    
+    max_q_length = 20     # for some reason I can't read the constant in ErrorCollector
+    
+    silence_stream(::STDERR) do
+     (max_q_length + 5).times do |n|
+        @error_collector.notice_error(Exception.new("exception #{n}"), nil, "path", {:x => n})
+      end
+    end
+    
+    errors = @error_collector.harvest_errors([])
+    assert errors.length == max_q_length 
+    errors.each_index do |i|
+      err = errors.shift
+      assert_equal i.to_s, err.params[:request_params][:x], err.params.inspect
+    end
+  end
+  
+  # Why would anyone undef these methods?
+  class TestClass
+    undef to_s
+    undef inspect
+  end
+  
+  
+  def test_supported_param_types
+    
+    types = [[1, '1'],
+    [1.1, '1.1'],
+    ['hi', 'hi'],
+    [:hi, :hi],
+    [Exception.new("test"), "#<Exception>"],
+    [TestClass.new, "#<NewRelic::Agent::ErrorCollectorTest::TestClass>"]
+    ]
+    
+    
+    types.each do |test|
+      @error_collector.notice_error(Exception.new("message"), nil, 'path', {:x => test[0]})
+      
+      assert_equal test[1], @error_collector.harvest_errors([])[0].params[:request_params][:x]
+    end
+  end
+  
+  
+  def test_exclude
+    @error_collector.ignore(["ActionController::RoutingError"])
+    
+    @error_collector.notice_error(ActionController::RoutingError.new("message"), nil, 'path', {:x => 'y'})
+    
+    errors = @error_collector.harvest_errors([])
+    
+    assert_equal 0, errors.length
+  end
+  
+  def test_exclude_block
+    @error_collector.ignore_error_filter do |e|
+      if e.is_a? ActionController::RoutingError
+        nil
+      else
+        e
+      end
+    end
+    
+    @error_collector.notice_error(ActionController::RoutingError.new("message"), nil, 'path', {:x => 'y'})
+    
+    errors = @error_collector.harvest_errors([])
+    
+    assert_equal 0, errors.length
+  end
+  
+end

data/test/new_relic/agent/method_tracer_test.rb

@@ -0,0 +1,340 @@
+require File.expand_path(File.join(File.dirname(__FILE__),'..','..','test_helper')) 
+require 'new_relic/agent/mock_scope_listener'
+
+class Module
+  def method_traced?(method_name, metric_name)
+    traced_method_prefix = _traced_method_name(method_name, metric_name)
+    
+    method_defined? traced_method_prefix
+  end
+end  
+
+class Insider
+  def initialize(stats_engine)
+    @stats_engine = stats_engine
+  end
+  def catcher(level=0)
+    thrower(level) if level>0
+  end
+  def thrower(level)
+    if level == 0
+      # don't use a real sampler because we can't instantiate one
+      # sampler = NewRelic::Agent::TransactionSampler.new(NewRelic::Agent.instance)
+      sampler = "<none>"
+      begin
+        @stats_engine.transaction_sampler = sampler
+        fail "This should not have worked."
+        rescue; end
+    else
+      thrower(level-1)
+    end
+  end
+end
+
+module NewRelic
+  module Agent
+    extend self
+    def module_method_to_be_traced (x, testcase)
+      testcase.assert x == "x"
+      testcase.assert testcase.stats_engine.peek_scope.name == "x"
+    end
+  end
+end
+
+class NewRelic::Agent::MethodTracerTest < Test::Unit::TestCase
+  attr_reader :stats_engine
+  
+  def setup
+    super
+    NewRelic::Agent.manual_start
+    @stats_engine = NewRelic::Agent.instance.stats_engine
+    @stats_engine.clear_stats
+    @scope_listener = NewRelic::Agent::MockScopeListener.new
+    @old_sampler = NewRelic::Agent.instance.transaction_sampler
+    @stats_engine.transaction_sampler = @scope_listener
+  end
+
+  def teardown
+    @stats_engine.transaction_sampler = @old_sampler
+    @stats_engine.clear_stats
+    self.class.remove_method_tracer :method_to_be_traced, @metric_name if @metric_name
+    @metric_name = nil
+    super
+  end
+  
+  def test_basic
+    metric = "hello"
+    t1 = Time.now
+    self.class.trace_execution_scoped metric do
+      sleep 1
+      assert metric == @stats_engine.peek_scope.name
+    end
+    elapsed = Time.now - t1
+    
+    stats = @stats_engine.get_stats(metric)
+    check_time stats.total_call_time, elapsed
+    assert stats.call_count == 1
+  end
+  
+  def test_basic__original_api
+    metric = "hello"
+    t1 = Time.now
+    self.class.trace_method_execution metric, true, true, true do
+      sleep 1
+      assert metric == @stats_engine.peek_scope.name
+    end
+    elapsed = Time.now - t1
+    
+    stats = @stats_engine.get_stats(metric)
+    check_time stats.total_call_time, elapsed
+    assert stats.call_count == 1
+  end
+  
+  METRIC = "metric"
+  def test_add_method_tracer
+    @metric_name = METRIC
+    self.class.add_method_tracer :method_to_be_traced, METRIC
+    
+    t1 = Time.now
+    method_to_be_traced 1,2,3,true,METRIC
+    elapsed = Time.now - t1
+    
+    stats = @stats_engine.get_stats(METRIC)
+    check_time stats.total_call_time, elapsed
+    assert stats.call_count == 1
+  end
+  
+  def test_add_method_tracer__default
+    self.class.add_method_tracer :simple_method
+    
+    simple_method
+    
+    stats = @stats_engine.get_stats("Custom/#{self.class.name}/simple_method")
+    assert stats.call_count == 1
+    
+  end
+  def test_add_method_tracer__reentry
+    self.class.add_method_tracer :simple_method
+    self.class.add_method_tracer :simple_method
+    self.class.add_method_tracer :simple_method
+    
+    simple_method
+    
+    stats = @stats_engine.get_stats("Custom/#{self.class.name}/simple_method")
+    assert stats.call_count == 1
+    
+  end
+
+  def test_method_traced?
+    assert !self.class.method_traced?(:method_to_be_traced, METRIC)
+    self.class.add_method_tracer :method_to_be_traced, METRIC
+    assert self.class.method_traced?(:method_to_be_traced, METRIC)
+  end
+  
+  def test_tt_only
+    
+    assert_nil @scope_listener.scope["c2"]
+    self.class.add_method_tracer :method_c1, "c1", true
+    
+    self.class.add_method_tracer :method_c2, "c2", :metric => false
+    self.class.add_method_tracer :method_c3, "c3", false
+    
+    method_c1
+    
+    assert_not_nil @stats_engine.lookup_stat("c1")
+    assert_nil @stats_engine.lookup_stat("c2")
+    assert_not_nil @stats_engine.lookup_stat("c3")
+    
+    assert_not_nil @scope_listener.scope["c2"]
+  end
+  
+  def test_nested_scope_tracer
+    Insider.add_method_tracer :catcher, "catcher", :push_scope => true
+    Insider.add_method_tracer :thrower, "thrower", :push_scope => true
+    sampler = NewRelic::Agent.instance.transaction_sampler
+    mock = Insider.new(@stats_engine)
+    mock.catcher(0)
+    mock.catcher(5)
+    stats = @stats_engine.get_stats("catcher")
+    assert_equal 2, stats.call_count
+    stats = @stats_engine.get_stats("thrower")
+    assert_equal 6, stats.call_count
+    sample = sampler.harvest
+    assert_not_nil sample
+  end
+  
+  def test_add_same_tracer_twice
+    @metric_name = METRIC
+    self.class.add_method_tracer :method_to_be_traced, METRIC
+    self.class.add_method_tracer :method_to_be_traced, METRIC
+    
+    t1 = Time.now
+    method_to_be_traced 1,2,3,true,METRIC
+    elapsed = Time.now - t1
+    
+    stats = @stats_engine.get_stats(METRIC)
+    check_time stats.total_call_time, elapsed
+    assert stats.call_count == 1
+  end
+  
+  def test_add_tracer_with_dynamic_metric
+    metric_code = '#{args[0]}.#{args[1]}'
+    @metric_name = metric_code
+    expected_metric = "1.2"
+    self.class.add_method_tracer :method_to_be_traced, metric_code
+    
+    t1 = Time.now
+    method_to_be_traced 1,2,3,true,expected_metric
+    elapsed = Time.now - t1
+    
+    stats = @stats_engine.get_stats(expected_metric)
+    check_time stats.total_call_time, elapsed
+    assert stats.call_count == 1
+  end
+  
+  def test_trace_method_with_block
+    self.class.add_method_tracer :method_with_block, METRIC
+    
+    t1 = Time.now
+    method_with_block(1,2,3,true,METRIC) do |scope|
+      assert scope == METRIC
+    end
+    elapsed = Time.now - t1
+    
+    stats = @stats_engine.get_stats(METRIC)
+    check_time stats.total_call_time, elapsed
+    assert stats.call_count == 1
+  end
+  
+  def test_trace_module_method
+    NewRelic::Agent.add_method_tracer :module_method_to_be_traced, '#{args[0]}'
+    NewRelic::Agent.module_method_to_be_traced "x", self
+    NewRelic::Agent.remove_method_tracer :module_method_to_be_traced, '#{args[0]}'
+  end
+  
+  def test_remove
+    self.class.add_method_tracer :method_to_be_traced, METRIC
+    self.class.remove_method_tracer :method_to_be_traced, METRIC
+    
+    t1 = Time.now
+    method_to_be_traced 1,2,3,false,METRIC
+    elapsed = Time.now - t1
+    
+    stats = @stats_engine.get_stats(METRIC)
+    assert stats.call_count == 0
+  end
+  
+  def self.static_method(x, testcase, is_traced)
+    testcase.assert x == "x"
+    testcase.assert((testcase.stats_engine.peek_scope.name == "x") == is_traced)
+  end
+  
+  def trace_trace_static_method
+    self.add_method_tracer :static_method, '#{args[0]}'
+    self.class.static_method "x", self, true
+    self.remove_method_tracer :static_method, '#{args[0]}'
+    self.class.static_method "x", self, false
+  end
+  
+  def test_multiple_metrics__scoped
+    metrics = %w[first second third]
+    self.class.trace_execution_scoped metrics do
+      sleep 0.05
+    end
+    elapsed = @stats_engine.get_stats('first').average_call_time
+    metrics.map{|name| @stats_engine.get_stats name}.each do | m |
+      assert_equal 1, m.call_count
+      assert_equal elapsed, m.total_call_time
+    end
+  end
+  def test_multiple_metrics__unscoped
+    metrics = %w[first second third]
+    self.class.trace_execution_unscoped metrics do
+      sleep 0.05
+    end
+    elapsed = @stats_engine.get_stats('first').average_call_time
+    metrics.map{|name| @stats_engine.get_stats name}.each do | m |
+      assert_equal 1, m.call_count
+      assert_equal elapsed, m.total_call_time
+    end
+  end
+  def test_exception
+    begin
+      metric = "hey"
+      self.class.trace_execution_scoped metric do
+        assert @stats_engine.peek_scope.name == metric
+        throw Exception.new            
+      end
+      
+      assert false # should never get here
+    rescue Exception
+      # make sure the scope gets popped
+      assert @stats_engine.peek_scope == nil
+    end
+    
+    stats = @stats_engine.get_stats metric
+    assert stats.call_count == 1
+  end
+  
+  def test_add_multiple_tracers
+    self.class.add_method_tracer :method_to_be_traced, 'X', :push_scope => false
+    method_to_be_traced 1,2,3,true,nil
+    self.class.add_method_tracer :method_to_be_traced, 'Y'
+    method_to_be_traced 1,2,3,true,'Y'
+    self.class.remove_method_tracer :method_to_be_traced, 'Y'
+    method_to_be_traced 1,2,3,true,nil
+    self.class.remove_method_tracer :method_to_be_traced, 'X'
+    method_to_be_traced 1,2,3,false,'X'
+  end
+  
+  def trace_no_push_scope
+    self.class.add_method_tracer :method_to_be_traced, 'X', :push_scope => false
+    method_to_be_traced 1,2,3,true,nil
+    self.class.remove_method_tracer :method_to_be_traced, 'X'
+    method_to_be_traced 1,2,3,false,'X'
+  end
+  
+  def check_time (t1, t2)
+    assert((t2-t1).abs < 0.01, "Times not close: #{t1} ~ #{t2}")
+  end
+  
+  # =======================================================
+  # test methods to be traced
+  def method_to_be_traced(x, y, z, is_traced, expected_metric)
+    sleep 0.1
+    assert x == 1
+    assert y == 2
+    assert z == 3
+    scope_name = @stats_engine.peek_scope ? @stats_engine.peek_scope.name : nil
+    if is_traced
+      assert_equal expected_metric, scope_name
+    else
+      assert_not_equal expected_metric, scope_name
+    end
+  end
+  
+  def method_with_block(x, y, z, is_traced, expected_metric, &block)
+    sleep 0.1
+    assert x == 1
+    assert y == 2
+    assert z == 3
+    block.call(@stats_engine.peek_scope.name)
+    
+    scope_name = @stats_engine.peek_scope ? @stats_engine.peek_scope.name : nil
+    assert((expected_metric == scope_name) == is_traced)
+  end
+  
+  def method_c1
+    method_c2
+  end
+  
+  def method_c2
+    method_c3
+  end
+  
+  def method_c3
+  end
+
+  def simple_method
+  end
+end