newrelic_rpm 6.8.0.360 → 6.9.0.363

data/lib/new_relic/agent/error_collector.rb

@@ -74,7 +74,7 @@ module NewRelic
       end
 
       def self.ignore_error_filter
-        @ignore_filter
+        defined?(@ignore_filter) ? @ignore_filter : nil
       end
 
       # errors is an array of Exception Class Names
@@ -227,13 +227,11 @@ module NewRelic
         truncated_trace
       end
 
-      EMPTY_STRING = ''.freeze
-
       def create_noticed_error(exception, options)
-        error_metric = options.delete(:metric) || EMPTY_STRING
+        error_metric = options.delete(:metric) || NewRelic::EMPTY_STR
 
         noticed_error = NewRelic::NoticedError.new(error_metric, exception)
-        noticed_error.request_uri = options.delete(:uri) || EMPTY_STRING
+        noticed_error.request_uri = options.delete(:uri) || NewRelic::EMPTY_STR
         noticed_error.request_port = options.delete(:port)
         noticed_error.attributes  = options.delete(:attributes)
 

data/lib/new_relic/agent/error_event_aggregator.rb

@@ -2,6 +2,7 @@
 # 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.
+# frozen_string_literal: true
 
 require 'new_relic/agent/event_aggregator'
 require 'new_relic/agent/transaction_error_primitive'
@@ -10,6 +11,7 @@ require 'new_relic/agent/priority_sampled_buffer'
 module NewRelic
   module Agent
     class ErrorEventAggregator < EventAggregator
+      include NewRelic::Coerce
 
       named :ErrorEventAggregator
       capacity_key :'error_collector.max_event_samples_stored'
@@ -20,7 +22,7 @@ module NewRelic
       def record noticed_error, transaction_payload = nil
         return unless enabled?
 
-        priority = (transaction_payload && transaction_payload[:priority]) || rand.round(6)
+        priority = float!((transaction_payload && transaction_payload[:priority]) || rand)
 
         @lock.synchronize do
           @buffer.append(priority: priority) do

data/lib/new_relic/agent/external.rb

@@ -3,8 +3,8 @@
 # See https://github.com/newrelic/rpm/blob/master/LICENSE for complete details.
 
 require 'new_relic/agent/transaction/tracing'
-require 'new_relic/agent/cross_app_tracing'
-require 'new_relic/agent/cross_app_payload'
+require 'new_relic/agent/distributed_tracing/cross_app_tracing'
+require 'new_relic/agent/distributed_tracing/cross_app_payload'
 
 module NewRelic
   module Agent
@@ -78,7 +78,7 @@ module NewRelic
             #
             if txn_info = rmd[NON_HTTP_CAT_TXN_HEADER]
               payload = CrossAppPayload.new(id, transaction, txn_info)
-              transaction.cross_app_payload = payload
+              transaction.distributed_tracer.cross_app_payload = payload
 
               CrossAppTracing.assign_intrinsic_transaction_attributes state
             end
@@ -112,16 +112,16 @@ module NewRelic
         NewRelic::Agent.record_api_supportability_metric(:get_response_metadata)
         return unless CrossAppTracing.cross_app_enabled?
 
-        return unless (transaction = Tracer.current_transaction)
-        return unless (cross_app_payload = transaction.cross_app_payload)
+        return unless (txn = Tracer.current_transaction)
+        return unless (payload = txn.distributed_tracer.cross_app_payload)
 
         # must freeze the name since we're responding with it
         #
-        transaction.freeze_name_and_execute_if_not_ignored do
+        txn.freeze_name_and_execute_if_not_ignored do
           # build response payload
           #
           rmd = {
-            NewRelicAppData: cross_app_payload.as_json_array(NON_HTTP_CAT_CONTENT_LENGTH)
+            NewRelicAppData: payload.as_json_array(NON_HTTP_CAT_CONTENT_LENGTH)
           }
 
           # obfuscate the generated response metadata JSON

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

@@ -47,10 +47,9 @@ module NewRelic
         end
 
         DOT_ACTION_CABLE = '.action_cable'.freeze
-        EMPTY_STRING = ''.freeze
 
         def action_name(name)
-          name.gsub DOT_ACTION_CABLE, EMPTY_STRING
+          name.gsub DOT_ACTION_CABLE, NewRelic::EMPTY_STR
         end
 
         def notice_error(payload)

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

@@ -11,7 +11,7 @@ DependencyDetection.defer do
 
   executes do
     ::NewRelic::Agent.logger.info 'Installing Bunny instrumentation'
