newrelic_rpm 3.3.2.1 → 3.3.3.beta1

data/CHANGELOG

@@ -1,5 +1,6 @@
-v3.3.2.1
-  * [SECURITY] fix for cookie handling by End User Monitoring instrumentation
+v3.3.3
+  * Improved Sinatra instrumentation
+  * Limit the number of nodes collected in long running transactions to prevent leaking memory
 
 v3.3.2
   * deployments recipe change: truncate git SHAs to 7 characters

data/lib/new_relic/agent/instrumentation/queue_time.rb

@@ -172,7 +172,7 @@ module NewRelic
         def record_time_stat(name, start_time, end_time) # (String, Time, Time) -> nil
           total_time = end_time - start_time
           if total_time < 0
-            raise "should not provide an end time less than start time: #{end_time} is less than #{start_time}"
+            raise "should not provide an end time less than start time: #{end_time.strftime('%s.%N')} is less than #{start_time.strftime('%s.%N')}. total time is #{total_time}."
           else
             NewRelic::Agent.get_stats(name).trace_call(total_time)
           end

data/lib/new_relic/agent/instrumentation/sinatra.rb

@@ -2,7 +2,8 @@ require 'new_relic/agent/instrumentation/controller_instrumentation'
 
 DependencyDetection.defer do
   depends_on do
-    defined?(::Sinatra) && defined?(::Sinatra::Base)
+    defined?(::Sinatra) && defined?(::Sinatra::Base) &&
+      Sinatra::Base.private_method_defined?(:dispatch!)
   end
 
   executes do
@@ -12,8 +13,8 @@ DependencyDetection.defer do
   executes do
     ::Sinatra::Base.class_eval do
       include NewRelic::Agent::Instrumentation::Sinatra
-      alias route_eval_without_newrelic route_eval
-      alias route_eval route_eval_with_newrelic
+      alias dispatch_without_newrelic dispatch!
+      alias dispatch! dispatch_with_newrelic
     end
   end
 end
@@ -30,26 +31,45 @@ module NewRelic
       # to match them.  HTTP operations are not distinguished.  Multiple matches
       # will all be tracked as separate actions.
       module Sinatra
+        include ::NewRelic::Agent::Instrumentation::ControllerInstrumentation
+                
+        def dispatch_with_newrelic
+          txn_name = NewRelic.transaction_name(self.class.routes, @request) do |pattern, keys, conditions|
+            process_route(pattern, keys, conditions) do
+              pattern.source
+            end
+          end
+          
+          perform_action_with_newrelic_trace(:category => :sinatra,
+                                             :name => txn_name,
+                                             :params => @request.params) do
+            dispatch_without_newrelic
+          end
+        end
 
-        include NewRelic::Agent::Instrumentation::ControllerInstrumentation
-
-        def route_eval_with_newrelic(&block_arg)
-          path = unescape(@request.path_info)
-          name = path
-          # Go through each route and look for a match
-          if routes = self.class.routes[@request.request_method]
-            routes.detect do |pattern, keys, conditions, block|
-              if block_arg.equal? block
-                name = pattern.source
+        module NewRelic
+          extend self
+          
+          def http_verb(request)
+            request.request_method if request.respond_to?(:request_method)
+          end
+          
+          def transaction_name(routes, request)
+            name = '(unknown)'
+            verb = http_verb(request)
+            
+            routes[verb].each do |pattern, keys, conditions, block|
+              if pattern = yield(pattern, keys, conditions)
+                name = pattern
               end
             end
-          end
-          # strip off leading ^ and / chars and trailing $ and /
-          name.gsub!(%r{^[/^]*(.*?)[/\$\?]*$}, '\1')
-          name = 'root' if name.empty?
-          name = @request.request_method + ' ' + name if @request && @request.respond_to?(:request_method)
-          perform_action_with_newrelic_trace(:category => :sinatra, :name => name, :params => @request.params) do
-            route_eval_without_newrelic(&block_arg)
+            
+            name.gsub!(%r{^[/^]*(.*?)[/\$\?]*$}, '\1')
+            if verb
+              name = verb + ' ' + name
+            end
+            
+            name
           end
         end
       end

