newrelic_rpm 6.15.0 → 9.7.1

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

@@ -1,6 +1,6 @@
-# encoding: utf-8
 # This file is distributed under New Relic's license terms.
 # See https://github.com/newrelic/newrelic-ruby-agent/blob/main/LICENSE for complete details.
+# frozen_string_literal: true
 
 require 'digest'
 require 'json'
@@ -12,24 +12,29 @@ module NewRelic
   module Agent
     module DistributedTracing
       class CrossAppMonitor < InboundRequestMonitor
-
-        NEWRELIC_ID_HEADER      = 'X-NewRelic-ID'.freeze
-        NEWRELIC_TXN_HEADER     = 'X-NewRelic-Transaction'.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
+        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)
+          if CrossAppTracing.cross_app_enabled?
+            Deprecator.deprecate('cross_application_tracer')
+            ::NewRelic::Agent.logger.warn(
+              '[DEPRECATED] Cross application tracing is enabled. Distributed tracing is replacing cross application tracing as the default means of tracing between services. To continue using cross application tracing, enable it with `cross_application_tracer.enabled: true` and `distributed_tracing.enabled: false`'
+            )
+          end
+
           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
+          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))
+          sprintf('%08x', rotated ^ hash_transaction_name(identifier))
         end
 
         private
@@ -38,10 +43,10 @@ module NewRelic
         #   :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")
+          NewRelic::Agent.logger
+            .debug('Wiring up Cross Application Tracing to events after finished configuring')
 
-          events.subscribe(:before_call) do |env| #THREAD_LOCAL_ACCESS
+          events.subscribe(:before_call) do |env| # THREAD_LOCAL_ACCESS
             if id = decoded_id(env) and should_process_request?(id)
               state = NewRelic::Agent::Tracer.state
 
@@ -52,11 +57,11 @@ module NewRelic
                 txn.distributed_tracer.cross_app_payload = payload
               end
 
-              CrossAppTracing.assign_intrinsic_transaction_attributes state
+              CrossAppTracing.assign_intrinsic_transaction_attributes(state)
             end
           end
 
-          events.subscribe(:after_call) do |env, (_status_code, headers, _body)| #THREAD_LOCAL_ACCESS
+          events.subscribe(:after_call) do |env, (_status_code, headers, _body)| # THREAD_LOCAL_ACCESS
             state = NewRelic::Agent::Tracer.state
 
             insert_response_header(state, env, headers)
@@ -78,21 +83,23 @@ module NewRelic
           end
         end
 
-        def should_process_request? id
+        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)))
+              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?
+          return NewRelic::EMPTY_STR if encoded_id.nil? || encoded_id.empty?
 
           obfuscator.deobfuscate(encoded_id)
         end
@@ -102,9 +109,9 @@ module NewRelic
         end
 
         def hash_transaction_name(identifier)
-          Digest::MD5.digest(identifier).unpack("@12N").first & 0xffffffff
+          Digest::MD5.digest(identifier).unpack('@12N').first & 0xffffffff
         end
       end
     end
   end
-end
+end

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

@@ -1,6 +1,6 @@
-# encoding: utf-8
 # This file is distributed under New Relic's license terms.
 # See https://github.com/newrelic/newrelic-ruby-agent/blob/main/LICENSE for complete details.
+# frozen_string_literal: true
 
 module NewRelic
   module Agent
@@ -8,20 +8,21 @@ module NewRelic
       class Monitor < InboundRequestMonitor
         def on_finished_configuring(events)
           return unless NewRelic::Agent.config[:'distributed_tracing.enabled']
+
           events.subscribe(:before_call, &method(:on_before_call))
         end
 
         def on_before_call(request)
           unless NewRelic::Agent.config[:'distributed_tracing.enabled']
-            NewRelic::Agent.logger.warn "Not configured to accept distributed trace headers" 
+            NewRelic::Agent.logger.warn('Not configured to accept distributed trace headers')
             return
           end
 
           return unless txn = Tracer.current_transaction
 
-          txn.distributed_tracer.accept_incoming_request request
+          txn.distributed_tracer.accept_incoming_request(request)
         end
       end
     end
   end
-end
+end

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

@@ -1,6 +1,6 @@
-# encoding: utf-8
 # This file is distributed under New Relic's license terms.
 # See https://github.com/newrelic/newrelic-ruby-agent/blob/main/LICENSE for complete details.
+# frozen_string_literal: true
 
 # This class serves as the base for objects wanting to monitor and respond to
 # incoming web requests. Examples include cross application tracing and
@@ -16,7 +16,6 @@ require 'json'
 module NewRelic
   module Agent
     class InboundRequestMonitor