-    require 'new_relic/agent/cross_app_tracing'
+    require 'new_relic/agent/distributed_tracing/cross_app_tracing'
     require 'new_relic/agent/messaging'
     require 'new_relic/agent/transaction/message_broker_segment'
   end

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

@@ -14,7 +14,7 @@ DependencyDetection.defer do
 
   executes do
     ::NewRelic::Agent.logger.info 'Installing Curb instrumentation'
-    require 'new_relic/agent/cross_app_tracing'
+    require 'new_relic/agent/distributed_tracing/cross_app_tracing'
     require 'new_relic/agent/http_clients/curb_wrappers'
   end
 

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

@@ -42,7 +42,7 @@ DependencyDetection.defer do
   end
 
   def install_excon_instrumentation(excon_version)
-    require 'new_relic/agent/cross_app_tracing'
+    require 'new_relic/agent/distributed_tracing/cross_app_tracing'
     require 'new_relic/agent/http_clients/excon_wrappers'
 
     if excon_version >= EXCON_MIDDLEWARE_MIN_VERSION

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

@@ -14,7 +14,6 @@ module NewRelic
         API_VERSION    = 'api.version'.freeze
         FORMAT_REGEX   = /\(\/?\.[\:\w]*\)/.freeze # either :format (< 0.12.0) or .ext (>= 0.12.0)
         VERSION_REGEX  = /:version(\/|$)/.freeze
-        EMPTY_STRING   = ''.freeze
         MIN_VERSION    = Gem::Version.new("0.2.0")
         PIPE_STRING    = '|'.freeze
 
@@ -33,7 +32,7 @@ module NewRelic
         end
 
         def name_for_transaction(route, class_name, version)
-          action_name = route.path.sub(FORMAT_REGEX, EMPTY_STRING)
+          action_name = route.path.sub(FORMAT_REGEX, NewRelic::EMPTY_STR)
           method_name = route.request_method
           version ||= route.version
 
@@ -42,7 +41,7 @@ module NewRelic
           version = version.join(PIPE_STRING) if Array === version
 
           if version
-            action_name = action_name.sub(VERSION_REGEX, EMPTY_STRING)
+            action_name = action_name.sub(VERSION_REGEX, NewRelic::EMPTY_STR)
             "#{class_name}-#{version}#{action_name} (#{method_name})"
           else
             "#{class_name}#{action_name} (#{method_name})"
@@ -50,12 +49,12 @@ module NewRelic
         end
 
         def name_for_transaction_deprecated(route, class_name, version)
-          action_name = route.route_path.sub(FORMAT_REGEX, EMPTY_STRING)
+          action_name = route.route_path.sub(FORMAT_REGEX, NewRelic::EMPTY_STR)
           method_name = route.route_method
           version ||= route.route_version
 
           if version
-            action_name = action_name.sub(VERSION_REGEX, EMPTY_STRING)
+            action_name = action_name.sub(VERSION_REGEX, NewRelic::EMPTY_STR)
             "#{class_name}-#{version}#{action_name} (#{method_name})"
           else
             "#{class_name}#{action_name} (#{method_name})"
@@ -118,11 +117,7 @@ DependencyDetection.defer do
 
     # Since 1.2.0, the class `Grape::API` no longer refers to an API instance, rather, what used to be `Grape::API` is `Grape::API::Instance`
     # https://github.com/ruby-grape/grape/blob/c20a73ac1e3f3ba1082005ed61bf69452373ba87/UPGRADING.md#upgrading-to--120
-    grape_api_class = if defined?(Grape::API::Instance)
-                        ::Grape::API::Instance
-                      else
-                        ::Grape::API
-                      end
+    grape_api_class = defined?(Grape::API::Instance) ? ::Grape::API::Instance : ::Grape::API
 
     grape_api_class.class_eval do
       def call_with_new_relic(env)

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

@@ -11,7 +11,7 @@ DependencyDetection.defer do
 
   executes do
     ::NewRelic::Agent.logger.info 'Installing http.rb instrumentation'
-    require 'new_relic/agent/cross_app_tracing'
+    require 'new_relic/agent/distributed_tracing/cross_app_tracing'
     require 'new_relic/agent/http_clients/http_rb_wrappers'
   end
 

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

@@ -20,7 +20,7 @@ DependencyDetection.defer do
 
   executes do
     ::NewRelic::Agent.logger.info 'Installing HTTPClient instrumentation'
-    require 'new_relic/agent/cross_app_tracing'
+    require 'new_relic/agent/distributed_tracing/cross_app_tracing'
     require 'new_relic/agent/http_clients/httpclient_wrappers'
   end
 

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

