Ruby agent release notes | New Relic Documentation

July 31

重要

最新のエージェントバージョンが利用可能になったらすぐに更新することをお勧めします。最新バージョンにアップグレードできない場合は、エージェントを 90 日以内のバージョンに更新してください。エージェントを最新の状態に保つ方法の詳細については、こちらをご覧ください。

エージェントのリリースとサポート日については、New Relic Ruby エージェントのEOL ポリシーを参照してください。

バージョン9.20.0

機能: Fargate 用の ECS Docker ID の追加
以前は、Ruby エージェントは AWS ECS Fargate 環境で実行されているときに Docker ID を記録しませんでした。Docker ID が正しく記録されるようになりました。PR#3172
機能: NewRelic::Helper.version_satisfied? を追加します。
エージェントには、バージョンの比較を簡素化する新しいヘルパーメソッドがあります。NewRelic::Helper.version_satisfied? 、左側のバージョン番号、文字列としての比較演算子、および右側のバージョン番号の 3 つの引数を受け入れます。この貢献に対して@kekke-nに感謝します。PR#3182
機能: 期間が設定された閾値を超えた場合に、データストアスパンに code.stacktrace プロパティを追加します。
期間が構成された炎症値を超えると、エージェントはcode.stacktraceプロパティをデータストアスパンに追加します。閾値は、 transaction_tracer.stack_trace_threshold設定オプションを使用して設定されます。 PR#3220
機能: 「不明」な定数値を統合する
「Unknown」のさまざまな大文字化スタイルへのすべての参照は、2 つの定数NewRelic::UNKNOWNとNewRelic::UNKNOWN_LOWERに統合されました。@tsubasa1122さん、ご協力ありがとうございました！PR#3185
バグ修正: Brewfile のソースリンクを修正
以前は、Multiverse README の Brewfile へのリンクが壊れていました。問題を修正するための PR を送信してくださった@emmanuel-ferdmanに感謝します。PR#3191
バグ修正: HTTPX 1.5.0 使用時のエラーを修正
以前、エージェントは新しい HTTPX バージョン 1.5.0 の使用時にエラーが発生しました。これは、HTTPX が応答を保存する方法が変更されたためです。エージェントは、この変更を適切に処理するように更新され、HTTPX 1.5.0 の使用時にエラーが発生しなくなりました。PR#3203
バグ修正: デバッグレベルエージェントログのバグ修正と改善
設定ソースにエージェントを読み込む際のデバッグレベルでの情報ログを改善します。 PR#3221
バグ修正: Slack ワークフロースクリプトのサーバー側での偽造のリスクを修正
社内では、Slack に更新を投稿する GitHub アクションワークフローを使用して、リリースされた gem を追跡しています。[@odaysec] は、このワークフローにおけるサーバー側の偽造のリスクを軽減できる方法を特定しました。ありがとう！PR#3184
バグ修正: JSON.load 呼び出しを JSON.parse に置き換えます
一般的に、JSON.parse は JSON.load よりも安全だと考えられています。この件を指摘していただいた@odaysec さん、ありがとうございます!PR#3183 PR#3230

April 30

Ruby agent v9.19.0

重要

エージェントのリリースとサポート日については、New Relic Ruby エージェントのEOL ポリシーを参照してください。

バージョン9.19.0

