newrelic_rpm 6.4.0.356 → 6.9.0.363

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5b076c28227c61e989c31bb41023266f4319602621a913cc403e224d7e5c5822
-  data.tar.gz: '06062208e9ca3921d1d3353ea91dcc84423747496f6744b617053e98d8488a83'
+  metadata.gz: 3eb269d5c36e6139c7b617d3083418a8c8acf85e94c4f1005b1241aafc9471dd
+  data.tar.gz: da6387b811e5402cd2a0da7b80acc5b88338768cf36e01b1c86d7576c2592f3d
 SHA512:
-  metadata.gz: f5ab26028a95f4bb69d6ae882733b0796f0e547cae5a0c276413b0c8daf701eed0697a67b4ad87e64c43e9d1359af37dc9a187f41d59cb2e24caa8b6bbd25afe
-  data.tar.gz: d67d418c31585f72e05173c10c858a649ca5f6615dfc80cdfaa25fee451055cf20430aac5602c4553468c7ff5018675b734902674a83a44be27f4e54c077df6c
+  metadata.gz: 077d136a9c8e3771f506ee67422983ae4782e23b9118e9cb070f35fdf3af7b8a9d9ed125725db34945d8195529c0c22bbde0a7ab313d1fae9488485e40f7398d
+  data.tar.gz: c577d7a04fac1e22f043156635d4d2eeb3674707a2f50f7b11756855f4b4ae7e3479a6783d45decdc1a4950ce2b69e8d1d691bad6ebe67b504b098838fa6c86f

data/.gitignore

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

data/.travis.yml

@@ -6,20 +6,23 @@ services:
 
 language: ruby
 
+dist: precise
 sudo: required
+jdk:
+  - oraclejdk8
 
 before_install:
   # RUBY-2072 Prevent Travis setup failure before our test even starts
   - 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 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:
@@ -39,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
   - 2.6.1
   - 2.5.3
   - 2.4.2
@@ -51,11 +56,14 @@ rvm:
   - 2.1.10
   - 2.0.0-p648
 
+jdk:
+  - oraclejdk8
+
 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
@@ -85,9 +93,46 @@ env:
     - TYPE=NULLVERSE
 
 matrix:
+  allow_failures:
+    - rvm: jruby-9.2.6.0
+      env: TYPE=FUNCTIONAL GROUP=agent
   fast_finish: true
   exclude:
     # Unsupported Rails/Ruby combinations
+    # 2.7
+    - rvm: 2.7.0
+      env: TYPE=UNIT ENVIRONMENT=rails30
+    - rvm: 2.7.0
+      env: TYPE=UNIT ENVIRONMENT=rails31
+    - rvm: 2.7.0
+      env: TYPE=UNIT ENVIRONMENT=rails32
+    - rvm: 2.7.0
+      env: TYPE=UNIT ENVIRONMENT=rails40
+    - rvm: 2.7.0
+      env: TYPE=UNIT ENVIRONMENT=rails41
+
+    - 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
+      env: TYPE=UNIT ENVIRONMENT=rails50  # rails (= 5.0.0) depends on bundler (< 2.0, >= 1.3.0)
+    - 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
+      env: TYPE=FUNCTIONAL GROUP=api      # blocked: https://github.com/solnic/coercible/issues/27
+    - rvm: 2.7.0
+      env: TYPE=FUNCTIONAL GROUP=sinatra  # padrino (~> 0.14.0) depends on bundler (~> 1.0)
+
+    - 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
+      env: TYPE=UNIT ENVIRONMENT=rails50  # rails (= 5.0.0) depends on bundler (< 2.0, >= 1.3.0)
+    - 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
+      env: TYPE=FUNCTIONAL GROUP=api      # blocked: https://github.com/solnic/coercible/issues/27
+    - rvm: 2.7.0
+      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,223 @@
 # 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**
