newrelic_rpm 4.8.0.341 → 6.13.1

data/lib/new_relic/agent/configuration/dotted_hash.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

data/lib/new_relic/agent/configuration/environment_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
@@ -9,7 +9,8 @@ module NewRelic
         SUPPORTED_PREFIXES = /^new_relic_|^newrelic_/i
         SPECIAL_CASE_KEYS  = [
           'NEW_RELIC_ENV', # read by NewRelic::Control::Frameworks::Ruby
-          'NEW_RELIC_LOG'  # read by set_log_file
+          'NEW_RELIC_LOG',  # read by set_log_file
+          /^NEW_RELIC_METADATA_/ # read by NewRelic::Agent::Connect::RequestBuilder
         ]
 
         attr_accessor :alias_map, :type_map
@@ -66,7 +67,8 @@ module NewRelic
           nr_env_var_keys = collect_new_relic_environment_variable_keys
 
           nr_env_var_keys.each do |key|
-            next if SPECIAL_CASE_KEYS.include?(key.upcase)
+            next if SPECIAL_CASE_KEYS.any? { |pattern| pattern === key.upcase }
+
             set_value_from_environment_variable(key)
           end
         end

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

@@ -0,0 +1,45 @@
+# 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 Configuration
+      module EventHarvestConfig
+
+        extend self
+
+        EVENT_HARVEST_CONFIG_KEY_MAPPING = {
+          :analytic_event_data => :'analytics_events.max_samples_stored',
+          :custom_event_data => :'custom_insights_events.max_samples_stored',
+          :error_event_data => :'error_collector.max_event_samples_stored',
+          :span_event_data => :'span_events.max_samples_stored'
+        }
+
+        def from_config(config)
+          {:harvest_limits => EVENT_HARVEST_CONFIG_KEY_MAPPING.inject({}) do
+            |connect_payload, (connect_payload_key, config_key)|
+              connect_payload[connect_payload_key] = config[config_key]
+              connect_payload
+            end
+          }
+        end
+
+        def to_config_hash(connect_reply)
+          event_harvest_interval = connect_reply['event_harvest_config']['report_period_ms'] / 1000
+          config_hash = EVENT_HARVEST_CONFIG_KEY_MAPPING.inject({}) do
+            |event_harvest_config, (connect_payload_key, config_key)|
+              if harvest_limit = connect_reply['event_harvest_config']['harvest_limits'][connect_payload_key.to_s]
+                event_harvest_config[config_key] = harvest_limit
+                report_period_key = :"event_report_period.#{connect_payload_key}"
+                event_harvest_config[report_period_key] = event_harvest_interval
+              end
+              event_harvest_config
+            end
+          config_hash[:event_report_period] = event_harvest_interval
+          config_hash
+        end
+      end
+    end
+  end
+end

data/lib/new_relic/agent/configuration/high_security_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'
 