-
       attr_reader :obfuscator
 
       def initialize(events)

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

@@ -1,11 +1,12 @@
-# encoding: utf-8
 # This file is distributed under New Relic's license terms.
 # See https://github.com/newrelic/newrelic-ruby-agent/blob/main/LICENSE for complete details.
+# frozen_string_literal: true
 
 module NewRelic
   module Agent
     class SyntheticsMonitor < InboundRequestMonitor
-      SYNTHETICS_HEADER_KEY  = 'HTTP_X_NEWRELIC_SYNTHETICS'.freeze
+      SYNTHETICS_HEADER_KEY = 'HTTP_X_NEWRELIC_SYNTHETICS'
+      SYNTHETICS_INFO_HEADER_KEY = 'HTTP_X_NEWRELIC_SYNTHETICS_INFO'
 
       SUPPORTED_VERSION = 1
       EXPECTED_PAYLOAD_LENGTH = 5
@@ -14,8 +15,9 @@ module NewRelic
         events.subscribe(:before_call, &method(:on_before_call))
       end
 
-      def on_before_call(request) #THREAD_LOCAL_ACCESS
+      def on_before_call(request) # THREAD_LOCAL_ACCESS
         encoded_header = request[SYNTHETICS_HEADER_KEY]
+        info_header = request[SYNTHETICS_INFO_HEADER_KEY]
         return unless encoded_header
 
         incoming_payload = deserialize_header(encoded_header, SYNTHETICS_HEADER_KEY)
@@ -27,11 +29,19 @@ module NewRelic
 
         txn = Tracer.current_transaction
         txn.raw_synthetics_header = encoded_header
-        txn.synthetics_payload    = incoming_payload
+        txn.raw_synthetics_info_header = info_header
+        txn.synthetics_payload = incoming_payload
+        txn.synthetics_info_payload = load_json(info_header, SYNTHETICS_INFO_HEADER_KEY)
       end
 
-      class << self
+      def load_json(header, key)
+        ::JSON.load(header)
+      rescue => err
+        NewRelic::Agent.logger.debug("Failure loading json header '#{key}' in #{self.class}, #{err.class}, #{err.message}")
+        nil
+      end
 
+      class << self
         def is_supported_version?(incoming_payload)
           incoming_payload.first == SUPPORTED_VERSION
         end
@@ -45,12 +55,10 @@ module NewRelic
           incoming_payload.length == EXPECTED_PAYLOAD_LENGTH
         end
 
-        def reject_messaging_synthetics_header headers
-          headers.reject {|k,_| k == CrossAppTracing::NR_MESSAGE_BROKER_SYNTHETICS_HEADER}
+        def reject_messaging_synthetics_header(headers)
+          headers.reject { |k, _| k == CrossAppTracing::NR_MESSAGE_BROKER_SYNTHETICS_HEADER }
         end
-
       end
-
     end
   end
 end

data/lib/new_relic/agent/monitors.rb

@@ -1,6 +1,6 @@
-# encoding: utf-8
 # This file is distributed under New Relic's license terms.
 # See https://github.com/newrelic/newrelic-ruby-agent/blob/main/LICENSE for complete details.
+# frozen_string_literal: true
 
 require_relative 'monitors/inbound_request_monitor'
 
@@ -16,12 +16,11 @@ module NewRelic
       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
+      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
+end

data/lib/new_relic/agent/new_relic_service/encoders.rb

@@ -1,35 +1,35 @@
-# encoding: utf-8
 # This file is distributed under New Relic's license terms.
 # See https://github.com/newrelic/newrelic-ruby-agent/blob/main/LICENSE for complete details.
+# frozen_string_literal: true
 
-require 'base64'
 require 'json'
 require 'stringio'
 require 'zlib'
+require 'new_relic/base64'
 
 module NewRelic
   module Agent
     class NewRelicService
       module Encoders
         module Identity
-          def self.encode(data, opts=nil)
+          def self.encode(data, opts = nil)
             data
           end
         end
 
         module Compressed
           module Deflate
-            def self.encode(data, opts=nil)
+            def self.encode(data, opts = nil)
               Zlib::Deflate.deflate(data, Zlib::DEFAULT_COMPRESSION)
             end
           end
 
           module Gzip
-            BINARY = "BINARY".freeze
+            BINARY = 'BINARY'.freeze
 
-            def self.encode(data, opts=nil)
+            def self.encode(data, opts = nil)
               output = StringIO.new
-              output.set_encoding BINARY
+              output.set_encoding(BINARY)
               gz = Zlib::GzipWriter.new(output, Zlib::DEFAULT_COMPRESSION, Zlib::DEFAULT_STRATEGY)
               gz.write(data)
               gz.close
