newrelic_rpm 9.24.0 → 10.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2a513be9b409b6ae8c4e08416ded683ef6abeb372607baf25ba7aa10f7a916f5
-  data.tar.gz: 3604c7f4df3c33a1f61cd2b3b984dce971bac3b3b028862929a0c99c79931f4c
+  metadata.gz: f1ba5e172b3a5648a782fbac5ff79ed02c515effb8f956277857b0d31df80e4c
+  data.tar.gz: 12b8f92031c90f9bf3afeec99651220ab1a08e08f176efe2a178a6d9c3b72e2c
 SHA512:
-  metadata.gz: 5ecb0cd5c7b6476b008ac82be5bbda20b2c4e8b58465f457057a9357ac499f82b3779b9bbbcdaa2e5c2376db98e000957f653875bb9e98436f41b1a4f718dc42
-  data.tar.gz: 72e77abe6f9b63be2ae7af1bd99dcb285ec82d54725826e38c5c54df391c13bc983b7d50fe4b9e0795ef6b28f02c732d196db1ebe40f7e590d031f3d8394c3a6
+  metadata.gz: 0b1f474da66156182fb297affe29c8c2231fec2c25d181b010134b648dcdd5c03b6543114bce29b760d59718fc77e86606b520d7d4ed1adf7675eb7982034be1
+  data.tar.gz: ac2cdcb58281265d7bdc6674ac02731e35de1cc2038ae2c0957c588bf8d5773bf69ed868cdc255e0a4ccea114378a44c8d4267e1faa7e4e8b2232f64f1f9a316

data/CHANGELOG.md

@@ -1,5 +1,123 @@
 # New Relic Ruby Agent Release Notes
 
