newrelic_rpm 8.9.0 → 8.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e16c313766a7d9c51bc1a1c3031f666747b4a3aefa773cf226d28510d90d6658
-  data.tar.gz: cb464a40400ce3b4a41178f737fa804952bfe22de66dc88f73deccaa256520a6
+  metadata.gz: b9556e153e6ae6bb4ea2894bc62e6c0745a08f2347c25074a97316fe6818ca6d
+  data.tar.gz: 1e07fc83567ff8b0e83a1c502265076fca5409021ff724801455c6e4ee5086ff
 SHA512:
-  metadata.gz: 93915783c6110bbc027d03d614b5ad582ba0bf73b93933d4a93f11a7e698fd82436c74b3b941c27846e6e1ae408b7d8929b9c1d7dcae0e6103ed3ded2836c9c2
-  data.tar.gz: f7a5196e10ecd5dd88ed16b218cdcb760511d3747f1c821ccc7f4b6c5e22c28a1e08d581022513d04e6540d6d5cd62419cc587c05c8154d4a7abe6a574944a97
+  metadata.gz: 9bb9efe02ea356b8969d3466bde7c76e2f20cb8880d93628d707ee92c05338e91262d456c4b5e0b9943ad1ee50e8edf512cb82096a3f5f2ea166a6b5b1bfdb0b
+  data.tar.gz: 1e13ef2b0b0ab49ef8c08f5d54536a37a3b3f5812b8a0ef884f2b1df670842499edcef344297aae59822cc43d456b47f3164ba86daf678e62080c09912a871a7

data/.rubocop.yml

@@ -1361,9 +1361,6 @@ Style/FormatString:
 Style/FormatStringToken:
   Enabled: false
 
-Style/FrozenStringLiteralComment:
-  Enabled: false
-
 # Disabling for now
 Style/GlobalStdStream:
   Enabled: false
@@ -1468,9 +1465,18 @@ Style/MapToHash:
   Enabled: false
 
 Style/MethodCallWithArgsParentheses:
-  Enabled: false
+  Enabled: true
+  IgnoredMethods:
+    - puts
+    - require
+    - raise
+    - include
+    - fail
+    - print
+    - add_dependency
+    - add_development_dependency
+  AllowedPatterns: [^assert, ^refute]
 
-# Disabling for now
 Style/MethodCallWithoutArgsParentheses:
   Enabled: false
   IgnoredMethods: []
@@ -1479,7 +1485,7 @@ Style/MethodCalledOnDoEndBlock:
   Enabled: false
 
 Style/MethodDefParentheses:
-  Enabled: false
+  Enabled: true
 
 Style/MinMax:
   Enabled: false

data/.simplecov

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 SimpleCov.start do
   enable_coverage :branch
   SimpleCov.root(File.join(File.dirname(__FILE__), '/lib'))

data/.snyk

@@ -0,0 +1,11 @@
+exclude:
+  global:
+    # The project Dockerfile is only used to orchestrate container usage for
+    # local development with containers that are not to be exposed to the
+    # outside world. We use vanilla "ruby" images and do not layer on any
+    # additional software dependencies or configurations ourselves that would
+    # change the original "ruby" images' security profile. We defer all
+    # security mitigation for the images to the "ruby" image maintainers (who
+    # themselves are periodically updating their base Ubuntu layers to mitigate
+    # issues).
+    - Dockerfile

data/Brewfile

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

data/CHANGELOG.md

@@ -1,6 +1,62 @@
 # New Relic Ruby Agent Release Notes #
 
 
