newrelic_rpm 3.9.1.236 → 3.9.2.239

data/lib/new_relic/recipes/capistrano3.rb

@@ -9,7 +9,7 @@ namespace :newrelic do
   # notifies New Relic of a deployment
   desc "Record a deployment in New Relic (newrelic.com)"
   task :notice_deployment do
-    on roles(:app) do
+    run_locally do
       rails_env = fetch(:newrelic_rails_env, fetch(:rails_env, "production"))
 
       require 'new_relic/cli/command.rb'
@@ -25,7 +25,7 @@ namespace :newrelic do
 
         unless scm == :none
           changelog ||= lookup_changelog
-          rev       = fetch(:current_revision)
+          rev       ||= fetch(:current_revision)
         end
 
         new_revision = rev

data/lib/new_relic/recipes/capistrano_legacy.rb

@@ -91,7 +91,7 @@ else
   instance = Capistrano::Configuration.instance
 
   if instance
-    instance.load &make_notify_task
+    instance.load(&make_notify_task)
   else
     make_notify_task.call
   end

data/lib/new_relic/timer_lib.rb

@@ -23,7 +23,7 @@ module NewRelic #:nodoc:
       require 'timeout'
       TimerLib = Timeout
     end
-  rescue LoadError => e
+  rescue LoadError
     require 'timeout'
     TimerLib = Timeout
   end

data/lib/new_relic/version.rb

@@ -12,11 +12,11 @@ module NewRelic
 
     MAJOR = 3
     MINOR = 9
-    TINY  = 1
+    TINY  = 2
 
     begin
       require File.join(File.dirname(__FILE__), 'build')
-    rescue LoadError => e
+    rescue LoadError
       BUILD = nil
     end
 

data/lib/tasks/config.html.erb

@@ -0,0 +1,28 @@
+<% sections.each do |(section_key, section_name, section_description, configs)| %>
+<h2 id="<%=section_key%>"><%=section_name%></h2>
+
+<%= "<p>#{section_description}</p>" unless section_description.nil? %>
+
+<dl class="clamshell-list">
+  <% configs.each do |config|%>
+  <!-- ********** <%= config[:key] %> ********** -->
+  <dt id="<%=config[:key]%>"><%=config[:key]%></dt>
+  <dd>
+  <table class="specs">
+    <tbody>
+      <tr>
+        <th>Type:</th>
+        <td><%=config[:type]%></td>
+      </tr>
+      <tr>
+        <th>Default:</th>
+        <td><%=config[:default]%></td>
+      </tr>
+    </tbody>
+  </table>
+
+  <p><%=config[:description]%></p>
+  </dd>
+  <% end %>
+</dl>
+<% end %>

data/lib/tasks/config.rake