@@ -11,7 +11,7 @@ DependencyDetection.defer do
 
   executes do
     ::NewRelic::Agent.logger.info 'Installing Net instrumentation'
-    require 'new_relic/agent/cross_app_tracing'
+    require 'new_relic/agent/distributed_tracing/cross_app_tracing'
     require 'new_relic/agent/http_clients/net_http_wrappers'
   end
 

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

@@ -43,6 +43,9 @@ DependencyDetection.defer do
               perform_without_instrumentation
             end
           ensure
+            # Stopping the event loop before flushing the pipe.
+            # The goal is to avoid conflict during write.
+            NewRelic::Agent.agent.stop_event_loop
             NewRelic::Agent.agent.flush_pipe_data
           end
         end

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

@@ -15,7 +15,7 @@ DependencyDetection.defer do
 
   executes do
     ::NewRelic::Agent.logger.info 'Installing Typhoeus instrumentation'
-    require 'new_relic/agent/cross_app_tracing'
+    require 'new_relic/agent/distributed_tracing/cross_app_tracing'
     require 'new_relic/agent/http_clients/typhoeus_wrappers'
   end
 

data/lib/new_relic/agent/logging.rb

@@ -119,9 +119,19 @@ module NewRelic
 
         alias :write :info
 
-        def initialize *args
-          super
-          self.formatter = DecoratingFormatter.new
+        # Positional and Keyword arguments are separated beginning with Ruby 2.7
+        # Signature of ::Logger constructor changes in Ruby 2.4 to have both positional and keyword args
+        # We pivot on Ruby 2.7 for widest supportability with least amount of hassle.
+        if RUBY_VERSION < "2.7.0"
+          def initialize(*args)
+            super(*args)
+            self.formatter = DecoratingFormatter.new
+          end
+        else
+          def initialize(*args, **kwargs)
+            super(*args, **kwargs)
+            self.formatter = DecoratingFormatter.new
+          end
         end
       end
     end

data/lib/new_relic/agent/messaging.rb

@@ -1,6 +1,8 @@
 # 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.
+# frozen_string_literal: true
+
 require 'new_relic/agent/transaction'
 
 module NewRelic
@@ -13,12 +15,12 @@ module NewRelic
     module Messaging
       extend self
 
+      RABBITMQ_TRANSPORT_TYPE = "RabbitMQ"
+
       ATTR_DESTINATION = AttributeFilter::DST_TRANSACTION_EVENTS |
                          AttributeFilter::DST_TRANSACTION_TRACER |
                          AttributeFilter::DST_ERROR_COLLECTOR
 
-      EMPTY_STRING = ''.freeze
-
       # Start a MessageBroker segment configured to trace a messaging action.
       # Finishing this segment will handle timing and recording of the proper
       # metrics for New Relic's messaging features..
@@ -133,7 +135,7 @@ module NewRelic
           txn = Tracer.start_transaction name: txn_name, category: :message
 
           if headers
-            consume_message_headers headers, txn, state
+            txn.distributed_tracer.consume_message_headers headers, state, RABBITMQ_TRANSPORT_TYPE
             CrossAppTracing.reject_messaging_cat_headers(headers).each do |k, v|
               txn.add_agent_attribute :"message.headers.#{k}", v, AttributeFilter::DST_NONE unless v.nil?
             end
@@ -365,76 +367,6 @@ module NewRelic
         transaction_name
       end
 
