newrelic_rpm 3.5.6.46.beta → 3.5.6.48.beta

data/CHANGELOG

@@ -1,6 +1,14 @@
 
 # New Relic Ruby Agent Release Notes #
 
+## v3.5.6 ##
+
+  * Fix two Resque-related issues
+
+    Fixes a possible hang on exit of an instrumented Resque master process
+    (https://github.com/defunkt/resque/issues/578), as well as a file descriptor
+    leak that could occur during startup of the Resque master process.
+
 ## v3.5.5 ##
 
   * Add thread profiling support

data/lib/new_relic/agent/agent.rb

@@ -458,6 +458,14 @@ module NewRelic
                    :info, "Connecting workers after forking.")
           end
 
+          # Return true if we're using resque and it hasn't had a chance to (potentially)
+          # daemonize itself. This avoids hanging when there's a Thread started
+          # before Resque calls Process.daemon (Jira RUBY-857)
+          def defer_for_resque?
+            NewRelic::Agent.config[:dispatcher] == :resque &&
+              !NewRelic::Agent::PipeChannelManager.listener.started?
+          end
+
           # Sanity-check the agent configuration and start the agent,
           # setting up the worker thread and the exit handler to shut
           # down the agent
@@ -475,6 +483,12 @@ module NewRelic
         # Logs a bunch of data and starts the agent, if needed
         def start
           return if already_started? || disabled?
+
+          if defer_for_resque?
+            ::NewRelic::Agent.logger.debug "Deferring startup for Resque in case it daemonizes"
+            return
+          end
+
           @started = true
           @local_host = determine_host
           log_startup

data/lib/new_relic/build.rb

@@ -1,2 +1,2 @@
-# GITSHA: 3d7e13a70958fa4cf64f0236dcf1a751da6824f7
-module NewRelic; module VERSION; BUILD='46.beta'; end; end
+# GITSHA: e81889c2bce97574ec682dafee12015e13ccb2e1
+module NewRelic; module VERSION; BUILD='48.beta'; end; end

data/lib/new_relic/latest_changes.rb