+## v10.0.0
+
+- **Breaking Change: Remove support for Ruby 2.4 and 2.5**
+
+  Support for Ruby versions 2.4 and 2.5 has been removed. The new minimum required Ruby version is now 2.6. [PR#3314](https://github.com/newrelic/newrelic-ruby-agent/pull/3314)
+
+- **Breaking Change: Removal of Cross Application Tracing (CAT)**
+
+  Previously, Cross Application Tracing (CAT) was deprecated in favor of Distributed Tracing. CAT functionality has now been removed. The configuration option `cross_application_tracer.enabled` has been removed. Public API methods `NewRelic::Agent::External.process_request_metadata`, `NewRelic::Agent::External.get_response_metadata`, `NewRelic::Agent::Transaction::ExternalRequestSegment#process_response_metadata`, `NewRelic::Agent::Transaction::ExternalRequestSegment#get_request_metadata`, and `NewRelic::Agent::Transaction::ExternalRequestSegment#read_response_headers` have also been removed. [PR#3333](https://github.com/newrelic/newrelic-ruby-agent/pull/3333)
+
+- **Breaking Change: Rename ActiveJob metrics and segments**
+
+  ActiveJob metrics have been updated to include the job's class name for more specific reporting. This is a breaking change and may require updating custom dashboards or alerts. [PR#3370](https://github.com/newrelic/newrelic-ruby-agent/pull/3370) [PR#3320](https://github.com/newrelic/newrelic-ruby-agent/pull/3320)
+    - Old format: `Ruby/ActiveJob/<QueueName>/<Method>`
+    - New format: `Ruby/ActiveJob/<QueueName>/<ClassName>/<Method>`
+
+  In addition, segments created for Active Job enqueuing actions now include the job class.
+    - Old format: `ActiveJob/<QueueAdapter>/Queue/<Event>/Named/<QueueName>`
+    - New format: `ActiveJob/<QueueAdapter>/Queue/<Event>/Named/<QueueName>/<ClassName>`
+
+- **Breaking Change: Rename `bin/newrelic` command to `bin/newrelic_rpm`**
+
+  The executable file for the agent's CLI has been renamed from `bin/newrelic` to `bin/newrelic_rpm`. This change resolves a name collision with the standalone New Relic CLI tool. [PR#3323](https://github.com/newrelic/newrelic-ruby-agent/pull/3323)
+
+- **Breaking Change: Remove the `newrelic deployments` CLI command**
+
+  The deprecated `newrelic deployments` CLI command has been removed. To track changes and deployments 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#3299](https://github.com/newrelic/newrelic-ruby-agent/pull/3299)
+
+- **Breaking Change: Remove the NewRelic::Agent::SqlSampler#notice_sql method**
+
+  Users should call `NewRelic::Agent::Datastores.notice_sql` instead. [PR#3338](https://github.com/newrelic/newrelic-ruby-agent/pull/3338)
+
+- **Breaking Change: Remove unused arguments from various NewRelic::Agent::Datastores APIs**
+
+  The following APIs from the `NewRelic::Agent::Datastores` class have had method arguments removed:
+  * `NewRelic::Agent::Datastores.notice_sql`, previously had three positional arguments, `query`, `scoped_metric` and `elapsed`. Now, it only has `query`.
+  * `NewRelic::Agent::Datastores.notice_statement`, previously had two positional arguments `query` and `elapsed`. Now it only has `query`.
+  * `NewRelic::Agent::Datastores.wrap` requires a proc. Previously the proc received three arguments: the result of the yield, the most specific scoped metric name, and the elapsed time of the call. Now, it only receives one: the result of the yield.
+
+  The values of the removed arguments are derived from the current segment at the time of the call. [PR#3347](https://github.com/newrelic/newrelic-ruby-agent/pull/3347)
+
+- **Breaking Change: Remove experimental feature Configurable Security Policies (CSP)**
+
+  The experimental feature, Configurable Security Policies (CSP), is no longer supported and has been removed. [PR#3292](https://github.com/newrelic/newrelic-ruby-agent/pull/3292)
+
+- **Breaking Change: Remove support for Puma versions < 3.9.0**
+
+  The minimum version of Puma now supported is 3.9.0 or higher. [PR#3326](https://github.com/newrelic/newrelic-ruby-agent/pull/3326)
+
+- **Breaking Change: Improve configuration validation and coercion**
+
+  The internals used to coerce and validate the values provided for agent configuration are now more performant and more accurate.
+    * Warning messages will now be logged to the newrelic_agent.log file when nil is provided as a config value for a setting that does not support it.
+    * Integer values are permitted for Float configuration types
+    * Float values are permitted for Integer configuration types
+    * Fatal interruptions are prevented when a default value can be found to replace an invalid input value
+  [PR#3341](https://github.com/newrelic/newrelic-ruby-agent/pull/3341)
+
+- **Breaking Change: Replace 'default' option with 'adaptive' for distributed tracing remote parent samplers**
+
+  Previously, the default option for `distributed_tracing.sampler.remote_parent_sampled` and `distributed_tracing.sampler.remote_parent_not_sampled` was `default`, which used the pre-existing adaptive sampler. The `default` option has been renamed to `adaptive`. [PR#3363](https://github.com/newrelic/newrelic-ruby-agent/pull/3363)
+
+- **Feature: Add `logger` as a dependency**
+
+  The `logger` gem is now listed as a dependency of the agent to ensure continued logging functionality and support for Ruby 4.0.0 and newer versions. [PR#3293](https://github.com/newrelic/newrelic-ruby-agent/pull/3293)
+
+- **Feature: Add Active Support notification allowlist configuration option**
+
+  A new configuration option, `instrumentation.active_support_notifications.active_support_events`, allows users to define an allowlist of Active
+  Support notifications event names for the agent to subscribe to. By default, the agent subscribes to all [Active Support: Caching](https://guides.rubyonrails.org/active_support_instrumentation.html#active-support-caching) and [Active Support: Messages](https://guides.rubyonrails.org/active_support_instrumentation.html#active-support-messages) events. [PR#3327](https://github.com/newrelic/newrelic-ruby-agent/pull/3327)
+
+- **Feature: Use Ruby's built-in Gzip compression**
+
+  The agent now uses the built-in `Zlib.gzip` method from the Ruby standard library for compression, replacing the previous custom implementation. [PR#3332](https://github.com/newrelic/newrelic-ruby-agent/pull/3332)
+
+- **Feature: Add argument validation for the `NewRelic::Agent#record_custom_event` API**
+
+  The `NewRelic::Agent#record_custom_event` API now raises an `ArgumentError` when an invalid `event_type` is provided. A valid event type must consist only of alphanumeric characters, underscores (`_`), colons (`:`), or spaces (` `). [PR#3319](https://github.com/newrelic/newrelic-ruby-agent/pull/3319)
+
+- **Feature: Add root sampling configuration options**
+
+  You can now configure the sampling behavior for traces that originate within the current service using `distributed_tracing.sampler.root`. [PR#3330](https://github.com/newrelic/newrelic-ruby-agent/pull/3330)
+
+  There are four modes available:
+
+  | Mode | Description |
+  | ------ | ----------- |
+  | `adaptive` | Uses the existing adaptive sampler algorithm |
+  | `always_off` | Marks 0% of root traces as sampled |
+  | `always_on` | Marks 100% of root traces as sampled |
+  | `trace_id_ratio_based` | Samples traces based on a ratio set in `distributed_tracing.sampler.root.trace_id_ratio_based.ratio`. The ratio must be float between 0.0 and 1.0 |
+
+- **Feature: Add Trace ID Ratio Based sampling options**
+
+  The agent can now sample traces using the OpenTelemetry Trace ID Ratio Based sampler algorithm. [PR#3330](https://github.com/newrelic/newrelic-ruby-agent/pull/3330) This samples traces based on a probability between 0.0 and 1.0 based on the trace ID.
+
+  To use this option, you must first set your distributed tracing sampler configuration to `trace_id_ratio_based` and then set the corresponding `distributed_tracing.sampler.*.trace_id_ratio_based.ratio` sampler to a Float between 0.0 and 1.0.
+
+  For example:
+  ```yaml
+    distributed_tracing.sampler.remote_parent_sampled: 'trace_id_ratio_based'
+    distributed_tracing.sampler.remote_parent_sampled.trace_id_ratio_based.ratio': 0.5
+  ```
+  This configuration would sample approximately 50% of your traces for all traces where the remote parent is sampled.
+
+  This option is available for:
+  * `distributed_tracing.sampler.root`
+  * `distributed_tracing.sampler.remote_parent_sampled`
+  * `distributed_tracing.sampler.remote_parent_not_sampled`
+
+- **Feature: Add Entity GUID to Agent Control health check files**
+
+  When the agent is started within an [Agent Control](https://docs-preview.newrelic.com/docs/new-relic-agent-control) environment, a health check file is created at the configured file location for every agent process. This file now includes the guid of the entity related to the agent when available. [PR#3371](https://github.com/newrelic/newrelic-ruby-agent/pull/3371)
+
+- **Bugfix: Resolve a `NoMethodError` in GCP utilization detection.**
+  
+  The GCP metadata discovery logic will now gracefully handle `nil` or unexpected values, preventing service initialization crashes. [PR##3388](https://github.com/newrelic/newrelic-ruby-agent/pull/#3388)
+
 ## v9.24.0
 
 - **Feature: Deprecation reminder for SqlSampler#notice_sql API**

data/README.md

@@ -77,13 +77,6 @@ For complete documentation on installing the New Relic Ruby agent, see the follo
 * [Update the agent](https://docs.newrelic.com/docs/agents/ruby-agent/installation/update-ruby-agent)
 * [Uninstall the Ruby agent](https://docs.newrelic.com/docs/agents/ruby-agent/installation/uninstall-ruby-agent)
 
-### Recording deploys
-
-The Ruby agent supports recording deployments in New Relic via a command line
-tool or Capistrano recipes. For more information on these features, see
-[our deployment documentation](http://docs.newrelic.com/docs/ruby/recording-deployments-with-the-ruby-agent)
-for more information.
-
 ## Support
 
 Should you need assistance with New Relic products, you are in good hands with several support diagnostic tools and support channels.

data/lib/new_relic/agent/agent.rb

@@ -100,6 +100,12 @@ module NewRelic
         @monotonic_gc_profiler = VM::MonotonicGCProfiler.new
         @adaptive_sampler = AdaptiveSampler.new(Agent.config[:sampling_target],
           Agent.config[:sampling_target_period_in_seconds])
+        # TODO: update the configs used here to match new sampler-specific options
+        # TODO: Consider refactoring to only create the sampler if 'adaptive' is the sampler's setting
+        @adaptive_sampler_remote_parent_sampled = AdaptiveSampler.new(Agent.config[:sampling_target],
+          Agent.config[:sampling_target_period_in_seconds])
+        @adaptive_sampler_remote_parent_not_sampled = AdaptiveSampler.new(Agent.config[:sampling_target],
+          Agent.config[:sampling_target_period_in_seconds])
         @serverless_handler = ServerlessHandler.new
         @opentelemetry_bridge = OpenTelemetryBridge.new
       end
@@ -156,8 +162,6 @@ module NewRelic
         attr_reader :record_sql
         # builder for JS agent scripts to inject
         attr_reader :javascript_instrumentor
-        # cross application tracing ids and encoding
-        attr_reader :cross_process_id
         # service for communicating with collector
         attr_reader :service
         # Global events dispatcher. This will provides our primary mechanism
@@ -180,6 +184,8 @@ module NewRelic
         attr_reader :transaction_event_recorder
         attr_reader :attribute_filter
         attr_reader :adaptive_sampler
+        attr_reader :adaptive_sampler_remote_parent_sampled
+        attr_reader :adaptive_sampler_remote_parent_not_sampled
         attr_reader :serverless_handler
 
         def transaction_event_aggregator
@@ -238,8 +244,7 @@ module NewRelic
           return false if !needs_restart ||
             !Agent.config[:agent_enabled] ||
             !Agent.config[:monitor_mode] ||
-            disconnected? ||
-            !control.security_settings_valid?
+            disconnected?
 
           true
         end