newrelic_rpm 6.7.0.359 → 6.8.0.360

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e0981d305747247f1ac56c96ff7268cfd8b9bd7d419e8b800f2daf9193ae1dee
-  data.tar.gz: 9b4ca44ed6641fe4ea5f71296d8042f3ed5024a9d8d1dc3230241f02cab529fd
+  metadata.gz: 07ac800f099e868f4ac7fb9e86972f5533c48d87bd28cb54b1015b5dfe4af601
+  data.tar.gz: 0e1daf547dc945b5b57c8ff09f4866b26f907796ae654d9ebdf4c409cde8cfdf
 SHA512:
-  metadata.gz: 8596846993859508c5acf8fc54155572332a75258f1970b01b9d89974ec7a4f935d5f728f2826bbac8190e49f368e51d961b6754f2742248a228458fa225763d
-  data.tar.gz: b07bc5d7dbd98faec43a76514ac6314f5f9c8667941db20b68ac4f13fddbf69656c7b75d1d3b02f4c1d46873aecf528bd5062c96f4895bf2a4234bd48da5999d
+  metadata.gz: 32b818ece7b0ac768d5ee8c8615633bc45ce6d7f3bc8e1a98ecc5632cc927c8dfa74266334f7fd6c55a468b6ff533deaed2773d90c1e32288598ea984f3e9aa0
+  data.tar.gz: a562491c09abeaaaf7de0fdb7b03e13706528144c004320b497bf214877831f221128bf92545ccac60bc02d4d696c2a6ecff5a3ca4091c3fba3bad8cba3ad287

data/.gitignore

@@ -1,4 +1,5 @@
 Gemfile.lock
+Guard*
 .DS\_Store
 .svn/
 *~

data/.travis.yml

@@ -16,14 +16,13 @@ before_install:
   - jdk_switcher use oraclejdk8
   - sudo rm -f /etc/apt/sources.list.d/travis_ci_zeromq3.list
   - gem --version
-  - ./test/script/before_install/update_rubygems.sh
-  - rvm @global do gem uninstall bundler --all --executables || true
-  - gem uninstall bundler --all --executables || true
-  - gem install bundler -v=1.17.3
+  - "echo 'gem: --no-rdoc --no-ri --no-document' > ~/.gemrc"
+  - ./test/script/before_install/conditionally_upgrade_rubygems.sh
   - ./test/script/before_install/gemstash_mirror.sh
+  - "echo GEMSTASH_MIRROR: $GEMSTASH_MIRROR"
   - bundle --version
 
-install: bundle install
+install: bundle install --jobs 4
 
 addons:
   apt:
@@ -43,10 +42,12 @@ branches:
     - master
     - dev
     - release
+    - RUBY-2227_w3c_trace_context_poc
 
 rvm:
   # Run slowest builds first to try and optimize overall cycle time.
   - jruby-9.2.6.0
+  - 2.7.0-preview1
   - 2.6.1
   - 2.5.3
   - 2.4.2
@@ -62,7 +63,7 @@ env:
   global:
     - BUNDLE_PATH=/home/travis/bundle
     - MONGODB=2.6.11
-    - JAVA_OPTS="-XX:+TieredCompilation -XX:TieredStopAtLevel=1 -Xmx640m"
+    - JAVA_OPTS="-XX:+TieredCompilation -XX:TieredStopAtLevel=1 -Xmx1024m -XX:CICompilerCount=1 -Xshare:auto"
     - JRUBY_OPTS="-Xcompile.invokedynamic=false -J-Djruby.compile.mode=OFF"
     - RBXOPT="-Xcompiler.no_rbc -Xint"
     - SERIALIZE=1
@@ -98,6 +99,40 @@ matrix:
   fast_finish: true
   exclude:
     # Unsupported Rails/Ruby combinations