@@ -40,12 +40,12 @@ module NewRelic
         end
 
         module Base64CompressedJSON
-          def self.encode(data, opts={})
+          def self.encode(data, opts = {})
             if !opts[:skip_normalization] && Agent.config[:normalize_json_string_encodings]
               data = NewRelic::Agent::EncodingNormalizer.normalize_object(data)
             end
             json = ::JSON.dump(data)
-            Base64.encode64(Compressed::Deflate.encode(json))
+            NewRelic::Base64.encode64(Compressed::Deflate.encode(json))
           end
         end
       end

data/lib/new_relic/agent/new_relic_service/json_marshaller.rb

@@ -1,6 +1,6 @@
-# encoding: utf-8
 # This file is distributed under New Relic's license terms.
 # See https://github.com/newrelic/newrelic-ruby-agent/blob/main/LICENSE for complete details.
+# frozen_string_literal: true
 
 require 'json'
 require 'new_relic/agent/new_relic_service/marshaller'
@@ -14,20 +14,20 @@ module NewRelic
           warn_for_yajl
         end
 
-        OK_YAJL_VERSION = Gem::Version.new("1.2.1")
+        OK_YAJL_VERSION = Gem::Version.new('1.2.1')
 
         def warn_for_yajl
           if defined?(::Yajl)
             require 'yajl/version'
             if Gem::Version.new(::Yajl::VERSION) < OK_YAJL_VERSION
-              ::NewRelic::Agent.logger.warn "Detected yajl-ruby version #{::Yajl::VERSION} which can cause segfaults with newrelic_rpm's thread profiling features. We strongly recommend you upgrade to the latest yajl-ruby version available."
+              ::NewRelic::Agent.logger.warn("Detected yajl-ruby version #{::Yajl::VERSION} which can cause segfaults with newrelic_rpm's thread profiling features. We strongly recommend you upgrade to the latest yajl-ruby version available.")
             end
           end
         rescue => err
-          ::NewRelic::Agent.logger.warn "Failed trying to watch for problematic yajl-ruby version.", err
+          ::NewRelic::Agent.logger.warn('Failed trying to watch for problematic yajl-ruby version.', err)
         end
 
-        def dump(ruby, opts={})
+        def dump(ruby, opts = {})
           prepared = prepare(ruby, opts)
 
           if !opts[:skip_normalization] && Agent.config[:normalize_json_string_encodings]
@@ -44,7 +44,7 @@ module NewRelic
 
           return_value(::JSON.load(data))
         rescue => e
-          ::NewRelic::Agent.logger.debug "#{e.class.name} : #{e.message} encountered loading collector response: #{data}"
+          ::NewRelic::Agent.logger.debug("#{e.class.name} : #{e.message} encountered loading collector response: #{data}")
           raise
         end
 

data/lib/new_relic/agent/new_relic_service/marshaller.rb

@@ -1,12 +1,12 @@
-# encoding: utf-8
 # This file is distributed under New Relic's license terms.
 # See https://github.com/newrelic/newrelic-ruby-agent/blob/main/LICENSE for complete details.
+# frozen_string_literal: true
 
 module NewRelic
   module Agent
     class NewRelicService
       class Marshaller
-        def prepare(data, options={})
+        def prepare(data, options = {})
           encoder = options[:encoder] || default_encoder
           if data.respond_to?(:to_collector_array)
             data.to_collector_array(encoder)

data/lib/new_relic/agent/new_relic_service/security_policy_settings.rb

@@ -1,12 +1,12 @@
-# encoding: utf-8
 # This file is distributed under New Relic's license terms.
 # See https://github.com/newrelic/newrelic-ruby-agent/blob/main/LICENSE for complete details.
+# frozen_string_literal: true
 
 module NewRelic
   module Agent
     class NewRelicService
       module SecurityPolicySettings
-        EXPECTED_SECURITY_POLICIES = %w(
+        EXPECTED_SECURITY_POLICIES = %w[
           record_sql
           attributes_include
           allow_raw_exception_messages
@@ -14,12 +14,12 @@ module NewRelic
           custom_parameters
           custom_instrumentation_editor
           message_parameters
-          job_arguments).map(&:freeze)
+        ].map(&:freeze)
 
         def self.preliminary_settings(security_policies)
           enabled_key = 'enabled'.freeze
           settings = EXPECTED_SECURITY_POLICIES.inject({}) do |memo, policy_name|
-            memo[policy_name] =  {enabled_key => security_policies[policy_name][enabled_key]}
+            memo[policy_name] = {enabled_key => security_policies[policy_name][enabled_key]}
             memo
           end
           {'security_policies' => settings}