+
+    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**
+
+    Several new API methods have been added to the agent:
+    * [`Agent#linking_metadata`](https://www.rubydoc.info/github/newrelic/rpm/NewRelic/Agent#linking_metadata-instance_method)
+    * [`Tracer#trace_id`](https://www.rubydoc.info/github/newrelic/rpm/NewRelic/Agent/Tracer#trace_id-class_method)
+    * [`Tracer#span_id`](https://www.rubydoc.info/github/newrelic/rpm/NewRelic/Agent/Tracer#span_id-class_method)
+    * [`Tracer#sampled?`](https://www.rubydoc.info/github/newrelic/rpm/NewRelic/Agent/Tracer#sampled?-class_method)
+
+    These API methods allow you to access information that can be used to link data of your choosing to a trace or entity.
+
+  * **Logs in Context**
+
+    This version of the agent includes a logger, which can be used in place of `::Logger`
+    from the standard library, or `ActiveSupport::Logger` from Rails.  This logger
+    leverages the new trace and entity metadata API to decorate log statements with entity
+    and trace metadata, so they can be correlated together in the New Relic UI.
+
+    For more information on how to use logs in context, see https://docs.newrelic.com/docs/enable-logs-context-ruby
+
+  * **Project metadata in Gemspec**
+
+     Project metadata has been added to the gemspec file. This means our Rubygems page will allow users to more easily
+     access the agent's source code, raise issues, and read the changelog.
+
+     Thanks to Orien Madgwick for the contribution!
+
+## v6.6.0
+
+  * **Bugfix for ActionCable Instrumentation**
+
+    Previous versions of the agent sometimes caused application crashes with some versions
+    of ActionCable.  The application would exit quickly after startup with the error:
+    `uninitialized constant ActionCable::Engine`.
+
+    Version 6.6.0 of the agent no longer crashes in this way.
+
+
+  * **Handling of disabling Error Collection**
+
+    When the agent first starts, it begins collecting Error Events and Traces before
+    fetching configuration from New Relic.  In previous versions of the agent, those
+    events or traces would be sent to New Relic, even if _Error Collection_ is disabled in
+    the application's server-side configuration.
+
+    Version 6.6.0 of the agent drops all collected Error Events and Traces if the
+    configuration from the server disables _Error Collection_.
+
+## v6.5.0
+
+* **Change to default setting for ActiveRecord connection resolution**
+
+  Due to incompatibilities between the faster ActiveRecord connection resolution
+  released in v6.3.0 of the agent and other gems which patch ActiveRecord,
+  `backport_fast_active_record_connection_lookup` will now be set to `false` by default.
+  Because it results in a significant performance improvement, we recommend customers
+  whose environments include ActiveRecord change this setting to `true`
+  _unless_ they are using other gems which measure ActiveRecord performance, which may
+  lose functionality when combined with this setting. If unsure whether to enable
+  `backport_fast_active_record_connection_lookup`, we recommend enabling it in a
+  development environment to make sure other gems which patch ActiveRecord are still
+  working as expected.
+
+* **Bugfix for ActiveStorage instrumentation error**
+
+  Version 6.4.0 of the agent introduced a bug that interfered with ActiveStorage
+  callbacks, resulting in the agent being unable to instrument ActiveStorage operations.
+  ActiveStorage segments are now correctly recorded.
+
+* **Bugfix for ActiveRecord 4.1 and 4.2 exception logging**
+
+  Version 6.3.0 of the agent introduced a bug that prevented ActiveRecord versions 4.1
+  and 4.2 from logging exceptions that occurred within a database transaction.  This
+  version of the agent restores the exception logging functionality from previous agent
+  versions.
+  Thanks to Oleksiy Kovyrin for the contribution!
+
 ## v6.4.0
 
 * **Custom Metadata Collection**

data/Guardfile

@@ -1,8 +1,23 @@
-guard :minitest, :test_folders => ['test/new_relic'], :all_after_pass => false do
+test_folders = Dir.glob("test/new_relic/*").select{|f| File.directory?(f)}
+test_folders += Dir.glob("test/new_relic/**/*").select{|f| File.directory?(f)}
+
+rake_lib_path = Bundler.with_unbundled_env{ `bundle exec gem which rake`.chomp.gsub("lib/rake.rb", "lib") }
+ruby_options = %{-w -I"#{rake_lib_path}" "#{rake_lib_path}/rake/rake_test_loader.rb"}
+
+guard_options = {
+  spring: "bundle exec ruby #{ruby_options} ",
+  test_folders: ['test/new_relic'] + test_folders, 
+  all_after_pass: false,
+  all_on_start: 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" }
+  watch(%r{^test/fixtures/cross_agent_tests/distributed_tracing/(.+).json}) { |m| "test/new_relic/agent/distributed_tracing/#{m[1]}_cross_agent_test.rb" }
   watch('test/test_helper.rb')  { "test/new_relic" }
   watch('test/agent_helper.rb') { "test/new_relic" }
   watch('lib/new_relic/agent/configuration/default_source.rb') { "test/new_relic/agent/configuration/orphan_configuration_test.rb" }
+  watch(%r{^lib/new_relic/agent/transaction/(.+).rb}) { |m| "test/new_relic/agent/distributed_tracing/#{m[1]}_cross_agent_test.rb" }
 end

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'
@@ -55,7 +54,9 @@ module NewRelic
     require 'new_relic/agent/system_info'
     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'
@@ -350,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
@@ -567,6 +567,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
@@ -580,6 +586,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
@@ -588,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.
@@ -660,6 +693,54 @@ module NewRelic
       NewRelic::Agent.logger.debug "Ignoring exception during %p event notification" % [event_type]
     end
 
+    # @!group Trace and Entity metadata
+
+    TRACE_ID_KEY = 'trace.id'.freeze
+    SPAN_ID_KEY = 'span.id'.freeze
+    ENTITY_NAME_KEY = 'entity.name'.freeze
+    ENTITY_TYPE_KEY = 'entity.type'.freeze
+    ENTITY_GUID_KEY = 'entity.guid'.freeze
+    HOSTNAME_KEY = 'hostname'.freeze
+
+    ENTITY_TYPE = 'SERVICE'.freeze
+
+    # Returns a new hash containing trace and entity metadata that can be used
+    # to relate data to a trace or to an entity in APM.
+    #
+    # This hash includes:
+    # * trace.id    - The current trace id, if there is a current trace id. This
+    #   value may be omitted.
+    # * span.id     - The current span id, if there is a current span.  This
+    #   value may be omitted.
+    # * entity.name - The name of the current application. This is read from
+    #   the +app_name+ key in your config.  If there are multiple application
+    #   names, the first one is used.
+    # * entity.type - The entity type is hardcoded to the string +'SERVICE'+.
+    # * entity.guid - The guid of the current entity.
+    # * hostname    - The fully qualified hostname.
+    #
+    # @api public
+    def linking_metadata
+      metadata = Hash.new
+      metadata[ENTITY_NAME_KEY] = config[:app_name][0]
+      metadata[ENTITY_TYPE_KEY] = ENTITY_TYPE
+      metadata[HOSTNAME_KEY] = Hostname.get
+
+      if entity_guid = config[:entity_guid]
+        metadata[ENTITY_GUID_KEY] = entity_guid
+      end
+
+      if trace_id = Tracer.current_trace_id
+        metadata[TRACE_ID_KEY] = trace_id
+      end
+      if span_id = Tracer.current_span_id
+        metadata[SPAN_ID_KEY] = span_id
+      end
+      metadata
+    end
+
+    #@!endgroup
+
     # @!group Manual browser monitoring configuration
 
     # This method returns a string suitable for inclusion in a page - known as