+    # 2.7
+    - rvm: 2.7.0-preview1
+      env: TYPE=UNIT ENVIRONMENT=rails30
+    - rvm: 2.7.0-preview1
+      env: TYPE=UNIT ENVIRONMENT=rails31
+    - rvm: 2.7.0-preview1
+      env: TYPE=UNIT ENVIRONMENT=rails32
+    - rvm: 2.7.0-preview1
+      env: TYPE=UNIT ENVIRONMENT=rails40
+    - rvm: 2.7.0-preview1
+      env: TYPE=UNIT ENVIRONMENT=rails41
+
+    - rvm: 2.7.0-preview1
+      env: TYPE=UNIT ENVIRONMENT=rails42  # rails (= 4.2.11) depends on bundler (< 2.0, >= 1.3.0)
+    - rvm: 2.7.0-preview1
+      env: TYPE=UNIT ENVIRONMENT=rails50  # rails (= 5.0.0) depends on bundler (< 2.0, >= 1.3.0)
+    - rvm: 2.7.0-preview1
+      env: TYPE=UNIT ENVIRONMENT=rails51  # rails (= 5.1.0) depends on bundler (< 2.0, >= 1.3.0)
+    - rvm: 2.7.0-preview1
+      env: TYPE=FUNCTIONAL GROUP=api      # blocked: https://github.com/solnic/coercible/issues/27
+    - rvm: 2.7.0-preview1
+      env: TYPE=FUNCTIONAL GROUP=sinatra  # padrino (~> 0.14.0) depends on bundler (~> 1.0)
+
+    - rvm: 2.7.0-preview1
+      env: TYPE=UNIT ENVIRONMENT=rails42  # rails (= 4.2.11) depends on bundler (< 2.0, >= 1.3.0)
+    - rvm: 2.7.0-preview1
+      env: TYPE=UNIT ENVIRONMENT=rails50  # rails (= 5.0.0) depends on bundler (< 2.0, >= 1.3.0)
+    - rvm: 2.7.0-preview1
+      env: TYPE=UNIT ENVIRONMENT=rails51  # rails (= 5.1.0) depends on bundler (< 2.0, >= 1.3.0)
+    - rvm: 2.7.0-preview1
+      env: TYPE=FUNCTIONAL GROUP=api      # blocked: https://github.com/solnic/coercible/issues/27
+    - rvm: 2.7.0-preview1
+      env: TYPE=FUNCTIONAL GROUP=sinatra  # padrino (~> 0.14.0) depends on bundler (~> 1.0)
+
     # 2.6
     - rvm: 2.6.1
       env: TYPE=UNIT ENVIRONMENT=rails30

data/CHANGELOG.md

@@ -1,5 +1,81 @@
 # New Relic Ruby Agent Release Notes #
 
