newrelic_rpm 9.18.0 → 9.19.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cb30bae7fc944221b3f08c8635e18c84c02b04f2fe36bc70814c3fed471dd8f8
-  data.tar.gz: 01fc3c88893c0fc0d8f3e92cc394767eac9ee134f2c58d3656e8d6e6b5a95d8f
+  metadata.gz: 3a2b588c4be509b5a02bb0516a47e9329cab3bcf79c97f614d4349291db0876f
+  data.tar.gz: 30f1dcd2997242e38836aa3325badb71656aaa3aa074857a2edad75f6e21972b
 SHA512:
-  metadata.gz: 99dc8ccbe8653343313da890dd8f6fc445638239c346fd104f3792519f33096f0ea2ec2faf96d03de72d050d38887c5c1a61caa3c7f66196d71bd5d0e057cf40
-  data.tar.gz: bb47acdc604c90a7bf8c7ddd0dafbb1377d8de51b3841cdcb2fef377a8b789cd523f522478d0387ec84ab4b6b85d7dc8e2f5ae7881501ee38c7c5d5acc6564fb
+  metadata.gz: 6915cfd19ea57029473609dd02b4e9bd110aaa3766f13af648705a0132d4608f33051ad0e44f6c03f72b037eb99c64f1992c92408d1caedd3381538e906c4b0d
+  data.tar.gz: 87c1d548bd4a78eb26706eae9f1932c9fb394c05f16e8d4603ce8b690e4df255fdd8748f7f2b09501a7e73770961ec20f6df07435255db293bb4e7395400094c

data/CHANGELOG.md

@@ -1,5 +1,23 @@
 # New Relic Ruby Agent Release Notes
 
