newrelic_rpm 6.8.0.360 → 6.9.0.363

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 07ac800f099e868f4ac7fb9e86972f5533c48d87bd28cb54b1015b5dfe4af601
-  data.tar.gz: 0e1daf547dc945b5b57c8ff09f4866b26f907796ae654d9ebdf4c409cde8cfdf
+  metadata.gz: 3eb269d5c36e6139c7b617d3083418a8c8acf85e94c4f1005b1241aafc9471dd
+  data.tar.gz: da6387b811e5402cd2a0da7b80acc5b88338768cf36e01b1c86d7576c2592f3d
 SHA512:
-  metadata.gz: 32b818ece7b0ac768d5ee8c8615633bc45ce6d7f3bc8e1a98ecc5632cc927c8dfa74266334f7fd6c55a468b6ff533deaed2773d90c1e32288598ea984f3e9aa0
-  data.tar.gz: a562491c09abeaaaf7de0fdb7b03e13706528144c004320b497bf214877831f221128bf92545ccac60bc02d4d696c2a6ecff5a3ca4091c3fba3bad8cba3ad287
+  metadata.gz: 077d136a9c8e3771f506ee67422983ae4782e23b9118e9cb070f35fdf3af7b8a9d9ed125725db34945d8195529c0c22bbde0a7ab313d1fae9488485e40f7398d
+  data.tar.gz: c577d7a04fac1e22f043156635d4d2eeb3674707a2f50f7b11756855f4b4ae7e3479a6783d45decdc1a4950ce2b69e8d1d691bad6ebe67b504b098838fa6c86f

data/.travis.yml

@@ -47,7 +47,7 @@ branches:
 rvm:
   # Run slowest builds first to try and optimize overall cycle time.
   - jruby-9.2.6.0
-  - 2.7.0-preview1
+  - 2.7.0
   - 2.6.1
   - 2.5.3
   - 2.4.2
@@ -100,37 +100,37 @@ matrix:
   exclude:
     # Unsupported Rails/Ruby combinations
     # 2.7
-    - rvm: 2.7.0-preview1
+    - rvm: 2.7.0
       env: TYPE=UNIT ENVIRONMENT=rails30
-    - rvm: 2.7.0-preview1
+    - rvm: 2.7.0
       env: TYPE=UNIT ENVIRONMENT=rails31
-    - rvm: 2.7.0-preview1
+    - rvm: 2.7.0
       env: TYPE=UNIT ENVIRONMENT=rails32
-    - rvm: 2.7.0-preview1
+    - rvm: 2.7.0
       env: TYPE=UNIT ENVIRONMENT=rails40
-    - rvm: 2.7.0-preview1
+    - rvm: 2.7.0
       env: TYPE=UNIT ENVIRONMENT=rails41
 
-    - rvm: 2.7.0-preview1
+    - rvm: 2.7.0
       env: TYPE=UNIT ENVIRONMENT=rails42  # rails (= 4.2.11) depends on bundler (< 2.0, >= 1.3.0)
-    - rvm: 2.7.0-preview1
+    - rvm: 2.7.0
       env: TYPE=UNIT ENVIRONMENT=rails50  # rails (= 5.0.0) depends on bundler (< 2.0, >= 1.3.0)
-    - rvm: 2.7.0-preview1
+    - rvm: 2.7.0
       env: TYPE=UNIT ENVIRONMENT=rails51  # rails (= 5.1.0) depends on bundler (< 2.0, >= 1.3.0)
-    - rvm: 2.7.0-preview1
+    - rvm: 2.7.0
       env: TYPE=FUNCTIONAL GROUP=api      # blocked: https://github.com/solnic/coercible/issues/27
-    - rvm: 2.7.0-preview1
+    - rvm: 2.7.0
       env: TYPE=FUNCTIONAL GROUP=sinatra  # padrino (~> 0.14.0) depends on bundler (~> 1.0)
 
-    - rvm: 2.7.0-preview1
+    - rvm: 2.7.0
       env: TYPE=UNIT ENVIRONMENT=rails42  # rails (= 4.2.11) depends on bundler (< 2.0, >= 1.3.0)
-    - rvm: 2.7.0-preview1
+    - rvm: 2.7.0
       env: TYPE=UNIT ENVIRONMENT=rails50  # rails (= 5.0.0) depends on bundler (< 2.0, >= 1.3.0)