-      RABBITMQ_TRANSPORT_TYPE = "RabbitMQ".freeze
-
-      def consume_message_headers headers, transaction, state
-        consume_distributed_tracing_headers headers, transaction
-        consume_cross_app_tracing_headers headers, state
-
-        assign_synthetics_header headers[CrossAppTracing::NR_MESSAGE_BROKER_SYNTHETICS_HEADER], transaction
-      rescue => e
-        NewRelic::Agent.logger.error "Error in consume_message_headers", e
-      end
-
-      def decode_txn_info headers, transaction_state
-        encoded_id = headers[CrossAppTracing::NR_MESSAGE_BROKER_ID_HEADER]
-
-        decoded_id = if encoded_id.nil?
-                       EMPTY_STRING
-                     else
-                       CrossAppTracing.obfuscator.deobfuscate(encoded_id)
-                     end
-
-        if CrossAppTracing.trusted_valid_cross_app_id?(decoded_id) && transaction_state.current_transaction
-          txn_header = headers[CrossAppTracing::NR_MESSAGE_BROKER_TXN_HEADER]
-          txn        = transaction_state.current_transaction
-          txn_info   = ::JSON.load(CrossAppTracing.obfuscator.deobfuscate(txn_header))
-          payload    = CrossAppPayload.new(decoded_id, txn, txn_info)
-
-          txn.cross_app_payload = payload
-        end
-      rescue => e
-        NewRelic::Agent.logger.debug("Failure deserializing encoded header in #{self.class}, #{e.class}, #{e.message}")
-        nil
-      end
-
-      CANDIDATE_HEADERS = ['newrelic'.freeze, 'NEWRELIC'.freeze, 'Newrelic'.freeze]
-
-      def consume_distributed_tracing_headers headers, transaction
-        if Agent.config[:'distributed_tracing.enabled']
-          return unless newrelic_trace_key = CANDIDATE_HEADERS.detect do |key|
-            headers.has_key?(key)
-          end
-
-          return unless payload = headers[newrelic_trace_key]
-
-          if transaction.accept_distributed_trace_payload payload
-            transaction.distributed_trace_payload.caller_transport_type = RABBITMQ_TRANSPORT_TYPE
-          end
-        end
-      end
-
-      def consume_cross_app_tracing_headers headers, state
-        if CrossAppTracing.cross_app_enabled? && CrossAppTracing.message_has_crossapp_request_header?(headers)
-          decode_txn_info headers, state
-          CrossAppTracing.assign_intrinsic_transaction_attributes state
-        end
-      end
-
-      def assign_synthetics_header synthetics_header, transaction
-        if synthetics_header and
-           incoming_payload = ::JSON.load(CrossAppTracing.obfuscator.deobfuscate(synthetics_header)) and
-           SyntheticsMonitor.is_valid_payload?(incoming_payload) and
-           SyntheticsMonitor.is_supported_version?(incoming_payload) and
-           SyntheticsMonitor.is_trusted?(incoming_payload)
-
-          transaction.raw_synthetics_header = synthetics_header
-          transaction.synthetics_payload = incoming_payload
-        end
-      rescue => e
-        NewRelic::Agent.logger.error "Error in assign_synthetics_header", e
-      end
-
     end
   end
 end

data/lib/new_relic/agent/method_tracer.rb

@@ -47,6 +47,7 @@ module NewRelic
     #
 
     module MethodTracer
+
       def self.included clazz
         clazz.extend ClassMethods
       end
@@ -67,7 +68,7 @@ module NewRelic
       #
       # @api public
       #
-      def trace_execution_scoped(metric_names, options={}) #THREAD_LOCAL_ACCESS
+      def trace_execution_scoped(metric_names, options=NewRelic::EMPTY_HASH) #THREAD_LOCAL_ACCESS
         NewRelic::Agent.record_api_supportability_metric :trace_execution_scoped
         NewRelic::Agent::MethodTracerHelpers.trace_execution_scoped(metric_names, options) do
           # Using an implicit block avoids object allocation for a &block param
@@ -83,7 +84,7 @@ module NewRelic
       #
       # @api public
       #
-      def trace_execution_unscoped(metric_names, options={}) #THREAD_LOCAL_ACCESS
+      def trace_execution_unscoped(metric_names, options=NewRelic::EMPTY_HASH) #THREAD_LOCAL_ACCESS
         NewRelic::Agent.record_api_supportability_metric :trace_execution_unscoped
         return yield unless NewRelic::Agent.tl_is_execution_traced?
         t0 = Time.now

data/lib/new_relic/agent/method_tracer_helpers.rb

@@ -9,7 +9,7 @@ module NewRelic
 
       extend self
 
-      def trace_execution_scoped(metric_names, options={}) #THREAD_LOCAL_ACCESS
+      def trace_execution_scoped(metric_names, options=NewRelic::EMPTY_HASH) #THREAD_LOCAL_ACCESS
         state = NewRelic::Agent::Tracer.state
         return yield unless state.is_execution_traced?
 

data/lib/new_relic/agent/monitors.rb

@@ -0,0 +1,27 @@
+# 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.
+
+require_relative 'monitors/inbound_request_monitor'
+
+require_relative 'monitors/synthetics_monitor'
+
+require_relative 'monitors/cross_app_monitor'
+require_relative 'monitors/distributed_tracing_monitor'
+
+module NewRelic
+  module Agent
+    class Monitors
+      attr_reader :cross_app_monitor
+      attr_reader :synthetics_monitor
+      attr_reader :distributed_tracing_monitor
+
+      def initialize events
+        @synthetics_monitor = NewRelic::Agent::SyntheticsMonitor.new events
+        @cross_app_monitor = NewRelic::Agent::DistributedTracing::CrossAppMonitor.new events
+        @distributed_tracing_monitor = NewRelic::Agent::DistributedTracing::Monitor.new events
+      end
+
+    end
+  end
+end