+## v9.19.0
+
+- **Feature: Add Thread ID as attribute to all spans**
+
+  The agent will now record the Thread ID as an attribute on each span. [PR#3122](https://github.com/newrelic/newrelic-ruby-agent/pull/3122)
+
+- **Feature: Add support for W3C TraceContext Trace Flag**
+
+  Previously, the agent would not use the trace flag field of the traceparent header for sampling decisions. This could lead to fragmented traces in the UI. While the default behavior remains unchanged, two new configuration options, `distributed_tracing.sampler.remote_parent_sampled` and `distributed_tracing.sampler.remote_parent_not_sampled`, have been introduced to allow more control over the way sampling decisions are made. [PR#3135](https://github.com/newrelic/newrelic-ruby-agent/pull/3135)
+
+- **Bugfix: Include request.uri in Transaction events by default**
+
+  [The New Relic data dictionary expects Transaction events to have the `request.uri` attribute.](https://docs.newrelic.com/attribute-dictionary/?event=Transaction&attribute=request.uri) The Ruby agent now fulfills this expectation. If you would like to exclude `request.uri` from Transaction events, you can do so by setting `transaction_events.attributes.exclude` to `'request.uri'`. [PR#3103](https://github.com/newrelic/newrelic-ruby-agent/pull/3103)
+
+- **Bugfix: Fix error in Active Job instrumentation when using perform_all_later**
+
+  Previously, when Active Job's `perform_all_later` method was called and the agent was running, a `NoMethodError` would be raised with the message `undefined method 'queue_name' for nil`. The error has been fixed and the name of the segment will reflect the first job in the queue. Our thanks goes to [@tan-linx](https://github.com/tan-linx) for bringing this to our attention and providing a fix. [PR#3110](https://github.com/newrelic/newrelic-ruby-agent/pull/3110)
+
 ## v9.18.0
 
 - **Feature: Add elasticsearch.capture_cluster_name configuration option**

data/lib/new_relic/agent/agent.rb

@@ -38,6 +38,7 @@ require 'new_relic/agent/adaptive_sampler'
 require 'new_relic/agent/serverless_handler'
 require 'new_relic/agent/connect/request_builder'
 require 'new_relic/agent/connect/response_handler'
+require 'new_relic/agent/opentelemetry_bridge'
 
 require 'new_relic/agent/agent_helpers/connect'
 require 'new_relic/agent/agent_helpers/harvest'
@@ -100,6 +101,7 @@ module NewRelic
         @adaptive_sampler = AdaptiveSampler.new(Agent.config[:sampling_target],
           Agent.config[:sampling_target_period_in_seconds])
         @serverless_handler = ServerlessHandler.new
+        @opentelemetry_bridge = OpenTelemetryBridge.new
       end
 
       def init_event_handlers

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

@@ -762,7 +762,12 @@ module NewRelic
           DESCRIPTION
         },
         :'error_collector.ignore_messages' => {
+          # we have to keep the hash rocket in the actual default so the
+          # class name key is treated like a string rather than a symbol.
+          # however, this isn't valid yaml, so document something that is
+          # valid yaml
           :default => {'ThreadError' => ['queue empty']},
+          :documentation_default => {'ThreadError': ['queue empty']},
           :public => true,
           :type => Hash,
           :allowed_from_server => true,
@@ -1458,6 +1463,20 @@ module NewRelic
           :allowed_from_server => true,
           :description => 'Distributed tracing lets you see the path that a request takes through your distributed system. Enabling distributed tracing changes the behavior of some New Relic features, so carefully consult the [transition guide](/docs/transition-guide-distributed-tracing) before you enable this feature.'
         },
+        :'distributed_tracing.sampler.remote_parent_sampled' => {
+          :default => 'default',
+          :public => true,
+          :type => String,
+          :allowed_from_server => true,
+          :description => 'This setting controls the behavior of transaction sampling when a remote parent is sampled and the trace flag is set in the traceparent. Available values are `default`, `always_on`, and `always_off`.'
+        },
+        :'distributed_tracing.sampler.remote_parent_not_sampled' => {
+          :default => 'default',
+          :public => true,
+          :type => String,
+          :allowed_from_server => true,
+          :description => 'This setting controls the behavior of transaction sampling when a remote parent is not sampled and the trace flag is not set in the traceparent. Available values are `default`, `always_on`, and `always_off`.'
+        },
         # Elasticsearch
         :'elasticsearch.capture_cluster_name' => {
           :default => true,
@@ -2490,6 +2509,14 @@ module NewRelic
           :allowed_from_server => true,
           :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' => {
+          :default => false,
+          :public => false,
+          :type => Boolean,
+          :allowed_from_server => false,
+          :description => 'Enables the creation of Transaction Trace segments and timeslice metrics from OpenTelemetry Spans. This will help drive New Relic UI experience for opentelemetry spans. **WARNING**: This is not feature complete and is not intended to be enabled yet.'
+        },
         :force_reconnect => {
           :default => false,
           :public => false,

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

@@ -8,7 +8,7 @@ module NewRelic
   module Agent
     module Instrumentation
       class ActiveJobSubscriber < NotificationsSubscriber
-        PAYLOAD_KEYS = %i[adapter db_runtime error job wait]
+        PAYLOAD_KEYS = %i[adapter db_runtime error job wait jobs]
 
         def add_segment_params(segment, payload)
           PAYLOAD_KEYS.each do |key|
@@ -16,8 +16,12 @@ module NewRelic
           end
         end
 
+        # NOTE: For `enqueue_all.active_job`, only the first job is used to determine the queue.
+        # Therefore, this assumes all jobs given as arguments for perform_all_later share the same queue.
         def metric_name(name, payload)
-          queue = payload[:job].queue_name
+          job = payload[:job] || payload[:jobs].first
+
+          queue = job.queue_name
           method = method_from_name(name)
           "Ruby/ActiveJob/#{queue}/#{method}"
         end

data/lib/new_relic/agent/opentelemetry/trace/span.rb

@@ -0,0 +1,23 @@
+# 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
+    module OpenTelemetry
+      module Trace
+        class Span < ::OpenTelemetry::Trace::Span
+          attr_reader :context
+
+          def initialize(segment:, transaction:)
+            @context = ::OpenTelemetry::Trace::SpanContext.new(
+              trace_id: transaction.trace_id,
+              span_id: segment.guid,
+              trace_flags: 1
+            )
+          end
+        end
+      end
+    end
+  end
+end

data/lib/new_relic/agent/opentelemetry/trace/tracer.rb

@@ -0,0 +1,38 @@
+# 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
+    module OpenTelemetry
+      module Trace
+        class Tracer < ::OpenTelemetry::Trace::Tracer
+          def initialize(name = nil, version = nil)
+            @name = name || ''
+            @version = version || ''
+          end
+
+          def in_span(name, attributes: nil, links: nil, start_timestamp: nil, kind: nil)
+            case kind
+            when :internal
+              begin
+                return yield unless NewRelic::Agent::Tracer.current_transaction
+
+                segment = NewRelic::Agent::Tracer.start_segment(name: name)
+                span = Span.new(segment: segment, transaction: segment.transaction)
+
+                ::OpenTelemetry::Trace.with_span(span) do
+                  yield
+                end
+              ensure
+                segment&.finish
+              end
+            else
+              NewRelic::Agent.logger.debug("Span kind: #{kind} is not supported yet")
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/new_relic/agent/opentelemetry/trace/tracer_provider.rb

@@ -0,0 +1,18 @@
+# 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
+    module OpenTelemetry
+      module Trace
+        class TracerProvider < ::OpenTelemetry::Trace::TracerProvider
+          # TODO: Add a registration mechanism for tracers like exists in the SDK
+          def tracer(name = nil, version = nil)
+            @tracer ||= Tracer.new(name, version)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/new_relic/agent/opentelemetry/trace.rb

@@ -0,0 +1,15 @@
+# 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
+    module OpenTelemetry
+      module Trace
+        require_relative 'trace/tracer_provider'
+        require_relative 'trace/tracer'
+        require_relative 'trace/span'
+      end
+    end
+  end
+end

data/lib/new_relic/agent/opentelemetry_bridge.rb

@@ -0,0 +1,26 @@
+# 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 OpenTelemetryBridge
+      def initialize
+        # no-op without OpenTelemetry API & config
+        return unless defined?(OpenTelemetry) &&
+          NewRelic::Agent.config[:'opentelemetry_bridge.enabled']
+
+        OpenTelemetryBridge.install
+      end
+
+      private
+
+      def self.install
+        require 'opentelemetry' # requires the opentelemetry-api gem
+        require_relative 'opentelemetry/trace'
+
+        ::OpenTelemetry.tracer_provider = NewRelic::Agent::OpenTelemetry::Trace::TracerProvider.new
+      end
+    end
+  end
+end

data/lib/new_relic/agent/span_event_primitive.rb

@@ -44,6 +44,7 @@ module NewRelic
       TRUSTED_PARENT_KEY = 'trustedParentId'
       TRACING_VENDORS_KEY = 'tracingVendors'
       TRANSACTION_NAME_KEY = 'transaction.name'
+      THREAD_ID_KEY = 'thread.id'
 
       # Strings for static values of the event structure
       EVENT_TYPE = 'Span'
@@ -135,7 +136,8 @@ module NewRelic
           PRIORITY_KEY => segment.transaction.priority,
           TIMESTAMP_KEY => milliseconds_since_epoch(segment),
           DURATION_KEY => segment.duration,
-          NAME_KEY => segment.name
+          NAME_KEY => segment.name,
+          THREAD_ID_KEY => segment.thread_id
         }
 
         # with infinite-tracing, transactions may or may not be sampled!

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

@@ -19,7 +19,7 @@ module NewRelic
         # after its parent. We will use the optimized exclusive duration
         # calculation in all other cases.
         #
-        attr_reader :start_time, :end_time, :duration, :exclusive_duration, :guid, :starting_segment_key
+        attr_reader :start_time, :end_time, :duration, :exclusive_duration, :guid, :starting_segment_key, :thread_id
         attr_accessor :name, :parent, :children_time, :transaction, :transaction_name, :llm_event
         attr_writer :record_metrics, :record_scoped_metric, :record_on_finish
         attr_reader :noticed_error
@@ -30,6 +30,7 @@ module NewRelic
         def initialize(name = nil, start_time = nil)
           @name = name
           @starting_segment_key = NewRelic::Agent::Tracer.current_segment_key
+          @thread_id = Thread.current.object_id
           @transaction_name = nil
           @transaction = nil
           @guid = NewRelic::Agent::GuidGenerator.generate_guid

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

@@ -43,12 +43,7 @@ module NewRelic
           end
 
           if request_path
-            destinations = if allow_other_headers?
-              default_destinations
-            else
-              AttributeFilter::DST_TRANSACTION_TRACER | AttributeFilter::DST_ERROR_COLLECTOR
-            end
-            txn.add_agent_attribute(:'request.uri', request_path, destinations)
+            txn.add_agent_attribute(:'request.uri', request_path, default_destinations)
           end
 
           if accept

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

@@ -136,10 +136,8 @@ module NewRelic
 
           transaction.distributed_tracer.parent_transaction_id = payload.transaction_id
 
-          unless payload.sampled.nil?
-            transaction.sampled = payload.sampled
-            transaction.priority = payload.priority if payload.priority
-          end
+          determine_sampling_decision(payload, header_data)
+
           NewRelic::Agent.increment_metric(ACCEPT_SUCCESS_METRIC)
           true
         rescue => e
@@ -148,6 +146,37 @@ module NewRelic
           false
         end
 
+        def determine_sampling_decision(payload, header_data)
+          if header_data.trace_parent['trace_flags'] == '01'
+            set_priority_and_sampled(NewRelic::Agent.config[:'distributed_tracing.sampler.remote_parent_sampled'], payload)
+          elsif header_data.trace_parent['trace_flags'] == '00'
+            set_priority_and_sampled(NewRelic::Agent.config[:'distributed_tracing.sampler.remote_parent_not_sampled'], payload)
+          else
+            use_nr_tracestate_sampled(payload)
+          end
+        rescue
+          use_nr_tracestate_sampled(payload)
+        end
+
+        def use_nr_tracestate_sampled(payload)
+          unless payload.sampled.nil?
+            transaction.sampled = payload.sampled
+            transaction.priority = payload.priority if payload.priority
+          end
+        end
+
+        def set_priority_and_sampled(config, payload)
+          if config == 'always_on'
+            transaction.sampled = true
+            transaction.priority = 2.0
+          elsif config == 'always_off'
+            transaction.sampled = false
+            transaction.priority = 0
+          else # default
+            use_nr_tracestate_sampled(payload)
+          end
+        end
+
         def ignore_trace_context?
           if trace_context_header_data
             NewRelic::Agent.increment_metric(IGNORE_MULTIPLE_ACCEPT_METRIC)

data/lib/new_relic/version.rb

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

data/newrelic.yml

@@ -359,6 +359,16 @@ common: &default_settings
   # enable this feature.
   # distributed_tracing.enabled: true
 
+  # This setting controls the behavior of transaction sampling when a remote
+  # parent is not sampled and the trace flag is not set in the traceparent.
+  # Available values are default, always_on, and always_off.
+  # distributed_tracing.sampler.remote_parent_not_sampled: default
+
+  # This setting controls the behavior of transaction sampling when a remote
+  # parent is sampled and the trace flag is set in the traceparent. Available
+  # values are default, always_on, and always_off.
+  # distributed_tracing.sampler.remote_parent_sampled: default
+
   # If true, the agent captures the Elasticsearch cluster name in transaction
   # traces.
   # elasticsearch.capture_cluster_name: true
@@ -409,7 +419,7 @@ common: &default_settings
   # classes specified here occurs, if its error message contains one of the
   # strings corresponding to it here, that error will be ignored.
   # This option can't be set via environment variable.
-  # error_collector.ignore_messages: {"ThreadError" => ["queue empty"]}
+  # error_collector.ignore_messages: {ThreadError: ["queue empty"]}
 
   # A comma separated list of status codes, possibly including ranges. Errors
   # associated with these status codes, where applicable, will be ignored.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: newrelic_rpm
 version: !ruby/object:Gem::Version
-  version: 9.18.0
+  version: 9.19.0
 platform: ruby
 authors:
 - Tanna McClure
@@ -10,7 +10,7 @@ authors:
 - Hannah Ramadan
 bindir: bin
 cert_chain: []
-date: 2025-04-02 00:00:00.000000000 Z
+date: 2025-04-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -614,6 +614,11 @@ files:
 - lib/new_relic/agent/noticeable_error.rb
 - lib/new_relic/agent/null_logger.rb
 - lib/new_relic/agent/obfuscator.rb
+- lib/new_relic/agent/opentelemetry/trace.rb
+- lib/new_relic/agent/opentelemetry/trace/span.rb
+- lib/new_relic/agent/opentelemetry/trace/tracer.rb
+- lib/new_relic/agent/opentelemetry/trace/tracer_provider.rb
+- lib/new_relic/agent/opentelemetry_bridge.rb
 - lib/new_relic/agent/parameter_filtering.rb
 - lib/new_relic/agent/payload_metric_mapping.rb
 - lib/new_relic/agent/pipe_channel_manager.rb