newrelic_rpm 8.11.0 → 8.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d0513ed874184a3e737b2663f0fb404f10ddc0f4660da2b85678a1b93f1de1c2
-  data.tar.gz: b82877030feb527d17c10732a4bfbe9625c36c0f4a3b5fc2e57d4d389f41a857
+  metadata.gz: 80f041d194a8a205c71293c88db7e0a35af051a9c318bc17aa7f6e16480f43a8
+  data.tar.gz: e7ffe3faef8538ed09feab8e416bfa28cbf82af31a5ae518c518c8540bcd8a01
 SHA512:
-  metadata.gz: e6ea4eaf8332be93253b1d3d9b894e59c5dee712bad8c098bc1b8c60bff904389b2ae4fb416f1d4d08b4ea36087327955d157101d523e43d1b5ddc97e382c2dc
-  data.tar.gz: 2139d99e93eb289e976611535a46d58a826f66477931bc93ea5577a8f2c287bc9c49fd2ea9abcaf3f7b739a8c952ed58500c9aeab8daecbbd12f57f2b4d4fe4b
+  metadata.gz: 46a30273eca12890d0800f6959c90dc80a77097f1f6b64bb7d7d77efbdf1ee758cf8aa1c3f9da2537d5ddd64c4a996aea39d7f2c0ca1daebe8583f62605bfb0a
+  data.tar.gz: a9002651aa6822c657ba3928121e06cad319d1650bb891feb26c8c7f055c4e5249a9bf9e44daf69bc0b89ed26f4192d380084942aed75288c1fc3fa443eb8e93

data/.rubocop.yml

@@ -132,9 +132,6 @@ Layout/EmptyComment:
   AllowBorderComment: true
   AllowMarginComment: true
 
-Layout/EmptyLineAfterGuardClause:
-  Enabled: false
-
 # Disabling for now
 Layout/EmptyLineAfterMagicComment:
   Enabled: false
@@ -1337,6 +1334,7 @@ Style/MethodCallWithArgsParentheses:
     - include
     - print
     - puts
+    - pp
     - raise
     - require
     - skip

data/.rubocop_todo.yml

@@ -14,15 +14,9 @@ Metrics/AbcSize:
     - test/**/*
     - infinite_tracing/test/**/*
 
-# Offense count: 145
 # This cop supports safe autocorrection (--autocorrect).
 Minitest/AssertInDelta:
-  Enabled: false
-
-# Offense count: 145
-# This cop supports safe autocorrection (--autocorrect).
-Minitest/AssertPredicate:
-  Enabled: false
+  Enabled: true
 
 # Offense count: 7
 Minitest/AssertRaisesCompoundBody:
@@ -50,3 +44,16 @@ Minitest/RefutePredicate:
 # This cop supports safe autocorrection (--autocorrect).
 Minitest/TestMethodName:
   Enabled: false
+
+Minitest/RefuteRespondTo:
+  Exclude:
+    - 'test/new_relic/cli/commands/deployments_test.rb'
+
+Minitest/EmptyLineBeforeAssertionMethods:
+  Exclude:
+    - 'test/new_relic/agent_test.rb'
+    - 'test/new_relic/cli/commands/deployments_test.rb'
+
+Style/RedundantStringEscape:
+  Exclude:
+    - 'test/new_relic/agent/logging_test.rb'

data/Brewfile

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+brew 'elasticsearch'
 brew 'imagemagick'
 brew 'memcached'
 tap 'mongodb/brew'

data/CHANGELOG.md

@@ -1,5 +1,67 @@
 # New Relic Ruby Agent Release Notes #
 
