newrelic_rpm 3.9.5.251 → 3.9.6.257

data/CHANGELOG

@@ -1,5 +1,76 @@
 # New Relic Ruby Agent Release Notes #
 
+## v3.9.6 ##
+
+  * Rails 4.2 ActiveJob support
+
+  A new version of Rails is coming! One of the highlight features is
+  ActiveJob, a framework for interacting with background job processors. This
+  release of the Ruby agent adds instrumentation to give you insight into
+  ActiveJob, whether you're just testing it out or running it for real.
+
+  Metrics are recorded around enqueuing ActiveJobs, and background transactions
+  are started for any ActiveJob performed where the agent didn't already
+  provide specific instrumentation (such as DelayedJob, Resque and Sidekiq).
+
+  Since Rails 4.2 is still in beta we'd love to hear any feedback on this
+  instrumentation so it'll be rock solid for the general release!
+
+  * Ruby 2.2.0-preview1 updates
+
+  Ruby 2.2.0 is on its way later in the year, and the Ruby agent is ready for
+  it. Updates to the GC stats and various other small changes have already been
+  applied, and our automated tests are running against 2.2.0 so the agent will
+  be ready on release day.
+
+  * Ignoring transactions by URL
+
+  While you could always ignore transactions by controller and action, the
+  Ruby agent previously lacked a way to ignore by specific URLs or patterns
+  without code changes. This release adds the config setting,
+  `rules.ignore_url_regexes` to ignore specific transactions based on the
+  request URL as well. For more information, see the documentation at:
+  https://docs.newrelic.com/docs/agents/ruby-agent/installation-configuration/ignoring-specific-transactions#config-ignoring
+
+  * Better dependency detection in non-Rack applications
+
+  The Ruby agent runs dependency detection at key points in the Rack and Rails
+  lifecycle, but non-Rails apps could occasionally miss out instrumenting late
+  loaded libraries. The agent now runs an additional dependency detection
+  during manual_start to more seamlessly install instrumentation in any app.
+
+  * Excluding /newrelic routes from developer mode
+
+  Recent changes to track time in middleware resulted in New Relic's developer
+  mode capturing its own page views in the list. This has been fixed. Thanks
+  to Ignatius Reza Lesmana for the report!
+
+  * Spikes in external time
+
+  Timeouts during certain external HTTP requests could result in incorrect
+  large spikes in the time recorded by the agent. This has been fixed.
+
+  * Recognize browser_monitoring.auto_instrument setting in non-Rails apps
+
+  The `browser_monitoring.auto_instrument` config setting disables
+  auto-injection of JavaScript into your pages, but was not properly obeyed in
+  Sinatra and other non-Rails contexts.  This has been fixed.
+
+  * Failures to gather CPU thread time on JRuby
+
+  JRuby running on certain JVM's and operating systems (FreeBSD in particular)
+  did not always support the method being used to gather CPU burn metrics.
+  This would result in a failure during those transactions. This has been
+  fixed.
+
+  * Fix for rare race condition in Resque instrumentation
+
+  A race condition in the agent's Resque instrumentation that could cause rare
+  Resque job failures in high-throughput Resque setups has been fixed. This bug
+  would manifest as an exception with the following error message:
+  "RuntimeError: can't add a new key into hash during iteration" and a backtrace
+  leading through the PipeChannelManager class in the agent.
+
 ## v3.9.5 ##
 
   * Per-dyno data on Heroku
@@ -22,10 +93,10 @@
   (including Rails and Sinatra apps) and include them under the httpResponseCode
   attribute on events sent to Insights.
 
-  * Stricter limits on memory usage of metrics and SQL traces
+  * Stricter limits on memory usage of SQL traces
 
-  The agent now imposes stricter limits on the number of distinct SQL traces and
-  metrics that it will buffer in memory at any point in time, leading to more
+  The agent now imposes stricter limits on the number of distinct SQL traces
+  that it will buffer in memory at any point in time, leading to more
   predictable memory consumption even in exceptional circumstances.
 
   * Improved reliability of thread profiling

data/GUIDELINES_FOR_CONTRIBUTING.md

@@ -1,18 +1,19 @@
 # Guidelines for Contributing Code
 
-At New Relic we welcome community code contributions to the Ruby Agent, and have
+At New Relic we welcome community code contributions to the Ruby agent, and have
 taken effort to make this process easy for both contributors and our development
 team.
 