@@ -0,0 +1,31 @@
+#!/usr/bin/ruby
+
+module NewRelic
+  module LatestChanges
+    def self.default_changelog
+      File.join(File.dirname(__FILE__), '..', '..', 'CHANGELOG')
+    end
+
+    def self.read(changelog=default_changelog)
+      footer = <<'EOS'
+See https://github.com/newrelic/rpm/blob/master/CHANGELOG for a full list of
+changes.
+EOS
+
+      return footer unless File.exists?(changelog) 
+
+      version_count = 0
+      changes = []
+      File.read(changelog).each_line do |line|
+        if line.match(/##\s+v[\d.]+\s+##/)
+          version_count += 1
+        end
+        break if version_count >= 2
+        changes << line.chomp
+      end
+
+      changes << footer
+      change_message =  changes.join("\n")
+    end
+  end
+end

data/newrelic_rpm.gemspec

@@ -3,12 +3,13 @@
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'new_relic/version'
+require 'new_relic/latest_changes'
 
 Gem::Specification.new do |s|
   s.name = "newrelic_rpm"
   s.version = NewRelic::VERSION::STRING
   s.required_rubygems_version = Gem::Requirement.new("> 1.3.1") if s.respond_to? :required_rubygems_version=
-  s.authors = [ "Jason Clark", "Sam Goldstein", "Jon Guymon", "Ben Weintraub" ]
+  s.authors = [ "Jason Clark", "Sam Goldstein", "Michael Granger", "Jon Guymon", "Ben Weintraub" ]
   s.date = Time.now.strftime('%Y-%m-%d')
   s.description = <<-EOS
 New Relic is a performance management system, developed by New Relic,
@@ -38,22 +39,5 @@ EOS
   s.require_paths = ["lib"]
   s.rubygems_version = Gem::VERSION
   s.summary = "New Relic Ruby Agent"
-
-  version_count = 0
-  changes = []
-  File.read(File.join(File.dirname(__FILE__), 'CHANGELOG')).each_line do |line|
-    if line.match(/##\s+v[\d.]+\s+##/)
-      version_count += 1
-    end
-    break if version_count >= 2
-    changes << line.chomp
-  end
-
-  post_install_message = changes.join("\n")
-  post_install_message += <<'EOS'
-
-See https://github.com/newrelic/rpm/blob/master/CHANGELOG for a full list of
-changes.
-EOS
-  s.post_install_message = post_install_message
+  s.post_install_message = NewRelic::LatestChanges.read
 end

data/test/multiverse/.gitignore

@@ -8,3 +8,4 @@ Gemfile.lock
 .idea
 tags
 *.sqlite3
+*.pid

data/test/multiverse/suites/active_record/Envfile

@@ -3,7 +3,7 @@ gemfile <<-RB
     gem 'activerecord', '2.3.14'
   elsif RUBY_PLATFORM == 'java'
     gem 'activerecord-jdbcsqlite3-adapter', '1.2.2.1'
-    gem 'jdbc-sqlite3'
+    gem 'jdbc-sqlite3', '3.7.2'
     gem 'activerecord'
   else
     gem 'activerecord'

data/test/multiverse/suites/resque/Envfile

@@ -1,10 +1,11 @@
-suite_condition("Resque not compatible with 1.8.6") do
-  RUBY_VERSION != '1.8.6'
+suite_condition("Resque tests not compatible with 1.8.6, JRuby") do
+  RUBY_VERSION != '1.8.6' && RUBY_PLATFORM != 'java'
 end
 
 gemfile <<-RB
   gem 'resque'
   gem 'json'
+  gem 'rake'
   if (RUBY_PLATFORM == 'java')
     gem "jruby-openssl"
   end
@@ -12,6 +13,7 @@ RB
 
 before_suite do
   ENV["NEWRELIC_MULTIVERSE_REDIS_PORT"] = (20_000 + ($$ % 10_000)).to_s
+  ENV["NEWRELIC_MULTIVERSE_FAKE_COLLECTOR_PORT"] = (30_000 + ($$ % 10_000)).to_s
   system("echo 'port #{ENV["NEWRELIC_MULTIVERSE_REDIS_PORT"]}' | redis-server - > /dev/null &")
 end
 

data/test/multiverse/suites/resque/Rakefile

@@ -0,0 +1,2 @@
+require File.join(File.dirname(__FILE__), 'resque_setup')
+require 'resque/tasks'

data/test/multiverse/suites/resque/config/newrelic.yml

@@ -11,7 +11,7 @@ development:
   app_name: test
   host: 127.0.0.1
   api_host: 127.0.0.1
-  port: <%= 30_000 + ($$ % 10_000) %>
+  port: <%= ENV['NEWRELIC_MULTIVERSE_FAKE_COLLECTOR_PORT'] %>
   transaction_tracer:
     record_sql: obfuscated
     enabled: true

data/test/multiverse/suites/resque/instrumentation_test.rb

@@ -5,88 +5,133 @@ require 'test/unit'
 require 'logger'
 require 'newrelic_rpm'
 require 'fake_collector'
-
-REDIS_PORT = ENV["NEWRELIC_MULTIVERSE_REDIS_PORT"]
-
-class JobForTesting
-  @queue = :resque_test
-
-  def self.perform(key, val, sleep_duration=0)
-    sleep sleep_duration
-    Redis.new(:port => REDIS_PORT).set(key, val)
-  end
-end
+require File.join(File.dirname(__FILE__), 'resque_setup')
 
 class ResqueTest < Test::Unit::TestCase
   JOB_COUNT = 5
+  COLLECTOR_PORT = ENV['NEWRELIC_MULTIVERSE_FAKE_COLLECTOR_PORT']
 
   def setup
-    @redis = Redis.new(:port => REDIS_PORT)
-    Resque.redis = @redis
-
     $collector ||= NewRelic::FakeCollector.new
     $collector.reset
-    $collector.run
+    $collector.run(COLLECTOR_PORT)
+    $redis.del('queue:resque_test')
+    $redis.set('index_key', 0)
+    @pidfile = "resque_test.#{$$}.pid"
+    JOB_COUNT.times do |i|
+      Resque.enqueue(JobForTesting, 'index_key', i + 1)
+    end
+  end
 
-    NewRelic::Agent.manual_start
-    DependencyDetection.detect!
+  def teardown
+    File.unlink(@pidfile) if File.file?(@pidfile)
+  end
 
-    JOB_COUNT.times {|i| Resque.enqueue(JobForTesting, 'index_key', i + 1) }
-    worker = Resque::Worker.new(:resque_test)
-    Thread.new do
-      worker.work
-    end.abort_on_exception = true
+  def start_worker(opts={})
+    opts[:background] ? start_worker_background : start_worker_child
+  end
 
-    wait_for_jobs
-    worker.shutdown
+  def stop_worker(opts={})
+    opts[:background] ? stop_worker_background : stop_worker_child
+  end
 
-    NewRelic::Agent.shutdown
+  def start_worker_child
+    worker_cmd = "NEWRELIC_DISPATCHER=resque QUEUE=* bundle exec rake resque:work"
+    @worker_pid = Process.fork
+    Process.exec(worker_cmd) if @worker_pid.nil?
   end
 
-  def wait_for_jobs
-    # JRuby barfs in the timeout on trying to read from Redis.
-    time_for_jobs = 2
-    if defined?(JRuby)
-      sleep time_for_jobs
-    else
-      # Give a little time to complete, get out early if we're done....
-      Timeout::timeout(time_for_jobs) do
-        until Resque.info[:pending] == 0; end
-      end
-    end
+  def stop_worker_child
+    Process.kill("QUIT", @worker_pid)
+    Process.waitpid(@worker_pid)
   end
 
-  def teardown
-    @redis.set('index_key', 0)
-    Resque.redis.del('queue:resque_test')
-    $collector.reset
+  def start_worker_background
+    worker_cmd = "PIDFILE=#{@pidfile} TERM_CHILD=1 RESQUE_TERM_TIMEOUT=1 BACKGROUND=1 " +
+      "NEWRELIC_DISPATCHER=resque QUEUE=* bundle exec rake resque:work"
+    system(worker_cmd)
   end
 
-  def test_resque_instrumentation_is_installed
-    assert DependencyDetection.installed?(:resque)
+  def stop_worker_background
+    daemon_pid = File.read(@pidfile).to_i
+
+    tries = 0
+    while process_alive?(daemon_pid) && tries < 3
+      Process.kill('TERM', daemon_pid)
+      sleep 4 # default resque TERM timeout
+      tries += 1
+    end
+
+    if process_alive?(daemon_pid)
+      $stderr.puts "Oops. Daemon (pid #{daemon_pid}) is still running. Trying to halt it with SIGQUIT"
+      Process.kill('QUIT', daemon_pid)
+      sleep 1
+
+      # If it's still alive, someone will likely have to go kill the process manually. 
+      # Alternatively, we could kill -9 it, but I decided to err on the side of caution
+      if process_alive?(daemon_pid)
+        raise "Resque is zombified. You might have to clean up process #{daemon_pid} manually."
+      end
+    end
   end
 
-  def test_all_jobs_ran
-    assert_equal JOB_COUNT, @redis.get('index_key').to_i
+  def process_alive?(pid)
+    Process.kill(0, pid)
+    return true
+  rescue Errno::ESRCH
+    return false
   end
 
-  def test_agent_makes_only_one_metric_post
-    assert_equal(1, $collector.agent_data.select{|x| x.action == 'metric_data'}.size,
-                 "wrong number of metric_data posts in #{$collector.agent_data.inspect}")
+  def wait_for_jobs
+    time_for_jobs = 5
+    begin
+      Timeout.timeout(time_for_jobs) { sleep(0.1) until Resque.info[:pending].zero? }
+    rescue Timeout::Error => err
+      raise err.exception("waiting #{time_for_jobs}s for completion of #{JOB_COUNT} jobs")
+    end
   end
 
+  def run_worker(opts={})
+    begin
+      start_worker(opts)
+      wait_for_jobs
+    ensure
+      stop_worker(opts)
+    end
+  end
 
   METRIC_VALUES_POSITION = 3
 
-  def test_agent_posts_correct_call_count
-    test_metric = 'OtherTransaction/ResqueJob/all'
-    metric_data = $collector.calls_for('metric_data').first
+  def assert_metric_and_call_count(name, expected_call_count)
+    metric_data = $collector.calls_for('metric_data')
+    assert_equal(1, metric_data.size, "expected exactly one metric_data post from agent")
 
-    metric_names = metric_data[METRIC_VALUES_POSITION].map{|m| m[0]['name']}
-    assert(metric_names.include?(test_metric),
-           "#{metric_names.inspect} should include '#{test_metric}'")
+    metric = metric_data.first[METRIC_VALUES_POSITION].find { |m| m[0]['name'] == name }
+    assert(metric, "could not find metric named #{name}")
 
-    call_count = metric_data[METRIC_VALUES_POSITION].find{|m| m[0]['name'] == test_metric}[1][0]
-    assert_equal JOB_COUNT, call_count
+    call_count = metric[1][0]
+    assert_equal(expected_call_count, call_count)
+  end
+
+  def test_all_jobs_ran
+    run_worker
+    assert_equal(JOB_COUNT, $redis.get('index_key').to_i)
+  end
+
+  def test_agent_posts_correct_metric_data
+    run_worker
+    assert_metric_and_call_count('OtherTransaction/ResqueJob/all', JOB_COUNT)
+  end
+
+  if RUBY_VERSION >= '1.9'
+    def test_all_jobs_ran_background
+      run_worker(:background => true)
+      assert_equal(JOB_COUNT, $redis.get('index_key').to_i)
+    end
+
+    def test_agent_posts_correct_metric_data_background
+      run_worker(:background => true)
+      assert_metric_and_call_count('OtherTransaction/ResqueJob/all', JOB_COUNT)
+    end
   end
 end

data/test/multiverse/suites/resque/resque_setup.rb

@@ -0,0 +1,15 @@
+require 'resque'
+require 'newrelic_rpm'
+
+redis_port = ENV["NEWRELIC_MULTIVERSE_REDIS_PORT"]
+$redis = Redis.new(:port => redis_port)
+Resque.redis = $redis
+
+class JobForTesting
+  @queue = :resque_test
+
+  def self.perform(key, val, sleep_duration=0)
+    sleep sleep_duration
+    $redis.set(key, val)
+  end
+end

data/test/new_relic/agent/agent_test.rb

@@ -4,12 +4,40 @@ require 'new_relic/agent/thread_profiler'
 module NewRelic
   module Agent
     class AgentTest < Test::Unit::TestCase
+
       def setup
         super
         @agent = NewRelic::Agent::Agent.new
         @agent.service = NewRelic::FakeService.new
       end
 
+      #
+      # Helpers
+      #
+
+      def with_config( options )
+        config_source = NewRelic::Agent::Configuration::ManualSource.new( options )
+        NewRelic::Agent.config.apply_config( config_source )
+
+        yield
+
+      ensure
+        NewRelic::Agent.config.remove_config( config_source ) if config_source
+      end
+
+      def with_profile(opts)
+        profile = NewRelic::Agent::ThreadProfile.new(-1, 0, 0, true)
+        profile.aggregate(["chunky.rb:42:in `bacon'"], profile.traces[:other])
+        profile.instance_variable_set(:@finished, opts[:finished])
+
+        @agent.thread_profiler.instance_variable_set(:@profile, profile)
+        profile
+      end
+
+      #
+      # Tests
+      #
+
       def test_after_fork_reporting_to_channel
         @agent.stubs(:connected?).returns(true)
         @agent.after_fork(:report_to_channel => 123)
@@ -100,15 +128,6 @@ module NewRelic
                        .find{|data| data.action == :profile_data}.params)
       end
 
-      def with_profile(opts)
-        profile = NewRelic::Agent::ThreadProfile.new(-1, 0, 0, true)
-        profile.aggregate(["chunky.rb:42:in `bacon'"], profile.traces[:other])
-        profile.instance_variable_set(:@finished, opts[:finished])
-
-        @agent.thread_profiler.instance_variable_set(:@profile, profile)
-        profile
-      end
-
       def test_harvest_timeslice_data
         assert_equal({}, @agent.send(:harvest_timeslice_data),
                      'should return timeslice data')
@@ -278,6 +297,29 @@ module NewRelic
         @agent.service.expects(:connect)
         @agent.send(:connect, :force_reconnect => true)
       end
+
+      def test_defer_start_if_resque_dispatcher_and_channel_manager_isnt_started
+        NewRelic::Agent::PipeChannelManager.listener.expects(:started?).returns(false)
+
+        # :send_data_on_exit setting to avoid setting an at_exit
+        with_config( :send_data_on_exit => false, :dispatcher => :resque ) do
+          @agent.start
+        end
+
+        assert !@agent.started?
+      end
+
+      def test_doesnt_defer_start_if_resque_dispatcher_and_channel_manager_started
+        NewRelic::Agent::PipeChannelManager.listener.expects(:started?).returns(true)
+
+        # :send_data_on_exit setting to avoid setting an at_exit
+        with_config( :send_data_on_exit => false, :dispatcher => :resque ) do
+          @agent.start
+        end
+
+        assert @agent.started?
+      end
+
     end
   end
 end

metadata

@@ -1,18 +1,19 @@
 --- !ruby/object:Gem::Specification
 name: newrelic_rpm
 version: !ruby/object:Gem::Version
-  version: 3.5.6.46.beta
+  version: 3.5.6.48.beta
   prerelease: 9
 platform: ruby
 authors:
 - Jason Clark
 - Sam Goldstein
+- Michael Granger
 - Jon Guymon
 - Ben Weintraub
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-22 00:00:00.000000000 Z
+date: 2013-01-24 00:00:00.000000000 Z
 dependencies: []
 description: ! 'New Relic is a performance management system, developed by New Relic,
 
@@ -150,6 +151,7 @@ files:
 - lib/new_relic/delayed_job_injection.rb
 - lib/new_relic/helper.rb
 - lib/new_relic/language_support.rb
+- lib/new_relic/latest_changes.rb
 - lib/new_relic/local_environment.rb
 - lib/new_relic/merbtasks.rb
 - lib/new_relic/metric_data.rb
@@ -236,9 +238,10 @@ files:
 - test/multiverse/suites/rails/queue_time_test.rb
 - test/multiverse/suites/rails/view_instrumentation_test.rb
 - test/multiverse/suites/resque/Envfile
+- test/multiverse/suites/resque/Rakefile
 - test/multiverse/suites/resque/config/newrelic.yml
-- test/multiverse/suites/resque/dump.rdb
 - test/multiverse/suites/resque/instrumentation_test.rb
+- test/multiverse/suites/resque/resque_setup.rb
 - test/multiverse/suites/sinatra/Envfile
 - test/multiverse/suites/sinatra/config/newrelic.yml
 - test/multiverse/suites/sinatra/sinatra_metric_explosion_test.rb
@@ -435,31 +438,12 @@ files:
 - lib/new_relic/build.rb
 homepage: http://www.github.com/newrelic/rpm
 licenses: []
-post_install_message: ! "\n# New Relic Ruby Agent Release Notes #\n\n## v3.5.5 ##\n\n
-  \ * Add thread profiling support\n\n    Thread profiling performs statistical sampling
-  of backtraces of all threads\n    within your Ruby processes. This feature requires
-  MRI >= 1.9.2, and is\n    controlled via the New Relic web UI. JRuby support (in
-  1.9.x compat mode) is\n    considered experimental, due to issues with JRuby's Thread#backtrace.\n\n
-  \ * Add audit logging capability\n\n    The agent can now log all of the data it
-  sends to the New Relic servers to\n    a special log file for human inspection.
-  This feature is off by default, and\n    can be enabled by setting the audit_log.enabled
-  configuration key to true.\n    You may also control the location of the audit log
-  with the audit_log.path key. \n\n  * Use config system for dispatcher, framework,
-  and config file detection\n\n    Several aspects of the agent's configuration were
-  not being handled by the\n    configuration system.  Detection/configuration of
-  the dispatcher (e.g. passenger,\n    unicorn, resque), framework (e.g. rails3, sinatra),
-  and newrelic.yml\n    location are now handled via the Agent environment, manual,
-  and default\n    configuration sources.\n\n  * Updates to logging across the agent\n\n
-  \   We've carefully reviewed the logging messages that the agent outputs, adding\n
-  \   details in some cases, and removing unnecessary clutter. We've also altered\n
-  \   the startup sequence to ensure that we don't spam STDOUT with messages\n    during
-  initialization.\n\n  * Fix passing environment to manual_start()\n\n    Thanks to
-  Justin Hannus.  The :env key, when passed to Agent.manual_start,\n    can again
-  be used to specify which section of newrelic.yml is loaded.\n\n  * Rails 4 support\n\n
-  \   This release includes preliminary support for Rails 4 as of 4.0.0.beta.\n    Rails
-  4 is still in development, but the agent should work as expected for\n    people
-  who are experimenting with the beta.\n\nSee https://github.com/newrelic/rpm/blob/master/CHANGELOG
-  for a full list of\nchanges.\n"
+post_install_message: ! "\n# New Relic Ruby Agent Release Notes #\n\n## v3.5.6 ##\n\n
+  \ * Fix two Resque-related issues\n\n    Fixes a possible hang on exit of an instrumented
+  Resque master process\n    (https://github.com/defunkt/resque/issues/578), as well
+  as a file descriptor\n    leak that could occur during startup of the Resque master
+  process.\n\nSee https://github.com/newrelic/rpm/blob/master/CHANGELOG for a full
+  list of\nchanges.\n"
 rdoc_options:
 - --line-numbers
 - --inline-source