newrelic_rpm 4.0.0.332 → 6.13.1

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

@@ -1,6 +1,6 @@
 # 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.
+# See https://github.com/newrelic/newrelic-ruby-agent/blob/main/LICENSE for complete details.
 
 module NewRelic
   module Agent
@@ -10,6 +10,7 @@ module NewRelic
         # response, but should still be merged in as config settings to the
         # main agent configuration.
         TOP_LEVEL_KEYS = [
+          "account_id",
           "apdex_t",
           "application_id",
           "beacon",
@@ -19,12 +20,17 @@ module NewRelic
           "browser_monitoring.loader_version",
           "cross_process_id",
           "data_report_period",
-          "data_report_periods.analytic_event_data",
           "encoding_key",
+          "entity_guid",
           "error_beacon",
           "js_agent_file",
           "js_agent_loader",
-          "trusted_account_ids"
+          "max_payload_size_in_bytes",
+          "primary_application_id",
+          "sampling_target",
+          "sampling_target_period_in_seconds",
+          "trusted_account_ids",
+          "trusted_account_key"
         ]
 
         def initialize(connect_reply, existing_config={})
@@ -33,6 +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_harvest_config(merged_settings, connect_reply)
           filter_keys(merged_settings)
 
           apply_feature_gates(merged_settings, connect_reply, existing_config)
@@ -63,11 +70,44 @@ module NewRelic
 
         def fix_transaction_threshold(merged_settings)
           # when value is "apdex_f" remove the config and defer to default
-          if merged_settings['transaction_tracer.transaction_threshold'] =~ /apdex_f/i
+          if merged_settings['transaction_tracer.transaction_threshold'].to_s =~ /apdex_f/i
             merged_settings.delete('transaction_tracer.transaction_threshold')
           end
         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)
           merged_settings.delete_if do |key, _|
             setting_spec = DEFAULTS[key.to_sym]
@@ -97,7 +137,8 @@ module NewRelic
             'error_collector.enabled'        => 'collect_errors',
             'analytics_events.enabled'       => 'collect_analytics_events',
             'custom_insights_events.enabled' => 'collect_custom_events',
-            'error_collector.capture_events' => 'collect_error_events'
+            'error_collector.capture_events' => 'collect_error_events',
+            'span_events.enabled'            => 'collect_span_events'
           }
           gated_features.each do |config_key, gate_key|
             if connect_reply.has_key?(gate_key)

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

@@ -1,6 +1,6 @@
 # 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.
+# See https://github.com/newrelic/newrelic-ruby-agent/blob/main/LICENSE for complete details.
 
 require 'new_relic/agent/configuration/dotted_hash'
 
@@ -9,11 +9,20 @@ module NewRelic
     module Configuration
       class YamlSource < DottedHash
         attr_accessor :file_path, :failures
+        attr_reader :generated_for_user, :license_key
 
         def initialize(path, env)
+          @path = path
           config    = {}
           @failures = []
 
+          # These are needed in process_erb for populating the newrelic.yml via
+          # erb binding, necessary when using the default newrelic.yml file. They
+          # are defined as ivars instead of local variables to prevent
+          # `assigned but unused variable` warnings when running with -W
+          @generated_for_user = ''
+          @license_key = ''
+
           begin
             @file_path = validate_config_file_path(path)
             return unless @file_path
