Ruby agent release notesRSS

v8.13.0

Version 8.13.0 of the agent updates our Rack, Redis, and Sidekiq instrumentation. It also delivers some bugfixes.

• Support for Redis v5.0

  Redis v5.0 restructures where some of our instrumented methods are located and how they are named. It also introduces a new instrumentation middleware API. This API is used for pipelined and multi calls to maintain reporting parity with previous Redis versions. However, it is introduced later in the chain, so you may see errors that used to appear at the segment level on the transaction instead. The agent's behavior when used with older supported Redis versions will remain unaffected. PR#1611

• Support for Sidekiq v7.0

  Sidekiq v7.0 removed Delayed Extensions and began offering client and server middleware classes to inherit from. The agent's Sidekiq instrumentation has been updated accordingly. The agent's behavior when used with older Sidekiq versions will remain unaffected. PR#1615 NOTE: an issue was discovered with Sidekiq v7.0+ and addressed by Ruby agent v8.13.1. If you are using Sidekiq, please skip Ruby agent v8.13.0 and use v8.13.1 or above.

• Support for Rack v3.0: Rack::Builder#new accepting a block

  Via rack/rack#1942 (released with Rack v3.0), Rack::Builder#run now optionally accepts a block instead of an app argument. The agent's instrumentation has been updated to support the use of a block with Rack::Builder#run. PR#1600

• Bugfix: Correctly identify Unicorn, Rainbows and FastCGI with Rack v3.0

  Unicorn, Rainbows, or FastCGI web applications using Rack v3.0 may previously have had the "dispatcher" value incorrectly reported as "Webrick" instead of "Unicorn", "Rainbows", or "FastCGI". This issue has now been addressed. PR#1585

• Bugfix: add_method_tracer fails to record code level metric attributes on private methods

  When using add_method_tracer on a private method, the agent was unable to record code level metrics for the method. This resulted in the following being logged to the newrelic_agent.log file.

  WARN : Unable to determine source code info for 'Example', method 'private_method' - NameError: undefined method 'private_method' for class '#<Class:Example\>'

  카피

  Thank you @jdelStrother for bringing this issue to our attention and suggesting a fix! PR#1593

• Bugfix: Category is a required keyword arg for NewRelic::Agent::Tracer.in_transaction

  When support for Ruby 2.0 was dropped in version 8.0.0 of the agent, the agent API methods were updated to use the required keyword argument feature built into Ruby, rather than manually raising ArgumentErrors. The API method NewRelic::Agent::Tracer.in_transaction removed the ArgumentError raised by the agent, but did not update the method arguments to identify :category as a required keyword argument. This is now resolved. Thank you @tatzsuzuki for bringing this to our attention. PR#1587

Support statement

New Relic recommends that you upgrade the Ruby agent regularly and at a minimum of every 3 months. As of this release, the oldest supported version is 6.8.0.359.

v8.12.0

Version 8.12.0 of the Ruby agent delivers new Elasticsearch instrumentation. Version 8.12.0 of the Ruby agent also increases the default number of recorded custom events, announces the deprecation of Ruby 2.3, and brings some valuable code cleanup.

• Support for Elasticsearch instrumentation

  This release of the Ruby agent adds support to automatically instrument the elasticsearch gem. Versions 7.x and 8.x are supported. PR#1525

  Configuration name	Default	Behavior
  instrumentation.elasticsearch	auto	Controls auto-instrumentation of the elasticsearch library at start up. May be one of auto, prepend, chain, disabled.
  elasticsearch.capture_queries	true	If true, the agent captures Elasticsearch queries in transaction traces.
  elasticsearch.obfuscate_queries	true	If true, the agent obfuscates Elasticsearch queries in transaction traces.

• Custom Event Limit Increase

  This version of the Ruby agent increases the default limit of custom events from 1000 events per minute to 3000 events per minute. If your custom events were being limited, this change will allow more custom events to be sent to New Relic. There is also a new configurable maximum limit of 100,000 events per minute. To change the limits, see the documentation for max_samples_stored. To learn more about the change and how to determine if custom events are being dropped, see our Explorers Hub post. PR#1541

