newrelic_rpm 9.21.0 → 9.23.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 28a51810c279118b462ee016c67fd8d62cde2bf457bfc2ca33e687712a3b3514
-  data.tar.gz: c9b530fcf6ea3c2775c1100dfa112ba1d356c8a18a2b18535be1184ebcbc7805
+  metadata.gz: c3bc35eb6cc82a0dd1ba947b3270d18b515da940533c11362ff531cfbeb05575
+  data.tar.gz: afd55578e5580b8bfb50280259c007c8c6e039a3d2029d9b8be2a2b2b4ea289c
 SHA512:
-  metadata.gz: 299297fc139e0ed8475254cfd73d1d43cea58743fcc89c6e9a02c31a59a44545062c47da422c1126306ac55a9d93a3dc028d9a235739c3d1d8cb642df5f0fc18
-  data.tar.gz: c41fdc820bcc54b2fd2a61777b979319af9aeabf77c4b9721a2f385bfd4cef62277d84030b281a38ab8e02684f88603e76a45be6cad64324517f310e6ba1d877
+  metadata.gz: 75bd39b66cf822e975b2e704360eea2bc3ac44fbd2f63ed38b069a7115ae1a502a29c149adca19f3d057fe1332f3e5122afcdec4f42aec9182195d432db1f206
+  data.tar.gz: 44a1abc2d6f0ce8c28ac20e0912b21a1081baa474e455c561c3f4ace6ade983d2fd1922174ef3922fc51d99f7a771b0d13756fc10f14c8a4f420b5cb84ec4a20

data/CHANGELOG.md

@@ -1,5 +1,43 @@
 # New Relic Ruby Agent Release Notes
 