@@ -81,20 +90,10 @@ module NewRelic
             # ERB template commented at the YML level is fine. Leave the line,
             # though, so ERB line numbers remain correct.
             file.gsub!(/^\s*#.*$/, '#')
-
-            # Next two are for populating the newrelic.yml via erb binding, necessary
-            # when using the default newrelic.yml file
-            generated_for_user = ''
-            license_key = ''
-
             ERB.new(file).result(binding)
           rescue ScriptError, StandardError => e
             log_failure("Failed ERB processing configuration file. This is typically caused by a Ruby error in <% %> templating blocks in your newrelic.yml file.", e)
             nil
-          ensure
-            # Avoid warnings by using these again
-            generated_for_user = nil
-            license_key = nil
           end
         end
 
@@ -113,30 +112,34 @@ module NewRelic
 
         def substitute_transaction_threshold(config)
           if config['transaction_tracer'] &&
-              config['transaction_tracer']['transaction_threshold'] =~ /apdex_f/i
+              config['transaction_tracer']['transaction_threshold'].to_s =~ /apdex_f/i
             # when value is "apdex_f" remove the config and defer to default
             config['transaction_tracer'].delete('transaction_threshold')
           end
         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

@@ -0,0 +1,61 @@
+# 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.
+
+require 'new_relic/environment_report'
+require 'new_relic/agent/configuration/event_harvest_config'
+
+module NewRelic
+  module Agent
+    module Connect
+
+      class RequestBuilder
+
+        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
+
+
+        # Initializes the hash of settings that we send to the
+        # server. Returns a literal hash containing the options
+        def connect_payload
+          {
+            :pid           => $$,
+            :host          => local_host,
+            :display_host  => Agent.config[:'process_host.display_name'],
+            :app_name      => Agent.config[:app_name],
+            :language      => 'ruby',
+            :labels        => Agent.config.parsed_labels,
+            :agent_version => NewRelic::VERSION::STRING,
+            :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_name].sort.join(',')}",
+            :event_harvest_config => @event_harvest_config
+          }
+        end
+
+        # We've seen objects in the environment report (Rails.env in
+        # particular) that can't seralize to JSON. Cope with that here and
+        # clear out so downstream code doesn't have to check again.
+        def sanitize_environment_report(environment_report)
+          return [] unless @service.valid_to_marshal?(environment_report)
+          environment_report
+        end
+
+        def environment_metadata
+          ENV.select {|k, v| k =~ /^NEW_RELIC_METADATA_/}
+        end
+
+        def local_host
+          NewRelic::Agent::Hostname.get
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,61 @@
+# 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.
+
+
+module NewRelic
+  module Agent
+    module Connect
+
+      class ResponseHandler
+
+        def initialize(agent, config)
+          @agent = agent
+          @config = config
+        end
+
+        # Takes a hash of configuration data returned from the
+        # server and uses it to set local variables and to
+        # initialize various parts of the agent that are configured
+        # separately.
+        #
+        # Can accommodate most arbitrary data - anything extra is
+        # ignored unless we say to do something with it here.
+        def configure_agent(config_data)
+          return if config_data == nil
+
+          @agent.agent_id = config_data['agent_run_id']
+
+          security_policies = config_data.delete('security_policies')
+
+          add_server_side_config(config_data)
+          add_security_policy_config(security_policies) if security_policies
+
+          @agent.transaction_rules = RulesEngine.create_transaction_rules(config_data)
+          @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(:initial_configuration_complete) callback instead!
+        end
+
+        def add_server_side_config(config_data)
+          if config_data['agent_config']
+            ::NewRelic::Agent.logger.debug "Using config from server"
+          end
+
+          ::NewRelic::Agent.logger.debug "Server provided config: #{config_data.inspect}"
+          server_config = NewRelic::Agent::Configuration::ServerSource.new(config_data, @config)
+          @config.replace_or_add_config(server_config)
+        end
+
+        def add_security_policy_config(security_policies)
+          ::NewRelic::Agent.logger.info 'Installing security policies'
+          security_policy_source = NewRelic::Agent::Configuration::SecurityPolicySource.new(security_policies)
+          @config.replace_or_add_config(security_policy_source)
+          # drop data collected before applying security policies
+          @agent.drop_buffered_data
+        end
+      end
+    end
+  end
+end

data/lib/new_relic/agent/custom_event_aggregator.rb

@@ -1,6 +1,6 @@
 # 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.
+# See https://github.com/newrelic/newrelic-ruby-agent/blob/main/LICENSE for complete details.
 
 require 'new_relic/agent/event_aggregator'
 require 'new_relic/agent/attribute_processing'
@@ -12,6 +12,7 @@ module NewRelic
 
       TYPE             = 'type'.freeze
       TIMESTAMP        = 'timestamp'.freeze
+      PRIORITY         = 'priority'.freeze
       EVENT_TYPE_REGEX = /^[a-zA-Z0-9:_ ]+$/.freeze
 
       named :CustomEventAggregator
@@ -23,25 +24,35 @@ module NewRelic
           raise ArgumentError, "Expected Hash but got #{attributes.class}"
         end
 
+        return unless enabled?
+
         type = @type_strings[type]
         unless type =~ EVENT_TYPE_REGEX
           note_dropped_event(type)
           return false
         end
 
