newrelic_rpm 9.10.2 → 9.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cef71bbfaac5e07f6d5b0862fccb3bf35e4c99251ce5fec00143036c89c964f8
-  data.tar.gz: e5521d0958408d97494625b155f2dcb97736d02994f7b7dfdc58143dabc73dee
+  metadata.gz: cc36449c6f2ea3322f353181809c05d3e84e28f85fb15544c82e088946384046
+  data.tar.gz: f8fa907597f05f47c5dbe9c38a005cb1d09f971183aa7075664e6ade029186fc
 SHA512:
-  metadata.gz: 28a45e748a241b3bfb2c93bb19500cda6bc433c9c428e56f4cbcc92ff5c12d8f6d0198ab87d3a910f11539695fc8d0a4935c65ea5869d6bf36b66ae2b012c3a7
-  data.tar.gz: 35426f77a90e9f10b2be825538482a5bda1d074cc4d3c22acd1df007774f21a190b10696ad962fe34e30db0dd57d0a5bcadb3db6d5bc97edad0dcfba88db9a19
+  metadata.gz: 622cdf275eb70aa1f57e027f2e73559855c17c4351741c80ec0db8ae45b773f2d7aa2831ae562e228b24a71a0532ae93dced167be3ecfdd3561886224d212070
+  data.tar.gz: a68a148e494bfc0e5f9da3c369eb56f7170664e78ffd12cc178e77b7361da39edefbc967b5c71c2905b993b5d4075b2189abc3ec7692081d6b4dd422149902f3

data/CHANGELOG.md

@@ -1,12 +1,28 @@
 # New Relic Ruby Agent Release Notes
 
