Ruby agent release notes | New Relic Documentation

July 31

Important

Nous vous recommandons de mettre à jour vers la dernière version de l'agent dès qu'elle est disponible. Si vous ne pouvez pas effectuer la mise à niveau vers la dernière version, mettez à jour vos agents vers une version datant de moins de 90 jours. En savoir plus sur la façon de tenir les agents informés.

Consultez la politique EOL de l'agent New Relic Ruby pour obtenir des informations sur la sortie de l'agent et les dates de support.

v9.20.0

Fonctionnalité : Ajouter un identifiant ECS Docker pour Fargate
Auparavant, l’agent Ruby n’enregistrait pas l’ID Docker lors de son exécution dans un environnement AWS ECS Fargate. L'ID Docker sera désormais enregistré correctement. PR#3172
Fonctionnalité : Ajouter NewRelic::Helper.version_satisfied?
L'agent dispose d'une nouvelle méthode d'assistance pour simplifier la comparaison des versions. NewRelic::Helper.version_satisfied? accepte trois arguments : un numéro de version côté gauche, l'opérateur de comparaison sous forme de chaîne et un numéro de version côté droit. Nos remerciements vont à @kekke-n pour cette contribution. PR#3182
Fonctionnalité : Ajouter l'attribut code.stacktrace sur les étendues datastore lorsque la durée dépasse le seuil configuré
L'agent ajoutera désormais l'attribut code.stacktrace aux étendues datastore lorsque la durée dépasse le seuil configuré. Le seuil est configuré à l’aide de l’option de configuration transaction_tracer.stack_trace_threshold. PR#3220
fonctionnalité : consolider les valeurs constantes "Inconnues"
Toutes les références aux différents styles de majuscules pour « Inconnu » ont été consolidées en deux constantes : NewRelic::UNKNOWN et NewRelic::UNKNOWN_LOWER. Merci, @tsubasa1122, pour votre contribution ! PR#3185
Correction de bug : correction des liens source du fichier Brewfile
Auparavant, les liens du fichier README du multivers vers le Brewfile étaient rompus. Nos remerciements vont à @emmanuel-ferdman pour avoir soumis un PR pour les corriger ! PR#3191
Correction de bug : correction d'une erreur lors de l'utilisation de HTTPX 1.5.0
L'agent a précédemment rencontré une erreur lors de l'utilisation de la nouvelle version HTTPX 1.5.0. Cela était dû à un changement dans la façon dont HTTPX stocke la réponse. L'agent a été mis à jour pour gérer correctement ce changement et ne rencontre plus d'erreur lors de l'utilisation de HTTPX 1.5.0. PR#3203
Correction de bugs : corrections de bugs et améliorations des logs de l'agent de niveau de débogage
Améliore l'informations enregistrée au niveau de débogage par l'agent lorsque l'agent lit une source configuration. PR#3221
Correction de bug : corrige le risque de falsification côté serveur pour le script de workflow Slack
En interne, nous suivons les gemmes qui sortent à l'aide d'un workflow d'actions GitHub qui publie des mises à jour sur Slack. [@odaysec] a identifié un moyen de réduire le risque de falsification côté serveur pour ce workflow. Merci! PR#3184
Correction de bug : remplacer les appels JSON.load par JSON.parse
En général, JSON.parse est considéré comme plus sûr que JSON.load. Merci, @odaysec, d'avoir attiré notre attention sur ce point ! PR#3183 PR#3230

April 30

Ruby agent v9.19.0

Important

Consultez la politique EOL de l'agent New Relic Ruby pour obtenir des informations sur la sortie de l'agent et les dates de support.

v9.19.0

Fonctionnalité : ajouter l'ID de thread comme attribut à toutes les étendues
L'agent enregistrera désormais l'ID de thread en tant qu'attribut sur chaque étendue. PR#3122
Fonctionnalité : Ajout de la prise en charge de l'indicateur de trace W3C TraceContext
Auparavant, l'agent n'utilisait pas le champ d'indicateur de trace de l'en-tête traceparent pour les décisions d'échantillonnage. Cela pourrait conduire à une trace fragmentée dans l'interface utilisateur. Bien que le comportement par défaut reste inchangé, deux nouvelles options de configuration, distributed_tracing.sampler.remote_parent_sampled et distributed_tracing.sampler.remote_parent_not_sampled, ont été introduites pour permettre un meilleur contrôle sur la manière dont les décisions d'échantillonnage sont prises. PR#3135
Correction de bogue : inclure request.uri dans l'événement Transaction par défaut
Le dictionnaire de données New Relic s'attend à ce que l'événement Transaction ait l'attribut request.uri . L'agent Ruby répond désormais à cette attente. Si vous souhaitez exclure request.uri de l'événement Transaction, vous pouvez le faire en définissant transaction_events.attributes.exclude sur 'request.uri'. PR#3103
Correction de bogue : correction d'une erreur dans l'instrumentation de la tâche active lors de l'utilisation de perform_all_later
Auparavant, lorsque la méthode perform_all_later d'Active Job était appelée et que l'agent était en cours d'exécution, un NoMethodError était généré avec le message undefined method 'queue_name' for nil. L'erreur a été corrigée et le nom du segment reflétera le premier travail dans la file d'attente. Nous remercions @tan-linx d'avoir attiré notre attention sur ce problème et d'avoir fourni une solution. PR#3110

April 2

Ruby agent v9.18.0

Important

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

Important

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

Important

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

Important

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

Important

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

Important

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.

Important

v9.20.0.css-21sua1{background:none;border:none;width:0;padding:0;}

Important

v9.19.0

Important

v9.18.0

Important

v9.17.0

Important

v9.16.1

Important

v9.16.0

Important

v9.15.0

Important

v9.14.0

v9.20.0