• EnglishEspañol日本語한국어Português
  • 로그인지금 시작하기

Ruby agent release notesRSS

August 16, 2023
Ruby agent v9.4.1

중요

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

Version 9.4.1 of the agent resolves a NoMethodError introduced in 9.4.0.

August 15, 2023
Ruby agent v9.4.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.4.0

Version 9.4.0 of the agent adds Roda instrumentation, adds a new allow_all_headers configuration option to permit capturing all HTTP headers, introduces improved error tracking functionality by associating a transaction id with each error, and uses more reliable network timeout logic.

  • Feature: Add Roda instrumentation

    Roda is a now an instrumented framework. The agent currently supports Roda versions 3.19.0+. PR#2144

  • Feature: New allow_all_headers configuration option

    A new allow_all_headers configuration option brings parity with the Node.js agent to capture all HTTP request headers.

    This configuration option:

    • Defaults to false
    • Is not compatible with high-security mode
    • Requires Rack version 2 or higher (as does Ruby on Rails version 5 and above)
    • Respects all existing behavior for the attributes.include and attributes.exclude configuration options
    • Captures the additional headers as attributes prefixed with request.headers.

    This work was done in response to a feature request submitted by community member @jamesarosen. Thank you very much, @jamesarosen! Issue#1029

  • Feature: Improved error tracking transaction linking

    Errors tracked and sent to the New Relic errors inbox will now be associated with a transaction id to enable improved UI/UX associations between transactions and errors. PR#2035

  • Feature: Use Net::HTTP native timeout logic

    In line with current Ruby best practices, make use of Net::HTTP's own timeout logic and avoid the use of Timeout.timeout() when possible. The agent's data transmissions and cloud provider detection routines have been updated accordingly. PR#2147

July 11, 2023
Ruby agent v9.3.1

중요

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

Version 9.3.1 of the agent fixes NewRelic::Agent.require_test_helper.

  • Bugfix: Fix NewRelic::Agent.require_test_helper

    Version 9.3.0 of the agent made a change to the files distributed with the gem. This change unintentionally broke the NewRelic::Agent.require_test_helper API by removing the test/agent_helper.rb file. The file has been added back to the gem. This change also removes the lib/new_relic/build.rb file from the list because it is no longer created with our current release process.

    Our thanks go to @ajesler for reporting this issue and writing a test for the bug. Issue#2113, PR#2115, Issue#2117, PR#2118

  • Source Documentation: update the Rack spec URL

    Community member @olleolleolle noticed that our source code was referencing a now defunct URL for the Rack specification and submitted PR#2121 to update it. He also provided a terrific recommendation that we automate the checking of links to proactively catch defunct ones in future. Thanks, @olleolleolle!

June 26, 2023
Ruby agent v9.3.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.3.0

Version 9.3.0 of the agent adds log-level filtering, adds custom attributes for log events, and updates instrumentation for Action Cable. It also provides fixes for how Fiber args are treated, Code-Level Metrics, unnecessary files being included in the gem, and NewRelic::Agent::Logging::DecoratingFormatter#clear_tags! being incorrectly private.

  • Feature: Filter forwarded logs based on level

    Previously, all log events, regardless of their level, were forwarded to New Relic when log forwarding was enabled. Now, you may specify the lowest log level you'd like forwarded to New Relic.

    Configuration nameDefaultBehaviorValid values
    application_logging.forwarding.log_leveldebugSets the minimum log level for events forwarded to New Relicdebug, info, warn, error, fatal, unknown

    This setting uses Ruby's Logger::Severity constants integer values to determine precedence.

  • Feature: Custom attributes for logs

    You can now add custom attributes to log events forwarded to New Relic! You can pass these attributes using an API and/or a configuration option.

    Configuration nameDefaultBehavior
    application_logging.forwarding.custom_attributes{}A hash with key/value pairs to add as custom attributes to all log events forwarded to New Relic. If sending using an environment variable, the value must be formatted like: "key1=value1,key2=value2"

