newrelic_rpm 6.3.0.355 → 6.8.0.360

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

@@ -21,6 +21,7 @@ module NewRelic
           "cross_process_id",
           "data_report_period",
           "encoding_key",
+          "entity_guid",
           "error_beacon",
           "js_agent_file",
           "js_agent_loader",
@@ -38,7 +39,7 @@ module NewRelic
           merge_top_level_keys(merged_settings, connect_reply)
           merge_agent_config_hash(merged_settings, connect_reply)
           fix_transaction_threshold(merged_settings)
-          add_event_data(merged_settings, connect_reply)
+          add_event_harvest_config(merged_settings, connect_reply)
           filter_keys(merged_settings)
 
           apply_feature_gates(merged_settings, connect_reply, existing_config)
@@ -74,14 +75,37 @@ module NewRelic
           end
         end
 
-        def add_event_data(merged_settings, connect_reply)
-            if connect_reply['event_data']
-              merged_settings.merge! EventData.to_config_hash(connect_reply)
-            else
-              NewRelic::Agent.logger.warn "No event data configuration found " \
-                  "in connect response; using default event report period."
-              NewRelic::Agent.record_metric('Supportability/Agent/Collector/MissingEventData', 1)
-            end
+        EVENT_HARVEST_CONFIG_SUPPORTABILITY_METRIC_NAMES = {
+          :'analytics_events.max_samples_stored' => 'Supportability/EventHarvest/AnalyticEventData/HarvestLimit',
+          :'custom_insights_events.max_samples_stored' => 'Supportability/EventHarvest/CustomEventData/HarvestLimit',
+          :'error_collector.max_event_samples_stored'=> 'Supportability/EventHarvest/ErrorEventData/HarvestLimit',
+          :'span_events.max_samples_stored'=> 'Supportability/EventHarvest/SpanEventData/HarvestLimit',
+          :event_report_period => 'Supportability/EventHarvest/ReportPeriod'
+        }
+
+        def add_event_harvest_config(merged_settings, connect_reply)
+          return unless event_harvest_config_is_valid connect_reply
+
+          event_harvest_config = EventHarvestConfig.to_config_hash(connect_reply)
+          EVENT_HARVEST_CONFIG_SUPPORTABILITY_METRIC_NAMES.each do |config_key, metric_name|
+            NewRelic::Agent.record_metric metric_name, event_harvest_config[config_key]
+          end
+
+          merged_settings.merge! event_harvest_config
+        end
+
+        def event_harvest_config_is_valid connect_reply
+          event_harvest_config = connect_reply['event_harvest_config']
+
+          if event_harvest_config.nil? \
+              || event_harvest_config['harvest_limits'].values.min < 0 \
+              || (event_harvest_config['report_period_ms'] / 1000) <= 0
+            NewRelic::Agent.logger.warn "Invalid event harvest config found " \
+                "in connect response; using default event report period."
+            false
+          else
+            true
+          end
         end
 
         def filter_keys(merged_settings)

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

@@ -12,6 +12,7 @@ module NewRelic
         attr_reader :generated_for_user, :license_key
 
         def initialize(path, env)
+          @path = path
           config    = {}
           @failures = []
 
@@ -118,23 +119,27 @@ module NewRelic
         end
 
         def booleanify_values(config, *keys)
-          # auto means defer ro default
+          # auto means defer to default
           keys.each do |option|
-            if config[option] == 'auto'
+            if 'auto' == config[option]
               config.delete(option)
             elsif !config[option].nil? && !is_boolean?(config[option])
-              config[option] = !!(config[option] =~ /yes|on|true/i)
+              coerced_value = !!(config[option].to_s =~ /yes|on|true/i)
+              if !coerced_value
+                log_failure "Unexpected value (#{config[option]}) for '#{option}' in #{@path}"
+              end
+              config[option] = coerced_value
             end
           end
         end
 
         def is_boolean?(value)