data/lib/new_relic/agent/transaction_info.rb

@@ -1,5 +1,3 @@
-require 'erb'
-
 module NewRelic
   module Agent
     class TransactionInfo
@@ -50,22 +48,17 @@ module NewRelic
       def self.reset(request=nil)
         clear
         instance = get
-        instance.token = get_token(request)
-      end
 
-      def self.get_token(request)
-        return nil unless request
-        
-        agent_flag = request.cookies['NRAGENT']
-        if agent_flag
-          s = agent_flag.split("=")
-          if s.length == 2
-            if s[0] == "tk" && s[1]
-              ERB::Util.h(s[1])
+        if request
+          agent_flag = request.cookies['NRAGENT']
+          if agent_flag
+            s = agent_flag.split("=")
+            if s.length == 2
+              if s[0] == "tk" && s[1]
+                instance.token = s[1]
+              end
             end
           end
-        else
-          nil
         end
       end
     end

data/lib/new_relic/agent/transaction_sample_builder.rb

@@ -9,6 +9,7 @@ module NewRelic
     # accessed by any other thread so no need for synchronization.
     class TransactionSampleBuilder
       attr_reader :current_segment, :sample
+      attr_accessor :segment_limit
 
       include NewRelic::CollectionHelper
 
@@ -16,24 +17,32 @@ module NewRelic
         @sample = NewRelic::TransactionSample.new(time.to_f)
         @sample_start = time.to_f
         @current_segment = @sample.root_segment
+        @segment_limit = NewRelic::Control.instance.fetch('transaction_tracer', {}) \
+          .fetch('limit_segments', 4000)
       end
 
       def sample_id
         @sample.sample_id
       end
+      
       def ignored?
         @ignore || @sample.params[:path].nil?
       end
+      
       def ignore_transaction
         @ignore = true
       end
+      
       def trace_entry(metric_name, time)
-        segment = @sample.create_segment(time.to_f - @sample_start, metric_name)
-        @current_segment.add_called_segment(segment)
-        @current_segment = segment
+        if @sample.count_segments < @segment_limit
+          segment = @sample.create_segment(time.to_f - @sample_start, metric_name)
+          @current_segment.add_called_segment(segment)
+          @current_segment = segment
+        end
       end
 
       def trace_exit(metric_name, time)
+        return unless @sample.count_segments < @segment_limit
         if metric_name != @current_segment.metric_name
           fail "unbalanced entry/exit: #{metric_name} != #{@current_segment.metric_name}"
         end

data/lib/new_relic/metric_spec.rb

@@ -6,18 +6,19 @@ class NewRelic::MetricSpec
   
   # the maximum length of a metric name or metric scope
   MAX_LENGTH = 255
+  LENGTH_RANGE = (0...MAX_LENGTH)
   # Need a "zero-arg" constructor so it can be instantiated from java (using
   # jruby) for sending responses to ruby agents from the java collector.
   #
   def initialize(metric_name = '', metric_scope = '')
-    self.name = (metric_name || '') && metric_name[0...MAX_LENGTH]
-    self.scope = metric_scope && metric_scope[0...MAX_LENGTH]
+    self.name = (metric_name || '') && metric_name[LENGTH_RANGE]
+    self.scope = metric_scope && metric_scope[LENGTH_RANGE]
   end
   
   # truncates the name and scope to the MAX_LENGTH
   def truncate!
-    self.name = name[0...MAX_LENGTH] if name && name.size > MAX_LENGTH
-    self.scope = scope[0...MAX_LENGTH] if scope && scope.size > MAX_LENGTH
+    self.name = name[LENGTH_RANGE] if name && name.size > MAX_LENGTH
+    self.scope = scope[LENGTH_RANGE] if scope && scope.size > MAX_LENGTH
   end
   
   def ==(o)
@@ -42,10 +43,10 @@ class NewRelic::MetricSpec
     NewRelic::Control.instance.log.warn("The sub method on metric specs is deprecated") rescue nil
     return nil if name !~ pattern &&
      (!apply_to_scope || scope.nil? || scope !~ pattern)
-    new_name = name.sub(pattern, replacement)[0...MAX_LENGTH]
+    new_name = name.sub(pattern, replacement)[LENGTH_RANGE]
 
     if apply_to_scope