-    - rvm: 2.7.0-preview1
+    - rvm: 2.7.0
       env: TYPE=UNIT ENVIRONMENT=rails51  # rails (= 5.1.0) depends on bundler (< 2.0, >= 1.3.0)
-    - rvm: 2.7.0-preview1
+    - rvm: 2.7.0
       env: TYPE=FUNCTIONAL GROUP=api      # blocked: https://github.com/solnic/coercible/issues/27
-    - rvm: 2.7.0-preview1
+    - rvm: 2.7.0
       env: TYPE=FUNCTIONAL GROUP=sinatra  # padrino (~> 0.14.0) depends on bundler (~> 1.0)
 
     # 2.6

data/CHANGELOG.md

@@ -1,5 +1,69 @@
 # New Relic Ruby Agent Release Notes #
 
+  ## v6.9.0
+
+  * **Added support for W3C Trace Context, with easy upgrade from New Relic trace context**
+
+    * [Distributed Tracing now supports W3C Trace Context headers](https://docs.newrelic.com/docs/understand-dependencies/distributed-tracing/get-started/introduction-distributed-tracing#w3c-support)  for HTTP protocols when distributed tracing is enabled. Our implementation can accept and emit both
+      the W3C trace header format and the New Relic trace header format. This simplifies
+      agent upgrades, allowing trace context to be propagated between services with older
+      and newer releases of New Relic agents. W3C trace header format will always be
+      accepted and emitted. New Relic trace header format will be accepted, and you can
+      optionally disable emission of the New Relic trace header format.
+
+    * When distributed tracing is enabled by setting `distributed_tracing.enabled` to `true`,
+      the Ruby agent will now accept W3C's `traceparent` and `tracestate` headers when
+      calling `DistributedTracing.accept_distributed_trace_headers` or automatically via
+      `http` instrumentation. When calling `DistributedTracing.insert_distributed_trace_headers`,
+      or automatically via `http` instrumentation, the Ruby agent will include the W3C
+      headers along with the New Relic distributed tracing header, unless the New Relic
+      trace header format is disabled by setting `exclude_newrelic_header` setting to `true`.
+
+    * Added `DistributedTracing.accept_distributed_trace_headers` API for accepting both
+      New Relic and W3C TraceContext distributed traces.
+
+    * Deprecated `DistributedTracing.accept_distributed_trace_payload` which will be removed
+      in a future major release.
+
+    * Added `DistributedTracing.insert_distributed_trace_headers` API for adding outbound
+      distributed trace headers. Both W3C TraceContext and New Relic formats will be
+      included unless `distributed_tracing.exclude_newrelic_header: true`.
+
+    * Deprecated `DistributedTracing.create_distributed_trace_payload` which will be removed
+      in a future major release.
+
+    Known Issues and Workarounds
+
+    * If a .NET agent is initiating traces as the root service, do not upgrade your 
+      downstream Ruby New Relic agents to this agent release.
+
+  * **Official Ruby 2.7 support**
+
+    The Ruby agent has been verified to run with Ruby 2.7.0.
+
+  * **Reduced allocations when tracing transactions using API calls**
+
+    Default empty hashes for `options` parameter were not frozen, leading to 
+    excessive and unnecessary allocations when calling APIs for tracing transactions.
+
+    Thanks to Joel Turkel (jturkel) for the contribution! 
+
+  * **Bugfix for Resque worker thread race conditions**
+
+    Recent changes in Rack surfaced issues marshalling data for resque, surfaced a potential race-condition with closing out the worker-threads before flushing the data pipe.  This
+    is now fixed.
+
+    Thanks to Bertrand Paquet (bpaquet) for the contribution!
+
+  * **Bugfix for Content-Length when injecting Browser Monitoring JS**
+    
+    The Content-Length HTTP header would be incorrect after injecting the Browser Monitoring
+    JS into the HEAD tag of the HTML source with Content-Length and lead to the HTML BODY content
+    being truncated in some cases.  The Content-Length is now correctly updated after injecting the 
+    Browser Monitoring JS script.
+
+    Thanks to Slava Kardakov (ojab) for the contribution!
+
   ## v6.8.0
 
   * **Initial Ruby 2.7 support**

data/lib/new_relic/agent.rb

@@ -35,7 +35,6 @@ module NewRelic
     require 'new_relic/agent/encoding_normalizer'
     require 'new_relic/agent/stats'
     require 'new_relic/agent/chained_call'
-    require 'new_relic/agent/cross_app_monitor'
     require 'new_relic/agent/agent'
     require 'new_relic/agent/method_tracer'
     require 'new_relic/agent/worker_loop'
@@ -56,7 +55,8 @@ module NewRelic
     require 'new_relic/agent/external'
     require 'new_relic/agent/deprecator'
     require 'new_relic/agent/logging'
-
+    require 'new_relic/agent/distributed_tracing'
+    
     require 'new_relic/agent/instrumentation/controller_instrumentation'
 
     require 'new_relic/agent/samplers/cpu_sampler'
@@ -351,10 +351,9 @@ module NewRelic
     # @api public
     #
     def manual_start(options={})
-      record_api_supportability_metric(:manual_start)
-
       raise "Options must be a hash" unless Hash === options
       NewRelic::Control.instance.init_plugin({ :agent_enabled => true, :sync_startup => true }.merge(options))
+      record_api_supportability_metric(:manual_start)
     end
 
     # Register this method as a callback for processes that fork
@@ -620,7 +619,9 @@ module NewRelic
     # apply a reasonable default based on framework routing, but in
     # cases where this is insufficient, this can be used to manually
     # control the name of the transaction.
-    # The category of transaction can be specified via the +:category+ option:
+    #
+    # The category of transaction can be specified via the +:category+ option. 
+    # The following are the only valid categories:
     #
     # * <tt>:category => :controller</tt> indicates that this is a
     #   controller action and will appear with all the other actions.

data/lib/new_relic/agent/agent.rb

@@ -8,6 +8,8 @@ require 'net/http'
 require 'logger'
 require 'zlib'
 require 'stringio'
+require 'new_relic/constants'
+require 'new_relic/coerce'
 require 'new_relic/agent/autostart'
 require 'new_relic/agent/harvester'
 require 'new_relic/agent/hostname'
@@ -17,10 +19,8 @@ require 'new_relic/agent/configuration/manager'
 require 'new_relic/agent/database'
 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/distributed_tracing'
+require 'new_relic/agent/monitors'
 require 'new_relic/agent/transaction_event_recorder'
 require 'new_relic/agent/custom_event_aggregator'
 require 'new_relic/agent/span_event_aggregator'
@@ -49,32 +49,30 @@ module NewRelic
       def initialize
         @started = false
         @event_loop = nil
+        @worker_thread = nil
 
         @service = NewRelicService.new
 
-        @events                    = NewRelic::Agent::EventListener.new
-        @stats_engine              = NewRelic::Agent::StatsEngine.new
-        @transaction_sampler       = NewRelic::Agent::TransactionSampler.new
-        @sql_sampler               = NewRelic::Agent::SqlSampler.new
-        @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
-        @harvest_samplers          = NewRelic::Agent::SamplerCollection.new(@events)
-        @monotonic_gc_profiler     = NewRelic::Agent::VM::MonotonicGCProfiler.new
-        @javascript_instrumentor   = NewRelic::Agent::JavascriptInstrumentor.new(@events)
-        @adaptive_sampler          = NewRelic::Agent::AdaptiveSampler.new(self.class.config[:sampling_target],
-                                                                          self.class.config[:sampling_target_period_in_seconds])
-
-        @harvester       = NewRelic::Agent::Harvester.new(@events)
+        @events                    = EventListener.new
+        @stats_engine              = StatsEngine.new
+        @transaction_sampler       = TransactionSampler.new
+        @sql_sampler               = SqlSampler.new
+        @agent_command_router      = Commands::AgentCommandRouter.new @events
+        @monitors                  = Monitors.new @events
+        @error_collector           = ErrorCollector.new @events
+        @transaction_rules         = RulesEngine.new
+        @harvest_samplers          = SamplerCollection.new @events
+        @monotonic_gc_profiler     = VM::MonotonicGCProfiler.new
+        @javascript_instrumentor   = JavascriptInstrumentor.new @events
+        @adaptive_sampler          = AdaptiveSampler.new(Agent.config[:sampling_target],
+                                                         Agent.config[:sampling_target_period_in_seconds])
+
+        @harvester       = Harvester.new @events
         @after_fork_lock = Mutex.new
 
-        @transaction_event_recorder = NewRelic::Agent::TransactionEventRecorder.new @events
-        @custom_event_aggregator    = NewRelic::Agent::CustomEventAggregator.new @events
-        @span_event_aggregator      = NewRelic::Agent::SpanEventAggregator.new @events
+        @transaction_event_recorder = TransactionEventRecorder.new @events
+        @custom_event_aggregator    = CustomEventAggregator.new @events
+        @span_event_aggregator      = SpanEventAggregator.new @events
 
         @connect_state      = :pending
         @connect_attempts   = 0
@@ -96,7 +94,7 @@ module NewRelic
       end
 
       def refresh_attribute_filter
-        @attribute_filter = NewRelic::Agent::AttributeFilter.new(NewRelic::Agent.config)
+        @attribute_filter = AttributeFilter.new(Agent.config)
       end
 
       # contains all the class-level methods for NewRelic::Agent::Agent
@@ -129,13 +127,16 @@ module NewRelic
         # cross application tracing ids and encoding
         attr_reader :cross_process_id
         attr_reader :cross_app_encoding_bytes
-        attr_reader :cross_app_monitor
         # service for communicating with collector
         attr_accessor :service
         # Global events dispatcher. This will provides our primary mechanism
         # for agent-wide events, such as finishing configuration, error notification
         # and request before/after from Rack.
         attr_reader :events
+
+        # listens and responds to events that need to process headers 
+        # for synthetics and distributed tracing
+        attr_reader :monitors
         # Transaction and metric renaming rules as provided by the
         # collector on connect.  The former are applied during txns,
         # the latter during harvest.
@@ -208,7 +209,7 @@ module NewRelic
         end
 
         def install_pipe_service(channel_id)
-          @service = NewRelic::Agent::PipeService.new(channel_id)
+          @service = PipeService.new(channel_id)
           if connected?
             @connected_pid = Process.pid
           else
@@ -239,12 +240,18 @@ module NewRelic
         end
 
         def revert_to_default_configuration
-          NewRelic::Agent.config.remove_config_type(:manual)
-          NewRelic::Agent.config.remove_config_type(:server)
+          Agent.config.remove_config_type(:manual)
+          Agent.config.remove_config_type(:server)
         end
 
         def stop_event_loop
           @event_loop.stop if @event_loop
+          # Wait the end of the event loop thread.
+          if @worker_thread
+            unless @worker_thread.join(3)
+              ::NewRelic::Agent.logger.error "Event loop thread did not stop within 3 seconds"
+            end
+          end
         end
 
         def trap_signals_for_litespeed
@@ -459,11 +466,11 @@ module NewRelic
           def defer_for_resque?
             NewRelic::Agent.config[:dispatcher] == :resque &&
               NewRelic::LanguageSupport.can_fork? &&
-              !NewRelic::Agent::PipeChannelManager.listener.started?
+              !PipeChannelManager.listener.started?
           end
 
           def in_resque_child_process?
-            defined?(@service) && @service.is_a?(NewRelic::Agent::PipeService)
+            defined?(@service) && @service.is_a?(PipeService)
           end
 
           # Sanity-check the agent configuration and start the agent,
@@ -559,11 +566,11 @@ module NewRelic
         # This is necessary for cases where we're in a forked child and Ruby
         # might be holding locks for background thread that aren't there anymore.
         def reset_objects_with_locks
-          @stats_engine = NewRelic::Agent::StatsEngine.new
+          @stats_engine = StatsEngine.new
         end
 
         def flush_pipe_data
-          if connected? && @service.is_a?(::NewRelic::Agent::PipeService)
+          if connected? && @service.is_a?(PipeService)
             transmit_data
             transmit_analytic_event_data
             transmit_custom_event_data
@@ -707,7 +714,7 @@ module NewRelic
           end
 
           ::NewRelic::Agent.logger.debug "Creating Ruby Agent worker thread."
-          @worker_thread = NewRelic::Agent::Threading::AgentThread.create('Worker Loop') do
+          @worker_thread = Threading::AgentThread.create('Worker Loop') do
             deferred_work!(connection_options)
           end
         end
@@ -1024,7 +1031,7 @@ module NewRelic
         end
 
         def harvest_and_send_timeslice_data
-          NewRelic::Agent::TransactionTimeAggregator.harvest!
+          TransactionTimeAggregator.harvest!
           harvest_and_send_from_container(@stats_engine, :metric_data)
         end
 

data/lib/new_relic/agent/attributes.rb

@@ -11,8 +11,6 @@ module NewRelic
       VALUE_LIMIT = 255
       COUNT_LIMIT = 64
 
-      EMPTY_HASH = {}.freeze
-
       def initialize(filter)
         @filter = filter
 
@@ -76,7 +74,7 @@ module NewRelic
            destination == NewRelic::Agent::AttributeFilter::DST_ERROR_COLLECTOR
           @intrinsic_attributes
         else
-          EMPTY_HASH
+          NewRelic::EMPTY_HASH
         end
       end
 
@@ -120,7 +118,7 @@ module NewRelic
 
       def for_destination(attributes, calculated_destinations, destination)
         # Avoid allocating anything if there are no attrs at all
-        return EMPTY_HASH if attributes.empty?
+        return NewRelic::EMPTY_HASH if attributes.empty?
 
         attributes.inject({}) do |memo, (key, value)|
           if @filter.allows?(calculated_destinations[key], destination)

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

@@ -395,7 +395,21 @@ module NewRelic
           :public => true,
           :type => Boolean,
           :allowed_from_server => false,
-          :description => 'When <code>true</code>, the agent captures HTTP request parameters and attaches them to transaction traces, traced errors, and <a href="https://docs.newrelic.com/docs/insights/new-relic-insights/decorating-events/error-event-default-attributes-insights">TransactionError events</a>.'
+          :description => 'When <code>true</code>, the agent captures HTTP request parameters ' \
+            'and attaches them to transaction traces, traced errors, and ' \
+            '<a href="https://docs.newrelic.com/attribute-dictionary?attribute_name=&events_tids%5B%5D=8241">'\
+            '<code>TransactionError</code> events.' \
+            "\n" \
+            '<div class="callout-warning">' \
+            "\n" \
+            '<p>When using the <code>capture_params</code> setting, the Ruby agent will not attempt ' \
+            'to filter secret information. <b>Recommendation:</b> To filter secret information from ' \
+            'request parameters, use the <a href="/docs/agents/ruby-agent/attributes/enable-disable-attributes-ruby">' \
+            '<code>attributes.include</code> setting</a> instead. For more information, see the ' \
+            '<a href="/docs/agents/ruby-agent/attributes/ruby-attribute-examples#ex_req_params">' \
+            'Ruby attribute examples</a>.' \
+            "</p>\n" \
+            '</div>'
         },
         :config_path => {
           :default => DefaultSource.config_path,
@@ -532,7 +546,7 @@ module NewRelic
           :transform => DefaultSource.method(:convert_to_constant_list),
           :description => 'Deprecated.  ' \
               'For agent versions 6.8.0 or higher, ' \
-              'use <a href="#strip_exception_messages-allowlist"><code>' \
+              'use <a href="#strip_exception_messages.allowed_classes"><code>' \
                 'strip_exception_messages.allowed_classes' \
               '</code></a> instead.'
         },
@@ -540,7 +554,6 @@ module NewRelic
           :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>.'
@@ -675,15 +688,6 @@ module NewRelic
           :allowed_from_server => true,
           :description => 'Number of seconds betwixt connections to the New Relic span event collection services.'
         },
-        :'data_report_periods.analytic_event_data' => {
-          :default => 60,
-          :public => false,
-          :type => Integer,
-          :deprecated => true,
-          :dynamic_name => true,
-          :allowed_from_server => true,
-          :description => 'Number of seconds between connections to the New Relic data collection service for sending transaction event data.'
-        },
         :keep_retrying => {
           :default => true,
           :public => false,
@@ -1888,16 +1892,6 @@ 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,
@@ -1933,6 +1927,13 @@ module NewRelic
           :type => Integer,
           :allowed_from_server => true,
           :description => 'Defines the maximum number of span events reported from a single harvest.'
+        },
+        :'exclude_newrelic_header' => {
+          :default => false,
+          :public => true,
+          :type => Boolean,
+          :allowed_from_server => true,
+          :description => "Allows newrelic distributed tracing headers to be suppressed on outbound requests."
         }
       }.freeze
     end