機能: すべてのスパンにスレッドIDを属性として追加
エージェントは、各スパンの属性としてスレッド ID を記録するようになりました。PR#3122
機能: W3C TraceContext トレースフラグのサポートを追加
以前は、エージェントはサンプリングの決定に traceparent ヘッダーのトレースフラグフィールドを使用していませんでした。これにより、UI のトレースが断片化される可能性があります。デフォルトの動作は変更されていませんが、サンプリングの決定方法をより細かく制御できるように、2 つの新しい設定オプションdistributed_tracing.sampler.remote_parent_sampledとdistributed_tracing.sampler.remote_parent_not_sampledが導入されました。 PR#3135
バグ修正: トランザクションイベントに request.uri をデフォルトで含める
New Relic データディクショナリでは、トランザクションイベントにrequest.uri属性があることを想定しています。Ruby エージェントは、この期待に応えるようになりました。トランザクションイベントからrequest.uriを除外する場合は、 transaction_events.attributes.excludeを'request.uri'に設定します。PR#3103
バグ修正: perform_all_later使用時のアクティブジョブインストルメンテーションのエラーを修正
以前は、Active Job のperform_all_laterメソッドが呼び出され、エージェントが実行されている場合、メッセージundefined method 'queue_name' for nilとともにNoMethodErrorが発生していました。エラーは修正され、セグメントの名前はキューの最初のジョブを反映するようになります。この問題を私たちに知らせ、修正を提供してくれた@tan-linxに感謝します。PR#3110

April 2

Ruby agent v9.18.0

重要

We recommend updating to the latest agent version as soon as it's available. If you can't upgrade to the latest version, update your agents to a version no more than 90 days old. Read more about keeping agents up to date.

See the New Relic Ruby agent EOL policy for information about agent releases and support dates.

v9.18.0

Feature: Add elasticsearch.capture_cluster_name configuration option
A new configuration option, elasticsearch.capture_cluster_name, has been added to control capturing Elasticsearch cluster names. Cluster names are captured by default, but can now be disabled as needed. PR#3038
Feature: Add support for sidekiq-delay_extensions
Sidekiq delay extensions were removed from Sidekiq in 7.x and are now avaliable through the sidekiq-delay_extensions gem. Thanks to @sobrinho, the agent now has continued support for delay extensions.PR#3056
Feature: Parallelize calls for vendor metadata
Previously, the agent would make calls for vendor metadata in a serial fashion. This could lead to a delay in starting the agent. Now, the agent will make these calls in parallel, reducing the time it takes to start the agent. PR#3094
Bugfix: Prevent a nil segment from causing errors in Net::HTTP instrumentation
When using JRuby, a race condition can happen that causes the segment creation to fail and return nil. This would cause an error to occur when methods were later called on the nil segment. These methods will no longer be called if the segment is nil, preventing that error from occurring. PR#3046
Bugfix: JRuby multithreading improvements
Added some additional nil checks and mutexes to prevent issues when using the agent on JRuby with multiple threads. Thanks to @NC-piercej for bringing this to our attention Issue#3021 PR#3053
Bugfix: Stop reporting rescued Sidekiq::OverLimit exceptions
When Sidekiq's concurrent rate limiters encounter an OverLimit exception, Sidekiq typically handles this by re-enqueuing the job. Previously, all occurrences of Sidekiq::OverLimit were logged as errors in New Relic, even when Sidekiq's middleware resolved the exception. New Relic will no longer report errors that are handled by Sidekiq's own middleware. Thanks to @97jaz for reporting this issue. Issue#3037 PR#3047
Bugfix: Protect against nil agents or health checks
In some cases the agent or health checks may be nil when they are called. Safe navigation operators have been added for protection on those occasions. PR#3049
Bugfix: Ignore Solid Queue ThreadError: queue empty error message by default
When using the solid_queue gem, the agent previously generated excessive warn-level logs when the queue was empty. The agent now ignores queue empty error messages of the ThreadError class by default. This behavior can be adjusted using the error_collector.ignore_messages configuration option. PR#3060
Bugfix: Refactor URI host handling to accommodate downcasing frozen strings
When URI host string was frozen, a FrozenError would be raised when the agent attempted to downcase the host as part of its data normalization process. Now, the update is friendly for frozen strings. Thank you @pedrol3001 for your contribution! PR#3097

January 29

Ruby agent v9.17.0

重要

See the New Relic Ruby agent EOL policy for information about agent releases and support dates.

v9.17.0

