newrelic_rpm 6.7.0.359 → 6.8.0.360

data/lib/new_relic/agent/autostart.rb

@@ -20,23 +20,28 @@ module NewRelic
 
 
       # The constants, executables (i.e. $0) and rake tasks used can be
-      # configured with the config keys 'autostart.blacklisted_constants',
-      # 'autostart.blacklisted_executables' and
-      # 'autostart.blacklisted_rake_tasks'
+      # configured with the config keys 'autostart.denylisted_constants',
+      # 'autostart.denylisted_executables' and
+      # 'autostart.denylisted_rake_tasks'
       def agent_should_start?
-          !blacklisted_constants? &&
-          !blacklisted_executables? &&
-          !in_blacklisted_rake_task?
+          !denylisted_constants? &&
+          !denylisted_executables? &&
+          !in_denylisted_rake_task?
       end
 
-      def blacklisted_constants?
-        blacklisted?(NewRelic::Agent.config[:'autostart.blacklisted_constants']) do |name|
+      COMMA = ",".freeze
+
+      def denylisted_constants?
+        # For backwards compatibility until :'autostart_blacklisted_constants' config option is removed
+        constants = NewRelic::Agent.config[:'autostart.denylisted_constants'] << COMMA << NewRelic::Agent.config[:'autostart.blacklisted_constants']
+
+        denylisted?(constants) do |name|
           constant_is_defined?(name)
         end
       end
 
-      def blacklisted_executables?
-        blacklisted?(NewRelic::Agent.config[:'autostart.blacklisted_executables']) do |bin|
+      def denylisted_executables?
+        denylisted?(NewRelic::Agent.config[:'autostart.denylisted_executables']) do |bin|
           File.basename($0) == bin
         end
       end
@@ -47,18 +52,18 @@ module NewRelic
         !!::NewRelic::LanguageSupport.constantize(const_name)
       end
 
-      def blacklisted?(value, &block)
+      def denylisted?(value, &block)
         value.split(/\s*,\s*/).any?(&block)
       end
 
-      def in_blacklisted_rake_task?
+      def in_denylisted_rake_task?
         tasks = begin
                   ::Rake.application.top_level_tasks
                 rescue => e
-            ::NewRelic::Agent.logger.debug("Not in Rake environment so skipping blacklisted_rake_tasks check: #{e}")
+            ::NewRelic::Agent.logger.debug("Not in Rake environment so skipping denylisted_rake_tasks check: #{e}")
             []
           end
-        !(tasks & ::NewRelic::Agent.config[:'autostart.blacklisted_rake_tasks'].split(/\s*,\s*/)).empty?
+        !(tasks & ::NewRelic::Agent.config[:'autostart.denylisted_rake_tasks'].split(/\s*,\s*/)).empty?
       end
     end
   end

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

@@ -218,9 +218,19 @@ module NewRelic
           end
           const_names.compact
         end
