newrelic_rpm 7.0.0 → 8.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 01dec51b68827b0fa9cd58d7882d9ddb29e7de80bcaa55cda486c30ff8529da9
-  data.tar.gz: 358e73adb1e93b0e12bc7f415df728a4a8670bed0ac4eb36b81df545cc1c4651
+  metadata.gz: dee9561e93a6cd3e2ae811234dae75cd65310c394031fcf3ad3091b46185cb6a
+  data.tar.gz: 7c017fcfeefe7fcce7ce662bed42cc3258028fb42a36e849cbc0d84231e8c4be
 SHA512:
-  metadata.gz: b06d4efcd172c4517ac7be9c7271833cef6709ff18040ceaa81240bf4a3f8ce66f9c609cc78dfffbadc698cc761a2c7e7b439c72d69b024808c10d4b9873180f
-  data.tar.gz: 6f665d24f019d4e5c55aef8851a48f3fe7ff9735e16c41ba97cc27664fdfc9f66cdbcfd698aebe2072b12c7124431e00f4c08bdb4b15a57350d886ff98745f08
+  metadata.gz: 7b51ea238bcbaadfc37ed5364556dbb994788a0214dcd4c890ecbf4bb20aac744db0c733e32955da60c60f1e28220f44b8529bdab74d3af613985a5ac6076ab2
+  data.tar.gz: d3400acd658bffec6058a3a7f7ac7e2df0a36ee95777bfc44768f839ec7b6c29184c8172b43d3f9f43a211add2c108aa68a3358f7b93d1e9581b19eeb8f37bd3

data/.gitignore