-          value == !!value
+          !!value == value
         end
 
         def log_failure(*messages)
           ::NewRelic::Agent.logger.error(*messages)
-          @failures << messages
+          messages.each { |message| @failures << message }
         end
       end
     end

data/lib/new_relic/agent/connect/request_builder.rb

@@ -3,7 +3,7 @@
 # See https://github.com/newrelic/rpm/blob/master/LICENSE for complete details.
 
 require 'new_relic/environment_report'
-require 'new_relic/agent/configuration/event_data'
+require 'new_relic/agent/configuration/event_harvest_config'
 
 module NewRelic
   module Agent
@@ -11,9 +11,11 @@ module NewRelic
 
       class RequestBuilder
 
-        def initialize(new_relic_service, config)
+        def initialize(new_relic_service, config, event_harvest_config, environment_report)
           @service = new_relic_service
           @config = config
+          @event_harvest_config = event_harvest_config
+          @environment_report = sanitize_environment_report(environment_report)
         end
 
 
@@ -24,16 +26,17 @@ module NewRelic
             :pid           => $$,
             :host          => local_host,
             :display_host  => Agent.config[:'process_host.display_name'],
-            :app_name      => Agent.config.app_names,
+            :app_name      => Agent.config[:app_name],
             :language      => 'ruby',
             :labels        => Agent.config.parsed_labels,
             :agent_version => NewRelic::VERSION::STRING,
-            :environment   => sanitize_environment_report(environment_report),
+            :environment   => @environment_report,
+            :metadata      => environment_metadata,
             :settings      => Agent.config.to_collector_hash,
             :high_security => Agent.config[:high_security],
             :utilization   => UtilizationData.new.to_collector_hash,
-            :identifier    => "ruby:#{local_host}:#{Agent.config.app_names.sort.join(',')}",
-            :event_data    => Configuration::EventData.from_config(Agent.config)
+            :identifier    => "ruby:#{local_host}:#{Agent.config[:app_name].sort.join(',')}",
+            :event_harvest_config => @event_harvest_config
           }
         end
 
@@ -45,13 +48,8 @@ module NewRelic
           environment_report
         end
 
-        # Checks whether we should send environment info, and if so,
-        # returns the snapshot from the local environment.
-        # Generating the EnvironmentReport has the potential to trigger
-        # require calls in Rails environments, so this method should only
-        # be called synchronously from on the main thread.
-        def environment_report
-          Agent.config[:send_environment_info] ? Array(EnvironmentReport.new) : []
+        def environment_metadata
+          ENV.select {|k, v| k =~ /^NEW_RELIC_METADATA_/}
         end
 
         def local_host

data/lib/new_relic/agent/connect/response_handler.rb

@@ -35,7 +35,7 @@ module NewRelic
           @agent.stats_engine.metric_rules = RulesEngine.create_metric_rules(config_data)
 
           # If you're adding something else here to respond to the server-side config,
-          # use Agent.instance.events.subscribe(:finished_configuring) callback instead!
+          # use Agent.instance.events.subscribe(:initial_configuration_complete) callback instead!
         end
 
         def add_server_side_config(config_data)

data/lib/new_relic/agent/cross_app_monitor.rb

@@ -28,7 +28,7 @@ module NewRelic
 
       def path_hash(txn_name, seed)
         rotated    = ((seed << 1) | (seed >> 31)) & 0xffffffff
-        app_name   = NewRelic::Agent.config.app_names.first
+        app_name   = NewRelic::Agent.config[:app_name].first
         identifier = "#{app_name};#{txn_name}"
         sprintf("%08x", rotated ^ hash_transaction_name(identifier))
       end

data/lib/new_relic/agent/datastores/mongo/event_formatter.rb

@@ -13,7 +13,7 @@ module NewRelic
           OBFUSCATE_KEYS = [ 'filter', 'query', 'pipeline' ].freeze
 
           # Keys that will get completely removed from the statement.