+## v9.11.0
+
+Version 9.11.0 introduces instrumentation for the aws-sdk-sqs gem, fixes a bug related to expected errors not bearing a "true" value for the "expected" attribute if expected as a result of an HTTP status code match and changes the way Stripe instrumentation metrics are named to prevent high-cardinality issues.
+
+- **Feature: Add instrumentation for SQS**
+
+    The agent has added instrumentation for the [aws-sdk-sqs gem](https://rubygems.org/gems/aws-sdk-sqs). The agent will now record message broker spans for SQS client calls made with the aws-sdk-sqs gem. [PR#2679](https://github.com/newrelic/newrelic-ruby-agent/pull/2679)
+
+- **Bugfix: HTTP status code based expected errors will now have an "expected" value of "true"**
+
+    Previously when an error was treated as expected by the agent as a result of a matching HTTP status code being found in the :'error_collector.expected_status_codes' configuration setting, the error would not appear with an "expected" attribute value of "true" in the errors in the errors inbox. [PR#2710](https://github.com/newrelic/newrelic-ruby-agent/pull/2710)
+
+- **Bugfix: Stripe metric names will no longer include full request paths to limit the unique name count**
+
+    The Stripe instrumentation introduced in agent version v9.5.0 produced instrumentation metric names that used the full Stripe request path. For any significant Stripe usage, this could quickly lead to very large number of distinct metric names. Now only the API version and the category part of the request path are included in the metric name which still includes the "Stripe" opener and method (ex: "get") closer. Thanks to [@jdelStrother](https://github.com/jdelStrother) and [@jsneedles](https://github.com/jsneedles) for bringing this issue to our attention and providing terrific information explaining the problem and potential paths to resolution. [PR#2716](https://github.com/newrelic/newrelic-ruby-agent/pull/2716)
+
 ## v9.10.2
 
 Version 9.10.2 fixes a bug related to the new DynamoDB instrumentation and removes `Rails::Command::RakeCommand` from the default list of denylisted constants.
 
 - **Bugfix: DynamoDB instrumentation logging errors when trying to get account_id**
 
-    When trying to access data needed to add the `account_id` to the DynamoDB span, the agent encountered an error when certain credentials classes were used. This has been fixed. Thanks to [@kichik](https://github.com/kichik) for bringing this to our attention. [PR#2864](https://github.com/newrelic/newrelic-ruby-agent/pull/2684)
+    When trying to access data needed to add the `account_id` to the DynamoDB span, the agent encountered an error when certain credentials classes were used. This has been fixed. Thanks to [@kichik](https://github.com/kichik) for bringing this to our attention. [PR#2684](https://github.com/newrelic/newrelic-ruby-agent/pull/2684)
 
 - **Bugfix: Remove Rails::Command::RakeCommand from the default list of autostart.denylisted_constants**
 

data/lib/new_relic/agent/configuration/default_source.rb

@@ -1458,6 +1458,14 @@ module NewRelic
           :allowed_from_server => false,
           :description => 'Controls auto-instrumentation of bunny at start-up. May be one of: `auto`, `prepend`, `chain`, `disabled`.'
         },
+        :'instrumentation.aws_sqs' => {
+          :default => 'auto',
+          :public => true,
+          :type => String,
+          :dynamic_name => true,
+          :allowed_from_server => false,
+          :description => 'Controls auto-instrumentation of the aws-sdk-sqs library at start-up. May be one of: `auto`, `prepend`, `chain`, `disabled`.'
+        },
         :'instrumentation.dynamodb' => {
           :default => 'auto',
           :public => true,

data/lib/new_relic/agent/error_collector.rb

@@ -237,7 +237,8 @@ module NewRelic
       end
 
       def notice_segment_error(segment, exception, options = {})
-        return if skip_notice_error?(exception)
+        status_code = process_http_status_code(exception, options)
+        return if skip_notice_error?(exception, status_code)
 
         options.merge!(segment.llm_event.error_attributes(exception)) if segment.llm_event
 
@@ -250,15 +251,13 @@ module NewRelic
 
       # See NewRelic::Agent.notice_error for options and commentary
       def notice_error(exception, options = {}, span_id = nil)
-        state = ::NewRelic::Agent::Tracer.state
-        transaction = state.current_transaction
-        status_code = transaction&.http_response_code
-
+        status_code = process_http_status_code(exception, options)
         return if skip_notice_error?(exception, status_code)
 
         tag_exception(exception)
 
-        if options[:expected] || @error_filter.expected?(exception, status_code)
+        state = ::NewRelic::Agent::Tracer.state
+        if options[:expected]
           increment_expected_error_count!(state, exception)
         else
           increment_error_count!(state, exception, options)
@@ -266,10 +265,8 @@ module NewRelic
 
         noticed_error = create_noticed_error(exception, options)
         error_trace_aggregator.add_to_error_queue(noticed_error)
-        transaction = state.current_transaction
-        payload = transaction&.payload
-        span_id ||= transaction&.current_segment ? transaction.current_segment.guid : nil
-        error_event_aggregator.record(noticed_error, payload, span_id)
+        span_id ||= state.current_transaction&.current_segment&.guid
+        error_event_aggregator.record(noticed_error, state.current_transaction&.payload, span_id)
         exception
       rescue => e
         ::NewRelic::Agent.logger.warn("Failure when capturing error '#{exception}':", e)
@@ -359,6 +356,13 @@ module NewRelic
       def error_group_callback
         NewRelic::Agent.error_group_callback
       end
+
+      def process_http_status_code(exception, options)
+        status_code = ::NewRelic::Agent::Tracer.state.current_transaction&.http_response_code
+        options[:expected] = true if !options[:expected] && @error_filter.expected?(exception, status_code)
+
+        status_code
+      end
     end
   end
 end

data/lib/new_relic/agent/instrumentation/aws_sqs/chain.rb

@@ -0,0 +1,37 @@
+# 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::Agent::Instrumentation
+  module AwsSqs::Chain
+    def self.instrument!
+      ::Aws::SQS::Client.class_eval do
+        include NewRelic::Agent::Instrumentation::AwsSqs
+
+        alias_method(:send_message_without_new_relic, :send_message)
+
+        def send_message(*args)
+          send_message_with_new_relic(*args) do
+            send_message_without_new_relic(*args)
+          end
+        end
+
+        alias_method(:send_message_batch_without_new_relic, :send_message_batch)
+
+        def send_message_batch(*args)
+          send_message_batch_with_new_relic(*args) do
+            send_message_batch_without_new_relic(*args)
+          end
+        end
+
+        alias_method(:receive_message_without_new_relic, :receive_message)
+
+        def receive_message(*args)
+          receive_message_with_new_relic(*args) do
+            receive_message_without_new_relic(*args)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/new_relic/agent/instrumentation/aws_sqs/instrumentation.rb

@@ -0,0 +1,67 @@
+# 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::Agent::Instrumentation
+  module AwsSqs
+    MESSAGING_LIBRARY = 'SQS'
+
+    def send_message_with_new_relic(*args)
+      with_tracing(:produce, args) do
+        yield
+      end
+    end
+
+    def send_message_batch_with_new_relic(*args)
+      with_tracing(:produce, args) do
+        yield
+      end
+    end
+
+    def receive_message_with_new_relic(*args)
+      with_tracing(:consume, args) do
+        yield
+      end
+    end
+
+    def with_tracing(action, params)
+      segment = nil
+      begin
+        info = get_url_info(params[0])
+        segment = NewRelic::Agent::Tracer.start_message_broker_segment(
+          action: action,
+          library: MESSAGING_LIBRARY,
+          destination_type: :queue,
+          destination_name: info[:queue_name]
+        )
+        add_aws_attributes(segment, info)
+      rescue => e
+        NewRelic::Agent.logger.error('Error starting message broker segment in Aws::SQS::Client', e)
+      end
+      NewRelic::Agent::Tracer.capture_segment_error(segment) do
+        yield
+      end
+    ensure
+      segment&.finish
+    end
+
+    private
+
+    def add_aws_attributes(segment, info)
+      return unless segment
+
+      segment.add_agent_attribute('messaging.system', 'aws_sqs')
+      segment.add_agent_attribute('cloud.region', config&.region)
+      segment.add_agent_attribute('cloud.account.id', info[:account_id])
+      segment.add_agent_attribute('messaging.destination.name', info[:queue_name])
+    end
+
+    def get_url_info(params)
+      split = params[:queue_url].split('/')
+      {
+        queue_name: split.last,
+        account_id: split[-2]
+      }
+    end
+  end
+end

data/lib/new_relic/agent/instrumentation/aws_sqs/prepend.rb

@@ -0,0 +1,21 @@
+# 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::Agent::Instrumentation
+  module AwsSqs::Prepend
+    include NewRelic::Agent::Instrumentation::AwsSqs
+
+    def send_message(*args)
+      send_message_with_new_relic(*args) { super }
+    end
+
+    def send_message_batch(*args)
+      send_message_batch_with_new_relic(*args) { super }
+    end
+
+    def receive_message(*args)
+      receive_message_with_new_relic(*args) { super }
+    end
+  end
+end

data/lib/new_relic/agent/instrumentation/aws_sqs.rb

@@ -0,0 +1,25 @@
+# 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_relative 'aws_sqs/instrumentation'
+require_relative 'aws_sqs/chain'
+require_relative 'aws_sqs/prepend'
+
+DependencyDetection.defer do
+  named :aws_sqs
+
+  depends_on do
+    defined?(Aws::SQS::Client)
+  end
+
+  executes do
+    NewRelic::Agent.logger.info('Installing aws-sdk-sqs instrumentation')
+
+    if use_prepend?
+      prepend_instrument Aws::SQS::Client, NewRelic::Agent::Instrumentation::AwsSqs::Prepend
+    else
+      chain_instrument NewRelic::Agent::Instrumentation::AwsSqs::Chain
+    end
+  end
+end

data/lib/new_relic/agent/instrumentation/stripe_subscriber.rb

@@ -10,6 +10,7 @@ module NewRelic
         EVENT_ATTRIBUTES = %i[http_status method num_retries path request_id].freeze
         ATTRIBUTE_NAMESPACE = 'stripe.user_data'
         ATTRIBUTE_FILTER_TYPES = %i[include exclude].freeze
+        PATH_PORTION_PATTERN = %r{^/([^/]+/[^/]+)(?:/|\z)}.freeze
 
         def start_segment(event)
           return unless is_execution_traced?
@@ -39,7 +40,27 @@ module NewRelic
         end
 
         def metric_name(event)
-          "Stripe#{event.path}/#{event.method}"
+          # Grab only the first 2 items from the slash (/) delimited event path.
+          # These items are the API version string and the category. Grabbing
+          # any more of the path will result in unique method names that will
+          # easily grow to be too numerous to sort through in the UI and
+          # possibly even violate default New Relic metric count thresholds.
+          # See newrelic/newrelic-ruby-agent#2654 and
+          # newrelic/newrelic-ruby-agent#2709 for more details.
+          #
+          # In Ruby v3.4 benchmarks, using regex to get at the first two path
+          # elements was seen as more performant than using String#split.
+          #
+          # Regex legend:
+          #
+          # ^ = starts with
+          # / = a literal '/'
+          # () = capture
+          # (?:) = don't capture
+          # [^/]+ = 1 or more characters that are not '/'
+          # /|\z = a literal '/' OR the end of the string
+          path_portion = event.path =~ PATH_PORTION_PATTERN ? Regexp.last_match(1) : NewRelic::UNKNOWN
+          "Stripe/#{path_portion}/#{event.method}"
         end
 
         def add_stripe_attributes(segment, event)

data/lib/new_relic/version.rb

@@ -6,8 +6,8 @@
 module NewRelic
   module VERSION # :nodoc:
     MAJOR = 9
-    MINOR = 10
-    TINY = 2
+    MINOR = 11
+    TINY = 0
 
     STRING = "#{MAJOR}.#{MINOR}.#{TINY}"
   end

data/lib/tasks/gha.rake

@@ -0,0 +1,31 @@
+# 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 'yaml'
+require_relative 'helpers/version_bump'
+
+# gha = GitHub Actions
+namespace :gha do
+  # See .github/versions.yml
+  desc 'Update 3rd party action versions across all workflows'
+  task :update_versions do
+    gh_dir = File.expand_path('../../../.github', __FILE__)
+    info = YAML.load_file(File.join(gh_dir, 'versions.yml'))
+    workflows = Dir.glob(File.join(gh_dir, 'workflows', '*.yml'))
+    workflows.each do |workflow|
+      original = File.read(workflow)
+      modified = original.dup
+      info.each do |action, settings|
+        modified.gsub!(/uses: #{action}.*$/, "uses: #{action}@#{settings[:sha]} # tag #{settings[:tag]}")
+      end
+
+      if original != modified
+        File.open(workflow, 'w') { |f| f.puts modified }
+        puts "Updated #{workflow} with changes"
+      else
+        puts "#{workflow} remains unchanged"
+      end
+    end
+  end
+end

data/newrelic.yml

@@ -407,6 +407,10 @@ common: &default_settings
   # prepend, chain, disabled.
   # instrumentation.async_http: auto
 
+  # Controls auto-instrumentation of the aws-sdk-sqs library at start-up. May be one
+  # of: auto, prepend, chain, disabled.
+  # instrumentation.aws_sqs: auto
+
   # Controls auto-instrumentation of bunny at start-up. May be one of: auto,
   # prepend, chain, disabled.
   # instrumentation.bunny: auto

data/newrelic_rpm.gemspec

@@ -56,6 +56,8 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'minitest', "#{RUBY_VERSION >= '2.7.0' ? '5.3.3' : '4.7.5'}"
   s.add_development_dependency 'minitest-stub-const', '0.6'
   s.add_development_dependency 'mocha', '~> 1.16'
+  s.add_development_dependency 'mutex_m' # used by Minitest, not included in Rubies above v3.3
+  s.add_development_dependency 'ostruct' # used by Rack, not included in Rubies above v3.4
   s.add_development_dependency 'pry' if ENV['ENABLE_PRY']
   s.add_development_dependency 'rack'
   s.add_development_dependency 'rake', '12.3.3'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: newrelic_rpm
 version: !ruby/object:Gem::Version
-  version: 9.10.2
+  version: 9.11.0
 platform: ruby
 authors:
 - Tanna McClure
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-06-06 00:00:00.000000000 Z
+date: 2024-06-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -69,6 +69,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: mutex_m
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: ostruct
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rack
   requirement: !ruby/object:Gem::Requirement
@@ -364,6 +392,10 @@ files:
 - lib/new_relic/agent/instrumentation/async_http/chain.rb
 - lib/new_relic/agent/instrumentation/async_http/instrumentation.rb
 - lib/new_relic/agent/instrumentation/async_http/prepend.rb
+- lib/new_relic/agent/instrumentation/aws_sqs.rb
+- lib/new_relic/agent/instrumentation/aws_sqs/chain.rb
+- lib/new_relic/agent/instrumentation/aws_sqs/instrumentation.rb
+- lib/new_relic/agent/instrumentation/aws_sqs/prepend.rb
 - lib/new_relic/agent/instrumentation/bunny.rb
 - lib/new_relic/agent/instrumentation/bunny/chain.rb
 - lib/new_relic/agent/instrumentation/bunny/instrumentation.rb
@@ -671,6 +703,7 @@ files:
 - lib/tasks/bump_version.rake
 - lib/tasks/config.rake
 - lib/tasks/coverage_report.rake
+- lib/tasks/gha.rake
 - lib/tasks/helpers/config.html.erb
 - lib/tasks/helpers/config.text.erb
 - lib/tasks/helpers/format.rb
@@ -723,7 +756,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.1
 requirements: []
-rubygems_version: 3.5.9
+rubygems_version: 3.5.11
 signing_key: 
 specification_version: 4
 summary: New Relic Ruby Agent