Call the API using NewRelic::Agent.add_custom_log_attributes and passing your attributes as a hash. For example, you could call: NewRelic::Agent.add_custom_log_attributes(dyno: ENV['DYNO'], pod_name: ENV['POD_NAME']), to add the attributes dyno and pod_name to your log events.

Attributes passed to the API or the configuration will be added to all log events.

Thanks to @rajpawar02 for raising this issue and @askreet for helping us with the solution. Issue#1141, PR#2084, PR#2087

  • Feature: Instrument transmit_subscription-related Action Cable actions

    This change subscribes the agent to the Active Support notifications for:

    • transmit_subscription_confirmation.action_cable
    • transmit_subscription_rejection.action_cable
  • Bugfix: Removed unwanted files from being included in file_list in gemspec

    Previously, the agent was including some files in the gem that were not needed but added to the size of the gem. These files will no longer be included. Thanks to @manuraj17 for the contribution! PR#2089

  • Bugfix: Report Code-Level Metrics for Rails controller methods

    Controllers in Rails automatically render views with names that correspond to valid routes. This means that a controller method may not have a corresponding method in the controller class. Code-Level Metrics now report on these methods and don't log false warnings. Thanks to @jcrisp for reporting this issue. PR#2061

  • Bugfix: Code-Level Metrics for ActiveRecord models

    Classes that inherit from ActiveRecord were not reporting Code-Level Metrics due to an error in the agent when identifying the class name. This has been fixed and Code-Level Metrics will now report for ActiveRecord models. Thanks to @abigail-rolling for reporting this issue. PR#2092.

  • Bugfix: Private method clear_tags! for NewRelic::Agent::Logging::DecoratingFormatter

    As part of a refactor included in a previous release of the agent, the method NewRelic::Agent::Logging::DecoratingFormatter#clear_tags! was incorrectly made private. This method is now public again. Thanks to @dark-panda for reporting this issue. PR#

  • Bugfix: Fix the way args are handled for Fibers

    Previously, the agent treated Fiber args the same as it was treating Thread args, which is not correct. Args are passed to Fiber#resume, and not Fiber.new. This has been fixed, and the agent will properly preserve args for both Fiber and Thread classes. This also caused an error to occur when using Async 2.6.2, due to mismatching initalize definitions for Fiber prepended modules. This has been fixed as well. Thanks to @travisbell for bringing this to our attention. PR#2083

May 1, 2023
Ruby agent v9.2.2

중요

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

Version 9.2.2 of the agent fixes a bug with the Transaction#finished? method.

  • Bugfix: Transaction#finished? no longer throws a NoMethodError when initial_segment is nil

    This change adds a safe navigation operator to Transaction#finished? to prevent NoMethodErrors when a transaction does not have any segments. Our thanks goes to @JulienDefrance for reporting this issue. PR#1983

Ruby agent v9.2.1

중요

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

Version 9.2.1 fixes a bug causing the agent to continue storing data on finished transactions, and a bug preventing errors from being expected.

  • Bugfix: Finished transactions continue to store data on different threads

    Previously, when a new thread was spawned the agent would continue using the current transaction to record data on, even if this transaction had finished already in a different thread. Now the agent will only use the current transaction in the new thread if it is not yet finished. Thank you to @fcheung for reporting this bug and providing us with an extremely helpful reproduction to debug. PR#1969

  • Bugfix: Expected Errors passed to notice_error are expected again

    A bug was introduced in 9.1.0 that caused to agent not to mark errors as expected if the error was passed in to notice_error using the expected: true parameter. This has been fixed and errors will now be marked as expected, as expected. Thank you very much to @eiskrenkov for finding this bug and contributing a fix for it! PR#1954

April 17, 2023
Ruby agent v9.2.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.2.0