• Deprecate support for Ruby 2.3

  Ruby 2.3 reached end of life on March 31, 2019. The Ruby agent has deprecated support for Ruby 2.3 and will make breaking changes for this version in its next major release, v9.0.0 (release date not yet planned). All 8.x.x versions of the agent will remain compatible with Ruby 2.3.

• Cleanup: Remove orphaned code

  In both the agent and unit tests, changes have taken place over the years that have left certain bits of code unreachable. This orphaned code can complicate code maintenance and refactoring, so getting it squared away can be very helpful. Commmuniy member @ohbarye contributed two separate cleanup PRs for this release; one for the agent and one for the tests. PR#1537 PR#1548

  Thank you to @ohbarye for contributing this helpful cleanup!

Support statement

New Relic recommends that you upgrade the Ruby agent regularly and at a minimum of every 3 months. As of this release, the oldest supported version is 6.7.0.359.

v8.11.0

Version 8.11.0 of the agent updates the newrelic deployments command to work with API keys issued to newer accounts, fixes a memory leak in the instrumentation of Curb error handling, further preps for Ruby 3.2.0 support, and includes several community member driven cleanup and improvement efforts. Thank you to everyone involved!

• Added support for New Relic REST API v2 when using newrelic deployments command

  Previously, the newrelic deployments command only supported the older version of the deployments api, which does not currently support newer license keys. Now you can use the New Relic REST API v2 to record deployments by providing your user API key to the agent configuration using api_key. When this configuration option is present, the newrelic deployments command will automatically use the New Relic REST API v2 deployment endpoint. PR#1461

  Thank you to @Arkham for bringing this to our attention!

• Cleanup: Performance tests, constants, rubocop-minitest assertions and refutations

  Community member @esquith contributed a whole slew of cleanup successes for our performance test configuration, orphaned constants in our code base, and RuboCop related improvements. PR#1406 PR#1408 PR#1409 PR#1411

  Thank you @esquith for these great contributions!

• CI: Notify on a change from failure to success

  A super handy, much beloved feature of certain CI and build systems is to not only notify when builds start to fail, but also to notify again when the builds once again start to go green. Community member @luigieai was able to figure out how to configure our existing complex, multiple-3rd-party-action based GitHub Actions pipeline to notify on a switch back to success from failure. PR#1519

  This is much appreciated! Thank you, @luigieai.

• Spelling corrections

  Community member @jsoref, author of the Check Spelling GitHub Action, contributed a significant number of spelling corrections throughout the code base. The intelligent issues that were flagged made for a more comprehensive review than a simple dictionary based check would have been able to provide, and the changes are much appreciated. PR#1508

  Thank you very much, @jsoref!

• Ruby 3.2.0-preview2 compatibility

  Ruby 3.2.0-preview1 introduced a change to the way that Ruby reports VM stats and the approach was changed yet again to a 3rd approach with the preview2 release. New Relic reports on Ruby VM stats and is keeping track of the Ruby 3.2 development process to help ensure our customers with a smooth and worthwhile upgrade process once Ruby 3.2.0 (non-preview) is released. PR#1436

• Bugfix: Fix memory leak in the Curb instrumentation

  Community member @charkost was able to rework the on_failure callback logic prepped via the agent's Curb instrumentation in order to avoid some nesting that was causing memory leaks. PR#1518

  Many thanks for both the heads up on the issue and the fix, @charkost!

Support statement

New Relic recommends that you upgrade the agent regularly and at a minimum every 3 months. As of this release, the oldest supported version is 6.7.0.359.

v8.10.1

• Bugfix: Missing unscoped metrics when instrumentation.thread.tracing is enabled

  Previously, when instrumentation.thread.tracing was set to true, some puma applications encountered a bug where a varying number of unscoped metrics would be missing. The agent now will correctly store and send all unscoped metrics.

  Thank you to @texpert for providing details of their situation to help resolve the issue.

