newrelic_rpm 4.2.0.334 → 4.3.0.335

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: eed94154d98e333b8c2c091ff3630815d4165045
-  data.tar.gz: 4206e75fd386e8f3ea148aba808854a2ec5cb91f
+  metadata.gz: 4c39aaf49c14d8f52c0ad1551e36d973c7ec9130
+  data.tar.gz: dda64be5f11fe80294aaac0c4435442aabdd69f2
 SHA512:
-  metadata.gz: 31f37e060cab1014f3c2163b890eb2e68d8296a06146360187121250e93291eb9fb2399ef0b18e14604ee0b0fc2563e55494844a1bf0705df4199a3b71eb73ef
-  data.tar.gz: fb5e6ddacced4c1d72e703582da15fa099bddddb32ca7cc0c535aadbd11faa48b76454094d30ac03e13cae234670906f63c57365d360b082864fc7133df24f65
+  metadata.gz: 504238d5388bcc1857fe19282a581f5011597c9a21484c321a7696628a2f078b6c232e1f2a11c417440b07db9860892a6a1a6448d1b9c64c61e289096130f1b5
+  data.tar.gz: 04b9adc55208fb75aa0437aadf72a7daf7c74730f55b0f3c9658dd38cafb7d5ca3170f80154036eebbe0d6eddacb1c468f54c28e1e0eaeca728698a226a08b02

data/.travis.yml

@@ -2,6 +2,7 @@ services:
   - mysql
   - redis-server
   - memcached
+  - rabbitmq
 
 language: ruby
 
@@ -31,7 +32,7 @@ notifications:
 
 rvm:
   # Run slowest builds first to try and optimize overall cycle time.
-  - jruby-9.1.8.0
+  - jruby-9.1.12.0
   - 2.4.1
   - 2.3.4
   - 2.2.7
@@ -140,15 +141,15 @@ matrix:
       env: TYPE=UNIT ENVIRONMENT=rails51
 
     # jruby 9.0
-    - rvm: jruby-9.1.8.0
+    - rvm: jruby-9.1.12.0
       env: TYPE=UNIT ENVIRONMENT=rails21
-    - rvm: jruby-9.1.8.0
+    - rvm: jruby-9.1.12.0
       env: TYPE=UNIT ENVIRONMENT=rails22
-    - rvm: jruby-9.1.8.0
+    - rvm: jruby-9.1.12.0
       env: TYPE=UNIT ENVIRONMENT=rails23
-    - rvm: jruby-9.1.8.0
+    - rvm: jruby-9.1.12.0
       env: TYPE=UNIT ENVIRONMENT=rails30
-    - rvm: jruby-9.1.8.0
+    - rvm: jruby-9.1.12.0
       env: TYPE=UNIT ENVIRONMENT=rails31
-    - rvm: jruby-9.1.8.0
+    - rvm: jruby-9.1.12.0
       env: TYPE=UNIT ENVIRONMENT=rails32

data/CHANGELOG.md

@@ -1,5 +1,49 @@
 # New Relic Ruby Agent Release Notes #
 
