newrelic_rpm 6.6.0.358 → 6.11.0

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

data/lib/new_relic/agent/monitors/distributed_tracing_monitor.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.
+
+module NewRelic
+  module Agent
+    module DistributedTracing
+      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" 
+            return
+          end
+
+          return unless txn = Tracer.current_transaction
+
+          txn.distributed_tracer.accept_incoming_request request
+        end
+      end
+    end
+  end
+end

data/lib/new_relic/agent/{inbound_request_monitor.rb → monitors/inbound_request_monitor.rb}

@@ -28,7 +28,7 @@ module NewRelic
       end
 
       def setup_obfuscator
-        @obfuscator = NewRelic::Agent::Obfuscator.new(NewRelic::Agent.config[:encoding_key])
+        @obfuscator = Obfuscator.new(Agent.config[:encoding_key])
       end
 
       def deserialize_header(encoded_header, key)

data/lib/new_relic/agent/{synthetics_monitor.rb → monitors/synthetics_monitor.rb}

@@ -2,8 +2,6 @@
 # This file is distributed under New Relic's license terms.
 # See https://github.com/newrelic/rpm/blob/master/LICENSE for complete details.
 
-require 'new_relic/agent/inbound_request_monitor'
-
 module NewRelic
   module Agent
     class SyntheticsMonitor < InboundRequestMonitor
@@ -40,7 +38,7 @@ module NewRelic
 
         def is_trusted?(incoming_payload)
           account_id = incoming_payload[1]
-          NewRelic::Agent.config[:trusted_account_ids].include?(account_id)
+          Agent.config[:trusted_account_ids].include?(account_id)
         end
 
         def is_valid_payload?(incoming_payload)
@@ -48,7 +46,7 @@ module NewRelic
         end
 
         def reject_messaging_synthetics_header headers
-          headers.reject {|k,_| k == NewRelic::Agent::CrossAppTracing::NR_MESSAGE_BROKER_SYNTHETICS_HEADER}
+          headers.reject {|k,_| k == CrossAppTracing::NR_MESSAGE_BROKER_SYNTHETICS_HEADER}
         end
 
       end

data/lib/new_relic/agent/new_relic_service.rb

@@ -92,14 +92,16 @@ module NewRelic
         token = Agent.config[:security_policies_token]
 
         if token && !token.empty?
-          response = invoke_remote(:preconnect, [{'security_policies_token' => token}])
+          response = invoke_remote(:preconnect, [{'security_policies_token' => token, 'high_security' => false}])
 
           validator = SecurityPolicySettings::Validator.new(response)
           validator.validate_matching_agent_config!
 
           response
+        elsif Agent.config[:high_security]
+          invoke_remote(:preconnect, [{'high_security' => true}])
         else
-          invoke_remote(:preconnect, [])
+          invoke_remote(:preconnect, [{'high_security' => false}])
         end
       end
 
@@ -196,10 +198,10 @@ module NewRelic
         encoding = 'identity'
         if data.size > 64 * 1024
           encoding = Agent.config[:compressed_content_encoding]
-          data = if encoding == 'gzip'
-            Encoders::Compressed::Gzip.encode(data)
-          else
+          data = if encoding == 'deflate'
             Encoders::Compressed::Deflate.encode(data)
+          else
+            Encoders::Compressed::Gzip.encode(data)
           end
         end
         check_post_size(data, endpoint)

data/lib/new_relic/agent/noticible_error.rb

@@ -0,0 +1,22 @@
+# 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
+
+module NewRelic
+  module Agent
+
+    # This class is used for instrumentations that have exceptions or error classes
+    # not derived from Ruby's usual Exception or StandardError or in situations
+    # where we do not have such Exception object to work with.
+    class NoticibleError
+      attr_reader :class_name, :message
+
+      def initialize class_name, message
+        @class_name = class_name
+        @message = message
+      end
+    end
+
+  end
+end

data/lib/new_relic/agent/span_event_aggregator.rb

@@ -12,6 +12,7 @@ module NewRelic
     class SpanEventAggregator < EventAggregator
       named :SpanEventAggregator
       capacity_key :'span_events.max_samples_stored'
+
       enabled_keys :'span_events.enabled',
                    :'distributed_tracing.enabled'
 

data/lib/new_relic/agent/span_event_primitive.rb

@@ -1,12 +1,13 @@
 # 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
 
 # This module builds the data structures necessary to create a Span
 # event for a segment.
 
 require 'new_relic/agent/payload_metric_mapping'