-          BLACKLISTED_KEYS = [ 'deletes', 'documents', 'updates' ].freeze
+          DENYLISTED_KEYS = [ 'deletes', 'documents', 'updates' ].freeze
 
           def self.format(command_name, database_name, command)
             return nil unless NewRelic::Agent.config[:'mongo.capture_queries']
@@ -25,7 +25,7 @@ module NewRelic
             }
 
             command.each do |key, value|
-              next if BLACKLISTED_KEYS.include?(key)
+              next if DENYLISTED_KEYS.include?(key)
               if OBFUSCATE_KEYS.include?(key)
                 obfuscated = obfuscate(value)
                 result[key] = obfuscated if obfuscated

data/lib/new_relic/agent/datastores/mongo/obfuscator.rb

@@ -8,31 +8,31 @@ module NewRelic
       module Mongo
         module Obfuscator
 
-          WHITELIST = [:operation].freeze
+          ALLOWLIST = [:operation].freeze
 
-          def self.obfuscate_statement(source, whitelist = WHITELIST)
+          def self.obfuscate_statement(source, allowlist = ALLOWLIST)
             if source.is_a? Hash
               obfuscated = {}
               source.each do |key, value|
-                if whitelist.include?(key)
+                if allowlist.include?(key)
                   obfuscated[key] = value
                 else
-                  obfuscated[key] = obfuscate_value(value, whitelist)
+                  obfuscated[key] = obfuscate_value(value, allowlist)
                 end
               end
               obfuscated
             else
-              obfuscate_value(source, whitelist)
+              obfuscate_value(source, allowlist)
             end
           end
 
           QUESTION_MARK = '?'.freeze
 
-          def self.obfuscate_value(value, whitelist = WHITELIST)
+          def self.obfuscate_value(value, allowlist = ALLOWLIST)
             if value.is_a?(Hash)
-              obfuscate_statement(value, whitelist)
+              obfuscate_statement(value, allowlist)
             elsif value.is_a?(Array)
-              value.map {|v| obfuscate_value(v, whitelist)}
+              value.map {|v| obfuscate_value(v, allowlist)}
             else
               QUESTION_MARK
             end

data/lib/new_relic/agent/distributed_trace_intrinsics.rb