+## v4.3.0 ##
+
+  * Instrumentation for the Bunny AMQP Client
+
+  The Bunny AMQP Client is now automatically instrumented. The agent will
+  report data for messages sent and received by an application. Data on messages
+  is available in both APM and Insights. Applications connected through a
+  RabbitMQ exchange will now also be visible on Service Maps as part of Cross
+  Application Tracing. See the [message queues documentation page](https://docs.newrelic.com/docs/agents/ruby-agent/features/message-queues)
+  for more details.
+
+  * Safely normalize external hostnames
+
+  The agent has been updated to check for nil host values before downcasing the
+  hostname. Thanks Rafael Valério for the contribution!
+
+  * PageView events will not be generated for ignored transactions
+
+  The agent now checks if transaction is ignored before injecting the New Relic
+  Browser Agent. This will prevent PageView events from being generated for
+  ignored transactions.
+
+  * Datastores required explicitly in agent
+
+  The agent has been modified to explicity `require` the Datastores module
+  whereas previously there were situations where the module could be
+  implicitly defined. Thanks Kevin Griffin for the contribution!
+
+  * Clear transaction state after forking
+
+  Previously, if a transaction was started and the process forks, the transaction
+  state survived the fork and `#after_fork` call in thread local storage. Now,
+  this state is cleared by `#after_fork`.
+
+  * Postgis adapter reports as Postgres for datastores
+
+  The agent now maps the Postgis adapter to Postgres for datastore metrics.
+  Thanks Vojtěch Vondra for the contribution!
+
+  * Deprecate `:trace_only` option
+
+  The `NewRelic::Agent.notice_error` API has been updated to deprecate the
+  `:trace_only` option in favor of `:expected`.
+
 ## v4.2.0 ##
 
   * Sinatra 2.0 and Padrino 0.14.x Support

data/lib/new_relic/agent.rb

@@ -47,6 +47,7 @@ module NewRelic
     require 'new_relic/agent/busy_calculator'
     require 'new_relic/agent/sampler'
     require 'new_relic/agent/database'
+    require 'new_relic/agent/datastores'
     require 'new_relic/agent/pipe_channel_manager'
     require 'new_relic/agent/configuration'
     require 'new_relic/agent/rules_engine'
@@ -211,7 +212,7 @@ module NewRelic
     # @param [Exception] exception Error you wish to send
     # @param [Hash]      options Modify how New Relic processes the error
     # @option options [Hash]    :custom_params Custom parameters to attach to the trace
-    # @option options [Boolean] :trace_only Only record the error trace
+    # @option options [Boolean] :expected Only record the error trace
     #                           (do not affect error rate or Apdex status)
     # @option options [String]  :uri Request path, minus request params or query string
     #                           (usually not needed)
@@ -235,6 +236,13 @@ module NewRelic
     # @api public
     #
     def notice_error(exception, options={})
+
+      if options.has_key?(:trace_only)
+        NewRelic::Agent.logger.log_once(:warn, :trace_only_deprecated,
+          'Passing the :trace_only option to NewRelic::Agent.notice_error is deprecated. Please use :expected instead.')
+        options[:expected] = options.delete(:trace_only)
+      end
+
       Transaction.notice_error(exception, options)
       nil # don't return a noticed error datastructure. it can only hurt.
     end

data/lib/new_relic/agent/agent.rb

@@ -543,6 +543,7 @@ module NewRelic
           @transaction_event_recorder.drop_buffered_data
           @custom_event_aggregator.reset!
           @sql_sampler.reset!
+          TransactionState.tl_clear
         end
 
         # Clear out state for any objects that we know lock from our parents

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

@@ -874,6 +874,13 @@ module NewRelic
           :allowed_from_server => false,
           :description  => 'Disables installation of Redis instrumentation. Standard key to use is disable_redis.'
         },
+        :'message_tracer.segment_parameters.enabled' => {
+          :default      => true,
+          :public       => true,
+          :type         => Boolean,
+          :allowed_from_server => true,
+          :description  => 'If <code>true</code>, the agent will collect metadata about messages and attach them as segment parameters.'
+        },
         :'slow_sql.enabled' => {
           :default => value_of(:'transaction_tracer.enabled'),
           :public => true,
@@ -1230,6 +1237,14 @@ module NewRelic
           :allowed_from_server => false,
           :description  => 'If <code>true</code>, disables instrumentation for ActiveRecord 5.'
         },