-      new_scope = (scope && scope.sub(pattern, replacement)[0...MAX_LENGTH])
+      new_scope = (scope && scope.sub(pattern, replacement)[LENGTH_RANGE])
     else
       new_scope = scope
     end

data/lib/new_relic/version.rb

@@ -3,8 +3,8 @@ module NewRelic
   module VERSION #:nodoc:
     MAJOR = 3
     MINOR = 3
-    TINY  = 2
-    BUILD = 1 # Set to nil for a release, 'beta1', 'alpha', etc for prerelease builds
+    TINY  = 3
+    BUILD = 'beta1' # Set to nil for a release, 'beta1', 'alpha', etc for prerelease builds
     STRING = [MAJOR, MINOR, TINY, BUILD].compact.join('.')
   end
 

data/newrelic_rpm.gemspec

@@ -5,14 +5,14 @@
 
 Gem::Specification.new do |s|
   s.name = "newrelic_rpm"
-  s.version = "3.3.2.1"
+  s.version = "3.3.3.beta1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Bill Kayser", "Jon Guymon", "Justin George", "Darin Swanson"]
-  s.date = "2012-03-15"
+  s.date = "2012-03-14"
   s.description = "New Relic is a performance management system, developed by New Relic,\nInc (http://www.newrelic.com).  New Relic provides you with deep\ninformation about the performance of your web application as it runs\nin production. The New Relic Ruby Agent is dual-purposed as a either a\nGem or plugin, hosted on\nhttp://github.com/newrelic/rpm/\n"
   s.email = "support@newrelic.com"