@@ -0,0 +1,134 @@
+namespace :newrelic do
+  namespace :config do
+    desc "Describe available New Relic configuration settings."
+
+    GENERAL   = "general"
+    DISABLING = "disabling"
+
+    SECTION_DESCRIPTIONS = {
+      GENERAL              => 'These settings are available for agent configuration. Some settings depend on your New Relic subscription level.',
+      DISABLING            => 'These settings are available to disable different instrumentation during the agent startup.',
+      "transaction_tracer" => 'The <a href="/docs/apm/traces/transaction-traces/transaction-traces">transaction traces</a> feature collects detailed information on a selection of transactions, including a summary of the calling sequence, a breakdown of time spent, and a list of SQL queries and their query plans (on mysql and postgresql). Available features depend on your New Relic subscription level.',
+      "error_collector"    => 'The agent will collect and report all uncaught exceptions.  Several configuration options allow you to customize the error collection.',
+      "browser_monitoring" => "New Relic Browser's page load timing feature (sometimes referred to as real user monitoring or RUM) gives you insight into the performance real users are experiencing with your website. This is accomplished by measuring the time it takes for your users' browsers to download and render your web pages by injecting a small amount of JavaScript code into the header and footer of each page.",
+      "analytics_events"   => 'New Relic Insights is a software analytics resource to gather and visualize data about your software and what it says about your business. With it you can quickly and easily create real-time dashboards to get immediate answers about end-user experiences, clickstreams, mobile activities, and server transactions.'
+    }
+
+    NAME_OVERRIDES = {
+      "slow_sql"     => "Slow SQL",
+      "xray_session" => "X-Ray Session"
+    }
+
+    def output(format)
+      config_hash = build_config_hash
+      sections = flatten_config_hash(config_hash)
+
+      puts build_erb(format).result(binding)
+    end
+
+    def build_config_hash
+      sections = Hash.new {|hash, key| hash[key] = []}
+      NewRelic::Agent::Configuration::DEFAULTS.each do |key, value|
+        next unless value[:public]
+
+        section_key = GENERAL
+        section = key.to_s.match(/(.*)\.(.*)/)
+
+        if section
+          section_key = section[1]
+          key = section[2]
+        elsif key.to_s.match(/^disable_/)
+          section_key = DISABLING
+          key = key.to_s
+        end
+
+        sections[section_key] << {
+          :key         => format_key(section_key, key),
+          :type        => format_type(value[:type]),
+          :description => format_description(value),
+          :default     => format_default_value(value)
+        }
+      end
+      sections
+    end
+
+    def flatten_config_hash(config_hash)
+      sections = []
+      sections << pluck(GENERAL, config_hash)
+      sections << pluck("transaction_tracer", config_hash)
+      sections << pluck("error_collector",    config_hash)
+      sections << pluck("browser_monitoring", config_hash)
+      sections << pluck("analytics_events",   config_hash)
+      sections.concat(config_hash.to_a.sort_by { |a| a.first})
+
+      add_data_to_sections(sections)
+
+      sections
+    end
+
+    def add_data_to_sections(sections)
+      sections.each do |section|
+        section_key = section[0]
+        section.insert(1, format_name(section_key))
+        section.insert(2, SECTION_DESCRIPTIONS[section_key])
+      end
+    end
+
+    def format_key(section_key, key)
+      if section_key == GENERAL || section_key == DISABLING
+        key.to_s
+      else
+        "#{section_key}.#{key}"
+      end
+    end
+
+    def format_name(key)
+      name = NAME_OVERRIDES[key]
+      return name if name
+
+      key.split("_").
+          each { |fragment| fragment[0] = fragment[0].upcase }.
+          join(" ")
+    end
+
+    def format_type(type)
+      if type == NewRelic::Agent::Configuration::Boolean
+        "Boolean"
+      else
+        type
+      end
+    end
+
+    def format_description(value)
+      description = value[:description]
+      description = "**DEPRECATED** #{description}" if value[:deprecated]
+      description
+    end
+
+    def format_default_value(spec)
+      if spec[:default].is_a?(Proc)
+        '(Dynamic)'
+      else
+        spec[:default].inspect
+      end
+    end
+
+    def pluck(key, config_hash)
+      value = config_hash.delete(key)
+      [key, value]
+    end
+
+    def build_erb(format)
+      require 'erb'
+      path = File.join(File.dirname(__FILE__), "config.#{format}.erb")
+      template = File.read(File.expand_path(path))
+      ERB.new(template)
+    end
+
+    task :docs, [:format] => [] do |t, args|
+      require File.expand_path(File.join(File.dirname(__FILE__), "..", "new_relic", "agent", "configuration", "default_source.rb"))
+      format = args[:format] || "text"
+      output(format)
+    end
+  end
+end

data/lib/tasks/config.text.erb

@@ -0,0 +1,7 @@
+<% sections.each do |(section_key, section_name, section_description, configs)| %><% configs.each do |config|%>
+<%=config[:key]%>
+<%=config[:description]%>
+
+Type:    <%=config[:type]%>
+Default: <%=config[:default]%>
+------------------------------<% end %><% end %>

data/lib/tasks/install.rake

@@ -8,67 +8,4 @@ namespace :newrelic do
   task :thanks do
     puts "The Ruby agent team is grateful to Jim Weirich for his kindness and his code. He will be missed."
   end