-        event = [
-          { TYPE => type, TIMESTAMP => Time.now.to_i },
-          AttributeProcessing.flatten_and_coerce(attributes)
-        ]
+        priority = attributes[:priority] || rand
 
         stored = @lock.synchronize do
-          @buffer.append(event)
+          @buffer.append(priority: priority) do
+            create_event(type, priority, attributes)
+          end
         end
         stored
       end
 
       private
 
+      def create_event(type, priority, attributes)
+        [
+          { TYPE => type, TIMESTAMP => Time.now.to_i,
+            PRIORITY => priority
+          },
+          AttributeProcessing.flatten_and_coerce(attributes)
+        ]
+      end
+
       def after_initialize
         @type_strings = Hash.new { |hash, key| hash[key] = key.to_s.freeze }
       end

data/lib/new_relic/agent/database.rb

@@ -1,6 +1,6 @@
 # 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.
+# See https://github.com/newrelic/newrelic-ruby-agent/blob/main/LICENSE for complete details.
 
 require 'singleton'
 require 'new_relic/agent/database/explain_plan_helpers'
@@ -24,6 +24,7 @@ module NewRelic
   module Agent
     module Database
       MAX_QUERY_LENGTH = 16384
+      ELLIPSIS = "...".freeze
 
       extend self
 
@@ -42,7 +43,7 @@ module NewRelic
 
       def truncate_query(query)
         if query.length > (MAX_QUERY_LENGTH - 4)
-          query[0..MAX_QUERY_LENGTH - 4] + '...'
+          query[0..MAX_QUERY_LENGTH - 4] << ELLIPSIS
         else
           query
         end
@@ -132,10 +133,9 @@ module NewRelic
       ]
 
       SQL_COMMENT_REGEX = Regexp.new('/\*.*?\*/', Regexp::MULTILINE).freeze
-      EMPTY_STRING      = ''.freeze
 
       def parse_operation_from_query(sql)
-        sql = Helper.correctly_encoded(sql).gsub(SQL_COMMENT_REGEX, EMPTY_STRING)
+        sql = Helper.correctly_encoded(sql).gsub(SQL_COMMENT_REGEX, NewRelic::EMPTY_STR)
         if sql =~ /(\w+)/
           op = $1.downcase
           return op if KNOWN_OPERATIONS.include?(op)
@@ -194,6 +194,20 @@ module NewRelic
           @host = host
           @port_path_or_id = port_path_or_id
           @database_name = database_name
+          @safe_sql = nil
+        end
+
+        # Returns an sql statement that will be in the form most permissable by
+        # the config. The format will be safe for transmission to New Relic.
+        def safe_sql
+          @safe_sql ||= case Database.record_sql_method
+            when :obfuscated
+              Database.obfuscate_sql(self)
+            when :raw
+              sql.to_s
+            else
+              nil
+            end
         end
 
         # This takes a connection config hash from ActiveRecord or Sequel and
@@ -221,15 +235,23 @@ module NewRelic
           end
         end
 
+        NEWLINE = "\n".freeze
+
+        def append_sql new_sql
+          return if new_sql.empty?
+          @sql = Database.truncate_query(@sql << NEWLINE << new_sql)
+        end
+
         private
 
+        POSTGIS_PREFIX  = 'postgis'.freeze
         POSTGRES_PREFIX = 'postgres'.freeze
         MYSQL_PREFIX    = 'mysql'.freeze
         MYSQL2_PREFIX   = 'mysql2'.freeze
         SQLITE_PREFIX   = 'sqlite'.freeze
 
         def symbolized_adapter(adapter)
-          if adapter.start_with? POSTGRES_PREFIX
+          if adapter.start_with?(POSTGRES_PREFIX) || adapter == POSTGIS_PREFIX
             :postgres
           elsif adapter == MYSQL_PREFIX
             :mysql
@@ -244,8 +266,6 @@ module NewRelic
           end
         end
 
-        ELLIPSIS = "...".freeze
-
         def explainable?
           return false unless @explainer && is_select?(@sql)
 
@@ -264,6 +284,11 @@ module NewRelic
             return false
           end
 
+          if multiple_queries?(@sql)
+            NewRelic::Agent.logger.debug('Unable to collect explain plan for multiple queries.')
+            return false
+          end
+
           true
         end
       end