-When contributing keep in mind that the agent runs in a wide variety of ruby
-language implementations (e.g. 1.8.6, 1.8.7, 1.9.x, jruby, etc.) as well as a
-wide variety of application environments (e.g. rails, sinatra, roll-your-own,
-etc., etc.)
+When contributing, keep in mind that the agent runs in a wide variety of Ruby
+language implementations (e.g. 1.8.7, 1.9.x, 2.x.x, jruby, rbx, etc.) as well as
+a wide variety of application environments (e.g. Rails, Sinatra, roll-your-own,
+etc.) See https://docs.newrelic.com/docs/agents/ruby-agent/getting-started/new-relic-ruby#compat
+for the current full list.
 
-Because of this we need to be more defensive in our coding practices than most
-projects.  Syntax must be compatible with all supported ruby implementations
+Because of this, we need to be more defensive in our coding practices than most
+projects. Syntax must be compatible with all supported Ruby implementations
 (e.g. no 1.9 specific hash syntax) and we can't assume the presence of any
-specific libraries such as `ActiveSupport`.
+specific libraries, including `ActiveSupport`, `ActiveRecord`, etc.
 
 ## Testing
 
@@ -31,15 +32,15 @@ Running the test suite is simple.  Just invoke:
     bundle exec rake
 
 This will run the unit tests in standalone mode, bootstrapping a basic Rails
-3.2 environment for the agent to instrument then executing the test suite.
+3.2 environment for the agent to instrument, then executing the test suite.
 
 These tests are setup to run automatically in
