Ruby agent release notesRSS

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

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

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 PR#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

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 for a list of available options. PR#3299

Breaking Change: Remove the NewRelic::Agent::SqlSampler#notice_sql method

Users should call NewRelic::Agent::Datastores.notice_sql instead. PR#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

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

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

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

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

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

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 and Active Support: Messages events. PR#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

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

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

There are four modes available:

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 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:

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 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

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

機能: SqlSampler#notice_sql API の廃止に関するお知らせ

NewRelic::Agent::SqlSampler#notice_sqlメソッドは非推奨であり、将来のメジャー バージョンで削除される予定です。代わりに、ユーザーはNewRelic::Agent::Datastores.notice_sqlを呼び出す必要があります。PR#3345

機能: Datastores.notice_sql の 2 番目と 3 番目の引数の非推奨通知API

NewRelic::Agent::Datastores.notice_sqlメソッドの 2 番目 (scoped_metric) および 3 番目 (elapsed) の引数は非推奨です。それらはしばらくの間、この方法では使用されていません。代わりに、これらの値は、API が呼び出されたときに現在のセグメントに基づいて設定されます。PR#3345

機能: Datastores.notice_statement の 2 番目の引数の非推奨通知API

NewRelic::Agent::Datastores.notice_statementメソッドの 2 番目の引数 (elapsed) は非推奨です。この方法は、しばらくの間使用されていません。代わりに、この値は API が呼び出されたときに現在のセグメントに基づいて設定されます。PR#3346

機能: Datastores.wrap API の proc の 2 番目と 3 番目の引数の非推奨通知

NewRelic::Agent::Datastores.wrapメソッドは変更されています。将来のメジャー バージョンでは、proc は単一の引数 (yield の結果) のみを受け入れるようになります。スコープ付きメトリック名と経過引数は、 Datastores.notice_sqlメソッドから削除されるため削除されます。 スコープ付きメトリック名と経過値は、ラップが実行されるときに現在のセグメントから導出されます。 PR#3346

機能: sidekiq.ignore_retry_errors を追加設定オプション

Sidekiq ジョブの再試行をキャプチャするかどうかを制御するための新しい設定オプションsidekiq.ignore_retry_errorsが追加されました。 再試行エラーはデフォルトでキャプチャされますが、 sidekiq.ignore_retry_errors trueに設定されている場合、エージェントは Sidekiq の再試行中に発生した例外を無視し、ジョブが永続的に失敗した場合にのみエラーを報告します。この改善点を認識し、解決策を提供してくれたDonGiulioに感謝します。PR#3317

機能: Capistrano を使用したデプロイメントの記録の廃止に関するお知らせ

Capistrano レシピを使用したアプリケーション デプロイメント情報の送信は非推奨となり、エージェント バージョン 10.0.0 で削除される予定です。 デプロイメントの記録については、利用可能なオプションのリストについては、変更追跡 (変更追跡機能)のガイドを参照してください。

機能: リモート親サンプリング設定を使用して、より多くのシナリオで意思決定を行う

以前は、 traceparentおよびtracestateヘッダーが存在する場合にのみ、 distributed_tracing.sampler.remote_parent_sampledおよびdistributed_tracing.sampler.remote_parent_not_sampled設定オプションがサンプリング決定に使用されていました。 現在、これらの設定オプションは、 tracestateヘッダーが欠落しており、 newrelicヘッダーのみが使用可能な場合に適用されます。 この変更により、ディストリビューティッド（分散）トレーシング サンプリングがより一貫性があり、予測可能になります。 PR#3306

機能: Kubernetesのワンステップ計装

Kubernetes APM 、インストゥルメントされたアプリケーションを自動的に自動アタッチし、 Kubernetesデプロイメント内のアップグレードを管理します。 この機能はプレビューを終了し、一般利用可能になりました。Kubernetes の自動接続の詳細をご覧ください。PR#2635 PR#3287

機能: Ruby 2.4 および Ruby 2.5 の非推奨に関するお知らせ

Ruby バージョン 2.4 および 2.5 に対する Ruby エージェントのサポートは非推奨となり、エージェント バージョン 10.0.0 で削除されます。新しい最低限必要な Ruby バージョンは Ruby 2.6 となり、Ruby 2.4 および 2.5 でのテストは停止されます。PR#3288

機能: newrelic deploymentsコマンドの廃止に関するお知らせ

newrelic deploymentsコマンドを使用したデプロイメントの記録のサポートは廃止され、エージェント バージョン 10.0.0 では削除されます。

今後、New Relic に変更を記録するための自動および手動の方法がいくつかある予定です。利用可能なオプションのリストについては、変更追跡 (変更追跡機能)のガイドをご覧ください。 PR#3262

機能: クロスアプリケーショントレースの廃止に関するお知らせ

クロスアプリケーション トレースは、Ruby エージェントのメジャー バージョン 8.0.0 以降では非推奨になっています。エージェントのバージョン 10.0.0 では、そのサポートは完全に削除されます。PR#3288

機能: Ruby 3.5 の Method#source_location の変更との互換性を確保

Ruby 3.5 で 2 要素から 5 要素の配列に変更される Method#source_location の戻り値を正しく解析するようにエージェントを更新しました。この変更により、将来のリリースのサポートが追加されながら、古い Ruby バージョンのサポートが維持されます。PR#3257

機能: Serverless APMモードでは、イベント ソース名をイベント名のプレフィックスとして使用します

エージェントは、Serverless APM モードで、イベント ソース名をトランザクション名のプレフィックスとして使用するようになりました。これにより、New Relic UI でトランザクションのソースをより適切に識別できるようになります。PR#3245

Bugfix: スパンの開始スレッドを追跡する方法の変更されたロジックを元に戻します

この変更により、スパンが開始されるスレッドを追跡する以前の動作が復元され、更新されたロジックから発生した問題に対処します。この件を私たちに知らせてくれた@david-zw-liuに感謝します。PR#3248