+  ## v8.10.0
+
+
+  * **New gRPC instrumentation**
+
+    The agent will now instrument [gRPC](https://grpc.io/) activity performed by clients and servers that use the [grpc](https://rubygems.org/gems/grpc) RubyGem. Instrumentation is automatic and enabled by default, so gRPC users should not need to modify any existing application code or agent configuration to benefit from the instrumentation. The instrumentation makes use of distributed tracing for a comprehensive overview of all gRPC traffic taking place across multiple monitored applications. This allows you to observe your client and server activity using any service that adheres to the W3C standard.
+
+    The following new configuration parameters have been added for gRPC. All are optional.
+
+    | Configuration name | Default | Behavior |
+    | ----------- | ----------- |----------- |
+    | `instrumentation.grpc_client` | auto | Set to 'disabled' to disable, set to 'chain' if there are module prepending conflicts |
+    | `instrumentation.grpc_server` | auto | Set to 'disabled' to disable, set to 'chain' if there are module prepending conflicts |
+    | `instrumentation.grpc.host_denylist` | "" |  Provide a comma delimited list of host regex patterns (ex: "private.com$,exception.*") |
+
+
+  * **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.
+
+
+  * **Performance: Make frozen string literals the default for the agent
+
+    The Ruby `frozen_string_literal: true` magic source code comment has now been applied consistently across all Ruby files belonging to the agent. This can provide a performance boost, given that Ruby can rely on the strings remaining immutable. Previously only about a third of the agent's code was freezing string literals by default. Now that 100% of the code freezes string literals by default, we have internally observed some related performance gains through testing. We are hopeful that these will translate into some real world gains in production capacities.
+
+
+  * **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. 
+
+    Example:
+
+    ```
+    # newrelic.yml
+    transaction_tracer:
+      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. 
+
+    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. 
+    
+    Thank you to @oboxodo for bringing this to our attention.
+
+
+  * **Bugfix: Don't modify frozen Logger**
+
+    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
   
   

data/Guardfile

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require './test/multiverse/lib/multiverse/bundler_patch'
 
 test_folders = Dir.glob("test/new_relic/*").select { |f| File.directory?(f) }

data/Rakefile

@@ -1,3 +1,8 @@
+# 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
+
 require 'rubygems'
 require 'rake/testtask'
 require 'yard'

data/bin/mongrel_rpm

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 require 'rubygems'
 require 'rack'
 require 'rack/handler/mongrel'
@@ -13,9 +14,9 @@ OptionParser.new do |opts|
   opts.on("--[no-]logging", "turn off request logging") { |l| options[:logging] = l }
   opts.on("--license=license_key", "override license key") { |l| options[:license_key] = l }
   opts.on("--install", "install a newrelic.yml template") { |l| options[:install] = true }
-  opts.separator ""
-  opts.separator "app_name is the name of the application where the metrics will be stored"
-  opts.separator ""
+  opts.separator("")
+  opts.separator("app_name is the name of the application where the metrics will be stored")
+  opts.separator("")
   # The rackup file references this var
   appname = opts.parse!(ARGV.clone).first
 end
@@ -23,10 +24,10 @@ end
 options[:app_name] = appname if appname
 
 ru_file = File.expand_path(File.join(File.dirname(__FILE__), "..", "lib", "new_relic", "rack", "mongrel_rpm.ru"))
-rackup_code = File.read ru_file
-builder = Rack::Builder.new { eval rackup_code, binding, ru_file }
+rackup_code = File.read(ru_file)
+builder = Rack::Builder.new { eval(rackup_code, binding, ru_file) }
 
 options = {:Host => '127.0.0.1', :Port => port}
 Rack::Handler::Mongrel.run(builder.to_app, options) do |server|
-  NewRelic::Agent.logger.info "Started Mongrel listening for '#{NewRelic::Control.instance.app_names.join(" and ")}' data at #{server.host}:#{server.port}"
+  NewRelic::Agent.logger.info("Started Mongrel listening for '#{NewRelic::Control.instance.app_names.join(" and ")}' data at #{server.host}:#{server.port}")
 end

data/bin/newrelic

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 # executes one of the commands in the new_relic/commands directory
 # pass the name of the command as an argument
 
@@ -9,5 +10,5 @@ begin
 rescue NewRelic::Cli::Command::CommandFailure => failure
   STDERR.puts failure.message
   STDERR.puts failure.options if failure.options
-  exit 1
+  exit(1)
 end

data/bin/newrelic_cmd

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 # This command has been renamed "newrelic"
 # executes one of the commands in the new_relic/commands directory
 # pass the name of the command as an argument

data/bin/nrdebug

@@ -3,6 +3,7 @@
 # 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
 
 require 'tempfile'
 require 'rbconfig'
@@ -178,10 +179,10 @@ class ProcessReport
   def open
     if @path
       File.open(@path, "w") do |f|
-        yield f
+        yield(f)
       end
     else
-      yield $stdout
+      yield($stdout)
     end
   end
 

data/init.rb

@@ -1,6 +1,7 @@
 # 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
 
 # This is the initialization for the New Relic Ruby Agent when used as
 # a plugin
@@ -24,7 +25,7 @@ begin
     Rails.configuration
   end
 
-  NewRelic::Control.instance.init_plugin :config => current_config
+  NewRelic::Control.instance.init_plugin(:config => current_config)
 rescue => e
-  ::NewRelic::Agent.logger.error "Error initializing New Relic plugin. Agent is disabled.", e
+  ::NewRelic::Agent.logger.error("Error initializing New Relic plugin. Agent is disabled.", e)
 end

data/install.rb

@@ -1,6 +1,7 @@
 # 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
 
 if __FILE__ == $0 || $0 =~ /script\/plugin/ || File.basename($0) == 'rake'
   $LOAD_PATH << File.expand_path(File.join(File.dirname(__FILE__), 'lib'))

data/lib/new_relic/agent/adaptive_sampler.rb

@@ -1,11 +1,12 @@
 # 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
 
 module NewRelic
   module Agent
     class AdaptiveSampler
-      def initialize target_samples = 10, period_duration = 60
+      def initialize(target_samples = 10, period_duration = 60)
         @target = target_samples
         @seen = 0
         @seen_last = 0
@@ -84,7 +85,7 @@ module NewRelic
             end
           end
           if target_changed
-            NewRelic::Agent.logger.debug "Sampling target set to: #{target}"
+            NewRelic::Agent.logger.debug("Sampling target set to: #{target}")
           end
         end
       end
@@ -99,7 +100,7 @@ module NewRelic
             end
           end
           if period_changed
-            NewRelic::Agent.logger.debug "Sampling period set to: #{period_duration}"
+            NewRelic::Agent.logger.debug("Sampling period set to: #{period_duration}")
           end
         end
       end

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

@@ -1,6 +1,7 @@
 # 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
 
 module NewRelic
   module Agent
@@ -9,7 +10,7 @@ module NewRelic
       # data.
       def shutdown
         return unless started?
-        ::NewRelic::Agent.logger.info "Starting Agent shutdown"
+        ::NewRelic::Agent.logger.info("Starting Agent shutdown")
 
         stop_event_loop
         trap_signals_for_litespeed
@@ -26,7 +27,7 @@ module NewRelic
             graceful_disconnect
           end
         rescue => e
-          ::NewRelic::Agent.logger.error e
+          ::NewRelic::Agent.logger.error(e)
         end
       end
     end

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

@@ -1,6 +1,7 @@
 # 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
 
 module NewRelic
   module Agent
@@ -10,8 +11,8 @@ module NewRelic
       # before connecting, otherwise the parent process sends useless data
       def using_forking_dispatcher?
         # TODO: MAJOR VERSION - remove :rainbows
-        if [:puma, :passenger, :rainbows, :unicorn].include? Agent.config[:dispatcher]
-          ::NewRelic::Agent.logger.info "Deferring startup of agent reporting thread because #{Agent.config[:dispatcher]} may fork."
+        if [:puma, :passenger, :rainbows, :unicorn].include?(Agent.config[:dispatcher])
+          ::NewRelic::Agent.logger.info("Deferring startup of agent reporting thread because #{Agent.config[:dispatcher]} may fork.")
           true
         else
           false

data/lib/new_relic/agent/agent/start_worker_thread.rb

@@ -1,6 +1,7 @@
 # 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
 
 module NewRelic
   module Agent
@@ -18,11 +19,11 @@ module NewRelic
       # See #connect for a description of connection_options.
       def start_worker_thread(connection_options = {})
         if disable = NewRelic::Agent.config[:disable_harvest_thread]
-          NewRelic::Agent.logger.info "Not starting Ruby Agent worker thread because :disable_harvest_thread is #{disable}"
+          NewRelic::Agent.logger.info("Not starting Ruby Agent worker thread because :disable_harvest_thread is #{disable}")
           return
         end
 
-        ::NewRelic::Agent.logger.debug "Creating Ruby Agent worker thread."
+        ::NewRelic::Agent.logger.debug("Creating Ruby Agent worker thread.")
         @worker_thread = Threading::AgentThread.create('Worker Loop') do
           deferred_work!(connection_options)
         end
@@ -44,7 +45,7 @@ module NewRelic
         # Wait the end of the event loop thread.
         if @worker_thread
           unless @worker_thread.join(3)
-            ::NewRelic::Agent.logger.debug "Event loop thread did not stop within 3 seconds"
+            ::NewRelic::Agent.logger.debug("Event loop thread did not stop within 3 seconds")
           end
         end
       end
@@ -52,7 +53,7 @@ module NewRelic
       # Certain event types may sometimes need to be on the same interval as metrics,
       # so we will check config assigned in EventHarvestConfig to determine the interval
       # on which to report them
-      def interval_for event_type
+      def interval_for(event_type)
         interval = Agent.config[:"event_report_period.#{event_type}"]
         :"#{interval}_second_harvest"
       end
@@ -66,19 +67,19 @@ module NewRelic
           transmit_data
         end
 
-        @event_loop.on(interval_for TRANSACTION_EVENT_DATA) do
+        @event_loop.on(interval_for(TRANSACTION_EVENT_DATA)) do
           transmit_analytic_event_data
         end
-        @event_loop.on(interval_for CUSTOM_EVENT_DATA) do
+        @event_loop.on(interval_for(CUSTOM_EVENT_DATA)) do
           transmit_custom_event_data
         end
-        @event_loop.on(interval_for ERROR_EVENT_DATA) do
+        @event_loop.on(interval_for(ERROR_EVENT_DATA)) do
           transmit_error_event_data
         end
-        @event_loop.on(interval_for SPAN_EVENT_DATA) do
+        @event_loop.on(interval_for(SPAN_EVENT_DATA)) do
           transmit_span_event_data
         end
-        @event_loop.on(interval_for LOG_EVENT_DATA) do
+        @event_loop.on(interval_for(LOG_EVENT_DATA)) do
           transmit_log_event_data
         end
 
@@ -96,18 +97,18 @@ module NewRelic
       # this clears the data, clears connection attempts, and
       # waits a while to reconnect.
       def handle_force_restart(error)
-        ::NewRelic::Agent.logger.debug error.message
+        ::NewRelic::Agent.logger.debug(error.message)
         drop_buffered_data
         @service.force_restart if @service
         @connect_state = :pending
-        sleep 30
+        sleep(30)
       end
 
       # when a disconnect is requested, stop the current thread, which
       # is the worker thread that gathers data and talks to the
       # server.
       def handle_force_disconnect(error)
-        ::NewRelic::Agent.logger.warn "Agent received a ForceDisconnectException from the server, disconnecting. (#{error.message})"
+        ::NewRelic::Agent.logger.warn("Agent received a ForceDisconnectException from the server, disconnecting. (#{error.message})")
         disconnect
       end
 
@@ -115,7 +116,7 @@ module NewRelic
       # it and disconnecting the agent, since we are now in an
       # unknown state.
       def handle_other_error(error)
-        ::NewRelic::Agent.logger.error "Unhandled error in worker thread, disconnecting."
+        ::NewRelic::Agent.logger.error("Unhandled error in worker thread, disconnecting.")
         # These errors are fatal (that is, they will prevent the agent from
         # reporting entirely), so we really want backtraces when they happen
         ::NewRelic::Agent.logger.log_exception(:error, error)
@@ -153,7 +154,7 @@ module NewRelic
               # never reaches here unless there is a problem or
               # the agent is exiting
             else
-              ::NewRelic::Agent.logger.debug "No connection.  Worker thread ending."
+              ::NewRelic::Agent.logger.debug("No connection.  Worker thread ending.")
             end
           end
         end

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

@@ -1,6 +1,7 @@
 # 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
 
 module NewRelic
   module Agent
@@ -68,7 +69,7 @@ module NewRelic
       # Log the environment the app thinks it's running in.
       # Useful in debugging, as this is the key for config YAML lookups.
       def log_environment
-        ::NewRelic::Agent.logger.info "Environment: #{NewRelic::Control.instance.env}"
+        ::NewRelic::Agent.logger.info("Environment: #{NewRelic::Control.instance.env}")
       end
 
       # Logs the dispatcher to the log file to assist with
@@ -78,21 +79,21 @@ module NewRelic
         dispatcher_name = Agent.config[:dispatcher].to_s
 
         if dispatcher_name.empty?
-          ::NewRelic::Agent.logger.info 'No known dispatcher detected.'
+          ::NewRelic::Agent.logger.info('No known dispatcher detected.')
         else
-          ::NewRelic::Agent.logger.info "Dispatcher: #{dispatcher_name}"
+          ::NewRelic::Agent.logger.info("Dispatcher: #{dispatcher_name}")
         end
       end
 
       def log_app_name
-        ::NewRelic::Agent.logger.info "Application: #{Agent.config[:app_name].join(", ")}"
+        ::NewRelic::Agent.logger.info("Application: #{Agent.config[:app_name].join(", ")}")
       end
 
       def log_ignore_url_regexes
         regexes = NewRelic::Agent.config[:'rules.ignore_url_regexes']
 
         unless regexes.empty?
-          ::NewRelic::Agent.logger.info "Ignoring URLs that match the following regexes: #{regexes.map(&:inspect).join(", ")}."
+          ::NewRelic::Agent.logger.info("Ignoring URLs that match the following regexes: #{regexes.map(&:inspect).join(", ")}.")
         end
       end
 
@@ -100,7 +101,7 @@ module NewRelic
       # so we can disambiguate processes in the log file and make
       # sure they're running a reasonable version
       def log_version_and_pid
-        ::NewRelic::Agent.logger.debug "New Relic Ruby Agent #{NewRelic::VERSION::STRING} Initialized: pid = #{$$}"
+        ::NewRelic::Agent.logger.debug("New Relic Ruby Agent #{NewRelic::VERSION::STRING} Initialized: pid = #{$$}")
       end
 
       # Logs the configured application names
@@ -164,21 +165,21 @@ module NewRelic
         return false if already_started? || disabled?
 
         if defer_for_delayed_job?
-          ::NewRelic::Agent.logger.debug "Deferring startup for DelayedJob"
+          ::NewRelic::Agent.logger.debug("Deferring startup for DelayedJob")
           return false
         end
 
         if defer_for_resque?
-          ::NewRelic::Agent.logger.debug "Deferring startup for Resque in case it daemonizes"
+          ::NewRelic::Agent.logger.debug("Deferring startup for Resque in case it daemonizes")
           return false
         end
 
         unless app_name_configured?
-          NewRelic::Agent.logger.error "No application name configured.",
+          NewRelic::Agent.logger.error("No application name configured.",
             "The Agent cannot start without at least one. Please check your ",
             "newrelic.yml and ensure that it is valid and has at least one ",
             "value set for app_name in the #{NewRelic::Control.instance.env} ",
-            "environment."
+            "environment.")
           return false
         end