data/lib/new_relic/agent/monitors/cross_app_monitor.rb

@@ -0,0 +1,110 @@
+# 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.
+
+require 'digest'
+require 'json'
+
+require 'new_relic/agent/tracer'
+require 'new_relic/agent/threading/agent_thread'
+
+module NewRelic
+  module Agent
+    module DistributedTracing
+      class CrossAppMonitor < InboundRequestMonitor
+
+        NEWRELIC_ID_HEADER      = 'X-NewRelic-ID'.freeze
+        NEWRELIC_TXN_HEADER     = 'X-NewRelic-Transaction'.freeze
+        NEWRELIC_APPDATA_HEADER = 'X-NewRelic-App-Data'.freeze
+
+        NEWRELIC_ID_HEADER_KEY    = 'HTTP_X_NEWRELIC_ID'.freeze
+        NEWRELIC_TXN_HEADER_KEY   = 'HTTP_X_NEWRELIC_TRANSACTION'.freeze
+        CONTENT_LENGTH_HEADER_KEY = 'HTTP_CONTENT_LENGTH'.freeze
+
+        def on_finished_configuring(events)
+          register_event_listeners(events)
+        end
+
+        def path_hash(txn_name, seed)
+          rotated    = ((seed << 1) | (seed >> 31)) & 0xffffffff
+          app_name   = NewRelic::Agent.config[:app_name].first
+          identifier = "#{app_name};#{txn_name}"
+          sprintf("%08x", rotated ^ hash_transaction_name(identifier))
+        end
+
+        private
+
+        # Expected sequence of events:
+        #   :before_call will save our cross application request id to the thread
+        #   :after_call will write our response headers/metrics and clean up the thread
+        def register_event_listeners(events)
+          NewRelic::Agent.logger.
+            debug("Wiring up Cross Application Tracing to events after finished configuring")
+
+          events.subscribe(:before_call) do |env| #THREAD_LOCAL_ACCESS
+            if id = decoded_id(env) and should_process_request?(id)
+              state = NewRelic::Agent::Tracer.state
+
+              if (txn = state.current_transaction)
+                transaction_info = referring_transaction_info(state, env)
+
+                payload = CrossAppPayload.new(id, txn, transaction_info)
+                txn.distributed_tracer.cross_app_payload = payload
+              end
+
+              CrossAppTracing.assign_intrinsic_transaction_attributes state
+            end
+          end
+
+          events.subscribe(:after_call) do |env, (_status_code, headers, _body)| #THREAD_LOCAL_ACCESS
+            state = NewRelic::Agent::Tracer.state
+
+            insert_response_header(state, env, headers)
+          end
+        end
+
+        def referring_transaction_info(state, request_headers)
+          txn_header = request_headers[NEWRELIC_TXN_HEADER_KEY] or return
+          deserialize_header(txn_header, NEWRELIC_TXN_HEADER)
+        end
+
+        def insert_response_header(state, request_headers, response_headers)
+          txn = state.current_transaction
+          unless txn.nil? || txn.distributed_tracer.cross_app_payload.nil?
+            txn.freeze_name_and_execute_if_not_ignored do
+              content_length = content_length_from_request(request_headers)
+              set_response_headers(txn, response_headers, content_length)
+            end
+          end
+        end
+
+        def should_process_request? id
+          CrossAppTracing.cross_app_enabled? && CrossAppTracing.trusts?(id)
+        end
+
+        def set_response_headers(transaction, response_headers, content_length)
+          payload = obfuscator.obfuscate(
+            ::JSON.dump(
+              transaction.distributed_tracer.cross_app_payload.as_json_array(content_length)))
+
+          response_headers[NEWRELIC_APPDATA_HEADER] = payload
+        end
+
+        def decoded_id(request)
+          encoded_id = request[NEWRELIC_ID_HEADER_KEY]
+          return "" if encoded_id.nil? || encoded_id.empty?
+
+          obfuscator.deobfuscate(encoded_id)
+        end
+
+        def content_length_from_request(request)
+          request[CONTENT_LENGTH_HEADER_KEY] || -1
+        end
+
+        def hash_transaction_name(identifier)
+          Digest::MD5.digest(identifier).unpack("@12N").first & 0xffffffff
+        end
+      end
+    end
+  end
+end