@@ -35,3 +35,5 @@ test/fixtures/cross_agent_tests/*/README.md
 node_modules/
 yarn.lock
 errors.txt
+.history/
+vendor/

data/CHANGELOG.md

@@ -1,5 +1,231 @@
 # New Relic Ruby Agent Release Notes #
 
+  ## v8.2.0
+
+  * **New Instrumentation for Tilt gem**
+
+    Template rendering using [Tilt](https://github.com/rtomayko/tilt) is now instrumented. See [PR #847](https://github.com/newrelic/newrelic-ruby-agent/pull/847) for details.
+
+  * **Configuration `error_collector.ignore_errors` is marked as deprecated**
+
+    This setting has been marked as deprecated in the documentation since version 7.2.0 and is now flagged as deprecated within the code.
+
+  * **Remove Rails 2 instrumentation**
+
+    Though any version of Rails 2 has not been supported by the Ruby Agent since v3.18.1.330, instrumentation for ActionController and ActionWebService specific to that version were still part of the agent. This instrumentation has been removed.
+
+  * **Remove duplicated settings from newrelic.yml**
+
+    Thank you @jakeonfire for bringing this to our attention and @kuroponzu for making the changes!
+
+  * **Bugfix: Span Events recorded when using newrelic_ignore**
+
+    Previously, the agent was incorrectly recording span events only on transactions that should be ignored. This fix will prevent any span events from being created for transactions using newrelic_ignore, or ignored through the `rules.ignore_url_regexes` configuration option.
+  
+  * **Bugfix: Print deprecation warning for Cross-Application Tracing if enabled**
+
+    Prior to this change, the deprecation warning would log whenever the agent started up, regardless of configuration. Thank you @alpha-san for bringing this to our attention!
+
+  * **Bugfix: Scrub non-unicode characters from DecoratingLogger**
+
+    To prevent `JSON::GeneratorErrors`, the DecoratingLogger replaces non-unicode characters with the replacement character: �. Thank you @jdelStrother for bringing this to our attention!
+    
+  * **Bugfix: Distributed tracing headers emitted errors when agent was not connected**
+
+    Previously, when the agent had not yet connected it would fail to create a trace context payload and emit an error, "TypeError: no implicit conversion of nil into String," to the agent logs. The correct behavior in this situation is to not create these headers due to the lack of required information. Now, the agent will not attempt to create trace context payloads until it has connected. Thank you @Izzette for bringing this to our attention!
+
+
+  ## v8.1.0
+
+  * **Instrumentation for Ruby standard library Logger**
+
+    The agent will now automatically instrument Logger, recording number of lines and size of logging output, with breakdown by severity.
+
+  * **Bugfix for Padrino instrumentation**
+
+    A bug was introduced to the way the agent installs padrino instrumentation in 7.0.0. This release fixes the issues with the padrino instrumentation. Thanks to @sriedel for bringing this issue to our attention.
+
+  * **Bugfix: Stop deadlocks between New Relic thread and Delayed Job sampling thread**
+
+    Running the agent's polling queries for the DelayedJobSampler within the same ActiveRecord connection decreases the frequency of deadlocks in development environments. Thanks @jdelStrother for bringing this to our attention and providing excellent sample code to speed up development!
+
+  * **Bugfix: Allow Net::HTTP request to IPv6 addresses**
+
+    The agent will no longer raise an `URI::InvalidURIError` error if an IPv6 address is passed to Net::HTTP. Thank you @tristinbarnett and @tabathadelane for crafting a solution!
+
+  * **Bugfix: Allow integers to be passed to error_collector.ignore_status_codes configuration**
+
+    Integers not wrapped in quotation marks can be passed to `error_collector.ignore_status_codes` in the `newrelic.yml` file. Our thanks goes to @elaguerta and @brammerl for resolving this issue!
+
+  * **Bugfix: Allow add_method_tracer to be used on BasicObjects**
+
+    Previously, our `add_method_tracer` changes referenced `self.class` which is not available on `BasicObjects`. This has been fixed. Thanks to @toncid for bringing this issue to our attention.
+
+
+  ## v8.0.0
+
+  * **`add_method_tracer` refactored to use prepend over alias_method chaining**
+
+    This release overhauls the implementation of `add_method_tracer`, as detailed in [issue #502](https://github.com/newrelic/newrelic-ruby-agent/issues/502). The main breaking updates are as follows:
+    - A metric name passed to `add_method_tracer` will no longer be interpolated in an instance context as before. To maintain this behavior, pass a Proc object with the same arity as the method being traced. For example:
+      ```ruby
+        # OLD
+        add_method_tracer :foo, '#{args[0]}.#{args[1]}'
+
+        # NEW
+        add_method_tracer :foo, -> (*args) { "#{args[0]}.#{args[1]}" }
+      ```
+
+    - Similarly, the `:code_header` and `:code_footer` options to `add_method_tracer` will *only* accept a Proc object, which will be bound to the calling instance when the traced method is invoked.
+
+    - Calling `add_method_tracer` for a method will overwrite any previously defined tracers for that method. To specify multiple metric names for a single method tracer, pass them to `add_method_tracer` as an array.
+
+    See updated documentation on the following pages for full details:
+    - [Ruby Custom Instrumentation: Method Tracers](https://docs.newrelic.com/docs/agents/ruby-agent/api-guides/ruby-custom-instrumentation/#method_tracers)
+    - [MethodTracer::ClassMethods#add_method_tracer](https://rubydoc.info/github/newrelic/newrelic-ruby-agent/NewRelic/Agent/MethodTracer/ClassMethods#add_method_tracer-instance_method)
+
+
+  * **Distributed tracing is enabled by default**
+
+    [Distributed tracing](https://docs.newrelic.com/docs/distributed-tracing/enable-configure/language-agents-enable-distributed-tracing/) tracks and observes service requests as they flow through distributed systems. Distributed tracing is now enabled by default and replaces [cross application tracing](https://docs.newrelic.com/docs/agents/ruby-agent/features/cross-application-tracing-ruby/).
+
+  * **Bugfix: Incorrectly loading configuration options from newrelic.yml**
+
+    The agent will now  import the configuration options [`error_collector.ignore_messages`](https://docs.newrelic.com/docs/agents/ruby-agent/configuration/ruby-agent-configuration/#error_collector-ignore_messages) and [`error_collector.expected_messages`](https://docs.newrelic.com/docs/agents/ruby-agent/configuration/ruby-agent-configuration/#error_collector-expected_messages) from the `newrelic.yml` file correctly.
+
+  * **Cross Application is now deprecated, and disabled by default**
+
+    [Distributed tracing](https://docs.newrelic.com/docs/distributed-tracing/enable-configure/language-agents-enable-distributed-tracing/) is replacing [cross application tracing](https://docs.newrelic.com/docs/agents/ruby-agent/features/cross-application-tracing-ruby/) as the default means of tracing between services. To continue using it, enable it with `cross_application_tracer.enabled: true` and `distributed_tracing.enabled: false`
+
+  * **Update configuration option default value for `span_events.max_samples_stored` from 1000 to 2000**
+
+    For more information about this congfiguration option, visit [the Ruby agent documentation](https://docs.newrelic.com/docs/agents/ruby-agent/configuration/ruby-agent-configuration/#span_events-max_samples_stored).
+
+  * **Agent now enforces server supplied maximum value for configuration option `span_events.max_samples_stored`**
+
+    Upon connection to the New Relic servers, the agent will now enforce a maximum value allowed for the configuration option [`span_events.max_samples_stored`](https://docs.newrelic.com/docs/agents/ruby-agent/configuration/ruby-agent-configuration/#span_events-max_samples_stored) sent from the New Relic servers.
+
+  * **Remove Ruby 2.0 required kwarg compatibility checks**
+
+    Our agent has code that provides compatibility for required keyword arguments in Ruby versions below 2.1. Since the agent now only supports Ruby 2.2+, this code is no longer required.
+
+  * **Replace Time.now with Process.clock_gettime**
+
+    Calls to `Time.now` have been replaced with calls to `Process.clock_gettime` to leverage the system's built-in clocks for elapsed time (`Process::CLOCK_MONOTONIC`) and wall-clock time (`Process::CLOCK_REALTIME`). This results in fewer object allocations, more accurate elapsed time records, and enhanced performance. Thanks to @sdemjanenko and @viraptor for advocating for this change!
+
+  * **Updated generated default newrelic.yml**
+
+    Thank you @wyhaines and @creaturenex for your contribution. The default newrelic.yml that the agent can generate is now updated with commented out examples of all configuration options.
+
+  * **Bugfix: Psych 4.0 causes errors when loading newrelic.yml**
+
+    Psych 4.0 now uses safe load behavior when using `YAML.load` which by default doesn't allow aliases, causing errors when the agent loads the config file. We have updated how we load the config file to avoid these errors.
+
+  * **Remove support for Excon versions below 0.19.0**
+
+    Excon versions below 0.19.0 will no longer be instrumented through the Ruby agent.
+
+  * **Remove support for Mongo versions below 2.1**
+
+    Mongo versions below 2.1 will no longer be instrumented through the Ruby agent.
+
+  * **Remove tests for Rails 3.0 and Rails 3.1**
+
+    As of the 7.0 release, the Ruby agent stopped supporting Rails 3.0 and Rails 3.1. Despite this, we still had tests for these versions running on the agent's CI. Those tests are now removed.
+
+  * **Update test Gemfiles for patched versions**
+
+    The gem has individual Gemfiles it uses to test against different common user setups. Rails 5.2, 6.0, and 6.1 have been updated to the latest patch versions in the test Gemfiles. Rack was updated in the Rails61 test suite to 2.1.4 to resolve a security vulnerability.
+
+  * **Remove Merb Support**
+
+    This release removes the remaining support for the [Merb](https://weblog.rubyonrails.org/2008/12/23/merb-gets-merged-into-rails-3/) framework. It merged with Rails during the 3.0 release. Now that the Ruby agent supports Rails 3.2 and above, we thought it was time to say goodbye.
+
+  * **Remove deprecated method External.start_segment**
+
+    The method `NewRelic::Agent::External.start_segment` has been deprecated as of Ruby Agent 6.0.0. This method is now removed.
+
+  * **Added testing and support for the following gem versions**
+
+    - activemerchant 1.121.0
+    - bunny 2.19.0
+    - excon 0.85.0
+    - mongo 2.14.0, 2.15.1
+    - padrino 0.15.1
+    - resque 2.1.0
+    - sequel 5.48.0
+    - yajl-ruby 1.4.1
+
+  * **This version adds support for ARM64/Graviton2 platform using Ruby 3.0.2+**
+
+
+  ## v7.2.0
+
+  * **Expected Errors and Ignore Errors**
+    This release adds support for configuration for expected/ignored errors by class name, status code, and message. The following configuration options are now available:
+    - `error_collector.ignore_classes`
+    - `error_collector.ignore_messages`
+    - `error_collector.ignore_status_codes`
+    - `error_collector.expected_classes`
+    - `error_collector.expected_messages`
+    - `error_collector.expected_status_codes`
+    For more details about expected and ignored errors, please see our [configuration documentation](https://docs.newrelic.com/docs/agents/ruby-agent/configuration/)
+
+  * **Bugfix: resolves "can't add a new key into hash during iteration" Errors**
+
+    Thanks to @wyhaines for this fix that prevents "can't add a new key into hash during iteration" errors from occuring when iterating over environment data.
+
+  * **Bugfix: kwarg support fixed for Rack middleware instrumentation**
+
+    Thanks to @walro for submitting this fix. This fixes the rack instrumentation when using kwargs.
+
+  * **Update known conflicts with use of Module#Prepend**
+
+    With our release of v7.0.0, we updated our instrumentation to use Module#Prepend by default, instead of method chaining. We have received reports of conflicts and added a check for these known conflicts. If a known conflict with prepend is detected while using the default value of 'auto' for gem instrumentation, the agent will instead install method chaining instrumentation in order to avoid this conflict. This check can be bypassed by setting the instrumentation method for the gem to 'prepend'.
+
+  ## v7.1.0
+
+  * **Add support for CSP nonces when using our API to insert the browser agent**
+
+    We now support passing in a nonce to our API method `browser_timing_header` to allow the browser agent to run on applications using CSP nonces. This allows users to inject the browser agent themselves and use the nonce required for the script to run. In order to utilize this new feature, you must disable auto instrumentation for the browser agent, and use the API method browser_timing_header to pass the nonce in and inject the script manually.
+
+  * **Removed MD5 use in the SQL sampler**
+
+    In order to allow the agent to run in FIPS compliant environments, the usage of MD5 for aggregating slow sql traces has been replaced with SHA1.
+
+  * **Enable server-side configuration of distributed tracing**
+
+    `distributed_tracing.enabled` may now be set in server-side application configuration.
+
+  * **Bugfix: Fix for missing part of a previous bugfix**
+
+    Our previous fix of "nil Middlewares injection now prevented and gracefully handled in Sinatra" released in 7.0.0 was partially overwritten by some of the other changes in that release. This release adds back those missing sections of the bugfix, and should resolve the issue for sinatra users.
+
+  * **Update known conflicts with use of Module#Prepend**
+
+    With our release of v7.0.0, we updated our instrumentation to use Module#Prepend by default, instead of method chaining. We have received reports of conflicts and added a check for these known conflicts. If a known conflict with prepend is detected while using the default value of 'auto' for gem instrumentation, the agent will instead install method chaining instrumentation in order to avoid this conflict. This check can be bypassed by setting the instrumentation method for the gem to 'prepend'.
+
+  * **Bugfix: Updated support for ActiveRecord 6.1+ instrumentation**
+
+    Previously, the agent depended on `connection_id` to be present in the Active Support instrumentation for `sql.active_record`
+    to get the current ActiveRecord connection. As of Rails 6.1, `connection_id` has been dropped in favor of providing the connection
+    object through the `connection` value exclusively. This resulted in datastore spans displaying fallback behavior, including showing
+    "ActiveRecord" as the database vendor.
+
+  * **Bugfix: Updated support for Resque's FORK_PER_JOB option**
+
+    Support for Resque's FORK_PER_JOB flag within the Ruby agent was incomplete and nonfunctional. The agent should now behave
+    correctly when running in a non-forking Resque worker process.
+
+  * **Bugfix: Added check for ruby2_keywords in add_transaction_tracer**
+
+    Thanks @beauraF for the contribution! Previously, the add_transaction_tracer was not updated when we added support for ruby 3. In order to correctly support `**kwargs`,  ruby2_keywords was added to correctly update the method signature to use **kwargs in ruby versions that support that.
+
+  * **Confirmed support for yajl 1.4.0**
+
+    Thanks to @creaturenex for the contribution! `yajl-ruby` 1.4.0 was added to our test suite and confirmed all tests pass, showing the agent supports this version as well.
+
+
   ## v7.0.0
 
   * **Ruby Agent 6.x to 7.x Migration Guide Available**

data/CONTRIBUTING.md

@@ -6,8 +6,7 @@ development team.
 
 When contributing, keep in mind that the agent runs in a wide variety of Ruby
 language implementations (e.g. 2.x.x, jruby, etc.) as well as a wide variety of
-application environments (e.g. Rails, Sinatra, roll-your-own, etc.) See [Ruby agent requirements and supported frameworks]
-(https://docs.newrelic.com/docs/agents/ruby-agent/getting-started/ruby-agent-requirements-supported-frameworks)
+application environments (e.g. Rails, Sinatra, roll-your-own, etc.) See [Ruby agent requirements and supported frameworks](https://docs.newrelic.com/docs/agents/ruby-agent/getting-started/ruby-agent-requirements-supported-frameworks)
 for the current full list.
 
 Because of this, we need to be more defensive in our coding practices than most
@@ -85,6 +84,18 @@ release from this repo, use the appropriate tag. New Relic usually pushes beta
 versions of a release to a working branch before tagging them for General
 Availability.
 
+## Development Environment Setup
+
+1. Fork and clone the repo locally
+    - Fork the repository inside GitHub
+    - `git clone git@github.com:<gh username>/newrelic-ruby-agent.git`
+1. Pick a Ruby version
+    - Use rbenv or rvm to install any version of Ruby between 2.2 up to 3.0.1
+1. Install development dependencies
+    - `bundle install`
+1. Check that your env is setup correctly
+    - `bundle exec rake`
+
 ## Testing
 
 The agent includes a suite of unit and functional tests which should be used to

data/README.md

@@ -11,6 +11,8 @@ to help you improve the customer experience and make data-driven business decisi
 The New Relic Ruby Agent is dual-purposed as a either a Gem or a Rails plugin,
 hosted on [github](https://github.com/newrelic/newrelic-ruby-agent).
 
+[![Gem Version](https://badge.fury.io/rb/newrelic_rpm.svg)](https://badge.fury.io/rb/newrelic_rpm)
+
 ## Supported Environments
 
 An up-to-date list of Ruby versions and frameworks for the latest agent
@@ -21,6 +23,8 @@ Environments" section below.
 
 ## Installing and Using
 
+The latest released gem for the Ruby Agent can be found at [Rubygems.org](https://rubygems.org/gems/newrelic_rpm)
+
 ### Quick Start
 
 #### With Bundler
@@ -131,6 +135,6 @@ The New Relic Ruby agent also uses source code from third-party libraries. Full
 
 Thank you, and may your application scale to infinity plus one.
 
-Lew Cirne, Founder and CEO
+Lew Cirne, Founder
 
 New Relic, Inc.

data/lib/new_relic/agent/adaptive_sampler.rb

@@ -13,7 +13,7 @@ module NewRelic
         @sampled_count = 0
         @period_duration = period_duration
         @first_period = true
-        @period_start = Time.now.to_f
+        @period_start = Process.clock_gettime(Process::CLOCK_MONOTONIC)
         @lock = Mutex.new
         register_config_callbacks
       end
@@ -53,7 +53,7 @@ module NewRelic
       private
 
       def reset_if_period_expired!
-        now = Time.now.to_f
+        now = Process.clock_gettime(Process::CLOCK_MONOTONIC)
         return unless @period_start + @period_duration <= now
 
         elapsed_periods = Integer((now - @period_start) / @period_duration)

data/lib/new_relic/agent/agent.rb

@@ -17,6 +17,7 @@ require 'new_relic/agent/new_relic_service'
 require 'new_relic/agent/pipe_service'
 require 'new_relic/agent/configuration/manager'
 require 'new_relic/agent/database'
+require 'new_relic/agent/instrumentation/resque/helper'
 require 'new_relic/agent/commands/agent_command_router'
 require 'new_relic/agent/event_listener'
 require 'new_relic/agent/distributed_tracing'
@@ -214,7 +215,7 @@ module NewRelic
             @connected_pid = Process.pid
           else
             ::NewRelic::Agent.logger.debug("Child process #{Process.pid} not reporting to non-connected parent (process #{Process.ppid}).")
-            @service.shutdown(Time.now)
+            @service.shutdown
             disconnect
           end
         end
@@ -470,7 +471,7 @@ module NewRelic
           # before Resque calls Process.daemon (Jira RUBY-857)
           def defer_for_resque?
             NewRelic::Agent.config[:dispatcher] == :resque &&
-              NewRelic::LanguageSupport.can_fork? &&
+              NewRelic::Agent::Instrumentation::Resque::Helper.resque_fork_per_job? &&
               !PipeChannelManager.listener.started?
           end
 
@@ -1122,7 +1123,7 @@ module NewRelic
         end
 
         def transmit_single_data_type(harvest_method, supportability_name)
-          now = Time.now
+          now = Process.clock_gettime(Process::CLOCK_MONOTONIC)
 
           msg = "Sending #{supportability_name} data to New Relic Service"
           ::NewRelic::Agent.logger.debug msg
@@ -1131,12 +1132,12 @@ module NewRelic
             self.send(harvest_method)
           end
         ensure
-          duration = (Time.now - now).to_f
+          duration = Process.clock_gettime(Process::CLOCK_MONOTONIC) - now
           NewRelic::Agent.record_metric("Supportability/#{supportability_name}Harvest", duration)
         end
 
         def transmit_data
-          now = Time.now
+          now = Process.clock_gettime(Process::CLOCK_MONOTONIC)
           ::NewRelic::Agent.logger.debug "Sending data to New Relic Service"
 
           @events.notify(:before_harvest)
@@ -1153,7 +1154,7 @@ module NewRelic
           end
         ensure
           NewRelic::Agent::Database.close_connections
-          duration = (Time.now - now).to_f
+          duration = Process.clock_gettime(Process::CLOCK_MONOTONIC) - now
           NewRelic::Agent.record_metric('Supportability/Harvest', duration)
         end
 
@@ -1178,7 +1179,7 @@ module NewRelic
 
               if @connected_pid == $$ && !@service.kind_of?(NewRelic::Agent::NewRelicService)
                 ::NewRelic::Agent.logger.debug "Sending New Relic service agent run shutdown message"
-                @service.shutdown(Time.now.to_f)
+                @service.shutdown
               else
                 ::NewRelic::Agent.logger.debug "This agent connected from parent process #{@connected_pid}--not sending shutdown"
               end

data/lib/new_relic/agent/commands/thread_profiler_session.rb

@@ -38,7 +38,7 @@ module NewRelic
             agent_command.arguments
           )
 
-          @started_at = Time.now
+          @started_at = Process.clock_gettime(Process::CLOCK_REALTIME)
           @duration = profile.duration if profile
         end
 
@@ -51,7 +51,9 @@ module NewRelic
         end
 
         def harvest
-          NewRelic::Agent.logger.debug("Harvesting from Thread Profiler #{@finished_profile.to_log_description unless @finished_profile.nil?}")
+          NewRelic::Agent.logger.debug(
+            "Harvesting from Thread Profiler #{@finished_profile.to_log_description unless @finished_profile.nil?}"
+          )
           profile = @finished_profile
           @backtrace_service.profile_agent_code = false
           @finished_profile = nil
@@ -72,7 +74,9 @@ module NewRelic
         end
 
         def past_time?
-          @started_at && (Time.now > @started_at + @duration)
+          @started_at && (
+            Process.clock_gettime(Process::CLOCK_REALTIME) > @started_at + @duration
+          )
         end
 
         def stopped?