newrelic_rpm 8.10.1 → 8.12.0

data/CHANGELOG.md

@@ -1,19 +1,92 @@
 # New Relic Ruby Agent Release Notes #
 
+  ## v8.12.0
+
+  Version 8.12.0 of the agent delivers new Elasticsearch instrumentation, increases the default number of recorded Custom Events, announces the deprecation of Ruby 2.3, and brings some valuable code cleanup.
+
+  * **Support for Elasticsearch instrumentation**
+
+    This release adds support to automatically instrument the [elasticsearch](https://rubygems.org/gems/elasticsearch) gem. Versions 7.x and 8.x are supported. [PR#1525](https://github.com/newrelic/newrelic-ruby-agent/pull/1525)
+
+    | Configuration name | Default | Behavior |
+    | ----------- | ----------- |----------- |
+    | `instrumentation.elasticsearch` | auto | Controls auto-instrumentation of the elasticsearch library at start up. May be one of `auto`, `prepend`, `chain`, `disabled`. |
+    | `elasticsearch.capture_queries` | true | If `true`, the agent captures Elasticsearch queries in transaction traces. |
+    | `elasticsearch.obfuscate_queries` | true |  If `true`, the agent obfuscates Elasticsearch queries in transaction traces. |
+
+  * **Custom Event Limit Increase**
+
+    This version increases the default limit of custom events from 1000 events per minute to 3000 events per minute. In the scenario that custom events were being limited, this change will allow more custom events to be sent to New Relic. There is also a new configurable maximum limit of 100,000 events per minute. To change the limits, see the documentation for [max_samples_stored](https://docs.newrelic.com/docs/apm/agents/ruby-agent/configuration/ruby-agent-configuration/#custom_insights_events-max_samples_stored). To learn more about the change and how to determine if custom events are being dropped, see our Explorers Hub [post](https://discuss.newrelic.com/t/send-more-custom-events-with-the-latest-apm-agents/190497). [PR#1541](https://github.com/newrelic/newrelic-ruby-agent/pull/1541)
+
+  * **Deprecate support for Ruby 2.3**
+
+    Ruby 2.3 reached end of life on March 31, 2019. The Ruby agent has deprecated support for Ruby 2.3 and will make breaking changes for this version in its next major release, v9.0.0 (release date not yet planned). All 8.x.x versions of the agent will remain compatible with Ruby 2.3.
+
+  * **Cleanup: Remove orphaned code**
+
+    In both the agent and unit tests, changes have taken place over the years that have left certain bits of code unreachable. This orphaned code can complicate code maintenance and refactoring, so getting it squared away can be very helpful. Commmuniy member [@ohbarye](https://github.com/ohbarye) contributed two separate cleanup PRs for this release; one for the agent and one for the tests. [PR#1537](https://github.com/newrelic/newrelic-ruby-agent/pull/1537) [PR#1548](https://github.com/newrelic/newrelic-ruby-agent/pull/1548)
+
+    Thank you to [@ohbarye](https://github.com/ohbarye) for contributing this helpful cleanup!
+
+
+  ## v8.11.0
+
+  Version 8.11.0 of the agent updates the `newrelic deployments` command to work with API keys issued to newer accounts, fixes a memory leak in the instrumentation of Curb error handling, further preps for Ruby 3.2.0 support, and includes several community member driven cleanup and improvement efforts. Thank you to everyone involved!
+
+
+  * **Added support for New Relic REST API v2 when using `newrelic deployments` command**
+
+    Previously, the `newrelic deployments` command only supported the older version of the deployments api, which does not currently support newer license keys. Now you can use the New Relic REST API v2 to record deployments by providing your user API key to the agent configuration using `api_key`. When this configuration option is present, the `newrelic deployments` command will automatically use the New Relic REST API v2 deployment endpoint. [PR#1461](https://github.com/newrelic/newrelic-ruby-agent/pull/1461)
+
+    Thank you to [@Arkham](https://github.com/Arkham) for bringing this to our attention!
+
+
+  * **Cleanup: Performance tests, constants, rubocop-minitest assertions and refutations**
+
+    Community member [@esquith](https://github.com/esquith) contributed a whole slew of cleanup successes for our performance test configuration, orphaned constants in our code base, and RuboCop related improvements. [PR#1406](https://github.com/newrelic/newrelic-ruby-agent/pull/1406) [PR#1408](https://github.com/newrelic/newrelic-ruby-agent/pull/1408) [PR#1409](https://github.com/newrelic/newrelic-ruby-agent/pull/1409) [PR#1411](https://github.com/newrelic/newrelic-ruby-agent/pull/1411)
+
+    Thank you [@esquith](https://github.com/esquith) for these great contributions!
+
+
+  * **CI: Notify on a change from failure to success**
+
+    A super handy, much beloved feature of certain CI and build systems is to not only notify when builds start to fail, but also to notify again when the builds once again start to go green. Community member [@luigieai](https://github.com/luigieai) was able to figure out how to configure our existing complex, multiple-3rd-party-action based GitHub Actions pipeline to notify on a switch back to success from failure. [PR#1519](https://github.com/newrelic/newrelic-ruby-agent/pull/1519)
+
+    This is much appreciated! Thank you, [@luigieai](https://github.com/luigieai).
+
+
+  * **Spelling corrections**
+
+    Community member [@jsoref](https://github.com/jsoref), author of the [Check Spelling](https://github.com/marketplace/actions/check-spelling) GitHub Action, contributed a significant number of spelling corrections throughout the code base. The intelligent issues that were flagged made for a more comprehensive review than a simple dictionary based check would have been able to provide, and the changes are much appreciated. [PR#1508](https://github.com/newrelic/newrelic-ruby-agent/pull/1508)
+
+    Thank you very much, [@jsoref](https://github.com/jsoref)!
+
+
+  * **Ruby 3.2.0-preview2 compatibility**
+
+    Ruby 3.2.0-preview1 introduced a change to the way that Ruby reports VM stats and the approach was changed yet again to a 3rd approach with the preview2 release. New Relic reports on Ruby VM stats and is keeping track of the Ruby 3.2 development process to help ensure our customers with a smooth and worthwhile upgrade process once Ruby 3.2.0 (non-preview) is released. [PR#1436](https://github.com/newrelic/newrelic-ruby-agent/pull/1436)
+
+
+  * **Bugfix: Fix memory leak in the Curb instrumentation**
+
+    Community member [@charkost](https://github.com/charkost) was able to rework the `on_failure` callback logic prepped via the agent's Curb instrumentation in order to avoid some nesting that was causing memory leaks. [PR#1518](https://github.com/newrelic/newrelic-ruby-agent/pull/1518)
+
+    Many thanks for both the heads up on the issue and the fix, [@charkost](https://github.com/charkost)!
+
 
   ## v8.10.1
 
 
   * **Bugfix: Missing unscoped metrics when instrumentation.thread.tracing is enabled**
-    
+
     Previously, when `instrumentation.thread.tracing` was set to true, some puma applications encountered a bug where a varying number of unscoped metrics would be missing. The agent now will correctly store and send all unscoped metrics.
-    
+
     Thank you to @texpert for providing details of their situation to help resolve the issue.
-  
-  
+
+
   * **Bugfix: gRPC instrumentation causes ArgumentError when other Google gems are present**
 
-    Previously, when the agent had gRPC instrumentation enabled in an application using other gems (such as google-ads-googleads), the instrumentation could cause the error `ArgumentError: wrong number of arguments (given 3, expected 2)`. The gRPC instrumentation has been updated to prevent this issue from occurring in the future. 
+    Previously, when the agent had gRPC instrumentation enabled in an application using other gems (such as google-ads-googleads), the instrumentation could cause the error `ArgumentError: wrong number of arguments (given 3, expected 2)`. The gRPC instrumentation has been updated to prevent this issue from occurring in the future.
 
     Thank you to @FeminismIsAwesome for bringing this issue to our attention.
 
@@ -41,7 +114,7 @@
 
   * **Performance: Rework timing range overlap calculations for multiple transaction segments**
 
-    Many thanks to GitHub community members @bmulholland and @hkdnet. @bmulholland alerted us to [rmosolgo/graphql-ruby#3945](https://github.com/rmosolgo/graphql-ruby/issues/3945). That Issue essentially notes that the New Relic Ruby agent incurs a significant perfomance hit when the `graphql` RubyGem (which ships with New Relic Ruby agent support) is used with DataLoader to generate a high number of transactions. Then @hkdnet diagnosed the root cause in the Ruby agent and put together both a proof of concept fix and a full blown PR to resolve the problem. The agent keeps track multiple segments that are concurrently in play for a given transaction in order to merge the ones whose start and stop times intersect. The logic for doing this find-and-merge operation has been reworked to a) be deferred entirely until the transaction is ready to be recorded, and b) made more performant when it is needed. GraphQL DataLoader users and other users who generate lots of activity for monitoring within a short amount of time will hopefully see some good performance gains from these changes.
+    Many thanks to GitHub community members @bmulholland and @hkdnet. @bmulholland alerted us to [rmosolgo/graphql-ruby#3945](https://github.com/rmosolgo/graphql-ruby/issues/3945). That Issue essentially notes that the New Relic Ruby agent incurs a significant performance hit when the `graphql` RubyGem (which ships with New Relic Ruby agent support) is used with DataLoader to generate a high number of transactions. Then @hkdnet diagnosed the root cause in the Ruby agent and put together both a proof of concept fix and a full blown PR to resolve the problem. The agent keeps track multiple segments that are concurrently in play for a given transaction in order to merge the ones whose start and stop times intersect. The logic for doing this find-and-merge operation has been reworked to a) be deferred entirely until the transaction is ready to be recorded, and b) made more performant when it is needed. GraphQL DataLoader users and other users who generate lots of activity for monitoring within a short amount of time will hopefully see some good performance gains from these changes.
 
 
   * **Performance: Make frozen string literals the default for the agent**
@@ -50,26 +123,26 @@
 
 
   * **Bugfix: Error when setting the yaml configuration with `transaction_tracer.transaction_threshold: apdex_f`**
-    
-    Originally, the agent was only checking the `transaction_tracer.transaction_threshold` from the newrelic.yml correctly if it was on two lines. 
+
+    Originally, the agent was only checking the `transaction_tracer.transaction_threshold` from the newrelic.yml correctly if it was on two lines.
 
     Example:
 
     ```
     # newrelic.yml
     transaction_tracer:
-      transaction_threshold: apdex_f 
+      transaction_threshold: apdex_f
     ```
 
-    When this was instead changed to be on one line, the agent was not able to correctly identify the value of apdex_f. 
+    When this was instead changed to be on one line, the agent was not able to correctly identify the value of apdex_f.
 
     Example:
     ```
     # newrelic.yml
     transaction_tracer.transaction_threshold: apdex_f
     ```
-    This would cause prevent transactions from finishing due to the error `ArgumentError: comparison of Float with String failed`. This has now been corrected and the agent is able to process newrelic.yml with a one line `transaction_tracer.transaction_threshold: apdex_f` correctly now. 
-    
+    This would cause prevent transactions from finishing due to the error `ArgumentError: comparison of Float with String failed`. This has now been corrected and the agent is able to process newrelic.yml with a one line `transaction_tracer.transaction_threshold: apdex_f` correctly now.
+
     Thank you to @oboxodo for bringing this to our attention.
 
 
@@ -78,10 +151,9 @@
     Previously the agent would modify each instance of the Logger class by adding a unique instance variable as part of the instrumentation. This could cause the error `FrozenError: can't modify frozen Logger` to be thrown if the Logger instance had been frozen. The agent will now check if the object is frozen before attempting to modify the object. Thanks to @mkcosta for bringing this issue to our attention.
 
 
-
   ## v8.9.0
-  
-  
+
+
   * **Add support for Dalli 3.1.0 to Dalli 3.2.2**
 
     Dalli versions 3.1.0 and above include breaking changes where the agent previously hooked into the gem. We have updated our instrumentation to correctly hook into Dalli 3.1.0 and above. At this time, 3.2.2 is the latest Dalli version and is confirmed to be supported.
@@ -93,9 +165,9 @@
 
   * **Bugfix: Use read_nonblock instead of read on pipe**
 
-    Previously, our PipeChannelManager was using read which could cause Resque jobs to get stuck in some versions. This change updates the PipeChannelManager to use read_nonblock instead. This method can leverage error handling to allow the instrumentation to gracefully log a message and exit the stuck Resque job. 
+    Previously, our PipeChannelManager was using read which could cause Resque jobs to get stuck in some versions. This change updates the PipeChannelManager to use read_nonblock instead. This method can leverage error handling to allow the instrumentation to gracefully log a message and exit the stuck Resque job.
+
 
-    
   ## v8.8.0
 
   * **Support Makara database adapters with ActiveRecord**
@@ -119,7 +191,7 @@
 
   * **APM logs-in-context log forwarding on by default**
 
-    Automatic application log forwarding is now enabled by default. This version of the agent will automatically send enriched application logs to New Relic. To learn more about about this feature see [here](https://docs.newrelic.com/docs/apm/new-relic-apm/getting-started/get-started-logs-context/), and additional configuration options are available [here](https://docs.newrelic.com/docs/logs/logs-context/configure-logs-context-ruby). To learn about how to toggle log ingestion on or off by account see [here](https://docs.newrelic.com/docs/logs/logs-context/disable-automatic-logging).
+    Automatic application log forwarding is now enabled by default. This version of the agent will automatically send enriched application logs to New Relic. To learn more about this feature see [here](https://docs.newrelic.com/docs/apm/new-relic-apm/getting-started/get-started-logs-context/), and additional configuration options are available [here](https://docs.newrelic.com/docs/logs/logs-context/configure-logs-context-ruby). To learn about how to toggle log ingestion on or off by account see [here](https://docs.newrelic.com/docs/logs/logs-context/disable-automatic-logging).
 
   * **Improved async support and Thread instrumentation**
 
@@ -128,7 +200,7 @@
     New configuration options included in this release:
     | Configuration name | Default | Behavior |
     | ----------- | ----------- |----------- |
-    | `instrumentation.thread`  | `auto` (enabled) | Allows the agent to correctly nest spans inside of an asyncronous transaction   |
+    | `instrumentation.thread`  | `auto` (enabled) | Allows the agent to correctly nest spans inside of an asynchronous transaction   |
     | `instrumentation.thread.tracing` | `false` (disabled)   |  Automatically add tracing to all Threads created in the application. This may be enabled by default in a future release. |
 
     We'd like to thank @mikeantonelli for sharing a gist with us that provided our team with an entry point for this feature.
@@ -192,7 +264,7 @@
   * **Bugfix: Error events missing attributes when created outside of a transaction**
 
     Previously the agent was not assigning a priority to error events that were created by calling notice_error outside the scope of a transaction. This caused issues with sampling when the error event buffer was full, resulting in a `NoMethodError: undefined method '<' for nil:NilClass` in the newrelic_agent.log. This bugfix ensures that a priority is always assigned on error events so that the agent will be able to sample these error events correctly. Thank you to @olleolleolle for bringing this issue to our attention.
-    
+
 
 
   ## v8.6.0
@@ -217,7 +289,7 @@
 
     Previously, unit tests would fail with unexpected invocation errors when `NEW_RELIC_LICENSE_KEY` and `NEW_RELIC_HOST` environment variables were present. Now, tests will discard these environment variables before running.
 
-  * **Bugfix: Curb - satify method_with_tracing's verb argument requirement**
+  * **Bugfix: Curb - satisfy method_with_tracing's verb argument requirement**
 
     When Curb instrumentation is used (either via prepend or chain), be sure to always pass the verb argument over to `method_with_tracing` which requires it. Thank you to @knarewski for bringing this issue to our attention, for providing a means of reproducing an error, and for providing a fix. That fix has been replicated by the agent team with permission. See [Issue 1033](https://github.com/newrelic/newrelic-ruby-agent/issues/1033) for more details.
 
@@ -399,7 +471,7 @@
 
   * **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).
+    For more information about this configuration 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`**
 
@@ -473,7 +545,7 @@
 
   * **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.
+    Thanks to @wyhaines for this fix that prevents "can't add a new key into hash during iteration" errors from occurring when iterating over environment data.
 
   * **Bugfix: kwarg support fixed for Rack middleware instrumentation**
 
@@ -530,7 +602,7 @@
 
   * **Ruby Agent 6.x to 7.x Migration Guide Available**
 
-    Please see our [Ruby Agent 6.x to 7.x migration guide](https://docs.newrelic.com/docs/agents/ruby-agent/getting-started/migration-7x-guide/) for helpful strategies and tips for migrating from earlier versions of the Ruby agent to 7.0.0.  We cover new configuration settings, diagnosiing and installing SSL CA certificates and deprecated items and their replacements in this guide.
+    Please see our [Ruby Agent 6.x to 7.x migration guide](https://docs.newrelic.com/docs/agents/ruby-agent/getting-started/migration-7x-guide/) for helpful strategies and tips for migrating from earlier versions of the Ruby agent to 7.0.0.  We cover new configuration settings, diagnosing and installing SSL CA certificates and deprecated items and their replacements in this guide.
 
   * **Ruby 2.0 and 2.1 Dropped**
 
@@ -649,7 +721,7 @@
   * **Default prepend_net_instrumentation to false**
 
     Previously, `prepend_net_instrumentation` defaulted to true. However, many gems are still using monkey patching on Net::HTTP, which causes compatibility issues with using prepend. Defaulting this to false minimizes instances of
-    unexpected compatibilty issues.
+    unexpected compatibility issues.
 
   ## v6.14.0
 
@@ -659,14 +731,14 @@
 
   * **Bugfix: Delayed Job instrumentation fixed for Ruby 2.7+**
 
-    Previously, the agent was erroneousy separating positional and keyword arguments on the instrumented method calls into
+    Previously, the agent was erroneously separating positional and keyword arguments on the instrumented method calls into
     Delayed Job's library.  The led to Delayed job not auto-instrumenting correctly and has been fixed.
 
   * **Bugfix: Ruby 2.7+ methods sometimes erroneously attributed compiler warnings to the Agent's `add_method_tracer`**
 
     The specific edge cases presented are now fixed by this release of the agent.  There are still some known corner-cases
     that will be resolved with upcoming changes in next major release of the Agent.  If you encounter a problem with adding
-    method tracers and compiler warnings raised, please continue to submit small repoducible examples.
+    method tracers and compiler warnings raised, please continue to submit small reproducible examples.
 
   * **Bugfix: Ruby 2.7+ fix for keyword arguments on Rack apps is unnecessary and removed**
 
@@ -683,14 +755,14 @@
 
     Previously, when a user specifies a `newrelic.yml.erb` and no `newrelic.yml` file, the agent fails to find
     the `.erb` file because it was not in the list of files searched at startup.  The Ruby agent has long supported this as a
-    means of configuring the agent programatically.  The `newrelic.yml.erb` filename is restored to the search
+    means of configuring the agent programmatically.  The `newrelic.yml.erb` filename is restored to the search
     path and will be utilized if present.  NOTE:  `newrelic.yml` still takes precedence over `newrelic.yml.erb`  If found,
     the `.yml` file is used instead of the `.erb` file.  Search directories and order of traversal remain unchanged.
 
   * **Bugfix: dependency detection of Redis now works without raising an exception**
 
     Previously, when detecting if Redis was available to instrument, the dependency detection would fail with an Exception raised
-    (with side effect of not attempting to instrument Redis).  This is now fixed with a better dependency check that resolves falsly without raising an `Exception`.
+    (with side effect of not attempting to instrument Redis).  This is now fixed with a better dependency check that resolves falsely without raising an `Exception`.
 
   * **Bugfix: Gracefully handles NilClass as a Middleware Class when instrumenting**
 
@@ -815,10 +887,10 @@
     Additionally, a bug in recording the metric for "findAndModify" as all lowercased "findandmodify"
     for versions 2.1 through 2.5 was fixed.
 
-  * **Bugfix: Priority Sampler causes crash in high throughput environents in rare cases**
+  * **Bugfix: Priority Sampler causes crash in high throughput environments in rare cases**
 
     Previously, the priority sampling buffer would, in rare cases, generate an error in high-throughput
-    environments once capacity is reached and the sampling algorthym engages.  This issue is fixed.
+    environments once capacity is reached and the sampling algorithm engages.  This issue is fixed.
 
   * **Additional Transaction Information applied to Span Events**
 
@@ -1537,7 +1609,7 @@
 
     Prior to this version, using an SSL connection to New Relic was
     the default behavior, but could be overridden. SSL connections are
-    now enforced (not overrideable).
+    now enforced (not overridable).
 
   * Additional security checking before trying to explain
     multi-statement SQL queries
@@ -1703,7 +1775,7 @@
   The agent will now collect slow SQL explain plans, if configured to, on
   connections using the PostGIS adapter. Thanks Ari Pollak for the contribution!
 
-  * Lazily intialize New Relic Config
+  * Lazily initialize New Relic Config
 
   The agent will lazily initialize the New Relic config. This allows the agent
   to pickup configuration from environment variables set by dotenv and similar
@@ -1950,7 +2022,7 @@
   * Include ControllerInstrumentation module with ActiveSupport.on_load
 
   The agent will now use the `on_load :action_controller` hook to include
-  the ControllerInstrumentation module in to both the `Base` and `API`
+  the ControllerInstrumentation module into both the `Base` and `API`
   classes of ActionController for Rails 5. This ensures that the proper
   load order is retained, minimizing side-effects of having the agent in
   an application.
@@ -1995,7 +2067,7 @@
   better compatibility between our ActiveRecord Instrumentation and
   other third party gems that modify ActiveRecord using `Module#prepend`.
 
-  * Use license key passed in to NewRelic::Agent.manual_start
+  * Use license key passed into NewRelic::Agent.manual_start
 
   Previously, the license key passed in when manually starting the agent
   with NewRelic::Agent.manual_start was not referenced when setting up
@@ -3128,7 +3200,7 @@
   runtime relative to the directory that the host process is started from.
 
   In cases where the host process was started from outside of the application's
-  root directory (for example, if the process is started from from '/'), it will
+  root directory (for example, if the process is started from '/'), it will
   now also attempt to locate its configuration file based on the value of
   Rails.root for Rails applications.
 
@@ -3177,7 +3249,7 @@
   Rack::Builder, or via Rails' middleware stack in Rails 3.0+.
 
   This instrumentation may be disabled with the
-  disable_middlware_instrumentation configuration setting.
+  disable_middleware_instrumentation configuration setting.
 
   For more details, see the documentation for this feature:
 
@@ -3315,7 +3387,7 @@
   * Separate in-transaction GC timings for web and background processes
 
   Previously, an application with GC instrumentation enabled, and both web and
-  background processes reporting in to it would show an overly inflated GC band
+  background processes reporting into it would show an overly inflated GC band
   on the application overview graph, because data from both web and non-web
   transactions would be included. This has been fixed, and GC time during web
   and non-web transactions is now tracked separately.
@@ -3543,7 +3615,7 @@
 
   The agent's ActiveRecord 4.0 instrumentation could not gather SQL explain
   plans on JRuby by default because of a dependency on ObjectSpace, which isn't
-  avialable by default. This has been fixed.
+  available by default. This has been fixed.
 
   * Fix for Curb http_put_with_newrelic
 
@@ -4176,7 +4248,7 @@
 
  * corrupt marshal data from pipe children crashing agent
 
-   If the agent received corrupted data from the Reqsue worker child agent
+   If the agent received corrupted data from the Resque worker child agent
    it could crash the agent itself. fixed.
 
  * should reset RubyBench GC counter between polls
@@ -4230,7 +4302,7 @@
   * fix for issues with RAILS_ROOT deprecation warnings
   * fixed incorrect 1.9 GC time reporting
   * obfuscation for Slow SQL queries respects transaction trace config
-  * fix for RUM instrumentation repoting bad timing info in some cases
+  * fix for RUM instrumentation reporting bad timing info in some cases
   * refactored ActiveRecord instrumentation, no longer requires Rails
 
 ## v3.3.0

data/Gemfile

@@ -1,4 +1,3 @@
-# encoding: utf-8
 # This file is distributed under New Relic's license terms.
 # See https://github.com/newrelic/newrelic-ruby-agent/blob/main/LICENSE for complete details.
 # frozen_string_literal: true

data/README.md

@@ -91,7 +91,7 @@ This [troubleshooting framework](https://discuss.newrelic.com/t/ruby-troubleshoo
 
 New Relic offers NRDiag, [a client-side diagnostic utility](https://docs.newrelic.com/docs/using-new-relic/cross-product-functions/troubleshooting/new-relic-diagnostics) that automatically detects common problems with New Relic agents. If NRDiag detects a problem, it suggests troubleshooting steps. NRDiag can also automatically attach troubleshooting data to a New Relic Support ticket.
 
-If the issue has been confirmed as a bug or is a Feature request, please file a Github issue.
+If the issue has been confirmed as a bug or is a Feature request, please file a GitHub issue.
 
 **Support Channels**
 

data/Rakefile

@@ -1,4 +1,3 @@
-# encoding: utf-8
 # This file is distributed under New Relic's license terms.
 # See https://github.com/newrelic/newrelic-ruby-agent/blob/main/LICENSE for complete details.
 # frozen_string_literal: true
@@ -7,6 +6,8 @@ require 'rubygems'
 require 'rake/testtask'
 require 'yard'
 require "#{File.dirname(__FILE__)}/lib/tasks/all.rb"
+require_relative 'lib/tasks/helpers/prompt'
+include Prompt
 
 YARD::Rake::YardocTask.new
 
@@ -115,25 +116,6 @@ namespace :cross_agent_tests do
   CROSS_AGENT_TESTS_UPSTREAM_PATH = File.expand_path(File.join('..', 'cross_agent_tests')).freeze
   CROSS_AGENT_TESTS_LOCAL_PATH = File.expand_path(File.join('test', 'fixtures', 'cross_agent_tests')).freeze
 
-  def prompt_to_continue(command, destination = 'local')
-    puts "The following rsync command will be executed to update the #{destination} copy of the specs:"
-    puts
-    puts command
-    puts
-    puts "CAUTION: Any unsaved changes that exist within the #{destination} content will be OVERWRITTEN!"
-    if destination.eql?('local')
-      puts 'CAUTION 2: Before continuing, make sure your local repo is on the correct, synced branch!'
-    end
-    puts
-    print "Do you wish to continue? ('y' to continue, return to cancel) [n] "
-    continue = STDIN.gets.chomp
-    if continue.downcase.eql?('y')
-      system(command)
-    else
-      puts 'Cancelled'
-    end
-  end
-
   desc 'Pull latest changes from cross_agent_tests repo'
   task :pull do
     command = "  rsync -av --exclude .git #{CROSS_AGENT_TESTS_UPSTREAM_PATH}/ #{CROSS_AGENT_TESTS_LOCAL_PATH}/"
@@ -147,6 +129,7 @@ namespace :cross_agent_tests do
   end
 end
 
+desc 'Start an interactive console session'
 task :console do
   require 'pry'
   require 'newrelic_rpm'

data/Thorfile

@@ -1,4 +1,3 @@
-# encoding: utf-8
 # This file is distributed under New Relic's license terms.
 # See https://github.com/newrelic/newrelic-ruby-agent/blob/main/LICENSE for complete details.
 # frozen_string_literal: true

data/bin/nrdebug

@@ -1,6 +1,5 @@
 #!/usr/bin/env ruby
 
-# encoding: utf-8
 # This file is distributed under New Relic's license terms.
 # See https://github.com/newrelic/newrelic-ruby-agent/blob/main/LICENSE for complete details.
 # frozen_string_literal: true
@@ -97,11 +96,11 @@ class LinuxProcessDataProvider < ProcessDataProvider
   end
 
   def procline
-    File.read(proc_path('cmdline')).gsub("\000", " ")
+    File.read(proc_path('cmdline')).tr("\000", " ")
   end
 
   def environment
-    File.read(proc_path('environ')).gsub("\000", "\n")
+    File.read(proc_path('environ')).tr("\000", "\n")
   end
 end
 
@@ -134,8 +133,29 @@ class RubyProcess
     backtrace_file = Tempfile.new('nrdebug_ruby_bt')
     File.chmod(0666, backtrace_file.path)
 
-    backtrace_gathering_code = 'Thread.list.each { |t| bt = t.backtrace rescue nil; puts \"#{t.inspect}\n#{bt && bt.join(\"\n\")}\n\n\" }'
-    gdb_script_body = <<-END
+    body = gdb_script_body(backtrace_file)
+
+    script_file = write_script_file(body)
+
+    gdb_stderr = Tempfile.new('nrdebug_gdb_stderr')
+
+    gdb_cmd = "gdb -batch -x #{script_file.path} 2>#{gdb_stderr.path}"
+    gdb_output = ShellWrapper.execute(gdb_cmd)
+    ruby_backtrace = File.read(backtrace_file.path)
+
+    script_file.close!
+    backtrace_file.close!
+    gdb_stderr.close!
+
+    [gdb_output, ruby_backtrace]
+  end
+
+  private
+
+  def gdb_script_body(backtrace_file)
+    backtrace_gathering_code = 'Thread.list.each { |t| bt = t.backtrace rescue nil; ' \
+      'puts \"#{t.inspect}\n#{bt && bt.join(\"\n\")}\n\n\" }'
+    <<-END
       attach #{pid}
       t a a bt
       call (void)close(1)
@@ -148,23 +168,14 @@ class RubyProcess
       call (void)fflush(0)
       quit
     END
-    Logger.log("Using gdb script:\n#{gdb_script_body}")
+  end
 
+  def write_script_file(body)
+    Logger.log("Using gdb script:\n#{body}")
     script_file = Tempfile.new('nrdebug_gdb_script')
-    script_file.write(gdb_script_body)
+    script_file.write(body)
     script_file.close
-
-    gdb_stderr = Tempfile.new('nrdebug_gdb_stderr')
-
-    gdb_cmd = "gdb -batch -x #{script_file.path} 2>#{gdb_stderr.path}"
-    gdb_output = ShellWrapper.execute(gdb_cmd)
-    ruby_backtrace = File.read(backtrace_file.path)
-
-    script_file.close!
-    backtrace_file.close!
-    gdb_stderr.close!
-
-    [gdb_output, ruby_backtrace]
+    script_file
   end
 end
 
@@ -201,20 +212,14 @@ class ProcessReport
 
   def generate
     open do |f|
-      section(f, "Time") { Time.now }
-      section(f, "PID") { @target.pid }
-      section(f, "Command") { @target.procline }
-      section(f, "RSS") { @target.rss }
-      section(f, "CPU") { @target.cpu }
-      section(f, "Parent PID") { @target.ppid }
-      section(f, "OS") { ShellWrapper.execute('uname -a') }
-      section(f, "Environment") { @target.environment }
+      add_environment_sections(f)
 
       section(f) do
         c_backtraces, ruby_backtraces = @target.gather_backtraces
-        if c_backtraces.match(/could not attach/i)
+        if c_backtraces =~ /could not attach/i
           fail("Failed to attach to target process. Please try again with sudo.")
         end
+
         section(f, "C Backtraces") { c_backtraces }
         section(f, "Ruby Backtrace(s)") { ruby_backtraces }
       end
@@ -226,23 +231,38 @@ class ProcessReport
       end
     end
   end
+
+  private
+
+  def add_environment_sections(handle)
+    section(handle, "Time") { Time.now }
+    section(handle, "PID") { @target.pid }
+    section(handle, "Command") { @target.procline }
+    section(handle, "RSS") { @target.rss }
+    section(handle, "CPU") { @target.cpu }
+    section(handle, "Parent PID") { @target.ppid }
+    section(handle, "OS") { ShellWrapper.execute('uname -a') }
+    section(handle, "Environment") { @target.environment }
+  end
 end
 
 def prompt_for_confirmation(target_pid, target_cmd)
-  puts "Are you sure you want to attach to PID #{target_pid} ('#{target_cmd}')}?"
-  puts ''
-  puts '************************** !WARNING! **************************'
-  puts "Extracting debug information from this process may cause it to CRASH OR HANG."
-  puts ''
-  puts "It is highly recommended that you only run this script against processes that"
-  puts "are already unresponsive."
-  puts ''
-  puts "Additionally, the output may contain sensitive information from the program's"
-  puts "command line arguments, environment, or open file list. Please examine the"
-  puts "output before sharing it."
-  puts '************************** !WARNING! **************************'
-  puts ''
-  puts "To continue, type 'continue':"
+  puts <<-PROMPT
+  Are you sure you want to attach to PID #{target_pid} ('#{target_cmd}')}?
+  
+  ************************** !WARNING! **************************
+  Extracting debug information from this process may cause it to CRASH OR HANG.
+  
+  It is highly recommended that you only run this script against processes that
+  are already unresponsive.
+  
+  Additionally, the output may contain sensitive information from the program's
+  command line arguments, environment, or open file list. Please examine the
+  output before sharing it.
+  ************************** !WARNING! **************************
+  
+  To continue, type 'continue':
+  PROMPT
 
   until $stdin.gets.strip == 'continue'
     puts "Please type 'continue' to continue, or ctrl-c to abort."
@@ -257,11 +277,13 @@ fail("Could not find gdb, please ensure it is installed and in your PATH") if gd
 
 target = RubyProcess.new(target_pid)
 if !target.attachable?
-  fail("You do not appear to have permissions to attach to the target process.\nPlease check the process owner and try again with sudo if necessary")
+  fail("You do not appear to have permissions to attach to the target process.\nPlease check the process owner " \
+    'and try again with sudo if necessary')
 end
 if !target.alive?
   fail("Could not find process with PID #{target_pid}")
 end
+
 target_cmd = target.procline
 
 prompt_for_confirmation(target_pid, target_cmd)

data/config.dot

@@ -90,7 +90,7 @@ digraph AgentEnabled {
   "Agent#log_seed_token"
   "Agent#log_error"
   "Agent#monitoring?"
-  "Agent#check_trasaction_sampler_status"
+  "Agent#check_transaction_sampler_status"
   "Agent#check_sql_sampler_status"
   "Agent#config_transaction_tracer"
   "Agent#set_sql_recording!"
@@ -134,8 +134,8 @@ digraph AgentEnabled {
 
   "MetricFrame.update_apdex"
 
-  "TranactionInfo#force_persist_sample?"
-  "TranactionInfo#include_guid?"
+  "TransactionInfo#force_persist_sample?"
+  "TransactionInfo#include_guid?"
 
   "TransactionSampleBuilder#initialize"
   "TransactionSampleBuilder#set_transaction_info"
@@ -257,8 +257,8 @@ digraph AgentEnabled {
 
   "MetricFrame.update_apdex" -> "[apdex_t]"
 
-  "TranactionInfo#force_persist_sample?" -> "[apdex_t]"
-  "TranactionInfo#include_guid?" -> "[apdex_t]"
+  "TransactionInfo#force_persist_sample?" -> "[apdex_t]"
+  "TransactionInfo#include_guid?" -> "[apdex_t]"
 
   "TransactionSampleBuilder#initialize" -> "[transaction_tracer.limit_segments]"
   "TransactionSampleBuilder#set_transaction_info" -> "[capture_params]"