-  s.executables = ["newrelic", "newrelic_cmd", "mongrel_rpm"]
+  s.executables = ["newrelic_cmd", "mongrel_rpm", "newrelic"]
   s.extra_rdoc_files = [
     "CHANGELOG",
     "LICENSE",
@@ -170,7 +170,6 @@ Gem::Specification.new do |s|
     "test/new_relic/agent/stats_engine/metric_stats_test.rb",
     "test/new_relic/agent/stats_engine/samplers_test.rb",
     "test/new_relic/agent/stats_engine_test.rb",
-    "test/new_relic/agent/transaction_info_test.rb",
     "test/new_relic/agent/transaction_sample_builder_test.rb",
     "test/new_relic/agent/transaction_sampler_test.rb",
     "test/new_relic/agent/worker_loop_test.rb",

data/test/new_relic/agent/agent_test_controller_test.rb

@@ -83,6 +83,9 @@ class NewRelic::Agent::AgentTestControllerTest < ActionController::TestCase
   end
 
   def test_new_queue_integration
+    # make this test deterministic
+    Time.stubs(:now => Time.at(2))
+
     NewRelic::Agent::AgentTestController.clear_headers
     engine.clear_stats
     start = ((Time.now - 1).to_f * 1_000_000).to_i
@@ -94,6 +97,9 @@ class NewRelic::Agent::AgentTestControllerTest < ActionController::TestCase
 
 
   def test_new_middleware_integration
+    # make this test deterministic
+    Time.stubs(:now => Time.at(2))
+
     engine.clear_stats
     start = ((Time.now - 1).to_f * 1_000_000).to_i
     NewRelic::Agent::AgentTestController.set_some_headers 'HTTP_X_MIDDLEWARE_START'=> "t=#{start}"
@@ -103,6 +109,9 @@ class NewRelic::Agent::AgentTestControllerTest < ActionController::TestCase
   end
 
   def test_new_server_time_integration
+    # make this test deterministic
+    Time.stubs(:now => Time.at(2))
+
     NewRelic::Agent::AgentTestController.clear_headers
     engine.clear_stats
     start = ((Time.now - 1).to_f * 1_000_000).to_i
@@ -113,6 +122,9 @@ class NewRelic::Agent::AgentTestControllerTest < ActionController::TestCase
   end
 
   def test_new_frontend_work_integration
+    # make this test deterministic
+    Time.stubs(:now => Time.at(10))
+
     engine.clear_stats
     times = [Time.now - 3, Time.now - 2, Time.now - 1]
     times.map! {|t| (t.to_f * 1_000_000).to_i }
@@ -299,6 +311,9 @@ class NewRelic::Agent::AgentTestControllerTest < ActionController::TestCase
   end
 
   def test_queue_headers_apache
+    # make this test deterministic
+    Time.stubs(:now => Time.at(10))
+
     NewRelic::Agent::AgentTestController.clear_headers
     engine.clear_stats
     queue_length_stat = stats('Mongrel/Queue Length')
@@ -315,6 +330,8 @@ class NewRelic::Agent::AgentTestControllerTest < ActionController::TestCase
 
   end
   def test_queue_headers_heroku
+    # make this test deterministic
+    Time.stubs(:now => Time.at(10))
 
     engine.clear_stats
     NewRelic::Agent::AgentTestController.clear_headers
@@ -333,6 +350,8 @@ class NewRelic::Agent::AgentTestControllerTest < ActionController::TestCase
   end
 
   def test_queue_headers_heroku_queue_length
+    # make this test deterministic
+    Time.stubs(:now => Time.at(10))
 
     engine.clear_stats
     NewRelic::Agent::AgentTestController.clear_headers

data/test/new_relic/agent/instrumentation/queue_time_test.rb

@@ -301,9 +301,9 @@ class NewRelic::Agent::Instrumentation::QueueTimeTest < Test::Unit::TestCase
   end
 
   def test_record_time_stat_with_end_after_start
-    record_time_stat('WebFrontend/WebServer/foo', 2, 1)
+    record_time_stat('WebFrontend/WebServer/foo', Time.at(1.0001), Time.at(1))
   rescue RuntimeError => e
-    assert_equal("should not provide an end time less than start time: 1 is less than 2", e.message)
+    assert_match(/should not provide an end time less than start time/, e.message)
   end
 
   def test_convert_to_microseconds

data/test/new_relic/agent/transaction_sample_builder_test.rb

@@ -159,7 +159,13 @@ class NewRelic::Agent::TransationSampleBuilderTest < Test::Unit::TestCase
     @builder.finish_trace(Time.now.to_f)
     validate_builder
   end
-
+  
+  def test_trace_should_not_record_more_than_segment_limit
+    @builder.segment_limit = 3
+    8.times {|i| build_segment i.to_s }
+    assert_equal 3, @builder.sample.count_segments
+  end
+  
   def validate_builder(check_names = true)
     validate_segment @builder.sample.root_segment, check_names
   end

data/test/new_relic/agent/transaction_sampler_test.rb

@@ -264,7 +264,6 @@ class NewRelic::Agent::TransactionSamplerTest < Test::Unit::TestCase
     assert_equal(new_sample, @sampler.instance_variable_get('@slowest_sample'))
   end
 
-
   def test_store_slowest_sample_not_slowest
     old_sample = mock('old_sample')
     new_sample = mock('new_sample')
@@ -297,7 +296,7 @@ class NewRelic::Agent::TransactionSamplerTest < Test::Unit::TestCase
     new_sample.expects(:duration).returns(1.0)
     assert_equal(true, @sampler.slowest_sample?(old_sample, new_sample))
   end
-
+    
   def test_truncate_samples_no_samples
     @sampler.instance_eval { @max_samples = 10 }
     @sampler.instance_eval { @samples = [] }
@@ -527,7 +526,6 @@ class NewRelic::Agent::TransactionSamplerTest < Test::Unit::TestCase
     assert_equal([], result, "should not add samples to the array when harvest count is not moduli sampling rate")
   end
 
-
   def test_add_random_sample_to_activated
     @sampler.instance_eval { @random_sampling = true }
     sample = mock('sample')
@@ -554,7 +552,6 @@ class NewRelic::Agent::TransactionSamplerTest < Test::Unit::TestCase
     assert_equal([], result, "should not add the sample to the array")
   end
 
-
   def test_add_samples_to_no_data
     result = []
     slow_threshold = 2.0
@@ -620,8 +617,7 @@ class NewRelic::Agent::TransactionSamplerTest < Test::Unit::TestCase
     @sampler.expects(:add_random_sample_to).with([slower_sample])
     assert_equal([slower_sample], @sampler.add_samples_to(result, slow_threshold))
   end
-  
-  
+    
   def test_keep_force_persist
     sample1 = mock('regular')
     sample1.stubs(:duration).returns(10)
@@ -636,8 +632,7 @@ class NewRelic::Agent::TransactionSamplerTest < Test::Unit::TestCase
     assert_equal 2, result.length
     assert_equal sample1, result[0]
     assert_equal sample2, result[1]
-  end
-  
+  end  
 
   def test_start_builder_default
     Thread.current[:record_tt] = true
@@ -679,7 +674,6 @@ class NewRelic::Agent::TransactionSamplerTest < Test::Unit::TestCase
   # generally usefully so
 
   def test_multiple_samples
-
     run_sample_trace
     run_sample_trace
     run_sample_trace
@@ -752,7 +746,6 @@ class NewRelic::Agent::TransactionSamplerTest < Test::Unit::TestCase
   # sample traces, for example. It's unfortunate, but we can't
   # reliably turn off GC on all versions of ruby under test
   def test_harvest_slowest
-
     run_sample_trace
     run_sample_trace
     run_sample_trace { sleep 0.1 }
@@ -775,9 +768,7 @@ class NewRelic::Agent::TransactionSamplerTest < Test::Unit::TestCase
     assert((new_slowest.duration >= 0.15), "Slowest duration must be >= 0.15, but was: #{new_slowest.duration.inspect}")
   end
 
-
   def test_prepare_to_send
-
     run_sample_trace { sleep 0.002 }
     sample = @sampler.harvest(nil, 0)[0]
 
@@ -804,7 +795,6 @@ class NewRelic::Agent::TransactionSamplerTest < Test::Unit::TestCase
   end
 
   def test_sample_with_parallel_paths
-
     assert_equal 0, @sampler.scope_depth
 
     @sampler.notice_first_scope_push Time.now.to_f
@@ -830,7 +820,6 @@ class NewRelic::Agent::TransactionSamplerTest < Test::Unit::TestCase
   end
 
   def test_double_scope_stack_empty
-
     @sampler.notice_first_scope_push Time.now.to_f
     @sampler.notice_transaction "/path", nil, {}
     @sampler.notice_push_scope "a"
@@ -845,7 +834,6 @@ class NewRelic::Agent::TransactionSamplerTest < Test::Unit::TestCase
 
 
   def test_record_sql_off
-
     @sampler.notice_first_scope_push Time.now.to_f
 
     Thread::current[:record_sql] = false
@@ -869,8 +857,8 @@ class NewRelic::Agent::TransactionSamplerTest < Test::Unit::TestCase
     assert segment[:sql]
     assert segment[:backtrace]
   end
+  
   def test_stack_trace__scope
-
     @sampler.stack_trace_threshold = 0
     t = Time.now
     @sampler.notice_first_scope_push t.to_f
@@ -881,7 +869,6 @@ class NewRelic::Agent::TransactionSamplerTest < Test::Unit::TestCase
   end
 
   def test_nil_stacktrace
-
     @sampler.stack_trace_threshold = 2
 
     @sampler.notice_first_scope_push Time.now.to_f
@@ -895,7 +882,6 @@ class NewRelic::Agent::TransactionSamplerTest < Test::Unit::TestCase
   end
 
   def test_big_sql
-
     @sampler.notice_first_scope_push Time.now.to_f
 
     sql = "SADJKHASDHASD KAJSDH ASKDH ASKDHASDK JASHD KASJDH ASKDJHSAKDJHAS DKJHSADKJSAH DKJASHD SAKJDH SAKDJHS"
@@ -913,9 +899,7 @@ class NewRelic::Agent::TransactionSamplerTest < Test::Unit::TestCase
     assert sql.length <= 16384
   end
 
-
   def test_segment_obfuscated
-
     @sampler.notice_first_scope_push Time.now.to_f
     @sampler.notice_push_scope "foo"
 
@@ -930,7 +914,6 @@ class NewRelic::Agent::TransactionSamplerTest < Test::Unit::TestCase
     @sampler.notice_pop_scope "foo"
   end
 
-
   def test_param_capture
     [true, false].each do |capture|
       NewRelic::Control.instance.stubs(:capture_params).returns(capture)
@@ -943,23 +926,41 @@ class NewRelic::Agent::TransactionSamplerTest < Test::Unit::TestCase
       assert_equal (capture) ? 1 : 0, tt.params[:request_params].length
     end
   end
-
-
+  
+  def test_should_not_collect_segments_beyond_limit
+    NewRelic::Control.instance.merge_options('transaction_tracer' => {
+                                               'limit_segments' => 3,
+                                             })
+    @sampler.configure!
+    run_sample_trace do
+      @sampler.notice_push_scope 'a1'
+      @sampler.notice_sql("SELECT * FROM sandwiches WHERE bread = 'hallah'", nil, 0)
+      @sampler.notice_push_scope 'a11'
+      @sampler.notice_sql("SELECT * FROM sandwiches WHERE bread = 'semolina'", nil, 0)
+      @sampler.notice_pop_scope "a11"
+      @sampler.notice_pop_scope "a1"
+    end
+    assert_equal 3, @sampler.samples[0].count_segments
+    NewRelic::Control.instance.merge_options('transaction_tracer' => {
+                                               'limit_segments' => 4000,
+                                             })
+  end
+  
   private
-  def run_sample_trace(&proc)
+  
+  def run_sample_trace
     @sampler.notice_first_scope_push Time.now.to_f
     @sampler.notice_transaction '/path', nil, {}
     @sampler.notice_push_scope "a"
     @sampler.notice_sql("SELECT * FROM sandwiches WHERE bread = 'wheat'", nil, 0)
     @sampler.notice_push_scope "ab"
     @sampler.notice_sql("SELECT * FROM sandwiches WHERE bread = 'white'", nil, 0)
-    proc.call if proc
+    yield if block_given?
     @sampler.notice_pop_scope "ab"
-    @sampler.notice_push_scope "lew"
+    @sampler.notice_push_scope "ac"
     @sampler.notice_sql("SELECT * FROM sandwiches WHERE bread = 'french'", nil, 0)
-    @sampler.notice_pop_scope "lew"
+    @sampler.notice_pop_scope "ac"
     @sampler.notice_pop_scope "a"
     @sampler.notice_scope_empty
   end
-
 end

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification 
 name: newrelic_rpm
 version: !ruby/object:Gem::Version 
-  hash: 109
-  prerelease: 
+  hash: 748706491
+  prerelease: 6
   segments: 
   - 3
   - 3
-  - 2
+  - 3
+  - beta
   - 1
-  version: 3.3.2.1
+  version: 3.3.3.beta1
 platform: ruby
 authors: 
 - Bill Kayser
@@ -19,7 +20,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-03-15 00:00:00 Z
+date: 2012-03-14 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: jeweler
@@ -73,9 +74,9 @@ description: |
 
 email: support@newrelic.com
 executables: 
-- newrelic
 - newrelic_cmd
 - mongrel_rpm
+- newrelic
 extensions: []
 
 extra_rdoc_files: 
@@ -234,7 +235,6 @@ files:
 - test/new_relic/agent/stats_engine/metric_stats_test.rb
 - test/new_relic/agent/stats_engine/samplers_test.rb
 - test/new_relic/agent/stats_engine_test.rb
-- test/new_relic/agent/transaction_info_test.rb
 - test/new_relic/agent/transaction_sample_builder_test.rb
 - test/new_relic/agent/transaction_sampler_test.rb
 - test/new_relic/agent/worker_loop_test.rb

data/test/new_relic/agent/transaction_info_test.rb

@@ -1,13 +0,0 @@
-require File.expand_path(File.join(File.dirname(__FILE__),'..','..','test_helper'))
-require 'ostruct'
-
-class NewRelic::Agent::TransactionInfoTest < Test::Unit::TestCase
-  def setup
-    @request = OpenStruct.new(:cookies => {'NRAGENT' => 'tk=1234<tag>evil</tag>5678'})
-  end
-  
-  def test_get_token_gets_sanitized_token_from_cookie
-    assert_equal('1234&lt;tag&gt;evil&lt;/tag&gt;5678',
-                 NewRelic::Agent::TransactionInfo.get_token(@request))
-  end
-end