Feature: Support Ruby 3.4.0
The agent now supports Ruby 3.4.0. We've made incremental changes throughout the preview stage to reach compatibility. This release includes an update to the Thread Profiler for compatibility with Ruby 3.4.0's new backtrace format. Issue#2992 PR#2997
Feature: Add instrumentation for aws-sdk-firehose
The agent now has instrumentation for the aws-sdk-firehose gem. PR#2973
Feature: Kubernetes APM auto-attach - new agent version precedent
Previously, when a customer installed the Ruby agent via Kubernetes APM auto-attach and also had the Ruby agent listed in their Gemfile, the agent version in Gemfile would take precedence. Now, the agent version installed by auto-attach takes priority. PR#3018
Feature: Add health checks when the agent runs within Agent Control
When the agent is started within an Agent Control environment, a health check file will be created at the configured file location for every agent process. By default, this location is: '/newrelic/apm/health'. The health check files will be updated at the configured frequency, which defaults to every five seconds. PR#2995
Feature: Add Redshift as recognized ActiveRecord adapter
When the agent does not recognize an ActiveRecord adapter, the host, port, and database name information is not added to the datastore span. Redshift will now be treated like PostgreSQL, and the agent will save the host, port, and database name on the span. PR#3032
Feature: Add instrumentation for aws-sdk-kinesis
The agent now has instrumentation for the aws-sdk-kinesis gem. It will record message broker segments for get_records, put_record, and put_records operations. All other operations will record standard segments. PR#2974
Bugfix: Stop emitting inaccurate debug-level log about deprecated configuration options
In the previous major release, we dropped support for many disable_library_name configuration options in favor of instrumentation.library_name. Previously, a DEBUG level log warning appeared whenever disable_* options were set to true, even for libraries (e.g. Action Dispatch) without equivalent instrumentation.* options:

>DEBUG : [DEPRECATED] configuration disable_library_name for library_name will be removed in the next major release. Use instrumentation. library_name with one of ["auto", "disabled", "prepend", "chain"]

This inaccurate warning has been removed. If you are disabling instrumentation using instrumentation.library_name: disabled or NEW_RELIC_INSTRUMENTATION_LIBRARY_NAME=disabled, please verify the option exists by consulting our configuration documentation. If the option does not exist, check the 'Disabling' section to see if there is a related option. We apologize for the confusion. PR#3005

Bugfix: Do not attempt to decorate logs with nil messages
The agent no longer attempts to add New Relic linking metadata to logs with nil messages. Thank you, @arlando for bringing this to our attention! Issue#2985 PR#2986
Bugfix: Stop renaming final Grape segment
Previously, the agent renamed the final segment in Grape transactions to "Middleware/Grape/#{class_name}/call". This was a part of an old instrumentation pattern that is no longer relevant. Many thanks to @seriousdev-gh for bringing this issue to our attention and along with a great reproduction and suggested fix. PR#2987.

December 4, 2024

Ruby agent v9.16.1

重要

See the New Relic Ruby agent EOL policy for information about agent releases and support dates.

v9.16.1

Bugfix: Added the support for the Trilogy database adapter.
The agent now fully supports the Trilogy, a client library for MySQL-compatible database servers, and correctly lists MySQL as the corresponding database in the UI. PR#2966.

November 19, 2024

Ruby agent v9.16.0

重要

See the New Relic Ruby agent EOL policy for information about agent releases and support dates.

v9.16.0

Version 9.16.0 introduces the following features and bug fixes:

Feature: Instrumentation for aws-sdk-lambda
When the aws-sdk-lambda gem is available and used to invoke remote AWS Lambda functions, the timing and error details of the invocations will be reported to New Relic. PR#2926.
Feature: Add new configuration options to attach custom tags (labels) to logs
The Ruby agent now allows you to opt-in to adding your custom tags (labels) to agent-forwarded logs. With custom tags on logs, platform engineers can easily filter, search, and correlate log data for faster and more efficient troubleshooting, improved performance, and optimized resource utilization. PR#2925
Feature: Update View Component instrumentation+
The .identifier method will be formally exposed as part of the View Component public API. The agent will now use this method for building metric names when available, ensuring ongoing compatibility with all View Component versions. PR#2956
Bugfix: Record explain plan traces on Rails 7.2+
Rails 7.2 removed adapter-specific connection methods (ex. ActiveRecord::Base.postgresql_connection) and replaced them with ActiveRecord::Base.with_connection. Our explain plan feature relies on making a connection to the database to create an explain plan trace. Due to a bug in our tests, we missed this regression. Now, the agent uses the new method to fetch explain plans on Rails 7.2+. Thank you, @gsar and @gstark for bringing this to our attention! Issue#2922 PR#2940