+        :disable_bunny => {
+          :default      => false,
+          :public       => true,
+          :type         => Boolean,
+          :dynamic_name => true,
+          :allowed_from_server => false,
+          :description  => 'If <code>true</code>, disables instrumentation for the bunny gem.'
+        },
         :disable_curb => {
           :default      => false,
           :public       => true,

data/lib/new_relic/agent/cross_app_monitor.rb

@@ -33,12 +33,12 @@ module NewRelic
           debug("Wiring up Cross Application Tracing to events after finished configuring")
 
         events.subscribe(:before_call) do |env| #THREAD_LOCAL_ACCESS
-          if should_process_request(env)
+          if id = decoded_id(env) and should_process_request?(id)
             state = NewRelic::Agent::TransactionState.tl_get
 
-            save_client_cross_app_id(state, env)
+            state.client_cross_app_id = id
             save_referring_transaction_info(state, env)
-            set_transaction_attributes(state)
+            CrossAppTracing.assign_intrinsic_transaction_attributes state
           end
         end
 
@@ -50,14 +50,6 @@ module NewRelic
 
       end
 
-      def save_client_cross_app_id(state, request_headers)
-        state.client_cross_app_id = decoded_id(request_headers)
-      end
-
-      def clear_client_cross_app_id(state)
-        state.client_cross_app_id = nil
-      end
-
       def save_referring_transaction_info(state, request_headers)
         txn_header = request_headers[NEWRELIC_TXN_HEADER_KEY] or return
         txn_info = deserialize_header(txn_header, NEWRELIC_TXN_HEADER)
@@ -93,30 +85,19 @@ module NewRelic
               content_length = content_length_from_request(request_headers)
 
               set_response_headers(state, response_headers, timings, content_length)
-              set_metrics(state.client_cross_app_id, timings)
             end
           end
-          clear_client_cross_app_id(state)
         end
       end
 
-      def should_process_request(request_headers)
-        return cross_app_enabled? && trusts?(request_headers)
+      def should_process_request? id
+        return cross_app_enabled? && CrossAppTracing.trusts?(id)
       end
 
       def cross_app_enabled?
         NewRelic::Agent::CrossAppTracing.cross_app_enabled?
       end
 
-      # Expects an ID of format "12#345", and will only accept that!
-      def trusts?(request)
-        id = decoded_id(request)
-        split_id = id.match(/(\d+)#\d+/)
-        return false if split_id.nil?
-
-        NewRelic::Agent.config[:trusted_account_ids].include?(split_id.captures.first.to_i)
-      end
-
       def set_response_headers(state, response_headers, timings, content_length)
         response_headers[NEWRELIC_APPDATA_HEADER] = build_payload(state, timings, content_length)
       end
@@ -133,26 +114,6 @@ module NewRelic
         payload = obfuscator.obfuscate(::JSON.dump(payload))
       end
 
-      def set_transaction_attributes(state)
-        # We expect to get the before call to set the id (if we have it) before
-        # this, and then write our custom parameter when the transaction starts
-        return unless txn = state.current_transaction
-
-        if state.client_cross_app_id
-          txn.attributes.add_intrinsic_attribute(:client_cross_process_id, state.client_cross_app_id)
-        end
-
-        referring_guid = client_referring_transaction_guid(state)
-        if referring_guid
-          txn.attributes.add_intrinsic_attribute(:referring_transaction_guid, referring_guid)
-        end
-      end
-
-      def set_metrics(id, timings)
-        metric_name = "ClientApplication/#{id}/all"
-        NewRelic::Agent.record_metric(metric_name, timings.app_time_in_seconds)
-      end
-
       def decoded_id(request)
         encoded_id = request[NEWRELIC_ID_HEADER_KEY]
         return "" if encoded_id.nil?

data/lib/new_relic/agent/cross_app_tracing.rb

@@ -21,6 +21,10 @@ module NewRelic
       # The cross app synthetics header
       NR_SYNTHETICS_HEADER = 'X-NewRelic-Synthetics'.freeze
 
+      NR_MESSAGE_BROKER_ID_HEADER  = 'NewRelicID'.freeze
+      NR_MESSAGE_BROKER_TXN_HEADER = 'NewRelicTransaction'.freeze
+      NR_MESSAGE_BROKER_SYNTHETICS_HEADER = 'NewRelicSynthetics'.freeze
+
       ###############
       module_function
       ###############
@@ -101,6 +105,45 @@ module NewRelic
       def valid_cross_app_id?(xp_id)
         !!(xp_id =~ /\A\d+#\d+\z/)
       end
+
+      def insert_message_headers headers, txn_guid, trip_id, path_hash, synthetics_header
+        headers[NR_MESSAGE_BROKER_ID_HEADER]  = obfuscator.obfuscate(NewRelic::Agent.config[:cross_process_id])
+        headers[NR_MESSAGE_BROKER_TXN_HEADER] = obfuscator.obfuscate(::JSON.dump([txn_guid, false, trip_id, path_hash]))
+        headers[NR_MESSAGE_BROKER_SYNTHETICS_HEADER] = synthetics_header if synthetics_header
+      end
+
+      def message_has_crossapp_request_header? headers
+        !!headers[NR_MESSAGE_BROKER_ID_HEADER]
+      end
+
+      def reject_messaging_cat_headers headers
+        headers.reject {|k,_| k == NR_MESSAGE_BROKER_ID_HEADER || k == NR_MESSAGE_BROKER_TXN_HEADER}
+      end
+
+      def trusts? id
+        split_id = id.match(/(\d+)#\d+/)
+        return false if split_id.nil?
+
+        NewRelic::Agent.config[:trusted_account_ids].include? split_id.captures.first.to_i
+      end
+
+      def trusted_valid_cross_app_id? id
+        valid_cross_app_id?(id) && trusts?(id)
+      end
+
+      def assign_intrinsic_transaction_attributes state
+        # We expect to get the before call to set the id (if we have it) before
+        # this, and then write our custom parameter when the transaction starts
+        return unless transaction = state.current_transaction
+
+        if state.client_cross_app_id
+          transaction.attributes.add_intrinsic_attribute(:client_cross_process_id, state.client_cross_app_id)
+        end
+
+        if referring_guid = state.referring_transaction_info && state.referring_transaction_info[0]
+          transaction.attributes.add_intrinsic_attribute(:referring_transaction_guid, referring_guid)
+        end
+      end
     end
   end
 end

data/lib/new_relic/agent/error_collector.rb

@@ -199,7 +199,7 @@ module NewRelic
 
         state = ::NewRelic::Agent::TransactionState.tl_get
 
-        unless options.delete(:trace_only)
+        unless options.delete(:expected)
           increment_error_count!(state, exception, options)
         end
 

data/lib/new_relic/agent/http_clients/uri_util.rb

@@ -37,7 +37,7 @@ module NewRelic
               uri = ::URI.parse(url)
             end
           end
-          uri.host.downcase!
+          uri.host.downcase! unless uri.host.nil?
           uri
         end
 

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

@@ -156,6 +156,9 @@ module NewRelic
 
           # https://rubygems.org/gems/activerecord-jdbcpostgresql-adapter
           "jdbcpostgresql" => "Postgres",
+          
+          # https://rubygems.org/gems/activerecord-postgis-adapter
+          "postgis"    => "Postgres",
 
           # https://rubygems.org/gems/activerecord-jdbcsqlite3-adapter
           "jdbcsqlite3"    => "SQLite",
@@ -197,7 +200,8 @@ module NewRelic
             "jdbcmysql"  => :mysql,
 
             "postgresql"     => :postgres,
-            "jdbcpostgresql" => :postgres
+            "jdbcpostgresql" => :postgres,
+            "postgis"        => :postgres
           }.freeze
 
           DATASTORE_DEFAULT_PORTS = {

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

@@ -0,0 +1,146 @@
+# encoding: utf-8
+# This file is distributed under New Relic's license terms.
+# See https://github.com/newrelic/rpm/blob/master/LICENSE for complete details.
+
+DependencyDetection.defer do
+  named :bunny
+
+  depends_on do
+    defined?(Bunny)
+  end
+
+  executes do
+    ::NewRelic::Agent.logger.info 'Installing Bunny instrumentation'
+    require 'new_relic/agent/cross_app_tracing'
+    require 'new_relic/agent/messaging'
+    require 'new_relic/agent/transaction/message_broker_segment'
+  end
+
+  executes do
+    module Bunny
+      class Exchange
+        alias_method :publish_without_new_relic, :publish
+
+        def publish payload, opts = {}
+          begin
+            destination = NewRelic::Agent::Instrumentation::Bunny.exchange_name(name)
+            opts[:headers] ||= {} if NewRelic::Agent::CrossAppTracing.cross_app_enabled?
+
+            segment = NewRelic::Agent::Messaging.start_amqp_publish_segment(
+              library: NewRelic::Agent::Instrumentation::Bunny::LIBRARY,
+              destination_name: destination,
+              headers: opts[:headers],
+              routing_key: opts[:routing_key] || opts[:key],
+              reply_to: opts[:reply_to],
+              correlation_id: opts[:correlation_id],
+              exchange_type: type
+            )
+          rescue => e
+            NewRelic::Agent.logger.error "Error starting message broker segment in Bunny::Exchange#publish", e
+          end
+
+          begin
+            publish_without_new_relic payload, opts
+          ensure
+            segment.finish if segment
+          end
+        end
+      end
+
+      class Queue
+        alias_method :pop_without_new_relic, :pop
+
+        def pop(opts = {:manual_ack => false}, &block)
+          t0 = Time.now
+          msg = pop_without_new_relic opts, &block
+
+          begin
+            exchange_name = NewRelic::Agent::Instrumentation::Bunny.exchange_name(msg.first.exchange)
+
+            segment = NewRelic::Agent::Messaging.start_amqp_consume_segment(
+              library: NewRelic::Agent::Instrumentation::Bunny::LIBRARY,
+              destination_name: exchange_name,
+              delivery_info: msg[0],
+              message_properties: msg[1],
+              exchange_type: channel.exchanges[msg.first.exchange].type,
+              queue_name: name,
+              start_time: t0
+            )
+
+          rescue => e
+            NewRelic::Agent.logger.error "Error starting message broker segment in Bunny::Queue#pop", e
+          ensure
+            segment.finish if segment
+          end
+
+          msg
+        end
+
+        alias_method :purge_without_new_relic, :purge
+
+        def purge *args
+          begin
+            type = server_named? ? :temporary_queue : :queue
+            segment = NewRelic::Agent::Transaction.start_message_broker_segment(
+              action: :purge,
+              library: NewRelic::Agent::Instrumentation::Bunny::LIBRARY,
+              destination_type: type,
+              destination_name: name
+            )
+          rescue => e
+            NewRelic::Agent.logger.error "Error starting message broker segment in Bunny::Queue#purge", e
+          end
+
+          begin
+            purge_without_new_relic(*args)
+          ensure
+            segment.finish if segment
+          end
+        end
+      end
+
+      class Consumer
+        alias_method :call_without_new_relic, :call
+
+        def call *args
+          delivery_info, message_properties, _ = args
+          NewRelic::Agent::Messaging.wrap_amqp_consume_transaction(
+            library: NewRelic::Agent::Instrumentation::Bunny::LIBRARY,
+            destination_name: NewRelic::Agent::Instrumentation::Bunny.exchange_name(delivery_info.exchange),
+            delivery_info: delivery_info,
+            message_properties: message_properties,
+            exchange_type: NewRelic::Agent::Instrumentation::Bunny.exchange_type(delivery_info, channel),
+            queue_name: queue.name) do
+
+            call_without_new_relic(*args)
+          end
+        end
+      end
+    end
+  end
+end
+
+module NewRelic
+  module Agent
+    module Instrumentation
+      module Bunny
+        LIBRARY = 'RabbitMQ'.freeze
+        DEFAULT = 'Default'.freeze
+        SLASH   = '/'.freeze
+
+        class << self
+          def exchange_name name
+            name.empty? ? DEFAULT : name
+          end
+
+          def exchange_type delivery_info, channel
+            if di_exchange = delivery_info[:exchange]
+              return :direct if di_exchange.empty?
+              return channel.exchanges[delivery_info[:exchange]].type if channel.exchanges[di_exchange]
+            end
+          end
+        end
+      end
+    end
+  end
+end