+  ## v6.8.0
+
+  * **Initial Ruby 2.7 support**
+
+    The Ruby agent has been verified to run with Ruby 2.7.0-preview1.
+
+  * **New API method to add custom attributes to Spans**
+
+    New API method for adding custom attributes to spans.  Previously, custom
+    attributes were only available at the Transaction level.  Now, with Span
+    level custom attributes, more granular tagging of events is possible for
+    easier isolation and review of trace events.  For more information:
+
+    * [`Agent#add_custom_span_attributes`](https://www.rubydoc.info/github/newrelic/rpm/NewRelic/Agent#add_custom_span_attributes)
+
+  * **Enables ability to migrate to Configurable Security Policies (CSP) on a per agent
+  basis for accounts already using High Security Mode (HSM).**
+
+    When both [HSM](https://docs.newrelic.com/docs/agents/manage-apm-agents/configuration/high-security-mode) and [CSP](https://docs.newrelic.com/docs/agents/manage-apm-agents/configuration/enable-configurable-security-policies) are enabled for an account, an agent (this version or later)
+    can successfully connect with either `high_security: true` or the appropriate
+    `security_policies_token` configured. `high_security` has been added as part of
+    the preconnect payload.
+
+  * **Bugfix for Logs in Context combined with act-fluent-logger-rails**
+
+    Previously, when using the Ruby agent's Logs in Context logger
+    to link logging data with trace and entity metadata for an
+    improved experience in the UI, customers who were also using
+    the `act-fluent-logger-rails` gem would see a `NoMethodError`
+    for `clear_tags!` that would interfere with the use of this
+    feature. This error no longer appears, allowing customers to
+    combine the use of Logs in Context with the use of this gem.
+
+    Please note that the Logs in Context logger does not support
+    tagged logging; if you are initializing your logger with a
+    `log_tags` argument, your custom tags may not appear on the
+    final version of your logs.
+
+  * **Bugfix for parsing invalid newrelic.yml**
+
+    Previously, if the newrelic.yml configuration file was invalid, and the agent
+    could not start as a result, the agent would not log any indication of
+    the problem.
+
+    This version of the agent will emit a FATAL message to STDOUT when this scenario
+    occurs so that customers can address issues with newrelic.yml that prevent startup.
+
+  * **Configuration options containing the terms "whitelist" and "blacklist" deprecated**
+
+    The following local configuration settings have been deprecated:
+
+    * `autostart.blacklisted_constants`: use `autostart.denylisted_constants` instead.
+    * `autostart.blacklisted_executables`: use `autostart.denylisted_executables` instead.
+    * `autostart.blacklisted_rake_tasks`: use `autostart.denylisted_rake_tasks` instead.
+    * `strip_exception_messages.whitelist`: use `strip_exception_messages.allowed_classes` instead.
+
+  * **Bugfix for module loading and constant resolution in Rails**
+
+    Starting in version 6.3, the Ruby agent has caused module loading and constant
+    resolution to sometimes fail, which caused errors in some Rails applications.
+    These errors were generally `NoMethodError` exceptions or I18n errors
+    `translation missing` or `invalid locale`.  These errors would not appear if the agent
+    was removed from the application's Gemfile.
+    This version of the agent fixes these issues with module loading and constant
+    resolution, so these errors no longer occur.
+
+  * **Bugfix: failed to get urandom**
+
+    Previous versions of the agent would fail unexpectedly when the Ruby process used
+    every available file descriptor.  The failures would include this message:
+    ```
+    ERROR : RuntimeError: failed to get urandom
+    ```
+    This version of the agent uses a different strategy for generating random IDs, and
+    will not fail in the same way when no file descriptors are available.
+
   ## v6.7.0
 
   * **Trace and Entity Metadata API**

data/Guardfile

@@ -1,4 +1,10 @@
-guard :minitest, :test_folders => ['test/new_relic'], :all_after_pass => false do
+guard_options = {
+  spring: "bundle exec ruby",
+  test_folders: ['test/new_relic', 'test'], 
+  all_after_pass: false
+}
+
+guard :minitest, guard_options do
   watch(%r{^lib/(.+)\.rb$})     { |m| "test/#{m[1]}_test.rb" }
   watch(%r{^test/.+_test\.rb$})
   watch(%r{^test/rum/.*})       { "test/new_relic/rack/browser_monitoring_test.rb" }

data/lib/new_relic/agent.rb

@@ -568,6 +568,12 @@ module NewRelic
     # these custom attributes will also be present in the script injected into
     # the response body, making them available on Insights PageView events.
     #
+    #
+    # @param [Hash] params      A Hash of attributes to be attached to the transaction event.
+    #                           Keys should be strings or symbols, and values
+    #                           may be strings, symbols, numeric values or
+    #                           booleans.
+    #
     # @api public
     #
     def add_custom_attributes(params) #THREAD_LOCAL_ACCESS
@@ -581,6 +587,31 @@ module NewRelic
       end
     end
 
+    # Add custom attributes to the span event for the current span. Attributes will be visible on spans in the
+    # New Relic Distributed Tracing UI and on span events in New Relic Insights.
+    #
+    # Custom attributes will not be transmitted when +high_security+ setting is enabled or
+    # +custom_attributes+ setting is disabled.
+    #
+    # @param [Hash] params      A Hash of attributes to be attached to the span event.
+    #                           Keys should be strings or symbols, and values
+    #                           may be strings, symbols, numeric values or
+    #                           booleans.
+    #
+    # @see https://docs.newrelic.com/docs/using-new-relic/welcome-new-relic/get-started/glossary#span
+    # @api public
+    def add_custom_span_attributes params
+      record_api_supportability_metric :add_custom_span_attributes
+
+      if params.is_a? Hash
+        if segment = NewRelic::Agent::Tracer.current_segment
+          segment.add_custom_attributes params
+        end
+      else
+        ::NewRelic::Agent.logger.warn "Bad argument passed to #add_custom_span_attributes. Expected Hash but got #{params.class}"
+      end
+    end
+
     # @!endgroup
 
     # @!group Transaction naming

data/lib/new_relic/agent/agent.rb

@@ -19,6 +19,7 @@ require 'new_relic/agent/commands/agent_command_router'
 require 'new_relic/agent/event_listener'
 require 'new_relic/agent/cross_app_monitor'
 require 'new_relic/agent/distributed_trace_monitor'
+require 'new_relic/agent/trace_context_request_monitor'
 require 'new_relic/agent/synthetics_monitor'
 require 'new_relic/agent/transaction_event_recorder'
 require 'new_relic/agent/custom_event_aggregator'
@@ -58,6 +59,7 @@ module NewRelic
         @agent_command_router      = NewRelic::Agent::Commands::AgentCommandRouter.new(@events)
         @cross_app_monitor         = NewRelic::Agent::CrossAppMonitor.new(@events)
         @distributed_trace_monitor = NewRelic::Agent::DistributedTraceMonitor.new(@events)
+        @trace_context_monitor     = NewRelic::Agent::TraceContextRequestMonitor.new(@events)
         @synthetics_monitor        = NewRelic::Agent::SyntheticsMonitor.new(@events)
         @error_collector           = NewRelic::Agent::ErrorCollector.new @events
         @transaction_rules         = NewRelic::Agent::RulesEngine.new
@@ -147,6 +149,7 @@ module NewRelic
         attr_reader :transaction_event_recorder
         attr_reader :attribute_filter
         attr_reader :adaptive_sampler
+        attr_reader :environment_report
 
         def transaction_event_aggregator
           @transaction_event_recorder.transaction_event_aggregator
@@ -482,6 +485,7 @@ module NewRelic
 
             unless in_resque_child_process?
               install_exit_handler
+              environment_for_connect
               @harvest_samplers.load_samplers unless Agent.config[:disable_samplers]
             end
 
@@ -789,7 +793,7 @@ module NewRelic
           # require calls in Rails environments, so this method should only
           # be called synchronously from on the main thread.
           def environment_for_connect
-            Agent.config[:send_environment_info] ? Array(EnvironmentReport.new) : []
+            @environment_report ||= Agent.config[:send_environment_info] ? Array(EnvironmentReport.new) : []
           end
 
           # Constructs and memoizes an event_harvest_config hash to be used in
@@ -805,7 +809,8 @@ module NewRelic
             request_builder = ::NewRelic::Agent::Connect::RequestBuilder.new \
               @service,
               Agent.config,
-              event_harvest_config
+              event_harvest_config,
+              environment_for_connect
             connect_response = @service.connect request_builder.connect_payload
 
             response_handler = ::NewRelic::Agent::Connect::ResponseHandler.new(self, Agent.config)

data/lib/new_relic/agent/agent_logger.rb

@@ -173,6 +173,10 @@ module NewRelic
         StartupLogger.instance.dump(self)
       end
 
+      def self.format_fatal_error message
+        "** [NewRelic] FATAL : #{message}\n"
+      end
+
     end
 
     # In an effort to not lose messages during startup, we trap them in memory

data/lib/new_relic/agent/attribute_filter.rb

@@ -121,7 +121,7 @@ module NewRelic
         @high_security = config[:high_security]
 
         setup_key_cache
-        cache_prefix_blacklist
+        cache_prefix_denylist
       end
 
       # Note the key_cache is a global cache, accessible by multiple threads,
@@ -222,16 +222,16 @@ module NewRelic
       # arguments for Sidekiq and Resque in the common case, since none of
       # these attributes are captured by default.
       #
-      def cache_prefix_blacklist
-        @prefix_blacklist = {}
-        @prefix_blacklist[:'request.parameters'] = true unless might_allow_prefix_uncached?(:'request.parameters')
-        @prefix_blacklist[:'job.sidekiq.args']   = true unless might_allow_prefix_uncached?(:'job.sidekiq.args')
-        @prefix_blacklist[:'job.resque.args']    = true unless might_allow_prefix_uncached?(:'job.resque.args')
+      def cache_prefix_denylist
+        @prefix_denylist = {}
+        @prefix_denylist[:'request.parameters'] = true unless might_allow_prefix_uncached?(:'request.parameters')
+        @prefix_denylist[:'job.sidekiq.args']   = true unless might_allow_prefix_uncached?(:'job.sidekiq.args')
+        @prefix_denylist[:'job.resque.args']    = true unless might_allow_prefix_uncached?(:'job.resque.args')
       end
 
       # Note that the given prefix *must* be a Symbol
       def might_allow_prefix?(prefix)
-        !@prefix_blacklist.include?(prefix)
+        !@prefix_denylist.include?(prefix)
       end
 
       def might_allow_prefix_uncached?(prefix)

data/lib/new_relic/agent/attributes.rb

@@ -0,0 +1,152 @@
+# 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/attribute_processing'
+
+module NewRelic
+  module Agent
+    class Attributes
+      KEY_LIMIT   = 255
+      VALUE_LIMIT = 255
+      COUNT_LIMIT = 64
+
+      EMPTY_HASH = {}.freeze
+
+      def initialize(filter)
+        @filter = filter
+
+        @custom_attributes = {}
+        @agent_attributes = {}
+        @intrinsic_attributes = {}
+
+        @custom_destinations = {}
+        @agent_destinations = {}
+        @already_warned_count_limit = nil
+      end
+
+      def add_agent_attribute(key, value, default_destinations)
+        destinations = @filter.apply(key, default_destinations)
+        return if destinations == AttributeFilter::DST_NONE
+
+        @agent_destinations[key] = destinations
+        add(@agent_attributes, key, value)
+      end
+
+      def add_agent_attribute_with_key_check(key, value, default_destinations)
+        if exceeds_bytesize_limit? key, KEY_LIMIT
+          NewRelic::Agent.logger.debug("Agent attribute #{key} was dropped for exceeding key length limit #{KEY_LIMIT}")
+          return
+        end
+
+        add_agent_attribute(key, value, default_destinations)
+      end
+
+      def add_intrinsic_attribute(key, value)
+        add(@intrinsic_attributes, key, value)
+      end
+
+      def merge_untrusted_agent_attributes(attributes, prefix, default_destinations)
+        return if @filter.high_security?
+        return if !@filter.might_allow_prefix?(prefix)
+
+        AttributeProcessing.flatten_and_coerce(attributes, prefix) do |k, v|
+          add_agent_attribute_with_key_check(k, v, AttributeFilter::DST_NONE)
+        end
+      end
+
+      def merge_custom_attributes(other)
+        return unless Agent.config[:'custom_attributes.enabled']
+        return if other.empty?
+        AttributeProcessing.flatten_and_coerce(other) do |k, v|
+          add_custom_attribute(k, v)
+        end
+      end
+
+      def custom_attributes_for(destination)
+        for_destination(@custom_attributes, @custom_destinations, destination)
+      end
+
+      def agent_attributes_for(destination)
+        for_destination(@agent_attributes, @agent_destinations, destination)
+      end
+
+      def intrinsic_attributes_for(destination)
+        if destination == NewRelic::Agent::AttributeFilter::DST_TRANSACTION_TRACER ||
+           destination == NewRelic::Agent::AttributeFilter::DST_ERROR_COLLECTOR
+          @intrinsic_attributes
+        else
+          EMPTY_HASH
+        end
+      end
+
+      private
+
+      def add_custom_attribute(key, value)
+        if @custom_attributes.size >= COUNT_LIMIT
+          unless @already_warned_count_limit
+            NewRelic::Agent.logger.warn("Custom attributes count exceeded limit of #{COUNT_LIMIT}. Any additional custom attributes during this transaction will be dropped.")
+            @already_warned_count_limit = true
+          end
+          return
+        end
+
+        if @filter.high_security?
+          NewRelic::Agent.logger.debug("Unable to add custom attribute #{key} while in high security mode.")
+          return
+        end
+
+        if exceeds_bytesize_limit?(key, KEY_LIMIT)
+          NewRelic::Agent.logger.warn("Custom attribute key '#{key}' was longer than limit of #{KEY_LIMIT} bytes. This attribute will be dropped.")
+          return
+        end
+
+        destinations = @filter.apply(key, AttributeFilter::DST_ALL)
+        return if destinations == AttributeFilter::DST_NONE
+
+        @custom_destinations[key] = destinations
+        add(@custom_attributes, key, value)
+      end
+
+      def add(attributes, key, value)
+        return if value.nil?
+
+        if exceeds_bytesize_limit?(value, VALUE_LIMIT)
+          value = slice(value)
+        end
+
+        attributes[key] = value
+      end
+
+      def for_destination(attributes, calculated_destinations, destination)
+        # Avoid allocating anything if there are no attrs at all
+        return EMPTY_HASH if attributes.empty?
+
+        attributes.inject({}) do |memo, (key, value)|
+          if @filter.allows?(calculated_destinations[key], destination)
+            memo[key] = value
+          end
+          memo
+        end
+      end
+
+      def exceeds_bytesize_limit?(value, limit)
+        if value.respond_to?(:bytesize)
+          value.bytesize > limit
+        elsif value.is_a?(Symbol)
+          value.to_s.bytesize > limit
+        else
+          false
+        end
+      end
+
+      # Take one byte past our limit. Why? This lets us unconditionally chop!
+      # the end. It'll either remove the one-character-too-many we have, or
+      # peel off the partial, mangled character left by the byteslice.
+      def slice(incoming)
+        result = incoming.to_s.byteslice(0, VALUE_LIMIT + 1)
+        result.chop!
+      end
+    end
+  end
+end