@@ -0,0 +1,90 @@
+# 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 'new_relic/agent/distributed_trace_transport_type'
+
+module NewRelic
+  module Agent
+    module DistributedTraceIntrinsics
+      extend self
+
+      # Intrinsic Keys
+      PARENT_TYPE_KEY                = "parent.type".freeze
+      PARENT_APP_KEY                 = "parent.app".freeze
+      PARENT_ACCOUNT_ID_KEY          = "parent.account".freeze
+      PARENT_TRANSPORT_TYPE_KEY      = "parent.transportType".freeze
+      PARENT_TRANSPORT_DURATION_KEY  = "parent.transportDuration".freeze
+      GUID_KEY                       = "guid".freeze
+      TRACE_ID_KEY                   = "traceId".freeze
+      PARENT_TRANSACTION_ID_KEY      = "parentId".freeze
+      PARENT_SPAN_ID_KEY             = "parentSpanId".freeze
+      SAMPLED_KEY                    = "sampled".freeze
+
+      INTRINSIC_KEYS = [
+        PARENT_TYPE_KEY,
+        PARENT_APP_KEY,
+        PARENT_ACCOUNT_ID_KEY,
+        PARENT_TRANSPORT_TYPE_KEY,
+        PARENT_TRANSPORT_DURATION_KEY,
+        GUID_KEY,
+        TRACE_ID_KEY,
+        PARENT_TRANSACTION_ID_KEY,
+        PARENT_SPAN_ID_KEY,
+        SAMPLED_KEY
+      ].freeze
+
+      # This method extracts intrinsics from the transaction_payload and
+      # inserts them into the specified destination.
+      def copy_to_hash transaction_payload, destination
+        return unless enabled?
+        INTRINSIC_KEYS.each do |key|
+          value = transaction_payload[key]
+          destination[key] = value unless value.nil?
+        end
+      end
+
+      # This method extracts intrinsics from the transaction_payload and
+      # inserts them as intrinsics in the specified transaction_attributes
+      def copy_to_attributes transaction_payload, destination
+        return unless enabled?
+        INTRINSIC_KEYS.each do |key|
+          next unless transaction_payload.key? key
+          destination.add_intrinsic_attribute key, transaction_payload[key]
+        end
+      end
+
+      # This method takes all distributed tracing intrinsics from the transaction
+      # and the distributed_trace_payload, and populates them into the destination
+      def copy_from_transaction transaction, distributed_trace_payload, destination
+        destination[GUID_KEY] = transaction.guid
+        destination[SAMPLED_KEY] = transaction.sampled?
+        destination[TRACE_ID_KEY] = transaction.trace_id
+
+        if transaction.parent_span_id
+          destination[PARENT_SPAN_ID_KEY] = transaction.parent_span_id
+        end
+
+        if distributed_trace_payload
+          destination[PARENT_TYPE_KEY] = distributed_trace_payload.parent_type
+          destination[PARENT_APP_KEY] = distributed_trace_payload.parent_app_id
+          destination[PARENT_ACCOUNT_ID_KEY] = distributed_trace_payload.parent_account_id
+          destination[PARENT_TRANSPORT_TYPE_KEY] = DistributedTraceTransportType.from distributed_trace_payload.caller_transport_type
+
+          destination[PARENT_TRANSPORT_DURATION_KEY] = transaction.calculate_transport_duration distributed_trace_payload
+
+          if transaction.parent_transaction_id
+            destination[PARENT_TRANSACTION_ID_KEY] = transaction.parent_transaction_id
+          end
+        end
+      end
+
+      private
+
+      def enabled?
+        return Agent.config[:'distributed_tracing.enabled']
+      end
+
+    end
+  end
+end

data/lib/new_relic/agent/distributed_trace_metrics.rb

@@ -0,0 +1,74 @@
+# 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 DistributedTraceMetrics
+      extend self
+
+      ALL_SUFFIX = "all".freeze
+      ALL_WEB_SUFFIX = "allWeb".freeze
+      ALL_OTHER_SUFFIX = "allOther".freeze
+
+      DURATION_BY_CALLER_UNKOWN_PREFIX = "DurationByCaller/Unknown/Unknown/Unknown/Unknown".freeze
+      ERRORS_BY_CALLER_UNKOWN_PREFIX = "ErrorsByCaller/Unknown/Unknown/Unknown/Unknown".freeze
+
+      def transaction_type_suffix
+        if Transaction.recording_web_transaction?
+          ALL_WEB_SUFFIX
+        else
+          ALL_OTHER_SUFFIX
+        end
+      end
+
+      def record_metrics_for_transaction transaction
+        return unless Agent.config[:'distributed_tracing.enabled']
+        payload = if transaction.distributed_trace_payload
+          transaction.distributed_trace_payload
+        elsif transaction.trace_state_payload
+          transaction.trace_state_payload
+        end
+
+        record_caller_by_duration_metrics transaction, payload
+        record_transport_duration_metrics transaction, payload
+        record_errors_by_caller_metrics transaction, payload
+      end
+
+      def record_caller_by_duration_metrics transaction, payload
+        prefix = if payload
+          "DurationByCaller/#{payload.parent_type}/#{payload.parent_account_id}/#{payload.parent_app_id}/#{payload.caller_transport_type}"
+        else
+          DURATION_BY_CALLER_UNKOWN_PREFIX
+        end
+
+        transaction.metrics.record_unscoped "#{prefix}/#{ALL_SUFFIX}",              transaction.duration
+        transaction.metrics.record_unscoped "#{prefix}/#{transaction_type_suffix}", transaction.duration
+      end
+
+      def record_transport_duration_metrics transaction, payload
+        return unless payload
+
+        prefix = "TransportDuration/#{payload.parent_type}/#{payload.parent_account_id}/#{payload.parent_app_id}/#{payload.caller_transport_type}"
+        duration = transaction.calculate_transport_duration payload
+
+        transaction.metrics.record_unscoped "#{prefix}/#{ALL_SUFFIX}",              duration
+        transaction.metrics.record_unscoped "#{prefix}/#{transaction_type_suffix}", duration
+      end
+
+      def record_errors_by_caller_metrics transaction, payload
+        return unless transaction.exceptions.size > 0
+
+        prefix = if payload
+          "ErrorsByCaller/#{payload.parent_type}/#{payload.parent_account_id}/#{payload.parent_app_id}/#{payload.caller_transport_type}"
+        else
+          ERRORS_BY_CALLER_UNKOWN_PREFIX
+        end
+
+        transaction.metrics.record_unscoped "#{prefix}/#{ALL_SUFFIX}",              1
+        transaction.metrics.record_unscoped "#{prefix}/#{transaction_type_suffix}", 1
+      end
+    end
+  end
+end