Version 9.2.0 of the agent introduces some performance improvements for working with high numbers of nested actions, and deprecates instrumentation for the memcached and memcache-client gems (with dalli still being supported).

  • Feature: Enhance performance for handling high numbers of nested actions

    With Issue#1910, community members @parkerfinch and @travisbell informed us of some CPU spikes and process hangs seen only when using the agent's thread instrumentation, which was enabled by default with v9.0. When thread instrumentation is enabled, instrumented actions taking place within threads are seen and reported on by the agent whereas they would have previously gone unnoticed. This is a great improvement to the agent's usefulness in an async context, and also makes it easier for higher numbers of nested actions to be observed. For example, if an instrumented background job framework (Sidekiq, Resque) kicks off a job that the agent notices and then that job in turn performs actions such as database queries that the agent also instruments, nested actions are seen. However, with very high (10,000+) numbers of actions nested within a single instrumented outer action, the agent would struggle to efficiently crunch through all of the collected data at the time when the outer action finished. The agent should now be much more efficient when any observed action with lots of nested actions is finished. Our performance testing was conducted with hundreds of thousands of nested actions taking place, and we hope that the benefits of thread tracing can now be enjoyed without any drawbacks. Thanks very much @parkerfinch and @travisbell! PR#1927

  • Feature: Deprecate memcached and memcache-client instrumentation

    Instrumentation for the memcached and memcache-client libraries is deprecated and will be removed during the next major release.

March 29, 2023
Ruby agent v9.1.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 at most 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.1.0

Version 9.1.0 of the agent delivers support for two new errors inbox features: error fingerprinting and user tracking, identifies the Amazon Timestream data store, removes Distributed Tracing warnings from agent logs when using Sidekiq, fixes bugs, and is tested against the recently released JRuby 9.4.2.0.

  • Feature: Error fingerprinting - supply your own errors inbox group names

    Are your error occurrences grouped poorly? Set your own error fingerprint via a callback function. A new set_error_group_callback public API method has been added that will accept a user defined proc. The proc will be invoked for each noticed error and whenever it returns a string, that string will be used as the error group name for the error and will take precedence over any server-side grouping that takes place with the New Relic errors inbox. This gives users much greater control over the grouping of their errors.

    The customer defined proc will be expected to receive exactly one input argument, a hash. The hash contains the following:

    KeyValue
    :errorThe Ruby error class instance. Offers #class, #message, and #backtrace
    :customAttributesAny customer defined custom attributes for the current transaction
    :'request.uri'The current request URI if available
    :'http.statusCode'The HTTP status code (200, 404, etc.) if available
    :'http.method'The HTTP method (GET, PUT, etc.) if available
    :'error.expected'Whether (true) or not (false) the error was expected
    :'options'The options hash passed to NewRelic::Agent.notice_error

    The callback only needs to be set once per initialization of the New Relic agent.

    Example usage:

    proc = proc { |hash| "Access" if hash[:'http.statusCode'] == 401 }
    NewRelic::Agent.set_error_group_callback(proc)
  • Feature: User tracking - associate errors with a user id

    You can now see the number of users impacted by an error group. Identify the end user with a new set_user_id public API method that will accept a string representation of a user id and associate that user id with the current transaction. Transactions and errors will then have a new enduser.id agent attribute associated with them. This will allow agent users to tag transactions and errors as belonging to given user ids in support of greater filtering and alerting capabilities.

  • Identify Amazon Timestream when the amazon_timestream AR adapter is used

    When the agent sees the activerecord-amazon-timestream-adapter gem being used, it will now identify the data store as "Timestream". Thanks very much to @wagner for contributing this enhancement! PR#1872

  • Bugfix: Remove Distributed Tracing related warnings from agent logs when headers are not present in Sidekiq

    Previously, the agent would log a warning to newrelic_agent.log every time it attempted to accept empty Distributed Tracing headers from Sidekiq jobs which could result in an excessive number of warnings. Now the agent will no longer create these warnings when using Sidekiq. PR#1834

  • Bugfix: Log request headers in debug-level logs instead of human-readable Objects

    Previously, the agent sometimes received children of the NewRelic::Agent::HTTPClients::AbstractRequest class as an argument when NewRelic::Agent::Transaction::DistributedTracers#log_request_headers was called. This caused debug-level log messages that print the request headers to show human-readable Objects (ex. #<NewRelic::Agent::HTTPClients::HTTPClientRequest:0x00007fd0dda983e0>) instead of the request headers. Now, the hash of the request headers should always be logged. PR#1839

  • Bugfix: Fix undefined method controller_path logged in Action Controller Instrumentation

    Previously, the agent could log an error when trying to determine the metric name in the Action Controller instrumentation if the controller class did not respond to controller_path. This has been resolved and the agent will no longer call this method unless the class responds to it. Thank you to @gsar for letting us know about this issue. PR#1844

  • Bugfix: Fix Transaction#finish exception and decrease log level for related warning during async transactions

    Previously, the agent would raise a non-fatal error when a segment without a parent was unfinished when the transaction completed. This error was raised while constructing a warn-level log message. Now that Thread instrumentation is on by default, this log message emits more frequently and is less concerning. In cases where we see a Thread, Fiber, or concurrent-ruby segment in a transaction, the message will be degraded to a debug-level. Thanks to @NielsKSchjoedt for creating the issue and @boomer196 for testing solutions. PR#1876

  • CI: Target JRuby 9.4.2.0

    The agent is now actively being tested against JRuby 9.4.2.0. NOTE that this release does not contain any non-CI related changes for JRuby. Old agent versions are still expected to work with newer JRubies and the newest agent version is still expected to work with older JRubies.