+## v9.23.0
+
+- **Feature: Add sidekiq.ignore_retry_errors configuration option**
+
+  A new configuration option, `sidekiq.ignore_retry_errors`, has been added to control if Sidekiq job retries are captured. Retry errors are captured by default, but now if `sidekiq.ignore_retry_errors` is set to `true`, the agent will ignore exceptions raised during Sidekiq's retry attempts and will only report the error if the job permanently fails. Thank you [DonGiulio](https://github.com/DonGiulio) for recognizing this improvement and contributing a solution. [PR#3317](https://github.com/newrelic/newrelic-ruby-agent/pull/3317)
+
+- **Feature: Deprecation notice for recording deployments using Capistrano**
+
+  Sending application deployment information using a Capistrano recipe is deprecated and will be removed in agent version 10.0.0. For recording deployments, please see our guide to [Change Tracking](https://docs.newrelic.com/docs/change-tracking/change-tracking-introduction/) for a list of available options.
+
+- **Feature: Use remote parent sampling configurations for decisions in more scenarios**
+
+  Previously, the `distributed_tracing.sampler.remote_parent_sampled` and `distributed_tracing.sampler.remote_parent_not_sampled` configuration options were used for the sampling decision only when the `traceparent` and `tracestate` headers were present. Now, these configuration options are applied in cases when the `tracestate` header is missing and when only the `newrelic` header is available. This change makes distributed trace sampling more consistent and predictable. [PR#3306](https://github.com/newrelic/newrelic-ruby-agent/pull/3306)
+
+## v9.22.0
+
+- **Feature: One-step instrumentation for Kubernetes**
+
+  The Kubernetes APM auto-attach automatically instruments applications and manages agent upgrades within Kubernetes deployments. This feature has exited preview and is now generally avaliable. Learn more about [Kubernetes auto-attach](https://docs.newrelic.com/docs/kubernetes-pixie/kubernetes-integration/installation/k8s-agent-operator/). [PR#2635](https://github.com/newrelic/newrelic-ruby-agent/pull/2635) [PR#3287](https://github.com/newrelic/newrelic-ruby-agent/pull/3287)
+
+- **Feature: Deprecation notice for Ruby 2.4 and Ruby 2.5**
+
+  Ruby agent support for Ruby versions 2.4 and 2.5 is deprecated and will be removed in agent version 10.0.0. The new miniumum required Ruby version will become Ruby 2.6 and we will stop testing with Ruby 2.4 and 2.5. [PR#3288](https://github.com/newrelic/newrelic-ruby-agent/pull/3288)
+
+- **Feature: Deprecation notice for the `newrelic deployments` command**
+
+  Support for recording deployments using the `newrelic deployments` command is now deprecated and will be removed in agent version 10.0.0.
+
+  Going forward, there are a number of automated and manual ways ways to record changes in New Relic. Please see our guide to [Change Tracking](https://docs.newrelic.com/docs/change-tracking/change-tracking-introduction/) for a list of available options. [PR#3262](https://github.com/newrelic/newrelic-ruby-agent/pull/3262)
+
+- **Feature: Deprecation reminder for cross application tracing**
+
+  Cross application tracing has been deprecated since major version 8.0.0 of the Ruby agent. We will remove support for it entirely in version 10.0.0 of the agent. [PR#3288](https://github.com/newrelic/newrelic-ruby-agent/pull/3288)
+
+- **Feature: Ensure compatibility with Ruby 3.5 change to Method#source_location**
+
+  Updated the agent to correctly parse the return value of Method#source_location, which is changing in Ruby 3.5 from a two-element to a five-element array. This change maintains support for older Ruby versions while adding support for the future release. [PR#3257](https://github.com/newrelic/newrelic-ruby-agent/pull/3257)
+
 ## v9.21.0
 
 - **Feature: In Serverless APM mode, use event source name as transaction name prefix**

data/lib/boot/strap.rb

@@ -5,8 +5,6 @@
 # This file is designed to bootstrap a `Bundler.require`-based Ruby app (such as
 # a Ruby on Rails app) so the app can be instrumented and observed by the
 # New Relic Ruby agent without the agent being added to the app as a dependency.
-# NOTE: introducing the agent into your application via bootstrap is in beta.
-# Use at your own risk.
 #
 # Given a production-ready Ruby app that optionally has a pre-packaged "frozen"
 # or "deployment"–gem bundle, the New Relic Ruby agent can be introduced

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

@@ -428,7 +428,7 @@ module NewRelic
           :type => String,
           :allowed_from_server => false,
           :exclude_from_reported_settings => true,
-          :description => 'Your New Relic <InlinePopover type="userKey" />. Required when using the New Relic REST API v2 to record deployments using the `newrelic deployments` command.'
+          :description => '# DEPRECATED: The `api_key` config setting is now deprecated. Its only use was for the `newrelic deployments` command, which is being removed in agent version 10.0.0.'
         },
         :backport_fast_active_record_connection_lookup => {
           :default => false,
@@ -2140,6 +2140,13 @@ module NewRelic
             argument array elements and job argument scalars will be excluded.
           SIDEKIQ_ARGS_EXCLUDE
         },
+        :'sidekiq.ignore_retry_errors' => {
+          :default => false,
+          :public => true,
+          :type => Boolean,
+          :allowed_from_server => false,
+          :description => %Q(If `true`, the agent will ignore exceptions raised during Sidekiq's retry attempts and will only report the error if the job permanently fails.)
+        },
         # Slow SQL
         :'slow_sql.enabled' => {
           :default => value_of(:'transaction_tracer.enabled'),
@@ -2510,7 +2517,7 @@ module NewRelic
           :description => 'Number of seconds betwixt connections to the New Relic span event collection services.'
         },
         # TODO: Sync with the other agents to see what the config should be named, how it should be enabled, how it should be described
-        :'opentelemetry_bridge.enabled' => {
+        :'opentelemetry.enabled' => {
           :default => false,
           :public => false,
           :type => Boolean,

data/lib/new_relic/agent/distributed_tracing/trace_context_payload.rb

@@ -96,6 +96,16 @@ module NewRelic
         @timestamp = timestamp
       end
 
+      # This is an invalid instance of the TraceContextPayload that is used to
+      # help us determine the sampling decision for an incoming trace when the
+      # tracestate header is missing. Creating an invalid instance allows us
+      # to call methods like .sampled on it without throwing errors.
+      # The timestamp value will represent the time it was created/when this
+      # class was initialized.
+      #
+      # @api private
+      INVALID = create
+
       def parent_type
         @parent_type_string ||= PARENT_TYPES[@parent_type_id]
       end

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

@@ -40,13 +40,19 @@ DependencyDetection.defer do
         end
       end
 
-      if config.respond_to?(:error_handlers)
+      if config.respond_to?(:error_handlers) && !NewRelic::Agent.config[:'sidekiq.ignore_retry_errors']
         # Sidekiq 3.0.0 - 7.1.4 expect error_handlers to have 2 arguments
         # Sidekiq 7.1.5+ expect error_handlers to have 3 arguments
         config.error_handlers << proc do |error, _ctx, *_|
           NewRelic::Agent.notice_error(error)
         end
       end
+
+      if config.respond_to?(:death_handlers) && NewRelic::Agent.config[:'sidekiq.ignore_retry_errors']
+        config.death_handlers << proc do |_, error|
+          NewRelic::Agent.notice_error(error)
+        end
+      end
     end
   end
 end

data/lib/new_relic/agent/method_tracer_helpers.rb

@@ -50,8 +50,8 @@ module NewRelic
         return ::NewRelic::EMPTY_HASH if info.empty?
 
         namespace, location, is_class_method = info
-        @code_information[cache_key] = {filepath: location.first,
-                                        lineno: location.last,
+        @code_information[cache_key] = {filepath: location[0],
+                                        lineno: location[1],
                                         function: "#{'self.' if is_class_method}#{method_name}",
                                         namespace: namespace}.freeze
       rescue StandardError => e

data/lib/new_relic/agent/opentelemetry_bridge.rb

@@ -8,7 +8,7 @@ module NewRelic
       def initialize
         # no-op without OpenTelemetry API & config
         return unless defined?(OpenTelemetry) &&
-          NewRelic::Agent.config[:'opentelemetry_bridge.enabled']
+          NewRelic::Agent.config[:'opentelemetry.enabled']
 
         OpenTelemetryBridge.install
       end

data/lib/new_relic/agent/transaction/distributed_tracing.rb

@@ -161,6 +161,25 @@ module NewRelic
           transaction.parent_span_id = payload.id
 
           unless payload.sampled.nil?
+            if payload.sampled == true
+              set_priority_and_sampled_newrelic_header(NewRelic::Agent.config[:'distributed_tracing.sampler.remote_parent_sampled'], payload)
+            elsif payload.sampled == false
+              set_priority_and_sampled_newrelic_header(NewRelic::Agent.config[:'distributed_tracing.sampler.remote_parent_not_sampled'], payload)
+            else
+              transaction.sampled = payload.sampled
+              transaction.priority = payload.priority if payload.priority
+            end
+          end
+        end
+
+        def set_priority_and_sampled_newrelic_header(config, payload)
+          if config == 'always_on'
+            transaction.sampled = true
+            transaction.priority = 2.0
+          elsif config == 'always_off'
+            transaction.sampled = false
+            transaction.priority = 0
+          else # case for 'default' value
             transaction.sampled = payload.sampled
             transaction.priority = payload.priority if payload.priority
           end

data/lib/new_relic/agent/transaction/trace_context.rb

@@ -132,11 +132,17 @@ module NewRelic
           transaction.trace_id = header_data.trace_id
           transaction.parent_span_id = header_data.parent_id
 
-          return false unless payload = assign_trace_state_payload
+          trace_flags = header_data.trace_parent['trace_flags']
+          payload = assign_trace_state_payload
 
-          transaction.distributed_tracer.parent_transaction_id = payload.transaction_id
+          if payload
+            determine_sampling_decision(payload, trace_flags)
+          else
+            determine_sampling_decision(TraceContextPayload::INVALID, trace_flags)
+            return false
+          end
 
-          determine_sampling_decision(payload, header_data.trace_parent['trace_flags'])
+          transaction.distributed_tracer.parent_transaction_id = payload.transaction_id
 
           NewRelic::Agent.increment_metric(ACCEPT_SUCCESS_METRIC)
           true

data/lib/new_relic/cli/commands/deployments.rb

@@ -15,6 +15,19 @@ require 'new_relic/agent/hostname'
 require 'new_relic/control' unless defined? NewRelic::Control
 
 class NewRelic::Cli::Deployments < NewRelic::Cli::Command
+  # DEPRECATION NOTICE (Effective September 2025)
+  #
+  # The entire `NewRelic::Cli::Deployments` class and its associated
+  # `newrelic deployments` command are deprecated and will be removed in
+  # agent version 10.0.0.
+  #
+  # Users should migrate to recording deployments directly via New Relic's
+  # APIs. For more information, please see the official Change Tracking
+  # documentation: https://docs.newrelic.com/docs/change-tracking/change-tracking-introduction/
+  #
+  # @api public
+  #
+
   attr_reader :control
   def self.command; 'deployments'; end
 
@@ -64,6 +77,12 @@ class NewRelic::Cli::Deployments < NewRelic::Cli::Command
   # Run the Deployment upload in New Relic via Active Resource.
   # Will possibly print errors and exit the VM
   def run
+    msg = <<~TEXT
+      DEPRECATED: The `newrelic deployments` command will be removed in v10.0.0. Learn more about the alternate options: https://docs.newrelic.com/docs/change-tracking/change-tracking-introduction/
+    TEXT
+    NewRelic::Agent.logger.log_once(:warn, 'newrelic_deployments'.to_sym, msg)
+    warn msg
+
     begin
       @description = nil if @description && @description.strip.empty?
 

data/lib/new_relic/version.rb

@@ -6,7 +6,7 @@
 module NewRelic
   module VERSION # :nodoc:
     MAJOR = 9
-    MINOR = 21
+    MINOR = 23
     TINY = 0
 
     STRING = "#{MAJOR}.#{MINOR}.#{TINY}"

data/newrelic.yml

@@ -52,8 +52,9 @@ common: &default_settings
   # If true, enables capture of all HTTP request headers for all destinations.
   # allow_all_headers: false
 
-  # Your New Relic userKey. Required when using the New Relic REST API v2 to
-  # record deployments using the newrelic deployments command.
+  # # DEPRECATED: The api_key config setting is now deprecated. Its only use was
+  # for the newrelic deployments command, which is being removed in agent version
+  # 10.0.0.
   # api_key: ""
 
   # If true, enables log decoration and the collection of log events and metrics.
@@ -790,6 +791,10 @@ common: &default_settings
   # will be included.
   # sidekiq.args.include: []
 
+  # If true, the agent will ignore exceptions raised during Sidekiq's retry
+  # attempts and will only report the error if the job permanently fails.
+  # sidekiq.ignore_retry_errors: false
+
   # If true, the agent collects slow SQL queries.
   # slow_sql.enabled: true
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: newrelic_rpm
 version: !ruby/object:Gem::Version
-  version: 9.21.0
+  version: 9.23.0
 platform: ruby
 authors:
 - Tanna McClure