-
-  namespace :config do
-    desc "Describe available New Relic configuration settings."
-
-    def output_text
-      NewRelic::Agent::Configuration::DEFAULTS.each do |key, value|
-        if value[:public]
-          puts "Setting:      #{key}"
-          if value[:type] == NewRelic::Agent::Configuration::Boolean
-            puts "Type:         Boolean"
-          else
-            puts "Type:         #{value[:type]}"
-          end
-          puts "Default:      #{format_default_value(value)}"
-
-          puts 'Description:  ' + value[:description]
-          puts "-" * (value[:description].length + 14)
-        end
-      end
-    end
-
-    def format_default_value(spec)
-      if spec[:default].is_a?(Proc)
-        '(Dynamic)'
-      else
-        spec[:default].inspect
-      end
-    end
-
-    def output_html
-      puts "<table>"
-      puts "<thead>"
-      puts "  <th>Setting</th>"
-      puts "  <th style='width: 15%'>Type</th>"
-      puts "  <th>Default</th>"
-      puts "  <th>Description</th>"
-      puts "</thead>"
-
-      NewRelic::Agent::Configuration::DEFAULTS.each do |key, value|
-        if value[:public]
-          puts "<tr>"
-          puts "  <td><a name='#{key}'></a>#{key}</td>"
-          puts "  <td>#{value[:type].to_s.gsub("NewRelic::Agent::Configuration::", "")}</td>"
-          puts "  <td>#{format_default_value(value)}</td>"
-          puts "  <td>#{value[:description]}</td>"
-          puts "</tr>"
-        end
-      end
-
-      puts "</table>"
-    end
-
-    task :docs, [:format] => [] do |t, args|
-      require File.expand_path(File.join(File.dirname(__FILE__), "..", "new_relic", "agent", "configuration", "default_source.rb"))
-
-      format = args[:format]
-      if format.nil? || format == "text"
-        output_text
-      else
-        output_html
-      end
-    end
-  end
 end

data/newrelic.yml

@@ -42,6 +42,13 @@ common: &default_settings
   #       - Ajax Service
   #       - All Services
   #
+  # Caution: If you change this name, a new application will appear in the New
+  # Relic user interface with the new name, and data will stop reporting to the
+  # app with the old name.
+  #
+  # See https://newrelic.com/docs/site/renaming-applications for more details
+  # on renaming your New Relic applications.
+  #
   app_name: <%= @app_name %>
 
   # When "true", the agent collects performance data about your

data/test/active_record_fixtures.rb

@@ -16,7 +16,7 @@ module ActiveRecordFixtures
     ActiveRecordFixtures::Order.teardown
     begin
       super
-    rescue => e
+    rescue
     end
   end
 
@@ -37,13 +37,13 @@ module ActiveRecordFixtures
 
     def self.check_for_table
       connection.table_exists?(self.table_name)
-    rescue => e
+    rescue
       false
     end
 
     def self.teardown
       def connection.log_info *args
-        super *args
+        super(*args)
       end
     end
   end
@@ -68,7 +68,7 @@ module ActiveRecordFixtures
     end
     def self.check_for_table
       connection.table_exists?(self.table_name) && connection.table_exists?('orders_shipments')
-    rescue => e
+    rescue
       false
     end
 

data/test/agent_helper.rb

@@ -63,6 +63,42 @@ def assert_equal_unordered(left, right)
   left.each { |element| assert_includes(right, element) }
 end
 