February 21, 2023
Ruby agent v9.0.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 at most 90 days old. Read more about keeping agent up to date.

As of this release, the oldest supported version is 6.10.0

v9.0.0

Version 9.0.0 of the agent removes several deprecated configuration options and API methods, enables Thread tracing by default, adds Fiber instrumentation, removes support for Ruby versions 2.2 and 2.3, removes instrumentation for several deprecated gems, changes how the API method set_transaction_name works, and updates rails_defer_initialization to be an environment variable only configuration option.

  • Remove deprecated configuration options

    The following configuration options have been removed and will no longer work. Please update all configs to use the replacements listed below. PR#1782

Removed

Replacement

newrelic.yml example

analytics_events.capture_attributes

transaction_events.attributes.enabled

transaction_events.attributes.enabled: false

browser_monitoring.capture_attributes

browser_monitoring.attributes.enabled

browser_monitoring.attributes.enabled: false

error_collector.capture_attributes

error_collector.attributes.enabled

error_collector.attributes.enabled: false

resque.capture_params

attributes.include

attributes.include: [&#39;job.resque.args.*&#39;]

sidekiq.capture_params

attributes.include

attributes.include: [&#39;job.sidekiq.args.*&#39;]

transaction_tracer.capture_attributes

transaction_tracer.attributes.enabled

transaction_tracer.attributes.enabled: false

error_collector.ignore_errors

error_collector.ignore_classes

error_collector.ignore_classes: [&#39;ActionController::RoutingError&#39;, &#39;CustomError&#39;]

analytics_events.enabled

transaction_events.enabled

transaction_events.enabled: false

analytics_events.max_samples_stored

transaction_events.max_samples_stored

transaction_events.max_samples_stored: 1200

disable_database_instrumentation

disable_sequel_instrumentation

disable_sequel_instrumentation: true

disable_bunny

instrumentation.bunny

instrumentation.bunny: disabled

disable_curb

instrumentation.curb

instrumentation.curb: disabled

disable_dj

instrumentation.delayed_job

instrumentation.delayed_job: disabled

disable_excon

instrumentation.excon

instrumentation.excon: disabled

disable_grape

instrumentation.grape

instrumentation.grape: disabled

disable_grape_instrumentation

instrumentation.grape

instrumentation.grape: disabled

disable_httpclient

instrumentation.httpclient

instrumentation.httpcient: disabled

disable_httprb

instrumentation.httprb

instrumentation.httprb: disabled

disable_dalli

instrumentation.memcache

instrumentation.memcache: disabled

disable_dalli_cas_client

instrumentation.memcache

instrumentation.memcache: disabled

disable_memcache_client

instrumentation.memcache-client

instrumentation.memcache-client: disabled

disable_memcache_instrumentation

instrumentation.memcache

instrumentation.memcache: disabled

disable_memcached

instrumentation.memcached

instrumentation.memcached: disabled

disable_mongo

instrumentation.mongo

instrumentation.mongo: disabled

disable_net_http

instrumentation.net_http

instrumentation.net_http: disabled

prepend_net_instrumentation

instrumentation.net_http

instrumentation.net_http: prepend

disable_puma_rack

instrumentation.puma_rack

instrumentation.puma_rack: disabled

disable_puma_rack_urlmap

instrumentation.puma_rack_urlmap

instrumentation.puma_rack_urlmap: disabled

disable_rack

instrumentation.rack

instrumentation.rack: disabled

disable_rack_urlmap

instrumentation.rack_urlmap

instrumentation.rack_urlmap: disabled

disable_redis

instrumentation.redis

instrumentation.redis: disabled

disable_redis_instrumentation

instrumentation.redis

instrumentation.redis: disabled

disable_resque

instrumentation.resque

instrumentation.resque: disabled

disable_sinatra

instrumentation.sinatra

instrumentation.sinatra: disabled

disable_rake

instrumentation.rake

instrumentation.rake: disabled

disable_rake_instrumentation

instrumentation.rake

instrumentation.rake: disabled

disable_typhoeus

instrumentation.typhoeus

instrumentation.typhoeus: disabled

  • Enable Thread instrumentation by default

    The configuration option instrumentation.thread.tracing is now enabled by default. This configuration allows the agent to properly monitor code occurring inside threads. In Ruby agent 9.0, instrumented code within threads will be recorded and associated with the current transaction when the thread was created.

    This may be a breaking change if you are currently using custom thread instrumentation. New transactions inside of threads will no longer be started if one already exists. PR#1767

  • Add Fiber instrumentation

    Fiber instances are now automatically instrumented similarly to Thread instances. This can be configured using instrumentation.fiber. PR#1802

  • Removed support for Ruby 2.2 and 2.3

    Ruby 2.2 and 2.3 are no longer supported by the Ruby agent. To continue using the latest Ruby Agent version, please update to Ruby 2.4.0 or above. PR#1778

  • Removed deprecated instrumentation

    Instrumentation for the following gems had been previously deprecated and has now been removed. PR#1788

    • Acts As Solr
    • Authlogic
    • DataMapper
    • Rainbows
    • Sunspot

    Versions of the following technologies had been previously deprecated and are no longer supported.

    • Passenger: 2.2.x - 4.0.x
    • Puma: 2.0.x
    • Grape: 0.2.0
    • Padrino: 0.14.x
    • Rails: 3.2.x
    • Sinatra: 1.4.x, 1.5.x
    • Mongo: 1.8.x - 2.3.x
    • Sequel: 3.37.x, 4.0.x
    • Delayed_Job: 2.0.x - 4.0.x
    • Sidekiq: 4.2.x
    • Excon: below 0.55.0
    • HttpClient: 2.2.0 - 2.8.0
    • HttpRb: 0.9.9 - 2.2.1
    • Typhoeus: 0.5.3 - 1.2.x
    • Bunny: 2.0.x - 2.6.x
    • ActiveMerchant: 1.25.0 - 1.64.x
  • Updated API method set_transaction_name

    When the method NewRelic::Agent.set_transaction_name is called, it will now always change the name and category of the currently running transaction to what is passed into the method. This is a change from previous agent versions.

    Previously, if set_transaction_name was called with a new transaction name and a new category that did not match the category already assigned to a transaction, neither the new name nor category would be saved to the transaction. If this method is being called in a situation in which it was previously ignored due to category differences, this will now change the name and category of the transaction. PR#1797

  • Removed API method: NewRelic::Agent.disable_transaction_tracing

    The deprecated API method NewRelic::Agent.disable_transaction_tracing has been removed. Instead use either NewRelic::Agent#ignore_transaction to disable the recording of the current transaction or NewRelic::Agent.disable_all_tracing to yield a block without collecting any metrics or traces in any of the subsequent calls. PR#1792

  • Renamed ActiveJob metrics

    Previously, ActiveJob was categorized as a message broker, which is inaccurate. We've updated the naming of ActiveJob traces from leading with MessageBroker/ActiveJob to simply leading with ActiveJob. PR#1811

  • Code cleanup

    Thank you to community member @esquith for contributing some cleanup of orphaned constants in our code base. PR#1793 PR#1794 PR#1808

    Community member @fchatterji helped standardize how we reference NewRelic throughout our codebase PR#1795 and updated our README's community header PR#1815. Thanks fchatterji!

  • Bugfix: Allow rails initialization to be deferred by environment variable

    The Ruby agent may force some Rails libraries to load on agent initialization, preventing some settings defined in config/initializers from being applied. Changing the initialization process to run after config/initializers, however, may break the configuration for other gems (ex. Roadie Rails).

    For those having troubles with agent initialization and Rails initializers, you can now pass the environment variable NEW_RELIC_DEFER_RAILS_INITIALIZATION=true to make the agent initialize after config/initializers are run. This config option can only be set using an environment variable and can't be set using YAML. PR#1791

    Thanks to @jdelStrother for bringing this issue to our attention and testing our fixes along the way. Issue#662

February 6, 2023
Ruby agent v8.16.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 at most 90 days old. Read more about keeping agent up to date.

As of this release, the oldest supported version is 6.9.0.363

v8.16.0

Version 8.16.0 introduces more Ruby on Rails instrumentation (especially for Rails 6 and 7) for various Action*/Active* libraries whose actions produce Active Support notifications events.

  • Add Various Ruby on Rails Library Instrumentations

    New instrumentation is now automatically provided by several Action*/Active* libaries that generate Active Support notifications. With each Ruby on Rails release, new the Rails libraries add new events and sometimes existing events have their payload parameters updated as well. The New Relic Ruby agent will now automatically process more of these events and parameters with New Relic segments created for each event. At a minimum, each segment gives timing information for the event. In several cases, all non-sensitive event payload parameters are also passed along in the segment.

    The agent now newly supports or has updated support for the following libraries:

    • Action Cable (for WebSockets) PR#1749
    • Action Controller (for the 'C' in MVC) PR#1744
    • Action Mailbox (for sending mail) PR#1740
    • Action Mailer (for routing mail) PR#1740
    • Active Job (for background jobs) PR#1742
    • Active Support (for caching operations) PR#1742

    The instrumentations for each of these libaries are all enabled by default, but can be independently disabled via configuration by using the following parameters:

    Configuration nameDefaultBehavior
    disable_action_cablefalseIf true, disables Action Cable instrumentation.
    disable_action_controllerfalseIf true, disables Action Controller instrumentation.
    disable_action_mailboxfalseIf true, disables Action Mailbox instrumentation.
    disable_action_mailerfalseIf true, disables Action Mailer instrumentation.
    disable_activejobfalseIf true, disables Active Job instrumentation.
    disable_active_supportfalseIf true, disables Active Support instrumentation.

Copyright © 2024 New Relic Inc.

This site is protected by reCAPTCHA and the Google Privacy Policy and Terms of Service apply.