data/lib/new_relic/agent/distributed_trace_monitor.rb

@@ -2,6 +2,7 @@
 # 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/distributed_trace_transport_type'
 require 'new_relic/agent/inbound_request_monitor'
 require 'new_relic/agent/cross_app_tracing'
 
@@ -21,20 +22,9 @@ module NewRelic
         return unless txn = Tracer.current_transaction
 
         if txn.accept_distributed_trace_payload payload
-          txn.distributed_trace_payload.caller_transport_type = transport_type(request)
+          txn.distributed_trace_payload.caller_transport_type = DistributedTraceTransportType.for_rack_request(request)
         end
       end
-
-      URL_SCHEMES = {
-        'http'  => 'HTTP'.freeze,
-        'https' => 'HTTPS'.freeze
-      }
-
-      RACK_URL_SCHEME = 'rack.url_scheme'.freeze
-
-      def transport_type(request)
-        URL_SCHEMES[request[RACK_URL_SCHEME]]
-      end
     end
   end
 end

data/lib/new_relic/agent/distributed_trace_payload.rb

@@ -5,6 +5,8 @@ require 'json'
 require 'base64'
 require 'set'
 
+require 'new_relic/agent/distributed_trace_transport_type'
+
 module NewRelic
   module Agent
     #
@@ -32,35 +34,6 @@ module NewRelic
       TIMESTAMP_KEY              = 'ti'.freeze
       PRIORITY_KEY               = 'pr'.freeze
 
-      # Intrinsic Keys
-      PARENT_TYPE_INTRINSIC_KEY                = "parent.type".freeze
-      PARENT_APP_INTRINSIC_KEY                 = "parent.app".freeze
-      PARENT_ACCOUNT_ID_INTRINSIC_KEY          = "parent.account".freeze
-      PARENT_TRANSPORT_TYPE_INTRINSIC_KEY      = "parent.transportType".freeze
-      PARENT_TRANSPORT_DURATION_INTRINSIC_KEY  = "parent.transportDuration".freeze
-      GUID_INTRINSIC_KEY                       = "guid".freeze
-      TRACE_ID_INTRINSIC_KEY                   = "traceId".freeze
-      PARENT_ID_INTRINSIC_KEY                  = "parentId".freeze
-      PARENT_SPAN_ID_INTRINSIC_KEY             = "parentSpanId".freeze
-      SAMPLED_INTRINSIC_KEY                    = "sampled".freeze
-      COMMA                                    = ",".freeze
-
-      INTRINSIC_KEYS = [
-        PARENT_TYPE_INTRINSIC_KEY,
-        PARENT_APP_INTRINSIC_KEY,
-        PARENT_ACCOUNT_ID_INTRINSIC_KEY,
-        PARENT_TRANSPORT_TYPE_INTRINSIC_KEY,
-        PARENT_TRANSPORT_DURATION_INTRINSIC_KEY,
-        GUID_INTRINSIC_KEY,
-        TRACE_ID_INTRINSIC_KEY,
-        PARENT_ID_INTRINSIC_KEY,
-        PARENT_SPAN_ID_INTRINSIC_KEY,
-        SAMPLED_INTRINSIC_KEY
-      ].freeze
-
-      # Intrinsic Values
-      PARENT_TRANSPORT_TYPE_UNKNOWN = 'Unknown'.freeze
-
       class << self
 
         def for_transaction transaction