October 31, 2024

Ruby agent v9.15.0

重要

See the New Relic Ruby agent EOL policy for information about agent releases and support dates.

v9.15.0

Version 9.15.0 updates View Component instrumentation to use a default metric name when one is unavailable, adds a configuration option to associate the AWS account ID with the DynamoDB calls from the AWS SDK, resolves a bug in rdkafka instrumentation when using the karafka-rdkafka gem, resolves a bug in the ruby-kafka instrumentation, fixes a bug with Grape instrumentation, and addresses a bug preventing the agent from running in serverless mode in an AWS Lambda layer.

Feature: New configuration option cloud.aws.account_id
A new configuration option has been added, cloud.aws.account_id, that will allow New Relic to provide more details about certain calls made using the AWS SDK. For example, relationships between AWS services instrumented with New Relic's CloudWatch Metric Streams will have relationships formed in the service map with APM applications. Currently, the DynamoDB instrumentation is the only instrumentation that will make use of this configuration option, but this will be used in future instrumentation as well. PR#2904
Feature: Use default View/component metric name for unidentified View Components
Previously, when a View Component metric name could not be identified, the agent would set the name as nil. Now, the agent defaults to using View/component as the metric name when one can not be identified. PR#2907
Bugfix: Instrumentation errors when using the karafka-rdkafka gem
Due to version differences between the rdkafka gem and karafka-rdkafka gem, the agent could encounter an error when it tried to install rdkafka instrumentation. This has now been resolved. Thank you to @krisdigital for bringing this issue to our attention. PR#2880
Bugfix: Stop calling deprecated all_specs method to check for the presence of newrelic-grape
In 9.14.0, we released a fix for calls to the deprecated Bundler.rubygems.all_specs, but the fix fell short for the agent's Grape instrumentation and deprecation warnings could still be raised. The condition has been simplified and deprecation warnings should no longer be raised. Thank you, @excelsior for bringing this to our attention. Issue#2885 PR#2906
Bugfix: Instrumentation errors when using the ruby-kafka gem
Kafka::Consumer#each_message takes keyword arguments, while the prepended method is defined with a single splat positional argument. In Ruby >= 3.0, this signature mismatch raises an ArgumentError. Thank you @patrickarnett for providing this bugfix. PR#2915
Bugfix: Restore AWS Lambda layer operational functionality
Version 9.14.0 of the agent introduced an optimization related to how the agent handles boolean configuration parameters which inadvertently caused the agent to stop operating properly in an AWS Lambda layer context. Issue#2919 PR#2920

September 30, 2024

Ruby agent v9.14.0

重要

See the New Relic Ruby agent EOL policy for information about agent releases and support dates.

v9.14.0

Version 9.14.0 adds Apache Kafka instrumentation for the rdkafka and ruby-kafka gems, introduces a configuration-based, automatic way to add custom instrumentation method tracers, correctly captures MIME type for ActionDispatch 7.0+ requests, properly handles Boolean coercion for newrelic.yml configuration, fixes a JRuby bug in the configuration manager, fixes a bug related to Bundler.rubygems.installed_specs, and fixes a bug to make the agent compatible with ViewComponent v3.15.0+.