• Bugfix: gRPC instrumentation causes ArgumentError when other Google gems are present

  Previously, when the agent had gRPC instrumentation enabled in an application using other gems (such as google-ads-googleads), the instrumentation could cause the error ArgumentError: wrong number of arguments (given 3, expected 2). The gRPC instrumentation has been updated to prevent this issue from occurring in the future.

  Thank you to @FeminismIsAwesome for bringing this issue to our attention.

Support statement

New Relic recommends that you upgrade the agent regularly and at a minimum every 3 months. As of this release, the oldest supported version is 6.5.0.357.

v8.10.0

• New gRPC instrumentation

  The agent will now instrument gRPC activity performed by clients and servers that use the grpc RubyGem. Instrumentation is automatic and enabled by default, so gRPC users should not need to modify any existing application code or agent configuration to benefit from the instrumentation. The instrumentation makes use of distributed tracing for a comprehensive overview of all gRPC traffic taking place across multiple monitored applications. This allows you to observe your client and server activity using any service that adheres to the W3C standard.

  The following new configuration parameters have been added for gRPC. All are optional.

  Configuration name	Default	Behavior
  instrumentation.grpc_client	auto	Set to 'disabled' to disable, set to 'chain' if there are module prepending conflicts
  instrumentation.grpc_server	auto	Set to 'disabled' to disable, set to 'chain' if there are module prepending conflicts
  instrumentation.grpc.host_denylist	""	Provide a comma delimited list of host regex patterns (ex: "private.com$,exception.*")

• Code-level metrics functionality is enabled by default

  The code-level metrics functionality for the Ruby agent's CodeStream integration is now enabled by default after we have received positive feedback and no open bugs for the past two releases.

• Performance: Rework timing range overlap calculations for multiple transaction segments

  Many thanks to GitHub community members @bmulholland and @hkdnet. @bmulholland alerted us to rmosolgo/graphql-ruby#3945. That Issue essentially notes that the New Relic Ruby agent incurs a significant perfomance hit when the graphql RubyGem (which ships with New Relic Ruby agent support) is used with DataLoader to generate a high number of transactions. Then @hkdnet diagnosed the root cause in the Ruby agent and put together both a proof of concept fix and a full blown PR to resolve the problem. The agent keeps track multiple segments that are concurrently in play for a given transaction in order to merge the ones whose start and stop times intersect. The logic for doing this find-and-merge operation has been reworked to a) be deferred entirely until the transaction is ready to be recorded, and b) made more performant when it is needed. GraphQL DataLoader users and other users who generate lots of activity for monitoring within a short amount of time will hopefully see some good performance gains from these changes.

• Performance: Make frozen string literals the default for the agent

  The Ruby frozen_string_literal: true magic source code comment has now been applied consistently across all Ruby files belonging to the agent. This can provide a performance boost, given that Ruby can rely on the strings remaining immutable. Previously only about a third of the agent's code was freezing string literals by default. Now that 100% of the code freezes string literals by default, we have internally observed some related performance gains through testing. We are hopeful that these will translate into some real world gains in production capacities.

• Bugfix: Error when setting the yaml configuration with transaction_tracer.transaction_threshold: apdex_f

  Originally, the agent was only checking the transaction_tracer.transaction_threshold from the newrelic.yml correctly if it was on two lines.

  Example:

  # newrelic.yml
  transaction_tracer:
    transaction_threshold: apdex_f

  카피

  When this was instead changed to be on one line, the agent was not able to correctly identify the value of apdex_f.

  Example:

  # newrelic.yml
  transaction_tracer.transaction_threshold: apdex_f

  카피

  This would cause prevent transactions from finishing due to the error ArgumentError: comparison of Float with String failed. This has now been corrected and the agent is able to process newrelic.yml with a one line transaction_tracer.transaction_threshold: apdex_f correctly now.

  Thank you to @oboxodo for bringing this to our attention.