@@ -10,11 +10,10 @@ module NewRelic
       class HighSecuritySource < DottedHash
         def initialize(local_settings)
           super({
-            :ssl => true,
-
             :capture_params           => false,
             :'resque.capture_params'  => false,
             :'sidekiq.capture_params' => false,
+            :'attributes.include'     => [],
 
             :'transaction_tracer.record_sql' => record_sql_setting(local_settings, :'transaction_tracer.record_sql'),
             :'slow_sql.record_sql'           => record_sql_setting(local_settings, :'slow_sql.record_sql'),

data/lib/new_relic/agent/configuration/manager.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 'forwardable'
 require 'new_relic/agent/configuration/mask_defaults'
@@ -9,6 +9,7 @@ require 'new_relic/agent/configuration/default_source'
 require 'new_relic/agent/configuration/server_source'
 require 'new_relic/agent/configuration/environment_source'
 require 'new_relic/agent/configuration/high_security_source'
+require 'new_relic/agent/configuration/security_policy_source'
 
 module NewRelic
   module Agent
@@ -44,12 +45,13 @@ module NewRelic
 
         def remove_config_type(sym)
           source = case sym
-          when :high_security then @high_security_source
-          when :environment   then @environment_source
-          when :server        then @server_source
-          when :manual        then @manual_source
-          when :yaml          then @yaml_source
-          when :default       then @default_source
+          when :security_policy then @security_policy_source
+          when :high_security   then @high_security_source
+          when :environment     then @environment_source
+          when :server          then @server_source
+          when :manual          then @manual_source
+          when :yaml            then @yaml_source
+          when :default         then @default_source
           end
 
           remove_config(source)
@@ -57,12 +59,13 @@ module NewRelic
 
         def remove_config(source)
           case source
-          when HighSecuritySource then @high_security_source = nil
-          when EnvironmentSource  then @environment_source   = nil
-          when ServerSource       then @server_source        = nil
-          when ManualSource       then @manual_source        = nil
-          when YamlSource         then @yaml_source          = nil
-          when DefaultSource      then @default_source       = nil
+          when SecurityPolicySource then @security_policy_source = nil
+          when HighSecuritySource   then @high_security_source   = nil
+          when EnvironmentSource    then @environment_source     = nil
+          when ServerSource         then @server_source          = nil
+          when ManualSource         then @manual_source          = nil
+          when YamlSource           then @yaml_source            = nil
+          when DefaultSource        then @default_source         = nil
           else
             @configs_for_testing.delete_if {|src,lvl| src == source}
           end
@@ -78,12 +81,13 @@ module NewRelic
 
           invoke_callbacks(:add, source)
           case source
-          when HighSecuritySource then @high_security_source = source
-          when EnvironmentSource  then @environment_source   = source
-          when ServerSource       then @server_source        = source
-          when ManualSource       then @manual_source        = source
-          when YamlSource         then @yaml_source          = source
-          when DefaultSource      then @default_source       = source
+          when SecurityPolicySource then @security_policy_source = source
+          when HighSecuritySource   then @high_security_source   = source
+          when EnvironmentSource    then @environment_source     = source
+          when ServerSource         then @server_source          = source
+          when ManualSource         then @manual_source          = source
+          when YamlSource           then @yaml_source            = source
+          when DefaultSource        then @default_source         = source
           else
             NewRelic::Agent.logger.warn("Invalid config format; config will be ignored: #{source}")
           end
@@ -91,6 +95,7 @@ module NewRelic
           reset_cache
           log_config(:add, source)
 
+          notify_server_source_added if ServerSource === source
           notify_finished_configuring if !was_finished && finished_configuring?
         end
 
@@ -167,8 +172,19 @@ module NewRelic
           end
         end
 
+        # This event is intended to be fired every time the server source is
+        # applied.  This happens after the agent's initial connect, and again
+        # on every forced reconnect.
+        def notify_server_source_added
+          NewRelic::Agent.instance.events.notify(:server_source_configuration_added)
+        end
+
+        # This event is intended to be fired once during the entire lifespan of
+        # an agent run, after the server source has been applied for the first
+        # time.  This should indicate that all configuration has been applied,
+        # and the main functions of the agent are safe to start.
         def notify_finished_configuring
-          NewRelic::Agent.instance.events.notify(:finished_configuring)
+          NewRelic::Agent.instance.events.notify(:initial_configuration_complete)
         end
 
         def finished_configuring?
@@ -212,14 +228,6 @@ module NewRelic
           end
         end
 
-        def app_names
-          case NewRelic::Agent.config[:app_name]
-          when Array then NewRelic::Agent.config[:app_name]
-          when String then NewRelic::Agent.config[:app_name].split(';')
-          else []
-          end
-        end
-
         MALFORMED_LABELS_WARNING = "Skipping malformed labels configuration"
         PARSING_LABELS_FAILURE   = "Failure during parsing labels. Ignoring and carrying on with connect."
 
@@ -323,14 +331,15 @@ module NewRelic
 
         # Generally only useful during initial construction and tests
         def reset_to_defaults
-          @high_security_source = nil
-          @environment_source   = EnvironmentSource.new
-          @server_source        = nil
-          @manual_source        = nil
-          @yaml_source          = nil
-          @default_source       = DefaultSource.new
+          @security_policy_source = nil
+          @high_security_source   = nil
+          @environment_source     = EnvironmentSource.new
+          @server_source          = nil
+          @manual_source          = nil
+          @yaml_source            = nil
+          @default_source         = DefaultSource.new
 
-          @configs_for_testing  = []
+          @configs_for_testing    = []
 
           reset_cache
         end
@@ -350,13 +359,14 @@ module NewRelic
         end
 
         def delete_all_configs_for_testing
-          @high_security_source = nil
-          @environment_source   = nil
-          @server_source        = nil
-          @manual_source        = nil
-          @yaml_source          = nil
-          @default_source       = nil
-          @configs_for_testing  = []
+          @security_policy_source = nil
+          @high_security_source   = nil
+          @environment_source     = nil
+          @server_source          = nil
+          @manual_source          = nil
+          @yaml_source            = nil
+          @default_source         = nil
+          @configs_for_testing    = []
         end
 
         def num_configs_for_testing
@@ -370,7 +380,8 @@ module NewRelic
         private
 
         def config_stack
-          stack = [@high_security_source,
+          stack = [@security_policy_source,
+                   @high_security_source,
                    @environment_source,
                    @server_source,
                    @manual_source,

data/lib/new_relic/agent/configuration/manual_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'
 

data/lib/new_relic/agent/configuration/mask_defaults.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

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

@@ -0,0 +1,238 @@
+# 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/agent/configuration/dotted_hash'
+
+module NewRelic
+  module Agent
+    module Configuration
+      class SecurityPolicySource < DottedHash
+        class << self
+          def enabled?(option)
+            Agent.config[option]
+          end
+
+          def record_sql_enabled?(option)
+            Agent.config[option] == 'obfuscated' ||
+              Agent.config[option] == 'raw' ||
+              false
+          end
+
+          def not_empty?(option)
+            !Agent.config[option].empty?
+          end
+
+          def change_setting(policies, option, new_value)
+            current_value = Agent.config[option]
+            unless current_value == new_value
+              NewRelic::Agent.logger.info \
+                "Setting changed: {#{option}: from #{current_value} " \
+                "to #{new_value}}. Source: SecurityPolicySource"
+            end
+            policies[option] = new_value
+          end
+        end
+
+        # The keys of the security settings map are the names of security
+        # policies received from the server. They map to multiple configuration
+        # options in the local config. There is a hash of metadata that
+        # corresponds to each configuration option with the following keys:
+        #
+        # option: the configuration option name
+        # supported: true if the agent has one or more corresponding
+        #   configuration options
+        # enabled_fn: a callable that takes the configuration option and returns
+        #   true if the option is enabled, false otherwise
+        # disabled_value: the value of the configuration option when it is
+        #   disabled
+        # permitted_fn: a callable, that will be executed if an option is
+        #   permitted by the security policy and is also enabled by the config
+
+        SECURITY_SETTINGS_MAP = {
+          "record_sql" => [
+            {
+              option:         :'transaction_tracer.record_sql',
+              supported:      true,
+              enabled_fn:     method(:record_sql_enabled?),
+              disabled_value: 'off',
+              permitted_fn:   proc { |policies|
+                change_setting(policies, :'transaction_tracer.record_sql', 'obfuscated')
+              }
+            },
+            {
+              option:         :'slow_sql.record_sql',
+              supported:      true,
+              enabled_fn:     method(:record_sql_enabled?),
+              disabled_value: 'off',
+              permitted_fn:   proc { |policies|
+                change_setting(policies, :'slow_sql.record_sql', 'obfuscated')
+              }
+            },
+            {
+              option:         :'mongo.capture_queries',
+              supported:      true,
+              enabled_fn:     method(:enabled?),
+              disabled_value: false,
+              permitted_fn:   proc{ |policies|
+                change_setting(policies, :'mongo.obfuscate_queries', true)
+              }
+            },
+            {
+              option:         :'transaction_tracer.record_redis_arguments',
+              supported:      true,
+              enabled_fn:     method(:enabled?),
+              disabled_value: false,
+              permitted_fn:   nil
+            }
+          ],
+          "attributes_include" => [
+            {
+              option:         :'attributes.include',
+              supported:      true,
+              enabled_fn:     method(:not_empty?),
+              disabled_value: [],
+              permitted_fn:   nil
+            },
+            {
+              option:         :'transaction_tracer.attributes.include',
+              supported:      true,
+              enabled_fn:     method(:not_empty?),
+              disabled_value: [],
+              permitted_fn:   nil
+            },
+            {
+              option:         :'transaction_events.attributes.include',
+              supported:      true,
+              enabled_fn:     method(:not_empty?),
+              disabled_value: [],
+              permitted_fn:   nil
+            },
+            {
+              option:         :'error_collector.attributes.include',
+              supported:      true,
+              enabled_fn:     method(:not_empty?),
+              disabled_value: [],
+              permitted_fn:   nil
+            },
+            {
+              option:         :'browser_monitoring.attributes.include',
+              supported:      true,
+              enabled_fn:     method(:not_empty?),
+              disabled_value: [],
+              permitted_fn:   nil
+            },
+            {
+              option:         :'span_events.attributes.include',
+              supported:      true,
+              enabled_fn:     method(:not_empty?),
+              disabled_value: [],
+              permitted_fn:   nil
+            },
+            {
+              option:         :'transaction_segments.attributes.include',
+              supported:      true,
+              enabled_fn:     method(:not_empty?),
+              disabled_value: [],
+              permitted_fn:   nil
+            }
+          ],
+          "allow_raw_exception_messages" => [
+            {
+              option:         :'strip_exception_messages.enabled',
+              supported:      true,
+              enabled_fn:     method(:enabled?),
+              disabled_value: false,
+              permitted_fn:   nil
+            }
+          ],
+          "custom_events" => [
+            {
+              option:         :'custom_insights_events.enabled',
+              supported:      true,
+              enabled_fn:     method(:enabled?),
+              disabled_value: false,
+              permitted_fn:   nil
+            }
+          ],
+          "custom_parameters" => [
+            {
+              option:         :'custom_attributes.enabled',
+              supported:      true,
+              enabled_fn:     method(:enabled?),
+              disabled_value: false,
+              permitted_fn:   nil
+            }
+          ],
+          "custom_instrumentation_editor" => [
+            {
+              option:         nil,
+              supported:      false,
+              enabled_fn:     nil,
+              disabled_value: nil,
+              permitted_fn:   nil
+            }
+          ],
+          "message_parameters" => [
+            {
+              option:         :'message_tracer.segment_parameters.enabled',
+              supported:      true,
+              enabled_fn:     method(:enabled?),
+              disabled_value: false,
+              permitted_fn:   nil
+            }
+          ],
+          "job_arguments" => [
+            {
+              option:         :'resque.capture_params',
+              supported:      true,
+              enabled_fn:     method(:enabled?),
+              disabled_value: false,
+              permitted_fn:   nil
+            },
+            {
+              option:         :'sidekiq.capture_params',
+              supported:      true,
+              enabled_fn:     method(:enabled?),
+              disabled_value: false,
+              permitted_fn:   nil
+            }
+          ]
+        }
+
+        def initialize(security_policies)
+          super(build_overrides(security_policies))
+        end
+
+        ENABLED = "enabled".freeze
+        COLON_COLON = "::".freeze
+
+        def build_overrides(security_policies)
+          security_policies.inject({}) do |settings, (policy_name, policy_settings)|
+            SECURITY_SETTINGS_MAP[policy_name].each do |policy|
+              next unless policy[:supported]
+              if policy_settings[ENABLED]
+                if policy[:enabled_fn].call(policy[:option])
+                  if permitted_fn = policy[:permitted_fn]
+                    permitted_fn.call(settings)
+                  end
+                else
+                  config_source = Agent.config.source(policy[:option]).class.name.split(COLON_COLON).last
+                  NewRelic::Agent.logger.info \
+                    "Setting applied: {#{policy[:option]}: #{policy[:disabled_value]}}. " \
+                    "Source: #{config_source}"
+                end
+              else
+                settings[policy[:option]] =  policy[:disabled_value]
+                NewRelic::Agent.logger.info \
+                  "Setting applied: {#{policy[:option]}: #{policy[:disabled_value]}}. " \
+                  "Source: SecurityPolicySource"
+              end
+            end
+            settings
+          end
+        end
+      end
+    end
+  end
+end