Feature: Add Apache Kafka instrumentation for the rdkafka and ruby-kafka gems
The agent now has instrumentation for both the rdkafka and ruby-kafka gems. The agent will record transactions and message broker segments for produce and consume calls made using these gems. PR#2824 PR#2842
Feature: Add a configuration option to permit custom method tracers to be defined automatically
A new :automatic_custom_instrumentation_method_list configuration parameter has been added to permit the user to define a list of fully qualified (namespaced) Ruby methods for the agent to automatically add custom instrumentation for without requiring any code modifications to be made to the classes that define the methods.
The list should be an array of CLASS#METHOD (for instance methods) and/or CLASS.METHOD (for class methods) strings.
Use fully qualified class names (using the :: delimiter) that include any module or class namespacing.
Here is some Ruby source code that defines a render_png instance method for an Image class and a notify class method for a User class, both within a MyCompany module namespace:
```
module MyCompany
  class Image
    def render_png
      # code to render a PNG
    end
  end

  class User
    def self.notify
      # code to notify users
    end
  end
end
```
Given that source code, the newrelic.yml config file might request instrumentation for both of these methods like so:
```
automatic_custom_instrumentation_method_list:
  - MyCompany::Image#render_png
  - MyCompany::User.notify
```
That configuration example uses YAML array syntax to specify both methods. Alternatively, a comma-delimited string can be used instead:
```
automatic_custom_instrumentation_method_list: 'MyCompany::Image#render_png, MyCompany::User.notify'
```
Whitespace around the comma(s) in the list is optional. When configuring the agent with a list of methods via the NEW_RELIC_AUTOMATIC_CUSTOM_INSTRUMENTATION_METHOD_LIST environment variable, this comma-delimited string format should be used:
```
export NEW_RELIC_AUTOMATIC_CUSTOM_INSTRUMENTATION_METHOD_LIST='MyCompany::Image#render_png, MyCompany::User.notify'
```
PR#2851
Feature: Collect just MIME type for ActionDispatch 7.0+ requests
Rails 7.0 introduced changes to the behavior of ActionDispatch::Request#content_type, adding extra request-related details the agent wasn't expecting to collect. Additionally, the agent's use of content_type was triggering deprecation warnings. The agent now uses ActionDispatch::Request#media_type to capture the MIME type. Thanks to @internethostage for letting us know about this change. Issue#2500 PR#2855
Bugfix: Corrected Boolean coercion for newrelic.yml configuration
Previously, any String assigned to New Relic configurations expecting a Boolean value were evaluated as true. This could lead to unexpected behavior. For example, setting application_logging.enabled: 'false' in newrelic.yml would incorrectly evaluate to application_logging.enabled: true due to the truthy nature of Strings.
Now, the agent strictly interprets Boolean configuration values. It recognizes both actual Boolean values and certain Strings/Symbols:
- 'true', 'yes', or 'on' (evaluates to true)
- 'false', 'no', or 'off' (evaluates to false)
Any other inputs will revert to the setting's default configuration value. PR#2847
Bugfix: JRuby not saving configuration values correctly in configuration manager
Previously, a change made to fix a different JRuby bug caused the agent to not save configuration values correctly in the configuration manager when running on JRuby. This has been fixed. PR#2848
Bugfix: Update condition to verify Bundler.rubygems.installed_specs is available
To address a recent Bundler deprecation warning, we started using Bundler.rubygems.installed_specs instead of Bundler.rubygems.all_specs in environments that seemed appropriate. We discovered the version constraint we used was too low. Now, rather than check the version, we check for the method using respond_to?. PR#2853
Bugfix: Support view_component v3.15.0+
Previously the agent had been making use of a private API to obtain a component identifier value. This private API was dropped in v3.15.0 of view_component, resulting in errors from the New Relic Ruby agent's continued attempts to use it. Many thanks to community member @navidemad for bringing this issue to our attention and supplying a bugfix with PR#2870.

重要

バージョン9.20.0.css-21sua1{background:none;border:none;width:0;padding:0;}

重要

バージョン9.19.0

重要

v9.18.0

重要

v9.17.0

重要

v9.16.1

重要

v9.16.0

重要

v9.15.0

重要

v9.14.0

バージョン9.20.0