• Bugfix: Don't modify frozen Logger

  Previously the agent would modify each instance of the Logger class by adding a unique instance variable as part of the instrumentation. This could cause the error FrozenError: can't modify frozen Logger to be thrown if the Logger instance had been frozen. The agent will now check if the object is frozen before attempting to modify the object. Thanks to @mkcosta for bringing this issue to our attention.

Support statement

New Relic recommends that you upgrade the agent regularly and at a minimum every 3 months. As of this release, the oldest supported version is 6.5.0.357.

v8.9.0

• Add support for Dalli 3.1.0 to Dalli 3.2.2

  Dalli versions 3.1.0 and above include breaking changes where the agent previously hooked into the gem. We have updated our instrumentation to correctly hook into Dalli 3.1.0 and above. At this time, 3.2.2 is the latest Dalli version and is confirmed to be supported.

• Bugfix: Infinite Tracing hung on connection restart

  Previously, when using infinite tracing, the agent would intermittently encounter a deadlock when attempting to restart the infinite tracing connection. This bug would prevent the agent from sending all data types, including non-infinite-tracing-related data. This change reworks how we restart Infinite Tracing to prevent potential deadlocks.

• Bugfix: Use read_nonblock instead of read on pipe

  Previously, our PipeChannelManager was using read which could cause resque jobs to get stuck in some versions. This change updates the PipeChannelManager to use read_nonblock instead to avoid this issue.

Support statement

New Relic recommends that you upgrade the agent regularly and at a minimum every 3 months. As of this release, the oldest supported version is 6.5.0.357.

v8.8.0

• Support Makara database adapters with ActiveRecord

  Thanks to a community submission from lucasklaassen with PR #1177, the Ruby agent will now correctly work well with the Makara gem. Functionality such as SQL obfuscation should now work when Makara database adapters are used with Active Record.

• Lowered the minimum payload size to compress

  Previously the Ruby agent used a particularly large payload size threshold of 64KiB that would need to be met before the agent would compress data en route to New Relic's collector. The original value stems from segfault issues that very old Rubies (older than 2.2) used to encounter when compressing smaller payloads. This value has been lowered to 2KiB (2048 bytes), which should provide a more optimal balance between the CPU cycles spent on compression and the bandwidth savings gained from it.

• Provide Code Level Metrics for New Relic CodeStream

  For Ruby on Rails applications and/or those with manually traced methods, the agent is now capable of reporting metrics with Ruby method-level granularity. When the new code_level_metrics.enabled configuration parameter is set to a true value, the agent will associate source-code-related metadata with the metrics for things such as Rails controller methods. Then, when the corresponding Ruby class file that defines the methods is loaded up in a New Relic CodeStream-powered IDE, the four golden signals for each method will be presented to the developer directly.

• Supportability Metrics will always report uncompressed payload size

  New Relic's agent specifications call for Supportability Metrics to always reference the uncompressed payload byte size. Previously, the Ruby agent was calculating the byte size after compression. Furthermore, compression is only performed on payloads of a certain size. This means that sometimes the value could have represented a compressed size and sometimes an uncompressed one. Now the uncompressed value is always used, bringing consistency for comparing two instances of the same metric and alignment with the New Relic agent specifications.

Support statement

New Relic recommends that you upgrade the agent regularly and at a minimum every 3 months. As of this release, the oldest supported version is 6.5.0.357.

v8.7.0

• APM logs-in-context log forwarding on by default

  Automatic application log forwarding is now enabled by default. This version of the agent will automatically send enriched application logs to New Relic. To learn more about about this feature see here, and additional configuration options are available here. To learn about how to toggle log ingestion on or off by account see here.