-require 'new_relic/agent/distributed_trace_payload'
+require 'new_relic/agent/distributed_tracing/distributed_trace_payload'
 
 module NewRelic
   module Agent
@@ -15,70 +16,80 @@ module NewRelic
       extend self
 
       # Strings for static keys of the event structure
-      TYPE_KEY             = 'type'.freeze
-      TRACE_ID_KEY         = 'traceId'.freeze
-      GUID_KEY             = 'guid'.freeze
-      PARENT_ID_KEY        = 'parentId'.freeze
-      GRANDPARENT_ID_KEY   = 'grandparentId'.freeze
-      TRANSACTION_ID_KEY   = 'transactionId'.freeze
-      SAMPLED_KEY          = 'sampled'.freeze
-      PRIORITY_KEY         = 'priority'.freeze
-      TIMESTAMP_KEY        = 'timestamp'.freeze
-      DURATION_KEY         = 'duration'.freeze
-      NAME_KEY             = 'name'.freeze
-      CATEGORY_KEY         = 'category'.freeze
-      HTTP_URL_KEY         = 'http.url'.freeze
-      HTTP_METHOD_KEY      = 'http.method'.freeze
-      COMPONENT_KEY        = 'component'.freeze
-      DB_INSTANCE_KEY      = 'db.instance'.freeze
-      DB_STATEMENT_KEY     = 'db.statement'.freeze
-      PEER_ADDRESS_KEY     = 'peer.address'.freeze
-      PEER_HOSTNAME_KEY    = 'peer.hostname'.freeze
-      SPAN_KIND_KEY        = 'span.kind'.freeze
-      ENTRY_POINT_KEY      = 'nr.entryPoint'.freeze
+      ELLIPSIS             = '...'
+      TYPE_KEY             = 'type'
+      TRACE_ID_KEY         = 'traceId'
+      GUID_KEY             = 'guid'
+      PARENT_ID_KEY        = 'parentId'
+      GRANDPARENT_ID_KEY   = 'grandparentId'
+      TRANSACTION_ID_KEY   = 'transactionId'
+      SAMPLED_KEY          = 'sampled'
+      PRIORITY_KEY         = 'priority'
+      TIMESTAMP_KEY        = 'timestamp'
+      DURATION_KEY         = 'duration'
+      NAME_KEY             = 'name'
+      CATEGORY_KEY         = 'category'
+      HTTP_URL_KEY         = 'http.url'
+      HTTP_METHOD_KEY      = 'http.method'
+      HTTP_STATUS_CODE_KEY = 'http.statusCode'
+      COMPONENT_KEY        = 'component'
+      DB_INSTANCE_KEY      = 'db.instance'
+      DB_STATEMENT_KEY     = 'db.statement'
+      PEER_ADDRESS_KEY     = 'peer.address'
+      PEER_HOSTNAME_KEY    = 'peer.hostname'
+      SPAN_KIND_KEY        = 'span.kind'
+      ENTRY_POINT_KEY      = 'nr.entryPoint'
+      TRUSTED_PARENT_KEY   = "trustedParentId"
+      TRACING_VENDORS_KEY  = "tracingVendors"
 
       # Strings for static values of the event structure
-      EVENT_TYPE         = 'Span'.freeze
-      GENERIC_CATEGORY   = 'generic'.freeze
-      HTTP_CATEGORY      = 'http'.freeze
-      DATASTORE_CATEGORY = 'datastore'.freeze
-      CLIENT             = 'client'.freeze
-
-      # To avoid allocations when we have empty custom or agent attributes
-      EMPTY_HASH = {}.freeze
+      EVENT_TYPE         = 'Span'
+      GENERIC_CATEGORY   = 'generic'
+      HTTP_CATEGORY      = 'http'
+      DATASTORE_CATEGORY = 'datastore'
+      CLIENT             = 'client'
+
+      # Builds a Hash of error attributes as well as the Span ID when
+      # an error is present.  Otherwise, returns nil when no error present.
+      def error_attributes segment
+        return if Agent.config[:high_security] || !segment.noticed_error
+        segment.noticed_error.build_error_attributes
+        segment.noticed_error_attributes
+      end
 
-      def for_segment(segment)
+      def for_segment segment
         intrinsics = intrinsics_for(segment)
         intrinsics[CATEGORY_KEY] = GENERIC_CATEGORY
 
-        [intrinsics, EMPTY_HASH, EMPTY_HASH]
+        [intrinsics, custom_attributes(segment.attributes), error_attributes(segment) || NewRelic::EMPTY_HASH]
       end
 