@@ -110,24 +83,12 @@ module NewRelic
           from_json decoded_payload
         end
 
-        def assign_initial_intrinsics transaction, transaction_payload
-          transaction_payload[GUID_INTRINSIC_KEY] = transaction.guid
-          transaction_payload[TRACE_ID_INTRINSIC_KEY] = transaction.trace_id
-          transaction_payload[SAMPLED_INTRINSIC_KEY] = transaction.sampled?
-        end
-
         def major_version_matches?(payload)
           payload.version[0] == VERSION[0]
         end
 
         private
 
-        # We use the presence of the account_id and primary_application in the
-        # config to tell if we have connected yet.
-        def connected?
-          Agent.config[:account_id] && Agent.config[:primary_application_id]
-        end
-
         def assign_trusted_account_key payload, account_id
           trusted_account_key = Agent.config[:trusted_account_key]
 
@@ -142,6 +103,10 @@ module NewRelic
             transaction.current_segment.guid
           end
         end
+
+        def connected?
+          Agent.instance.connected?
+        end
       end
 
       attr_accessor :version,
@@ -160,12 +125,12 @@ module NewRelic
 
       attr_reader :caller_transport_type
 
-      def caller_transport_type=(type)
-        @caller_transport_type = valid_transport_type_for(type)
+      def caller_transport_type= type
+        @caller_transport_type = DistributedTraceTransportType.from type
       end
 
       def initialize
-        @caller_transport_type = PARENT_TRANSPORT_TYPE_UNKNOWN
+        @caller_transport_type = DistributedTraceTransportType::UNKNOWN
       end
 
       # Represent this payload as a raw JSON string.
@@ -205,38 +170,6 @@ module NewRelic
       def http_safe
         Base64.strict_encode64 text
       end
-
-      def assign_intrinsics transaction, transaction_payload
-        transaction_payload[PARENT_TYPE_INTRINSIC_KEY] = parent_type
-        transaction_payload[PARENT_APP_INTRINSIC_KEY] = parent_app_id
-        transaction_payload[PARENT_ACCOUNT_ID_INTRINSIC_KEY] = parent_account_id
-        transaction_payload[PARENT_TRANSPORT_TYPE_INTRINSIC_KEY] = caller_transport_type
-        transaction_payload[PARENT_TRANSPORT_DURATION_INTRINSIC_KEY] = transaction.transport_duration
-        transaction_payload[GUID_INTRINSIC_KEY] = transaction.guid
-        transaction_payload[TRACE_ID_INTRINSIC_KEY] = trace_id
-        transaction_payload[PARENT_ID_INTRINSIC_KEY] = transaction.parent_id if transaction.parent_id
-        transaction_payload[PARENT_SPAN_ID_INTRINSIC_KEY] = id if id
-        transaction_payload[SAMPLED_INTRINSIC_KEY] = transaction.sampled?
-      end
-
-      private
-
-      ALLOWABLE_TRANSPORT_TYPES = Set.new(%w[
-        Unknown
-        HTTP
-        HTTPS
-        Kafka
-        JMS
-        IronMQ
-        AMQP
-        Queue
-        Other
-      ]).freeze
-
-      def valid_transport_type_for(value)
-        return value if ALLOWABLE_TRANSPORT_TYPES.include?(value)
-        PARENT_TRANSPORT_TYPE_UNKNOWN
-      end
     end
   end
 end