+
+        def self.enforce_fallback(allowed_values: nil, fallback: nil)
+          Proc.new do |configured_value|
+            if allowed_values.any? { |v| v =~ /#{configured_value}/i }
+              configured_value
+            else
+              fallback
+            end
+          end
+        end
       end
 
-      AUTOSTART_BLACKLISTED_RAKE_TASKS = [
+      AUTOSTART_DENYLISTED_RAKE_TASKS = [
         'about',
         'assets:clean',
         'assets:clobber',
@@ -416,6 +426,17 @@ module NewRelic
           :description => 'Autodetected application framework used to enable framework-specific functionality.'
         },
         :'autostart.blacklisted_constants' => {
+          :default => 'Rails::Console',
+          :public => true,
+          :type => String,
+          :allowed_from_server => false,
+          :description => 'Deprecated.  ' \
+              'For agent versions 6.8.0 or higher, ' \
+              'use <a href="#autostart-denylisted_constants"><code>' \
+                'autostart.denylisted_constants' \
+              '</code></a> instead.'
+        },
+        :'autostart.denylisted_constants' => {
           :default => 'Rails::Console',
           :public => true,
           :type => String,
@@ -427,10 +448,32 @@ module NewRelic
           :public => true,
           :type => String,
           :allowed_from_server => false,
+          :description => 'Deprecated.  ' \
+              'For agent versions 6.8.0 or higher, ' \
+              'use <a href="#autostart-denylisted_executables"><code>' \
+                'autostart.denylisted_executables' \
+              '</code></a> instead.'
+        },
+        :'autostart.denylisted_executables' => {
+          :default => value_of(:'autostart.blacklisted_executables'),
+          :public => true,
+          :type => String,
+          :allowed_from_server => false,
           :description => 'Defines a comma-delimited list of executables that the agent should not instrument. For example, <code>rake,my_ruby_script.rb</code>.'
         },
         :'autostart.blacklisted_rake_tasks' => {
-          :default => AUTOSTART_BLACKLISTED_RAKE_TASKS,
+          :default => AUTOSTART_DENYLISTED_RAKE_TASKS,
+          :public => true,
+          :type => String,
+          :allowed_from_server => false,
+          :description => 'Deprecated.  ' \
+              'For agent versions 6.8.0 or higher, ' \
+              'use <a href="#autostart-denylisted_rake_tasks"><code>' \
+                'autostart.denylisted_rake_tasks' \
+              '</code></a> instead.'
+        },
+        :'autostart.denylisted_rake_tasks' => {
+          :default => value_of(:'autostart.blacklisted_rake_tasks'),
           :public => true,
           :type => String,
           :allowed_from_server => false,
@@ -478,15 +521,29 @@ module NewRelic
           :public => true,
           :type => Boolean,
           :allowed_from_server => false,
-          :description => 'If true, the agent strips messages from all exceptions except those in the <a href="#strip_exception_messages-whitelist">whitelist</a>. Enabled automatically in <a href="https://docs.newrelic.com/docs/accounts-partnerships/accounts/security/high-security">high security mode</a>.'
+          :description => 'If true, the agent strips messages from all exceptions except those in the <a href="#strip_exception_messages-allowlist">allowlist</a>. Enabled automatically in <a href="https://docs.newrelic.com/docs/accounts-partnerships/accounts/security/high-security">high security mode</a>.'
         },
         :'strip_exception_messages.whitelist' => {
           :default => '',
           :public => true,
           :type => String,
+          :deprecated => true,
           :allowed_from_server => false,
           :transform => DefaultSource.method(:convert_to_constant_list),
-          :description => 'Specify a whitelist of exceptions you do not want the agent to strip when <a href="#strip_exception_messages-enabled">strip_exception_messages</a> is <code>true</code>. Separate exceptions with a comma. For example, <code>"ImportantException,PreserveMessageException"</code>.'
+          :description => 'Deprecated.  ' \
+              'For agent versions 6.8.0 or higher, ' \
+              'use <a href="#strip_exception_messages-allowlist"><code>' \
+                'strip_exception_messages.allowed_classes' \
+              '</code></a> instead.'
+        },
+        :'strip_exception_messages.allowed_classes' => {
+          :default => '',
+          :public => true,
+          :type => String,
+          :deprecated => true,
+          :allowed_from_server => false,
+          :transform => DefaultSource.method(:convert_to_constant_list),
+          :description => 'Specify a list of exceptions you do not want the agent to strip when <a href="#strip_exception_messages-enabled">strip_exception_messages</a> is <code>true</code>. Separate exceptions with a comma. For example, <code>"ImportantException,PreserveMessageException"</code>.'
         },
         :host => {
           :default => DefaultSource.host,
@@ -545,7 +602,7 @@ module NewRelic
           :description => 'Use HTTP PUT requests instead of POST.'
         },
         :compressed_content_encoding => {
-          :default => 'deflate',
+          :default => 'gzip',
           :public => false,
           :type => String,
           :allowed_from_server => false,
@@ -1831,6 +1888,16 @@ module NewRelic
           :allowed_from_server => false,
           :description => 'Distributed tracing lets you see the path that a request takes through your distributed system. Enabling distributed tracing changes the behavior of some New Relic features, so carefully consult the <a href="https://docs.newrelic.com/docs/transition-guide-distributed-tracing">transition guide</a> before you enable this feature.'
         },
+        :'distributed_tracing.format' => {
+          :default => 'newrelic',
+          :public => false,
+          :type => String,
+          :transform => DefaultSource.enforce_fallback(
+            allowed_values: ['w3c', 'newrelic'],
+            fallback: 'newrelic'),
+          :allowed_from_server => false,
+          :description => 'The format to use for distributed tracing if it is enabled. Options are w3c for W3C Trace Context or newrelic for New Relic Distriburted Tracing. Defaults to New Relic Distributed Tracing.'
+        },
         :trusted_account_key => {
           :default => nil,
           :allow_nil => true,

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

@@ -11,10 +11,11 @@ module NewRelic
 
       class RequestBuilder
 
-        def initialize(new_relic_service, config, event_harvest_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
 
 
@@ -29,7 +30,7 @@ module NewRelic
             :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],
@@ -47,15 +48,6 @@ 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) : []
-        end
-
         def environment_metadata
           ENV.select {|k, v| k =~ /^NEW_RELIC_METADATA_/}
         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