-      def for_external_request_segment(segment)
+      def for_external_request_segment segment
         intrinsics = intrinsics_for(segment)
 
         intrinsics[COMPONENT_KEY]   = segment.library
         intrinsics[HTTP_METHOD_KEY] = segment.procedure
+        intrinsics[HTTP_STATUS_CODE_KEY] = segment.http_status_code if segment.http_status_code
         intrinsics[CATEGORY_KEY]    = HTTP_CATEGORY
         intrinsics[SPAN_KIND_KEY]   = CLIENT
 
-        agent_attributes = {}
+        agent_attributes = error_attributes(segment) || {}
 
         if allowed?(HTTP_URL_KEY)
           agent_attributes[HTTP_URL_KEY] = truncate(segment.uri)
         end
 
-        [intrinsics, EMPTY_HASH, agent_attributes]
+        [intrinsics, custom_attributes(segment.attributes), agent_attributes]
       end
 
-      def for_datastore_segment(segment)
+      def for_datastore_segment segment
         intrinsics = intrinsics_for(segment)
 
         intrinsics[COMPONENT_KEY] = segment.product
         intrinsics[SPAN_KIND_KEY] = CLIENT
         intrinsics[CATEGORY_KEY] = DATASTORE_CATEGORY
 
-        agent_attributes = {}
+        agent_attributes = error_attributes(segment) || {}
 
         if segment.database_name && allowed?(DB_INSTANCE_KEY)
           agent_attributes[DB_INSTANCE_KEY] = truncate(segment.database_name)
@@ -96,14 +107,13 @@ module NewRelic
           agent_attributes[DB_STATEMENT_KEY] = truncate(segment.nosql_statement, 2000)
         end
 
-        [intrinsics, EMPTY_HASH, agent_attributes]
+        [intrinsics, custom_attributes(segment.attributes), agent_attributes]
       end
 
       private
 
-      def intrinsics_for(segment)
-        intrinsics =
-        {
+      def intrinsics_for segment
+        intrinsics = {
           TYPE_KEY           => EVENT_TYPE,
           TRACE_ID_KEY       => segment.transaction.trace_id,
           GUID_KEY           => segment.guid,
@@ -115,29 +125,48 @@ module NewRelic
           NAME_KEY           => segment.name
         }
 
-        parent_id = parent_guid(segment)
-        intrinsics[PARENT_ID_KEY] = parent_id if parent_id
-
-        intrinsics[ENTRY_POINT_KEY] = true unless segment.parent
+        if segment.parent.nil?
+          intrinsics[ENTRY_POINT_KEY] = true
+          if txn = segment.transaction
+            if header_data = txn.distributed_tracer.trace_context_header_data
+              if trace_state_vendors = header_data.trace_state_vendors
+                intrinsics[TRACING_VENDORS_KEY] = trace_state_vendors unless trace_state_vendors == NewRelic::EMPTY_STR
+              end
+            end
+            if trace_state_payload = txn.distributed_tracer.trace_state_payload
+              intrinsics[TRUSTED_PARENT_KEY] = trace_state_payload.id if trace_state_payload.id
+            end
+          end
+        end
 
+        if parent_id = parent_guid(segment)
+          intrinsics[PARENT_ID_KEY] = parent_id
+        end
         intrinsics
       end
 
-      def parent_guid(segment)
+      def custom_attributes attributes
+        if attributes
+          result = attributes.custom_attributes_for(NewRelic::Agent::AttributeFilter::DST_SPAN_EVENTS)
+          result.freeze
+        else
+          NewRelic::EMPTY_HASH
+        end
+      end
+
+      def parent_guid segment
         if segment.parent
           segment.parent.guid
-        elsif segment.transaction && segment.transaction.distributed_trace?
-          segment.transaction.distributed_trace_payload.id
+        elsif txn = segment.transaction
+          txn.distributed_tracer.parent_guid
         end
       end
 
-      def milliseconds_since_epoch(segment)
+      def milliseconds_since_epoch segment
         Integer(segment.start_time.to_f * 1000.0)
       end
 
-      ELLIPSIS = '...'.freeze
-
-      def truncate(value, max_size=255)
+      def truncate value, max_size=255
         value = value.to_s
         if value.bytesize > max_size
           value.byteslice(0, max_size - 2).chop! << ELLIPSIS
@@ -146,7 +175,7 @@ module NewRelic
         end
       end
 
-      def allowed?(key)
+      def allowed? key
         NewRelic::Agent.instance.attribute_filter.allows_key?(key, AttributeFilter::DST_SPAN_EVENTS)
       end
     end