• Improved async support and Thread instrumentation

  Previously, the agent was not able to record events and metrics inside Threads created inside of an already running transaction. This release includes 2 new configuration options to support multithreaded applications to automatically instrument threads. A new configuration option,instrumentation.thread.tracing (disabled by default), has been introduced that, when enabled, will allow the agent to insert New Relic tracing inside of all Threads created by an application. To support applications that only want some threads instrumented by New Relic, a new class is available, NewRelic::TracedThread, that will create a thread that includes New Relic instrumentation, see our API documentation for more details.

  New configuration options included in this release:

  Configuration name	Default	Behavior
  instrumentation.thread	auto (enabled)	Allows the agent to correctly nest spans inside of an asyncronous transaction.
  instrumentation.thread.tracing	false (disabled)	Automatically add tracing to all Threads created in the application. This may be enabled by default in a future release.

  We'd like to thank @mikeantonelli for sharing a gist with us that provided our team with an entry point for this feature.

• Deprecate support for Ruby 2.2

  Ruby 2.2 reached end of life on March 31, 2018. The agent has deprecated support for Ruby 2.2 and will make breaking changes for this version in its next major release.

• Added updated configuration options for transaction events and deprecated previous configs

  This release deprecates the following instrumentation:

  Deprecated	Replacement
  ActiveMerchant 1.64.0 or lower	ActiveMerchant 1.65.0 or higher
  ActiveRecord 3.2.22.5 or lower	ActiveRecord 4.0.0 or higher
  Acts As Solr (all versions)	none
  Authlogic (all versions)	none
  Bunny 2.6.7 or lower	Bunny 2.7.0 or higher
  Dalli 2.7.6 or lower	Dalli 2.7.7 or higher
  DataMapper (all versions)	none
  Delayed Job 4.1.2 or lower	Delayed Job 4.1.3 or higher
  Excon 0.55.0 or lower	Excon 0.56.0 or higher
  Grape 0.19.1 or lower	Grape 0.19.2 or higher
  HTTPClient 2.8.2.4 or lower	HTTPClient 2.8.3
  HTTP.rb 2.2.1 or lower	HTTP.rb 2.2.2 or higher
  Mongo 2.4.0 or lower	Mongo 2.4.1 or higher
  Padrino 0.14.4 or lower	Padrino 0.15.0 or higher
  Passenger 5.1.2 or lower	Passenger 5.1.3 or higher
  Puma 3.8.2 or lower	Puma 3.9.0 or higher
  Rack 1.6.7 or lower	Rack 1.6.8 or higher
  Rails 3.2.22.5 or lower	Rails 4.0.0 or higher
  Rainbows (all versions)	none
  Sequel 4.44.0 or lower	Sequel 4.45.0 or higher
  Sidekiq 4.2.10 or lower	Sidekiq 5.0.0 or higher
  Sinatra 1.4.8 or lower	Sinatra 2.0.0 or higher
  Sunspot (all versions)	none
  Typhoeus 1.1.2 or lower	Typhoeus 1.3.0 or higher
  Unicorn 5.2.0 or lower	Unicorn 5.3.0 or higher

  For the gems with deprecated versions, we will no longer test those versions in our multiverse suite. They may, however, still be compatible with the agent. We will no longer fix bug reports for issues with these versions of the gem.

• Internally leverage Object.const_get and Object.const_defined?

  When dynamically checking for or obtaining a handle to a class constant from a string, leverage the Object class's built in methods wherever possible to enjoy simpler, more performant operations. All JRubies and CRubies v2.5 and below need a bit of assistance beyond what Object can provide given that those Rubies may yield an unwanted constant from a different namespace than the one that was specified. But for all other Rubies and even for those Rubies in contexts where we can 100% trust the string value coming in, leverage the Object class's methods and reap the benefits.

• Clarify documentation for rake.tasks configuration

  The rake.tasks description in the default newrelic.yml file and the New Relic Ruby Agent Configuration docs have been updated to clarify its behavior and usage. The documentation now reads:

  Specify an array of Rake tasks to automatically instrument. This configuration option converts the Array to a RegEx list. If you'd like to allow all tasks by default, use rake.tasks: [.+]. Rake tasks will not be instrumented unless they're added to this list. For more information, visit the (New Relic Rake Instrumentation docs)[/docs/apm/agents/ruby-agent/background-jobs/rake-instrumentation].

  We thank @robotfelix for suggesting these changes.