+def assert_audit_log_contains(audit_log_contents, needle)
+  # Original request bodies dumped to the log have symbol keys, but once
+  # they go through a dump/load, they're strings again, so we strip
+  # double-quotes and colons from the log, and the strings we searching for.
+  regex = /[:"]/
+  needle = needle.gsub(regex, '')
+  haystack = audit_log_contents.gsub(regex, '')
+  assert(haystack.include?(needle), "Expected log to contain '#{needle}'")
+end
+
+# Because we don't generate a strictly machine-readable representation of
+# request bodies for the audit log, the transformation into strings is
+# effectively one-way. This, combined with the fact that Hash traversal order
+# is arbitrary in Ruby 1.8.x means that it's difficult to directly assert that
+# some object graph made it into the audit log (due to different possible
+# orderings of the key/value pairs in Hashes that were embedded in the request
+# body). So, this method traverses an object graph and only makes assertions
+# about the terminal (non-Array-or-Hash) nodes therein.
+def assert_audit_log_contains_object(audit_log_contents, o, format)
+  case o
+  when Hash
+    o.each do |k,v|
+      assert_audit_log_contains_object(audit_log_contents, v, format)
+      assert_audit_log_contains_object(audit_log_contents, k, format)
+    end
+  when Array
+    o.each do |el|
+      assert_audit_log_contains_object(audit_log_contents, el, format)
+    end
+  when NilClass
+    assert_audit_log_contains(audit_log_contents, format == :json ? "null" : "nil")
+  else
+    assert_audit_log_contains(audit_log_contents, o.inspect)
+  end
+end
+
 def compare_metrics(expected, actual)
   actual.delete_if {|a| a.include?('GC/Transaction/') }
   assert_equal(expected.to_a.sort, actual.to_a.sort, "extra: #{(actual - expected).to_a.inspect}; missing: #{(expected - actual).to_a.inspect}")
@@ -341,14 +377,9 @@ def find_all_segments_with_name_matching(transaction_sample, regexes)
   matching_segments
 end
 
-def with_config(config_hash, opts={})
-  opts = { :level => 0, :do_not_cast => false }.merge(opts)
-  if opts[:do_not_cast]
-    config = config_hash
-  else
-    config = NewRelic::Agent::Configuration::DottedHash.new(config_hash)
-  end
-  NewRelic::Agent.config.add_config_for_testing(config, opts[:level])
+def with_config(config_hash, at_start=true)
+  config = NewRelic::Agent::Configuration::DottedHash.new(config_hash, true)
+  NewRelic::Agent.config.add_config_for_testing(config, at_start)
   begin
     yield
   ensure
@@ -356,6 +387,12 @@ def with_config(config_hash, opts={})
   end
 end
 
+def with_config_low_priority(config_hash)
+  with_config(config_hash, false) do
+    yield
+  end
+end
+
 def freeze_time(now=Time.now)
   Time.stubs(:now).returns(now)
   now
@@ -444,11 +481,7 @@ end
 
 def with_array_logger(level=:info)
   orig_logger = NewRelic::Agent.logger
-  config = {
-      :log_file_path => nil,
-      :log_file_name => nil,
-      :log_level => level,
-    }
+  config = { :log_level => level }
   logdev = ArrayLogDevice.new
   override_logger = Logger.new(logdev)
 
@@ -481,11 +514,7 @@ def with_ignore_error_filter(filter, &blk)
 
   yield
 ensure
-  if original_filter.nil?
-    NewRelic::Agent.instance.error_collector.clear_ignore_error_filter
-  else
-    NewRelic::Agent.ignore_error_filter(&original_filter)
-  end
+  NewRelic::Agent::ErrorCollector.ignore_error_filter = original_filter
 end
 
 def json_dump_and_encode(object)
@@ -496,6 +525,17 @@ def get_last_analytics_event
   NewRelic::Agent.agent.instance_variable_get(:@request_sampler).samples.last
 end
 
+def swap_instance_method(target, method_name, new_method_implementation, &blk)
+  old_method_implementation = target.instance_method(method_name)
+  target.send(:define_method, method_name, new_method_implementation)
+  yield
+rescue NameError => e
+  puts "Your target does not have the instance method #{method_name}"
+  puts e.inspect
+ensure
+  target.send(:define_method, method_name, old_method_implementation)
+end
+
 def cross_agent_tests_dir
   File.expand_path(File.join(File.dirname(__FILE__), 'fixtures', 'cross_agent_tests'))
 end