+  ## v8.13.0
+
+  Version 8.13.0 of the agent updates our Rack, Redis, and Sidekiq instrumentation. It also delivers some bugfixes.
+
+  * **Support for Redis v5.0**
+
+    Redis v5.0 restructures where some of our instrumented methods are located and how they are named. It also introduces a new [instrumentation middleware API](https://github.com/redis-rb/redis-client#instrumentation-and-middlewares). This API is used for pipelined and multi calls to maintain reporting parity with previous Redis versions. However, it is introduced later in the chain, so you may see errors that used to appear at the segment level on the transaction instead. The agent's behavior when used with older supported Redis versions will remain unaffected. [PR#1611](https://github.com/newrelic/newrelic-ruby-agent/pull/1611)
+
+  * **Support for Sidekiq v7.0**
+
+    Sidekiq v7.0 removed Delayed Extensions and began offering client and server [middleware](https://github.com/mperham/sidekiq/blob/main/docs/middleware.md) classes to inherit from. The agent's Sidekiq instrumentation has been updated accordingly. The agent's behavior when used with older Sidekiq versions will remain unaffected. [PR#1615](https://github.com/newrelic/newrelic-ruby-agent/pull/1615)
+
+  * **Support for Rack v3.0: Rack::Builder#new accepting a block**
+
+    Via [rack/rack#1942](https://github.com/rack/rack/pull/1942) (released with Rack v3.0), `Rack::Builder#run` now optionally accepts a block instead of an app argument. The agent's instrumentation has been updated to support the use of a block with `Rack::Builder#run`. [PR#1600](https://github.com/newrelic/newrelic-ruby-agent/pull/1600)
+
+  * **Bugfix: Correctly identify Unicorn, Rainbows and FastCGI with Rack v3.0**
+
+    Unicorn, Rainbows, or FastCGI web applications using Rack v3.0 may previously have had the "dispatcher" value incorrectly reported as "Webrick" instead of "Unicorn", "Rainbows", or "FastCGI". This issue has now been addressed. [PR#1585](https://github.com/newrelic/newrelic-ruby-agent/pull/1585)
+
+  * **Bugfix: add_method_tracer fails to record code level metric attributes on private methods**
+
+    When using `add_method_tracer` on a private method, the agent was unable to record code level metrics for the method. This resulted in the following being logged to the newrelic_agent.log file.
+    ```
+    WARN : Unable to determine source code info for 'Example', method 'private_method' - NameError: undefined method 'private_method' for class '#<Class:Example>'
+    ```
+    Thank you [@jdelStrother](https://github.com/jdelStrother) for bringing this issue to our attention and suggesting a fix! [PR#1593](https://github.com/newrelic/newrelic-ruby-agent/pull/1593)
+
+
+  * **Bugfix: Category is a required keyword arg for NewRelic::Agent::Tracer.in_transaction**
+
+    When support for Ruby 2.0 was dropped in version 8.0.0 of the agent, the agent API methods were updated to use the required keyword argument feature built into Ruby, rather than manually raising ArgumentErrors. The API method `NewRelic::Agent::Tracer.in_transaction` removed the ArgumentError raised by the agent, but did not update the method arguments to identify `:category` as a required keyword argument. This is now resolved. Thank you [@tatzsuzuki](https://github.com/tatzsuzuki) for bringing this to our attention. [PR#1587](https://github.com/newrelic/newrelic-ruby-agent/pull/1587)
+
+  ## 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!
@@ -49,15 +111,15 @@
 
 
   * **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.
 
@@ -94,26 +156,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.
 
 
@@ -123,8 +185,8 @@
 
 
   ## 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.
@@ -136,9 +198,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**
@@ -235,7 +297,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

data/README.md

@@ -1,4 +1,4 @@
-[![Blue banner - Community Plus: This code is currently maintained by New Relic engineering teams and delivered here in GitHub. See the README for troubleshooting and defect reporting instructions.](https://github.com/newrelic/opensource-website/raw/master/src/images/categories/Community_Plus.png)](https://opensource.newrelic.com/oss-category/#community-plus)
+[![Blue banner - Community Plus: This code is currently maintained by New Relic engineering teams and delivered here in GitHub. See the README for troubleshooting and defect reporting instructions.](https://github.com/newrelic/opensource-website/raw/main/src/images/categories/Community_Plus.png)](https://opensource.newrelic.com/oss-category/#community-plus)
 
 # New Relic Ruby Agent
 

data/bin/nrdebug

@@ -219,6 +219,7 @@ class ProcessReport
         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
@@ -282,6 +283,7 @@ 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/docker-compose.yml

@@ -1,5 +1,25 @@
 version: "3.9"
 services:
+  elasticsearch7:
+    image: elasticsearch:7.16.2
+    ports:
+      - "9200:9200"
+    environment:
+      - discovery.type=single-node
+      - bootstrap.memory_lock=true
+      - "ES_JAVA_OPTS=-Xms512m -Xmx512m"
+    mem_limit: 1g
+  elasticsearch8:
+    image: elasticsearch:8.4.2
+    ports:
+      - "9250:9250"
+    environment:
+      - discovery.type=single-node
+      - xpack.security.enabled=false
+      - http.port=9250
+      - bootstrap.memory_lock=true
+      - "ES_JAVA_OPTS=-Xms512m -Xmx512m"
+    mem_limit: 1g
   mysql:
     image: mysql:5.7
     restart: always
@@ -68,6 +88,8 @@ services:
     volumes:
       - ".:/usr/src/app"
     depends_on:
+      - elasticsearch7
+      - elasticsearch8
       - mysql
       - memcached
       - mongodb

data/lib/new_relic/agent/agent/shutdown.rb

@@ -9,6 +9,7 @@ module NewRelic
       # data.
       def shutdown
         return unless started?
+
         ::NewRelic::Agent.logger.info("Starting Agent shutdown")
 
         stop_event_loop

data/lib/new_relic/agent/agent/special_startup.rb

@@ -57,11 +57,13 @@ module NewRelic
 
       def should_install_exit_handler?
         return false unless Agent.config[:send_data_on_exit]
+
         !sinatra_classic_app? || Agent.config[:force_install_exit_handler]
       end
 
       def install_exit_handler
         return unless should_install_exit_handler?
+
         NewRelic::Agent.logger.debug("Installing at_exit handler")
         at_exit { shutdown }
       end

data/lib/new_relic/agent/agent/startup.rb

@@ -37,6 +37,7 @@ module NewRelic
       def check_config_and_start_agent
         return unless monitoring? && has_correct_license_key?
         return if using_forking_dispatcher?
+
         setup_and_start_agent
       end
 

data/lib/new_relic/agent/agent_logger.rb

@@ -132,7 +132,7 @@ module NewRelic
       end
 
       def wants_stdout?
-        ::NewRelic::Agent.config[:log_file_path].casecmp("STDOUT").zero?
+        ::NewRelic::Agent.config[:log_file_path].casecmp(NewRelic::STANDARD_OUT) == 0
       end
 
       def find_or_create_file_path(path_setting, root)

data/lib/new_relic/agent/attributes.rb

@@ -58,6 +58,7 @@ module NewRelic
       def merge_custom_attributes(other)
         return unless Agent.config[:'custom_attributes.enabled']
         return if other.empty?
+
         AttributeProcessing.flatten_and_coerce(other) do |k, v|
           add_custom_attribute(k, v)
         end

data/lib/new_relic/agent/audit_logger.rb

@@ -29,6 +29,7 @@ module NewRelic
 
       def log_request_headers(uri, headers)
         return unless enabled? && allowed_endpoint?(uri)
+
         @log.info("REQUEST HEADERS: #{headers}")
       rescue StandardError, SystemStackError, SystemCallError => e
         ::NewRelic::Agent.logger.warn("Failed writing request headers to audit log", e)
@@ -94,7 +95,7 @@ module NewRelic
       end
 
       def wants_stdout?
-        ::NewRelic::Agent.config[:'audit_log.path'].casecmp("STDOUT").zero?
+        ::NewRelic::Agent.config[:'audit_log.path'].casecmp(NewRelic::STANDARD_OUT) == 0
       end
 
       def create_log_formatter

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

@@ -42,6 +42,7 @@ module NewRelic
 
         def stop(report_data)
           return unless running?
+
           NewRelic::Agent.logger.debug("Stopping Thread Profiler.")
           @finished_profile = @backtrace_service.harvest(NewRelic::Agent::Threading::BacktraceService::ALL_TRANSACTIONS)
           @backtrace_service.unsubscribe(NewRelic::Agent::Threading::BacktraceService::ALL_TRANSACTIONS)