• Enable Environment Variables setting Array configurations to be converted to Arrays

  Prior to this change, when comma-separated lists were passed as environment variables, an error would be emitted to the newrelic_agent.log and a String would be set as the value. Now, Arrays will be accurately coerced.

• Bugfix: Allow TransactionEvents to be sampled at the expected rate

  The transaction_events.max_samples_stored capacity value within the TransactionEventAggregator did not match up with its expected harvest cycle interval, causing TransactionEvents to be over-sampled. This bugfix builds upon the updates made in #952 so that the interval and capacity behave as expected for the renamed transaction_events* configuration options.

• Bugfix: Error events missing attributes when created outside of a transaction

  Previously the agent was not assigning a priority to error events that were created by calling notice_error outside the scope of a transaction. This caused issues with sampling when the error event buffer was full, resulting in a NoMethodError: undefined method '<' for nil:NilClass in the newrelic_agent.log. This bugfix ensures that a priority is always assigned on error events so that the agent will be able to sample these error events correctly. Thank you to @olleolleolle for bringing this issue to our attention.

Support statement

New Relic recommends that you upgrade the agent regularly and at a minimum every 3 months. As of this release, the oldest supported version is 5.7.0.350.

v8.6.0

• Telemetry-in-Context: Automatic Application Logs, a quick way to view logs no matter where you are in the platform

  • Adds support for forwarding application logs to New Relic. This automatically sends application logs that have been enriched to power Telemetry-in-Context. This is disabled by default in this release. This may be on by default in a future release.
  • Adds support for enriching application logs written to disk or standard out. This can be used with another log forwarder to power Telemetry-in-Context if in-agent log forwarding is not desired. We recommend enabling either log forwarding or local log decorating, but not both features. This is disabled by default in this release.
  • Improves speed and Resque support for logging metrics which shows the rate of log message by severity in the Logs chart in the APM Summary view. This is enabled by default in this release.

  To learn more about Telemetry-in-Context and the configuration options please see the documentation here.

• Bugfix: Curb - satify method_with_tracing's verb argument requirement

  When Curb instrumentation is used (either via prepend or chain), be sure to always pass the verb argument over to method_with_tracing which requires it. Thank you to @knarewski for bringing this issue to our attention, for providing a means of reproducing an error, and for providing a fix. That fix has been replicated by the agent team with permission. See Issue 1033 for more details.

• Improve the usage of the 'hostname' executable and other executables

  In all places where a call to an executable binary is made (currently this is done only for the 'hostname' and 'uname' binaries), leverage a new helper method when making the call. This new helper will a) not attempt to execute the binary if it cannot be found, and b) prevent STDERR/STDOUT content from appearing anywhere except New Relic's own logs if the New Relic logger is set to the 'debug' level. When calling 'hostname', fall back to Socket.gethostname if the 'hostname' binary cannot be found. When calling 'uname', fall back on using a value of 'unknown' if the 'uname' command fails. Many thanks to @metaskills and @brcarp for letting us know that Ruby AWS Lambda functions can't invoke 'hostname' and for providing ideas and feedback with Issue #697.

• Documentation: remove confusing duplicate RUM entry from newrelic.yml

  The browser_monitoring.auto_instrument configuration option to enable web page load timing (RUM) was confusingly listed twice in the newrelic.yml config file. This option is enabled by default. The newrelic.yml file has been updated to list the option only once. Many thanks to @robotfelix for bringing this to our attention with Issue #955.

• Bugfix: fix unit test failures when New Relic environment variables are present

  Previously, unit tests would fail with unexpected invocation errors when NEW_RELIC_LICENSE_KEY and NEW_RELIC_HOST environment variables were present. Now, tests will discard these environment variables before running.

Support statement

New Relic recommends that you upgrade the agent regularly and at a minimum every 3 months. As of this release, the oldest supported version is 6.3.0.355.