-[travis-ci](https://travis-ci.org/newrelic/rpm) under several Ruby implementations.
-When you've pushed your changes to github you can confirm that the travis-ci
-build passes for your fork of the codebase.
+[Travis CI](https://travis-ci.org/newrelic/rpm) under several Ruby implementations.
+When you've pushed your changes to GitHub, you can confirm that the Travis
+build passes for your fork.
 
-Additionally, our own CI jobs runs these tests under multiple versions of Rails to
-verify compatibility.
+Additionally, our own CI jobs runs these tests under multiple versions of Rails
+to verify compatibility.
 
 ### Writing Tests
 
@@ -57,7 +58,7 @@ chances it will be accepted.
 ### Functional Testing
 
 For cases where the unit test environment is not sufficient for testing a
-change (e.g. instrumentation for a non-rails framework, not available in the
+change (e.g. instrumentation for a non-Rails framework, not available in the
 unit test environment), we have a functional testing suite called multiverse.
 These tests can be run by invoking:
 
@@ -74,3 +75,6 @@ that you are granting New Relic a non-exclusive, non-revokable, no-cost license
 to use the code, algorithms, patents, and ideas in that code in our products if
 we so choose. You also agree the code is provided as-is and you provide no
 warranties as to its fitness or correctness for any purpose.
+
+If you have any feedback on how we can make contributing easier, please get in
+touch at [support.newrelic.com](http://support.newrelic.com) and let us know!

data/README.md

@@ -67,7 +67,7 @@ The initial configuration is done in the `newrelic.yml` file.  This file
 is by default read from the `config` directory of the application root
 and is subsequently searched for in the application root directory,
 and then in a `~/.newrelic` directory.  Once you're up and running you can
-enable Server Side Config and manage your newrelic configuation from the web
+enable Server Side Config and manage your newrelic configuration from the web
 UI.
 
 #### Rails Installation

data/Rakefile

@@ -73,7 +73,7 @@ end
 desc 'Record build number and stage'
 task :record_build, [ :build_number, :stage ] do |t, args|
   build_string = args.build_number
-  build_string << ".#{args.stage}" if args.stage
+  build_string << ".#{args.stage}" unless args.stage.nil? || args.stage.empty?
 
   gitsha = File.exists?(".git") ? `git rev-parse HEAD` : "Unknown"
   gitsha.chomp!
@@ -125,6 +125,27 @@ task :update_ca_bundle do |t|
   puts "Done, please commit your changes to #{bundle_path}"
 end
 
+namespace :cross_agent_tests do
+  cross_agent_tests_upstream_path = File.expand_path(File.join(File.dirname(__FILE__), '..', 'cross_agent_tests'))
+  cross_agent_tests_local_path    = File.expand_path(File.join(File.dirname(__FILE__), 'test', 'fixtures', 'cross_agent_tests'))
+
+  desc 'Pull latest changes from cross_agent_tests repo'
+  task :pull do
+    puts "Updating embedded cross_agent_tests from #{cross_agent_tests_upstream_path}..."
+    cmd = "rsync -avu --exclude .git #{cross_agent_tests_upstream_path}/ #{cross_agent_tests_local_path}/"
+    puts cmd
+    system(cmd)
+  end
+
+  desc 'Copy changes from embedded cross_agent_tests to official repo working copy'
+  task :push do
+    puts "Copying changes from embedded cross_agent_tests to #{cross_agent_tests_upstream_path}..."
+    cmd = "rsync -avu #{cross_agent_tests_local_path}/ #{cross_agent_tests_upstream_path}/"
+    puts cmd
+    system(cmd)
+  end
+end
+
 task :console do
   require 'pry'
   require 'newrelic_rpm'

data/lib/new_relic/agent/agent.rb

@@ -298,6 +298,14 @@ module NewRelic
             ::NewRelic::Agent.logger.info "Application: #{Agent.config.app_names.join(", ")}"
           end
 
+          def log_ignore_url_regexes
+            regexes = NewRelic::Agent.config[:'rules.ignore_url_regexes']
+
+            unless regexes.empty?
+              ::NewRelic::Agent.logger.info "Ignoring URLs that match the following regexes: #{regexes.map(&:inspect).join(", ")}."
+            end
+          end
+
           # Logs the configured application names
           def app_name_configured?
             names = Agent.config.app_names
@@ -495,6 +503,10 @@ module NewRelic
           log_startup
           check_config_and_start_agent
           log_version_and_pid
+
+          events.subscribe(:finished_configuring) do
+            log_ignore_url_regexes
+          end
         end
 
         # Clear out the metric data, errors, and transaction traces, etc.
@@ -570,11 +582,11 @@ module NewRelic
             @event_loop.on(:report_data) do
               transmit_data
             end
-            @event_loop.on(:report_transaction_event_data) do
-              transmit_transaction_event_data
+            @event_loop.on(:report_event_data) do
+              transmit_event_data
             end
             @event_loop.fire_every(Agent.config[:data_report_period],       :report_data)
-            @event_loop.fire_every(report_period_for(:analytic_event_data), :report_transaction_event_data)
+            @event_loop.fire_every(report_period_for(:analytic_event_data), :report_event_data)
             @event_loop.run
           end
 
@@ -1019,7 +1031,7 @@ module NewRelic
           end
         end
 
-        def transmit_transaction_event_data
+        def transmit_event_data
           now = Time.now
           ::NewRelic::Agent.logger.debug "Sending analytics data to New Relic Service"
 
@@ -1071,7 +1083,7 @@ module NewRelic
 
               @events.notify(:before_shutdown)
               transmit_data
-              transmit_transaction_event_data
+              transmit_event_data
 
               if @connected_pid == $$ && !@service.kind_of?(NewRelic::Agent::NewRelicService)
                 ::NewRelic::Agent.logger.debug "Sending New Relic service agent run shutdown message"

data/lib/new_relic/agent/agent_logger.rb

@@ -145,6 +145,10 @@ module NewRelic
         @already_logged
       end
 
+      def clear_already_logged
+        @already_logged = {}
+      end
+
       def wants_stdout?
         ::NewRelic::Agent.config[:log_file_path].upcase == "STDOUT"
       end

data/lib/new_relic/agent/configuration/default_source.rb

@@ -27,6 +27,11 @@ module NewRelic
           result
         end
 
+        def self.transform_for(key)
+          default_settings = ::NewRelic::Agent::Configuration::DEFAULTS[key]
+          default_settings[:transform] if default_settings
+        end
+
         def self.config_search_paths
           Proc.new {
             paths = [
@@ -182,6 +187,25 @@ module NewRelic
         def self.monitor_mode
           Proc.new { NewRelic::Agent.config[:enabled] }
         end
+
+        def self.rules_ignore
+          Proc.new do |rules|
+            rules = convert_to_list(rules)
+
+            rules.map do |rule|
+              /#{rule}/
+            end
+          end
+        end
+
+        def self.convert_to_list(value)
+          case value
+          when String
+            value.split(',')
+          else
+            value
+          end
+        end
       end
 
       AUTOSTART_BLACKLISTED_RAKE_TASKS = [
@@ -595,6 +619,13 @@ module NewRelic
           :type => Boolean,
           :description => 'Enable or disable active record instrumentation.'
         },
+        :disable_activejob => {
+          :default => false,
+          :public => true,
+          :type => Boolean,
+          :dynamic_name => true,
+          :description => 'Enable or disable ActiveJob instrumentation.'
+        },
         :disable_memcache_instrumentation => {
           :default => false,
           :public => true,
@@ -1032,6 +1063,12 @@ module NewRelic
           :type         => Boolean,
           :description  => 'Defines whether the agent will wrap third-party middlewares in instrumentation (regardless of whether they are installed via Rack::Builder or Rails).'
         },
+        :disable_rails_middleware => {
+          :default      => false,
+          :public       => false,
+          :type         => Boolean,
+          :description  => 'Internal name for controlling Rails 3+ middleware instrumentation'
+        },
         :'heroku.use_dyno_names' => {
           :default      => true,
           :public       => true,
@@ -1068,7 +1105,14 @@ module NewRelic
           :public       => true,
           :type         => String,
           :description  => "Manual override for the path to your local CA bundle. This CA bundle will be used to validate the SSL certificate presented by New Relic's data collection service."
-        }
+        },
+        :'rules.ignore_url_regexes' => {
+          :default      => [],
+          :public       => true,
+          :type         => Array,
+          :transform    => DefaultSource.rules_ignore,
+          :description  => 'A list of patterns that will cause a transaction to be ignored if any of them match the URI.'
+         }
       }.freeze
 
     end

data/lib/new_relic/agent/configuration/manager.rb

@@ -115,17 +115,46 @@ module NewRelic
           config_stack.each do |config|
             next unless config
             accessor = key.to_sym
+
             if config.has_key?(accessor)
-              if config[accessor].respond_to?(:call)
-                return instance_eval(&config[accessor])
-              else
-                return config[accessor]
+              evaluated = evaluate_procs(config[accessor])
+
+              begin
+                return apply_transformations(accessor, evaluated)
+              rescue
+                next
               end
             end
           end
+
           nil
         end
 
+        def evaluate_procs(value)
+          if value.respond_to?(:call)
+            instance_eval(&value)
+          else
+            value
+          end
+        end
+
+        def apply_transformations(key, value)
+          if transform = transform_from_default(key)
+            begin
+              transform.call(value)
+            rescue => e
+              ::NewRelic::Agent.logger.error("Error applying transformation for #{key}, falling back to #{value}.", e)
+              raise e
+            end
+          else
+            value
+          end
+        end
+
+        def transform_from_default(key)
+          ::NewRelic::Agent::Configuration::DefaultSource.transform_for(key)
+        end
+
         def register_callback(key, &proc)
           @callbacks[key] << proc
           proc.call(@cache[key])
@@ -134,6 +163,7 @@ module NewRelic
         def invoke_callbacks(direction, source)
           return unless source
           source.keys.each do |key|
+
             if @cache[key] != source[key]
               @callbacks[key].each do |proc|
                 if direction == :add
@@ -224,10 +254,9 @@ module NewRelic
         end
 
         def break_label_string_into_pairs(labels)
-          # Strip whitespaces immediately before and after colons or semicolons
-          stripped_labels = labels.gsub(/\s*(:|;)\s*/, '\1')
+          stripped_labels = labels.strip
           stripped_labels.split(';').map do |pair|
-            pair.split(':')
+            pair.split(':').map(&:strip)
           end
         end
 
@@ -259,6 +288,7 @@ module NewRelic
           end
 
           pairs = limit_number_of_labels(pairs)
+          pairs = remove_duplicates(pairs)
           pairs.map do |key, value|
             {
               'label_type'  => truncate(key),
@@ -290,6 +320,12 @@ module NewRelic
           end
         end
 
+        # We only take the last value provided for a given label type key
+        def remove_duplicates(pairs)
+          grouped_by_type = pairs.group_by(&:first)
+          grouped_by_type.values.map(&:last)
+        end
+
         def parse_labels_from_dictionary
           make_label_hash(NewRelic::Agent.config[:labels])
         end

data/lib/new_relic/agent/cross_app_monitor.rb

@@ -89,8 +89,6 @@ module NewRelic
         txn_header = from_headers(request_headers, NEWRELIC_TXN_HEADER_KEYS) or return
         txn_header = obfuscator.deobfuscate(txn_header)
         txn_info = NewRelic::JSONWrapper.load(txn_header)
-        NewRelic::Agent.logger.debug("Referring txn_info: %p" % [txn_info])
-
         state.referring_transaction_info = txn_info
       end
 
@@ -170,7 +168,6 @@ module NewRelic
 
         referring_guid = client_referring_transaction_guid(state)
         if referring_guid
-          NewRelic::Agent.logger.debug "Referring transaction guid: %p" % [referring_guid]
           NewRelic::Agent.add_custom_parameters(:referring_transaction_guid => referring_guid)
         end
       end