# New Relic Ruby Agent Release Notes #
## v8.2.0
* **New Instrumentation for Tilt gem**
Template rendering using [Tilt](https://github.com/rtomayko/tilt) is now instrumented. See [PR #847](https://github.com/newrelic/newrelic-ruby-agent/pull/847) for details.
* **Configuration `error_collector.ignore_errors` is marked as deprecated**
This setting has been marked as deprecated in the documentation since version 7.2.0 and is now flagged as deprecated within the code.
* **Remove Rails 2 instrumentation**
Though any version of Rails 2 has not been supported by the Ruby Agent since v3.18.1.330, instrumentation for ActionController and ActionWebService specific to that version were still part of the agent. This instrumentation has been removed.
* **Remove duplicated settings from newrelic.yml**
Thank you @jakeonfire for bringing this to our attention and @kuroponzu for making the changes!
* **Bugfix: Span Events recorded when using newrelic_ignore**
Previously, the agent was incorrectly recording span events only on transactions that should be ignored. This fix will prevent any span events from being created for transactions using newrelic_ignore, or ignored through the `rules.ignore_url_regexes` configuration option.
* **Bugfix: Print deprecation warning for Cross-Application Tracing if enabled**
Prior to this change, the deprecation warning would log whenever the agent started up, regardless of configuration. Thank you @alpha-san for bringing this to our attention!
* **Bugfix: Scrub non-unicode characters from DecoratingLogger**
To prevent `JSON::GeneratorErrors`, the DecoratingLogger replaces non-unicode characters with the replacement character: �. Thank you @jdelStrother for bringing this to our attention!
* **Bugfix: Distributed tracing headers emitted errors when agent was not connected**
Previously, when the agent had not yet connected it would fail to create a trace context payload and emit an error, "TypeError: no implicit conversion of nil into String," to the agent logs. The correct behavior in this situation is to not create these headers due to the lack of required information. Now, the agent will not attempt to create trace context payloads until it has connected. Thank you @Izzette for bringing this to our attention!
## v8.1.0
* **Instrumentation for Ruby standard library Logger**
The agent will now automatically instrument Logger, recording number of lines and size of logging output, with breakdown by severity.
* **Bugfix for Padrino instrumentation**
A bug was introduced to the way the agent installs padrino instrumentation in 7.0.0. This release fixes the issues with the padrino instrumentation. Thanks to @sriedel for bringing this issue to our attention.
* **Bugfix: Stop deadlocks between New Relic thread and Delayed Job sampling thread**
Running the agent's polling queries for the DelayedJobSampler within the same ActiveRecord connection decreases the frequency of deadlocks in development environments. Thanks @jdelStrother for bringing this to our attention and providing excellent sample code to speed up development!
* **Bugfix: Allow Net::HTTP request to IPv6 addresses**
The agent will no longer raise an `URI::InvalidURIError` error if an IPv6 address is passed to Net::HTTP. Thank you @tristinbarnett and @tabathadelane for crafting a solution!
* **Bugfix: Allow integers to be passed to error_collector.ignore_status_codes configuration**
Integers not wrapped in quotation marks can be passed to `error_collector.ignore_status_codes` in the `newrelic.yml` file. Our thanks goes to @elaguerta and @brammerl for resolving this issue!
* **Bugfix: Allow add_method_tracer to be used on BasicObjects**
Previously, our `add_method_tracer` changes referenced `self.class` which is not available on `BasicObjects`. This has been fixed. Thanks to @toncid for bringing this issue to our attention.
## v8.0.0
* **`add_method_tracer` refactored to use prepend over alias_method chaining**
This release overhauls the implementation of `add_method_tracer`, as detailed in [issue #502](https://github.com/newrelic/newrelic-ruby-agent/issues/502). The main breaking updates are as follows:
- A metric name passed to `add_method_tracer` will no longer be interpolated in an instance context as before. To maintain this behavior, pass a Proc object with the same arity as the method being traced. For example:
```ruby
# OLD
add_method_tracer :foo, '#{args[0]}.#{args[1]}'
# NEW
add_method_tracer :foo, -> (*args) { "#{args[0]}.#{args[1]}" }
```
- Similarly, the `:code_header` and `:code_footer` options to `add_method_tracer` will *only* accept a Proc object, which will be bound to the calling instance when the traced method is invoked.
- Calling `add_method_tracer` for a method will overwrite any previously defined tracers for that method. To specify multiple metric names for a single method tracer, pass them to `add_method_tracer` as an array.
See updated documentation on the following pages for full details:
- [Ruby Custom Instrumentation: Method Tracers](https://docs.newrelic.com/docs/agents/ruby-agent/api-guides/ruby-custom-instrumentation/#method_tracers)
- [MethodTracer::ClassMethods#add_method_tracer](https://rubydoc.info/github/newrelic/newrelic-ruby-agent/NewRelic/Agent/MethodTracer/ClassMethods#add_method_tracer-instance_method)
* **Distributed tracing is enabled by default**
[Distributed tracing](https://docs.newrelic.com/docs/distributed-tracing/enable-configure/language-agents-enable-distributed-tracing/) tracks and observes service requests as they flow through distributed systems. Distributed tracing is now enabled by default and replaces [cross application tracing](https://docs.newrelic.com/docs/agents/ruby-agent/features/cross-application-tracing-ruby/).
* **Bugfix: Incorrectly loading configuration options from newrelic.yml**
The agent will now import the configuration options [`error_collector.ignore_messages`](https://docs.newrelic.com/docs/agents/ruby-agent/configuration/ruby-agent-configuration/#error_collector-ignore_messages) and [`error_collector.expected_messages`](https://docs.newrelic.com/docs/agents/ruby-agent/configuration/ruby-agent-configuration/#error_collector-expected_messages) from the `newrelic.yml` file correctly.
* **Cross Application is now deprecated, and disabled by default**
[Distributed tracing](https://docs.newrelic.com/docs/distributed-tracing/enable-configure/language-agents-enable-distributed-tracing/) is replacing [cross application tracing](https://docs.newrelic.com/docs/agents/ruby-agent/features/cross-application-tracing-ruby/) as the default means of tracing between services. To continue using it, enable it with `cross_application_tracer.enabled: true` and `distributed_tracing.enabled: false`
* **Update configuration option default value for `span_events.max_samples_stored` from 1000 to 2000**
For more information about this congfiguration option, visit [the Ruby agent documentation](https://docs.newrelic.com/docs/agents/ruby-agent/configuration/ruby-agent-configuration/#span_events-max_samples_stored).
* **Agent now enforces server supplied maximum value for configuration option `span_events.max_samples_stored`**
Upon connection to the New Relic servers, the agent will now enforce a maximum value allowed for the configuration option [`span_events.max_samples_stored`](https://docs.newrelic.com/docs/agents/ruby-agent/configuration/ruby-agent-configuration/#span_events-max_samples_stored) sent from the New Relic servers.
* **Remove Ruby 2.0 required kwarg compatibility checks**
Our agent has code that provides compatibility for required keyword arguments in Ruby versions below 2.1. Since the agent now only supports Ruby 2.2+, this code is no longer required.
* **Replace Time.now with Process.clock_gettime**
Calls to `Time.now` have been replaced with calls to `Process.clock_gettime` to leverage the system's built-in clocks for elapsed time (`Process::CLOCK_MONOTONIC`) and wall-clock time (`Process::CLOCK_REALTIME`). This results in fewer object allocations, more accurate elapsed time records, and enhanced performance. Thanks to @sdemjanenko and @viraptor for advocating for this change!
* **Updated generated default newrelic.yml**
Thank you @wyhaines and @creaturenex for your contribution. The default newrelic.yml that the agent can generate is now updated with commented out examples of all configuration options.
* **Bugfix: Psych 4.0 causes errors when loading newrelic.yml**
Psych 4.0 now uses safe load behavior when using `YAML.load` which by default doesn't allow aliases, causing errors when the agent loads the config file. We have updated how we load the config file to avoid these errors.
* **Remove support for Excon versions below 0.19.0**
Excon versions below 0.19.0 will no longer be instrumented through the Ruby agent.
* **Remove support for Mongo versions below 2.1**
Mongo versions below 2.1 will no longer be instrumented through the Ruby agent.
* **Remove tests for Rails 3.0 and Rails 3.1**
As of the 7.0 release, the Ruby agent stopped supporting Rails 3.0 and Rails 3.1. Despite this, we still had tests for these versions running on the agent's CI. Those tests are now removed.
* **Update test Gemfiles for patched versions**
The gem has individual Gemfiles it uses to test against different common user setups. Rails 5.2, 6.0, and 6.1 have been updated to the latest patch versions in the test Gemfiles. Rack was updated in the Rails61 test suite to 2.1.4 to resolve a security vulnerability.
* **Remove Merb Support**
This release removes the remaining support for the [Merb](https://weblog.rubyonrails.org/2008/12/23/merb-gets-merged-into-rails-3/) framework. It merged with Rails during the 3.0 release. Now that the Ruby agent supports Rails 3.2 and above, we thought it was time to say goodbye.
* **Remove deprecated method External.start_segment**
The method `NewRelic::Agent::External.start_segment` has been deprecated as of Ruby Agent 6.0.0. This method is now removed.
* **Added testing and support for the following gem versions**
- activemerchant 1.121.0
- bunny 2.19.0
- excon 0.85.0
- mongo 2.14.0, 2.15.1
- padrino 0.15.1
- resque 2.1.0
- sequel 5.48.0
- yajl-ruby 1.4.1
* **This version adds support for ARM64/Graviton2 platform using Ruby 3.0.2+**
## v7.2.0
* **Expected Errors and Ignore Errors**
This release adds support for configuration for expected/ignored errors by class name, status code, and message. The following configuration options are now available:
- `error_collector.ignore_classes`
- `error_collector.ignore_messages`
- `error_collector.ignore_status_codes`
- `error_collector.expected_classes`
- `error_collector.expected_messages`
- `error_collector.expected_status_codes`
For more details about expected and ignored errors, please see our [configuration documentation](https://docs.newrelic.com/docs/agents/ruby-agent/configuration/)
* **Bugfix: resolves "can't add a new key into hash during iteration" Errors**
Thanks to @wyhaines for this fix that prevents "can't add a new key into hash during iteration" errors from occuring when iterating over environment data.
* **Bugfix: kwarg support fixed for Rack middleware instrumentation**
Thanks to @walro for submitting this fix. This fixes the rack instrumentation when using kwargs.
* **Update known conflicts with use of Module#Prepend**
With our release of v7.0.0, we updated our instrumentation to use Module#Prepend by default, instead of method chaining. We have received reports of conflicts and added a check for these known conflicts. If a known conflict with prepend is detected while using the default value of 'auto' for gem instrumentation, the agent will instead install method chaining instrumentation in order to avoid this conflict. This check can be bypassed by setting the instrumentation method for the gem to 'prepend'.
## v7.1.0
* **Add support for CSP nonces when using our API to insert the browser agent**
We now support passing in a nonce to our API method `browser_timing_header` to allow the browser agent to run on applications using CSP nonces. This allows users to inject the browser agent themselves and use the nonce required for the script to run. In order to utilize this new feature, you must disable auto instrumentation for the browser agent, and use the API method browser_timing_header to pass the nonce in and inject the script manually.
* **Removed MD5 use in the SQL sampler**
In order to allow the agent to run in FIPS compliant environments, the usage of MD5 for aggregating slow sql traces has been replaced with SHA1.
* **Enable server-side configuration of distributed tracing**
`distributed_tracing.enabled` may now be set in server-side application configuration.
* **Bugfix: Fix for missing part of a previous bugfix**
Our previous fix of "nil Middlewares injection now prevented and gracefully handled in Sinatra" released in 7.0.0 was partially overwritten by some of the other changes in that release. This release adds back those missing sections of the bugfix, and should resolve the issue for sinatra users.
* **Update known conflicts with use of Module#Prepend**
With our release of v7.0.0, we updated our instrumentation to use Module#Prepend by default, instead of method chaining. We have received reports of conflicts and added a check for these known conflicts. If a known conflict with prepend is detected while using the default value of 'auto' for gem instrumentation, the agent will instead install method chaining instrumentation in order to avoid this conflict. This check can be bypassed by setting the instrumentation method for the gem to 'prepend'.
* **Bugfix: Updated support for ActiveRecord 6.1+ instrumentation**
Previously, the agent depended on `connection_id` to be present in the Active Support instrumentation for `sql.active_record`
to get the current ActiveRecord connection. As of Rails 6.1, `connection_id` has been dropped in favor of providing the connection
object through the `connection` value exclusively. This resulted in datastore spans displaying fallback behavior, including showing
"ActiveRecord" as the database vendor.
* **Bugfix: Updated support for Resque's FORK_PER_JOB option**
Support for Resque's FORK_PER_JOB flag within the Ruby agent was incomplete and nonfunctional. The agent should now behave
correctly when running in a non-forking Resque worker process.
* **Bugfix: Added check for ruby2_keywords in add_transaction_tracer**
Thanks @beauraF for the contribution! Previously, the add_transaction_tracer was not updated when we added support for ruby 3. In order to correctly support `**kwargs`, ruby2_keywords was added to correctly update the method signature to use **kwargs in ruby versions that support that.
* **Confirmed support for yajl 1.4.0**
Thanks to @creaturenex for the contribution! `yajl-ruby` 1.4.0 was added to our test suite and confirmed all tests pass, showing the agent supports this version as well.
## v7.0.0
* **Ruby Agent 6.x to 7.x Migration Guide Available**
Please see our [Ruby Agent 6.x to 7.x migration guide](https://docs.newrelic.com/docs/agents/ruby-agent/getting-started/migration-7x-guide/) for helpful strategies and tips for migrating from earlier versions of the Ruby agent to 7.0.0. We cover new configuration settings, diagnosiing and installing SSL CA certificates and deprecated items and their replacements in this guide.
* **Ruby 2.0 and 2.1 Dropped**
Support for Ruby 2.0 and 2.1 dropped with this release. No code changes that would prevent the agent from continuing to
work with these releases are known. However, Rubies 2.0 and 2.1 are no longer included in our test matrices and are not supported
for 7.0.0 and onward.
* **Implemented prepend auto-instrumentation strategies for most Ruby gems/libraries**
This release brings the auto-instrumentation strategies for most gems into the modern era for Ruby by providing both
prepend and method-chaining (a.k.a. method-aliasing) strategies for auto instrumenting. Prepend, which has been available since
Ruby 2.0 is now the default strategy employed in auto-instrumenting. It is known that some external gems lead to Stack Level
too Deep exceptions when prepend and method-chaining are mixed. In such known cases, auto-instrumenting strategy will fall back
to method-chaining automatically.
This release also deprecates many overlapping and inconsistently named configuration settings in favor of being able to control
behavior of instrumentation per library with one setting that can be one of auto (the default), disabled, prepend, or chain.
Please see the above-referenced migration guide for further details.
* **Removed SSL cert bundle**
The agent will no longer ship this bundle and will rely on system certs.
* **Removed deprecated config options**
The following config options were previously deprecated and are no longer available
- `disable_active_record_4`
- `disable_active_record_5`
- `autostart.blacklisted_constants`
- `autostart.blacklisted_executables`
- `autostart.blacklisted_rake_tasks`
- `strip_exception_messages.whitelist`
* **Removed deprecated attribute**
The attribute `httpResponseCode` was previously deprecated and replaced with `http.statusCode`. This deprecated attribute has now been removed.
* **Removed deprecated option in notice_error**
Previously, the `:trace_only` option to NewRelic::Agent.notice_error was deprecated and replaced with `:expected`. This deprecated option has been removed.
* **Removed deprecated api methods**
Previously the api methods `create_distributed_trace_payload` and `accept_distributed_trace_payload` were deprecated. These have now been removed. Instead, please see `insert_distributed_trace_headers` and `accept_distributed_trace_headers`, respectively.
* **Bugfix: Prevent browser monitoring middleware from installing to middleware multiple times**
In rare cases on jRuby, the BrowserMonitoring middleware could attempt to install itself
multiple times at start up. This bug fix addresses that by using a mutex to introduce
thread safety to the operation. Sintra in particular can have this race condition because
its middleware stack is not installed until the first request is received.
* **Skip constructing Time for transactions**
Thanks to @viraptor, we are no longer constructing an unused Time object with every call to starting a new Transaction.
* **Bugfix: nil Middlewares injection now prevented and gracefully handled in Sinatra**
Previously, the agent could potentially inject multiples of an instrumented middleware if Sinatra received many
requests at once during start up and initialization due to Sinatra's ability to delay full start up as long as possible.
This has now been fixed and the Ruby agent correctly instruments only once as well as gracefully handles nil middleware
classes in general.
* **Bugfix: Ensure transaction nesting max depth is always consistent with length of segments**
Thanks to @warp for noticing and fixing the scenario where Transaction nesting_max_depth can get out of sync
with segments length resulting in an exception when attempting to nest the initial segment which does not exist.
## v6.15.0
* **Official Ruby 3.0 support**
The ruby agent has been verified to run on ruby 3.0.0
* **Added support for Rails 6.1**
The ruby agent has been verified to run with Rails 6.1
Special thanks to @hasghari for setting this up!
* **Added support for Sidekiq 6.0, 6.1**
The ruby agent has been verified to run with both 6.0 and 6.1 versions of sidekiq
* **Bugfix: No longer overwrites sidekiq trace data**
Distributed tracing data is now added to the job trace info rather than overwriting the existing data.
* **Bugfix: Fixes cases where errors are reported for spans with no other attributes**
Previously, in cases where a span does not have any agent/custom attributes on it, but an error
is noticed and recorded against the span, a `FrozenError: can't modify frozen Hash` is thrown.
This is now fixed and errors are now correctly recorded against such span events.
* **Bugfix: `DistributedTracing.insert_distributed_trace_headers` Supportability metric now recorded**
Previously, API calls to `DistributedTracing.insert_distributed_trace_headers` would lead to an exception
about the missing supportability metric rather than flowing through the API implementation as intended.
This would potentially lead to broken distributed traces as the trace headers were not inserted on the API call.
`DistributedTracing.insert_distributed_trace_headers` now correctly records the supportability metric and
inserts the distributed trace headers as intended.
* **Bugfix: child completions after parent completes sometimes throws exception attempting to access nil parent**
In scenarios where the child segment/span is completing after the parent in jRuby, the parent may have already
been freed and no longer accessible. This would lead to an attempt to call `descendant_complete` on a Nil
object. This is fixed to protect against calling the `descendant_complete` in such cases.
* **Feature: implements `force_install_exit_handler` config flag**
The `force_install_exit_handler` configuration flag allows an application to instruct the agent to install its
graceful shutdown exit handler, which will send any locally cached data to the New Relic collector prior to the
application shutting down. This is useful for when the primary framework has an embedded Sinatra application that
is otherwise detected and skips installing the exit hook for graceful shutdowns.
* **Default prepend_net_instrumentation to false**
Previously, `prepend_net_instrumentation` defaulted to true. However, many gems are still using monkey patching on Net::HTTP, which causes compatibility issues with using prepend. Defaulting this to false minimizes instances of
unexpected compatibilty issues.
## v6.14.0
* **Bugfix: Method tracers no longer cloning arguments**
Previously, when calling add_method_tracer with certain combination of arguments, it would lead to the wrapped method's arguments being cloned rather than passed to the original method for manipulation as intended. This has been fixed.
* **Bugfix: Delayed Job instrumentation fixed for Ruby 2.7+**
Previously, the agent was erroneousy separating positional and keyword arguments on the instrumented method calls into
Delayed Job's library. The led to Delayed job not auto-instrumenting correctly and has been fixed.
* **Bugfix: Ruby 2.7+ methods sometimes erroneously attributed compiler warnings to the Agent's `add_method_tracer`**
The specific edge cases presented are now fixed by this release of the agent. There are still some known corner-cases
that will be resolved with upcoming changes in next major release of the Agent. If you encounter a problem with adding
method tracers and compiler warnings raised, please continue to submit small repoducible examples.
* **Bugfix: Ruby 2.7+ fix for keyword arguments on Rack apps is unnecessary and removed**
A common fix for positional and keyword arguments for method parameters was implemented where it was not needed and
led to RackApps getting extra arguments converted to keyword arguments rather than Hash when it expected one. This
Ruby 2.7+ change was reverted so that Rack apps behave correctly for Ruby >= 2.7.
* **Feature: captures incoming and outgoing request headers for distributed tracing**
HTTP request headers will be logged when log level is at least debug level. Similarly, request headers
for exchanges with New Relic servers are now audit logged when audit logging is enabled.
* **Bugfix: `newrelic.yml.erb` added to the configuration search path**
Previously, when a user specifies a `newrelic.yml.erb` and no `newrelic.yml` file, the agent fails to find
the `.erb` file because it was not in the list of files searched at startup. The Ruby agent has long supported this as a
means of configuring the agent programatically. The `newrelic.yml.erb` filename is restored to the search
path and will be utilized if present. NOTE: `newrelic.yml` still takes precedence over `newrelic.yml.erb` If found,
the `.yml` file is used instead of the `.erb` file. Search directories and order of traversal remain unchanged.
* **Bugfix: dependency detection of Redis now works without raising an exception**
Previously, when detecting if Redis was available to instrument, the dependency detection would fail with an Exception raised
(with side effect of not attempting to instrument Redis). This is now fixed with a better dependency check that resolves falsly without raising an `Exception`.
* **Bugfix: Gracefully handles NilClass as a Middleware Class when instrumenting**
Previously, if a NilClass is passed as the Middleware Class to instrument when processing the middleware stack,
the agent would fail to fully load and instrument the middleware stack. This fix gracefully skips over nil classes.
* **Memory Sampler updated to recognize macOS Big Sur**
Previously, the agent was unable to recognize the platform macOS Big Sur in the memory sampler, resulting in an error being logged. The memory sampler is now able to recognize Big Sur.
* **Prepend implementation of Net::HTTP instrumentation available**
There is now a config option (`prepend_net_instrumentation`) that will enable the agent to use prepend while instrumenting Net::HTTP. This option is set to true by default.
## v6.13.1
* **Bugfix: obfuscating URLs to external services no longer modifying original URI**
A recent change to the Ruby agent to obfuscate URIs sent to external services had the unintended side-effect of removing query parameters
from the original URI. This is fixed to obfuscate while also preserving the original URI.
Thanks to @VictorJimenezKwast for pinpointing and helpful unit test to demonstrate.
## v6.13.0
* **Bugfix: never use redirect host when accessing preconnect endpoint**
When connecting to New Relic, the Ruby Agent uses the value in `Agent.config[:host]` to post a request to the New Relic preconnect endpoint. This endpoint returns a "redirect host" which is the URL to which agents send data from that point on.
Previously, if the agent needed to reconnect to the collector, it would incorrectly use this redirect host to call the preconnect
endpoint, when it should have used the original configured value in `Agent.config[:host]`. The agent now uses the correct host
for all calls to preconnect.
* **Bugfix: calling `add_custom_attributes` no longer modifies the params of the caller**
The previous agent's improvements to recording attributes at the span level had an unexpected
side-effect of modifying the params passed to the API call as duplicated attributes were deleted
in the process. This is now fixed and params passed in are no longer modified.
Thanks to Pete Johns (@johnsyweb) for the PR that resolves this bug.
* **Bugfix: `http.url` query parameters spans are now obfuscated**
Previously, the agent was recording the full URL of the external requests, including
the query and fragment parts of the URL as part of the attributes on the external request
span. This has been fixed so that the URL is obfuscated to filter out potentially sensitive data.
* **Use system SSL certificates by default**
The Ruby agent previously used a root SSL/TLS certificate bundle by default. Now the agent will attempt to use
the default system certificates, but will fall back to the bundled certs if there is an issue (and log that this occurred).
* **Bugfix: reduce allocations for segment attributes**
Previously, every segment received an `Attributes` object on initialization. The agent now lazily creates attributes
on segments, resulting in a significant reduction in object allocations for a typical transaction.
* **Bugfix: eliminate errors around Rake::VERSION with Rails**
When running a Rails application with rake tasks, customers could see the following error:
* **Prevent connecting agent thread from hanging on shutdown**
A bug in `Net::HTTP`'s Gzip decoder can cause the (un-catchable)
thread-kill exception to be replaced with a (catchable) `Zlib` exception,
which prevents a connecting agent thread from exiting during shutdown,
causing the Ruby process to hang indefinitely.
This workaround checks for an `aborting` thread in the `#connect` exception handler
and re-raises the exception, allowing a killed thread to continue exiting.
Thanks to Will Jordan (@wjordan) for chasing this one down and patching with tests.
* **Fix error messages about Rake instrumentation**
When running a Rails application with rake tasks, customers could see the following error in logs resulting from
a small part of rake functionality being loaded with the Rails test runner:
```
ERROR : Error while detecting rake_instrumentation:
ERROR : NameError: uninitialized constant Rake::VERSION
```
Such error messages should no longer appear in this context.
Thanks to @CamilleDrapier for pointing out this issue.
* **Remove NewRelic::Metrics**
The `NewRelic::Metrics` module has been removed from the agent since it is no longer used.
Thanks to @csaura for the contribution!
## v6.12.0
* The New Relic Ruby Agent is now open source under the [Apache 2 license](LICENSE)
and you can now observe the project roadmap. See our [Contributing guide](https://github.com/newrelic/newrelic-ruby-agent/blob/main/CONTRIBUTING.md)
and [Code of Conduct](https://github.com/newrelic/.github/blob/master/CODE_OF_CONDUCT.md) for details on contributing!
* **Security: Updated all uses of Rake to >= 12.3.3**
All versions of Rake testing prior to 12.3.3 were removed to address
[CVE-2020-8130](https://nvd.nist.gov/vuln/detail/CVE-2020-8130).
No functionality in the agent was removed nor deprecated with this change, and older versions
of rake are expected to continue to work as they have in the past. However, versions of
rake < 12.3.3 are no longer tested nor supported.
* **Bugfix: fixes an error capturing content length in middleware on multi-part responses**
In the middleware tracing, the `Content-Length` header is sometimes returned as an array of
values when content is a multi-part response. Previously, the agent would fail with
"NoMethodError: undefined method `to_i` for Array" Error. This bug is now fixed and
multi-part content lengths are summed for a total when an `Array` is present.
* **Added support for auto-instrumenting Mongo gem versions 2.6 to 2.12**
* **Bugfix: MongoDB instrumentation did not handle CommandFailed events when noticing errors**
The mongo gem sometimes returns a CommandFailed object instead of a CommandSucceeded object with
error attributes populated. The instrumentation did not handle noticing errors on CommandFailed
objects and resulted in logging an error and backtrace to the log file.
Additionally, a bug in recording the metric for "findAndModify" as all lowercased "findandmodify"
for versions 2.1 through 2.5 was fixed.
* **Bugfix: Priority Sampler causes crash in high throughput environents in rare cases**
Previously, the priority sampling buffer would, in rare cases, generate an error in high-throughput
environments once capacity is reached and the sampling algorthym engages. This issue is fixed.
* **Additional Transaction Information applied to Span Events**
When Distributed Tracing and/or Infinite Tracing are enabled, the Agent will now incorporate additional information from the Transaction Event on to the root Span Event of the transaction.
The following items are affected:
* Custom attribute values applied to the Transaction via our [add_custom_attributes](http://www.rubydoc.info/github/newrelic/newrelic-ruby-agent/NewRelic/Agent#add_custom_attributes-instance_method) API method.
* Request parameters: `request.parameters.*`
* Request headers: `request.headers.*`
* Response headers: `response.headers.*`
* Resque job arguments: `job.resque.args.*`
* Sidekiq job arguments: `job.sidekiq.args.*`
* Messaging arguments: `message.*`
* `httpResponseCode` (deprecated in this version; see note below)/`http.statusCode`
* `response.status`
* `request.uri`
* `request.method`
* `host.displayName`
* **Security Recommendation**
Review your Transaction attributes [include](https://docs.newrelic.com/docs/agents/ruby-agent/attributes/enable-disable-attributes-ruby#transaction_events-attributes-include) and [exclude](https://docs.newrelic.com/docs/agents/ruby-agent/attributes/enable-disable-attributes-ruby#transaction_events-attributes-exclude) configurations. Any attribute include or exclude settings specific to Transaction Events should be applied
to your Span attributes [include](https://docs.newrelic.com/docs/agents/ruby-agent/attributes/enable-disable-attributes-ruby#span-events-attributes-include) and [exclude](https://docs.newrelic.com/docs/agents/ruby-agent/attributes/enable-disable-attributes-ruby#span-events-attributes-exclude) configuration or your global attributes [include](https://docs.newrelic.com/docs/agents/ruby-agent/attributes/enable-disable-attributes-ruby#attributes-include) and [exclude](https://docs.newrelic.com/docs/agents/ruby-agent/attributes/enable-disable-attributes-ruby#attributes-exclude) configuration.
* **Agent attribute deprecation: httpResponseCode**
Starting in this agent version, the [agent attribute](https://docs.newrelic.com/docs/agents/ruby-agent/attributes/ruby-agent-attributes#attributes) `httpResponseCode` (string value) has been deprecated. Customers can begin using `http.statusCode`
(integer value) immediately, and `httpResponseCode` will be removed in the agent's next major version update.
* **Bugfix: Eliminate warnings for distributed tracing when using sidekiq**
Previously, using sidekiq with distributed tracing disabled resulted in warning messages\
`WARN : Not configured to accept distributed trace headers`\
` WARN : Not configured to insert distributed trace headers`\
These messages no longer appear.
## v6.11.0
* **Infinite Tracing**
This release adds support for [Infinite Tracing](https://docs.newrelic.com/docs/understand-dependencies/distributed-tracing/enable-configure/enable-distributed-tracing). Infinite Tracing observes 100% of your distributed traces and provides visualizations for the most actionable data. With Infinite Tracing, you get examples of errors and long-running traces so you can better diagnose and troubleshoot your systems.
Configure your agent to send traces to a trace observer in New Relic Edge. View distributed traces through New Relic’s UI. There is no need to install a collector on your network.
Infinite Tracing is currently available on a sign-up basis. If you would like to participate, please contact your sales representative.
* **Bugfix: Cross Application Tracing (CAT) adds a missing field to response**
Previously, the Ruby agent's Cross Application Tracing header was missing a reserved field that would lead to an error
in the Go agent's processing of incoming headers from the Ruby agent. This fix adds that missing field to the headers, eliminating
the issue with traces involving the Ruby agent and the Go agent.
* **Bugfix: Environment Report now supports Rails >= 6.1**
Previously, users of Rails 6.1 would see the following deprecation warning appear when the Ruby agent attempted to
collect enviroment data: `DEPRECATION WARNING: [] is deprecated and will be removed from Rails 6.2`. These deprecation methods
no longer appear.
Thanks to Sébastien Dubois (sedubois) for reporting this issue and for the contribution!
* **Added distributed tracing to Sidekiq jobs**
Previously, Sidekiq jobs were not included in portions of distributed traces captured by the Ruby agent. Now you can view distributed
traces that include Sidekiq jobs instrumented by the Ruby agent.
Thanks to andreaseger for the contribution!
* **Bugfix: Eliminate warnings appearing when using `add_method_tracer` with Ruby 2.7**
Previously, using `add_method_tracer` with Ruby 2.7 to trace a method that included keyword arguments resulted in warning messages:
`warning: Using the last argument as keyword parameters is deprecated; maybe ** should be added to the call`. These messages no
longer appear.
Thanks to Harm de Wit and Atsuo Fukaya for reporting the issue!
## v6.10.0
* **Error attributes now added to each span that exits with an error or exception**
Error attributes `error.class` and `error.message` are now included on the span event in which an error
or exception was noticed, and, in the case of unhandled exceptions, on any ancestor spans that also exit with an error.
The public API method `notice_error` now attaches these error attributes to the currently executing span.
Spans with error details are now highlighted red in the Distributed Tracing UI, and error details will expose the associated
`error.class` and `error.message`. It is also now possible to see when an exception leaves the boundary of the span,
and if it is caught in an ancestor span without reaching the entry span. NOTE: This “bubbling up” of exceptions will impact
the error count when compared to prior behavior for the same trace. It is possible to have a trace that now has span errors
without the trace level showing an error.
If multiple errors occur on the same span, only the most recent error information is added to the attributes. Prior errors on the same span are overwritten.
These span event attributes conform to ignored errors and expected errors.
* **Added tests for latest Grape / Rack combination**
For a short period of time, the latest versions of Grape and Rack had compatibility issues.
Generally, Rack 2.1.0 should be avoided in all cases due to breaking changes in many gems
reliant on Rack. We recommend using either Rack <= 2.0.9, or using latest Rack when using Grape
(2.2.2 at the time of this writing).
* **Bugfix: Calculate Content-Length in bytes**
Previously, the Content-Length HTTP header would be incorrect after injecting the Browser Monitoring
JS when the response contained Unicode characters because the value was not calculated in bytes.
The Content-Length is now correctly updated.
Thanks to thaim for the contribution!
* **Bugfix: Fix Content-Length calculation when response is nil**
Previously, calculating the Content-Length HTTP header would result in a `NoMethodError` in the case of
a nil response. These errors will no longer occur in such a case.
Thanks to Johan Van Ryseghem for the contribution!
* **Bugfix: DecoratingFormatter now logs timestamps as millisecond Integers**
Previously the agent sent timestamps as a Float with milliseconds as part of the
fractional value. Logs in Context was changed to only accept Integer values and this
release changes DecoratingFormatter to match.
* **Added --force option to `newrelic install` cli command to allow overwriting newrelic.yml**
* **Bugfix: The fully qualified hostname now works correctly for BSD and Solaris**
Previously, when running on systems such as BSD and Solaris, the agent was unable to determine the fully
qualified domain name, which is used to help link Ruby agent data with data from New Relic Infrastructure.
This information is now successfully collected on various BSD distros and Solaris.
## v6.9.0
* **Added support for W3C Trace Context, with easy upgrade from New Relic trace context**
* [Distributed Tracing now supports W3C Trace Context headers](https://docs.newrelic.com/docs/understand-dependencies/distributed-tracing/get-started/introduction-distributed-tracing#w3c-support) for HTTP protocols when distributed tracing is enabled. Our implementation can accept and emit both
the W3C trace header format and the New Relic trace header format. This simplifies
agent upgrades, allowing trace context to be propagated between services with older
and newer releases of New Relic agents. W3C trace header format will always be
accepted and emitted. New Relic trace header format will be accepted, and you can
optionally disable emission of the New Relic trace header format.
* When distributed tracing is enabled by setting `distributed_tracing.enabled` to `true`,
the Ruby agent will now accept W3C's `traceparent` and `tracestate` headers when
calling `DistributedTracing.accept_distributed_trace_headers` or automatically via
`http` instrumentation. When calling `DistributedTracing.insert_distributed_trace_headers`,
or automatically via `http` instrumentation, the Ruby agent will include the W3C
headers along with the New Relic distributed tracing header, unless the New Relic
trace header format is disabled by setting `exclude_newrelic_header` setting to `true`.
* Added `DistributedTracing.accept_distributed_trace_headers` API for accepting both
New Relic and W3C TraceContext distributed traces.
* Deprecated `DistributedTracing.accept_distributed_trace_payload` which will be removed
in a future major release.
* Added `DistributedTracing.insert_distributed_trace_headers` API for adding outbound
distributed trace headers. Both W3C TraceContext and New Relic formats will be
included unless `distributed_tracing.exclude_newrelic_header: true`.
* Deprecated `DistributedTracing.create_distributed_trace_payload` which will be removed
in a future major release.
Known Issues and Workarounds
* If a .NET agent is initiating traces as the root service, do not upgrade your
downstream Ruby New Relic agents to this agent release.
* **Official Ruby 2.7 support**
The Ruby agent has been verified to run with Ruby 2.7.0.
* **Reduced allocations when tracing transactions using API calls**
Default empty hashes for `options` parameter were not frozen, leading to
excessive and unnecessary allocations when calling APIs for tracing transactions.
Thanks to Joel Turkel (jturkel) for the contribution!
* **Bugfix for Resque worker thread race conditions**
Recent changes in Rack surfaced issues marshalling data for resque, surfaced a potential race-condition with closing out the worker-threads before flushing the data pipe. This
is now fixed.
Thanks to Bertrand Paquet (bpaquet) for the contribution!
* **Bugfix for Content-Length when injecting Browser Monitoring JS**
The Content-Length HTTP header would be incorrect after injecting the Browser Monitoring
JS into the HEAD tag of the HTML source with Content-Length and lead to the HTML BODY content
being truncated in some cases. The Content-Length is now correctly updated after injecting the
Browser Monitoring JS script.
Thanks to Slava Kardakov (ojab) for the contribution!
## v6.8.0
* **Initial Ruby 2.7 support**
The Ruby agent has been verified to run with Ruby 2.7.0-preview1.
* **New API method to add custom attributes to Spans**
New API method for adding custom attributes to spans. Previously, custom
attributes were only available at the Transaction level. Now, with Span
level custom attributes, more granular tagging of events is possible for
easier isolation and review of trace events. For more information:
* [`Agent#add_custom_span_attributes`](https://www.rubydoc.info/github/newrelic/newrelic-ruby-agent/NewRelic/Agent#add_custom_span_attributes)
* **Enables ability to migrate to Configurable Security Policies (CSP) on a per agent
basis for accounts already using High Security Mode (HSM).**
When both [HSM](https://docs.newrelic.com/docs/agents/manage-apm-agents/configuration/high-security-mode) and [CSP](https://docs.newrelic.com/docs/agents/manage-apm-agents/configuration/enable-configurable-security-policies) are enabled for an account, an agent (this version or later)
can successfully connect with either `high_security: true` or the appropriate
`security_policies_token` configured. `high_security` has been added as part of
the preconnect payload.
* **Bugfix for Logs in Context combined with act-fluent-logger-rails**
Previously, when using the Ruby agent's Logs in Context logger
to link logging data with trace and entity metadata for an
improved experience in the UI, customers who were also using
the `act-fluent-logger-rails` gem would see a `NoMethodError`
for `clear_tags!` that would interfere with the use of this
feature. This error no longer appears, allowing customers to
combine the use of Logs in Context with the use of this gem.
Please note that the Logs in Context logger does not support
tagged logging; if you are initializing your logger with a
`log_tags` argument, your custom tags may not appear on the
final version of your logs.
* **Bugfix for parsing invalid newrelic.yml**
Previously, if the newrelic.yml configuration file was invalid, and the agent
could not start as a result, the agent would not log any indication of
the problem.
This version of the agent will emit a FATAL message to STDOUT when this scenario
occurs so that customers can address issues with newrelic.yml that prevent startup.
* **Configuration options containing the terms "whitelist" and "blacklist" deprecated**
The following local configuration settings have been deprecated:
* `autostart.blacklisted_constants`: use `autostart.denylisted_constants` instead.
* `autostart.blacklisted_executables`: use `autostart.denylisted_executables` instead.
* `autostart.blacklisted_rake_tasks`: use `autostart.denylisted_rake_tasks` instead.
* `strip_exception_messages.whitelist`: use `strip_exception_messages.allowed_classes` instead.
* **Bugfix for module loading and constant resolution in Rails**
Starting in version 6.3, the Ruby agent has caused module loading and constant
resolution to sometimes fail, which caused errors in some Rails applications.
These errors were generally `NoMethodError` exceptions or I18n errors
`translation missing` or `invalid locale`. These errors would not appear if the agent
was removed from the application's Gemfile.
This version of the agent fixes these issues with module loading and constant
resolution, so these errors no longer occur.
* **Bugfix: failed to get urandom**
Previous versions of the agent would fail unexpectedly when the Ruby process used
every available file descriptor. The failures would include this message:
```
ERROR : RuntimeError: failed to get urandom
```
This version of the agent uses a different strategy for generating random IDs, and
will not fail in the same way when no file descriptors are available.
## v6.7.0
* **Trace and Entity Metadata API**
Several new API methods have been added to the agent:
* [`Agent#linking_metadata`](https://www.rubydoc.info/github/newrelic/newrelic-ruby-agent/NewRelic/Agent#linking_metadata-instance_method)
* [`Tracer#trace_id`](https://www.rubydoc.info/github/newrelic/newrelic-ruby-agent/NewRelic/Agent/Tracer#trace_id-class_method)
* [`Tracer#span_id`](https://www.rubydoc.info/github/newrelic/newrelic-ruby-agent/NewRelic/Agent/Tracer#span_id-class_method)
* [`Tracer#sampled?`](https://www.rubydoc.info/github/newrelic/newrelic-ruby-agent/NewRelic/Agent/Tracer#sampled?-class_method)
These API methods allow you to access information that can be used to link data of your choosing to a trace or entity.
* **Logs in Context**
This version of the agent includes a logger, which can be used in place of `::Logger`
from the standard library, or `ActiveSupport::Logger` from Rails. This logger
leverages the new trace and entity metadata API to decorate log statements with entity
and trace metadata, so they can be correlated together in the New Relic UI.
For more information on how to use logs in context, see https://docs.newrelic.com/docs/enable-logs-context-ruby
* **Project metadata in Gemspec**
Project metadata has been added to the gemspec file. This means our Rubygems page will allow users to more easily
access the agent's source code, raise issues, and read the changelog.
Thanks to Orien Madgwick for the contribution!
## v6.6.0
* **Bugfix for ActionCable Instrumentation**
Previous versions of the agent sometimes caused application crashes with some versions
of ActionCable. The application would exit quickly after startup with the error:
`uninitialized constant ActionCable::Engine`.
Version 6.6.0 of the agent no longer crashes in this way.
* **Handling of disabling Error Collection**
When the agent first starts, it begins collecting Error Events and Traces before
fetching configuration from New Relic. In previous versions of the agent, those
events or traces would be sent to New Relic, even if _Error Collection_ is disabled in
the application's server-side configuration.
Version 6.6.0 of the agent drops all collected Error Events and Traces if the
configuration from the server disables _Error Collection_.
## v6.5.0
* **Change to default setting for ActiveRecord connection resolution**
Due to incompatibilities between the faster ActiveRecord connection resolution
released in v6.3.0 of the agent and other gems which patch ActiveRecord,
`backport_fast_active_record_connection_lookup` will now be set to `false` by default.
Because it results in a significant performance improvement, we recommend customers
whose environments include ActiveRecord change this setting to `true`
_unless_ they are using other gems which measure ActiveRecord performance, which may
lose functionality when combined with this setting. If unsure whether to enable
`backport_fast_active_record_connection_lookup`, we recommend enabling it in a
development environment to make sure other gems which patch ActiveRecord are still
working as expected.
* **Bugfix for ActiveStorage instrumentation error**
Version 6.4.0 of the agent introduced a bug that interfered with ActiveStorage
callbacks, resulting in the agent being unable to instrument ActiveStorage operations.
ActiveStorage segments are now correctly recorded.
* **Bugfix for ActiveRecord 4.1 and 4.2 exception logging**
Version 6.3.0 of the agent introduced a bug that prevented ActiveRecord versions 4.1
and 4.2 from logging exceptions that occurred within a database transaction. This
version of the agent restores the exception logging functionality from previous agent
versions.
Thanks to Oleksiy Kovyrin for the contribution!
## v6.4.0
* **Custom Metadata Collection**
The agent now collects environment variables prefixed by `NEW_RELIC_METADATA_`. These
may be added to transaction events to provide context between your Kubernetes cluster
and your services. For details on the behavior, see
[this blog post](https://blog.newrelic.com/engineering/monitoring-application-performance-in-kubernetes/).
* **Bugfix for faster ActiveRecord connection resolution**
Version 6.3.0 of the agent backported the faster ActiveRecord connection resolution
from Rails 6.0 to previous versions, but the implementation caused certain other gems
which measured ActiveRecord performance to stop working. This version of the agent
changes the implementation of this performance improvement so no such conflicts occur.
* **Bugfix for Grape instrumentation error**
Previous versions of the agent would fail to install Grape instrumentation in Grape
versions 1.2.0 and up if the API being instrumented subclassed `Grape::API::Instance`
rather than `Grape::API`. A warning would also print to the newrelic_agent log:
```
WARN : Error in Grape instrumentation
WARN : NoMethodError: undefined method `name' for nil:NilClass
```
This version of the agent successfully installs instrumentation for subclasses
of `Grape::API::Instance`, and these log messages should no longer appear.
* **Bugfix for streaming responses**
Previous versions of the agent would attempt to insert JavaScript instrumentation into
any streaming response that did not make use of `ActionController::Live`. This resulted
in an empty, non-streamed response being sent to the client.
This version of the agent will not attempt to insert JavaScript instrumentation into
a response which includes the header `Transfer-Encoding=chunked`, which indicates a
streaming response.
This should exclude JavaScript instrumentation for all streamed responses. To include
this instrumentation manually, see
[Manually instrument via agent API](https://docs.newrelic.com/docs/agents/ruby-agent/features/new-relic-browser-ruby-agent#manual_instrumentation)
in our documentation.
## v6.3.0
* **Official Rails 6.0 support**
This version of the agent has been verified against the Rails 6.0.0 release.
As ActiveRecord 4, 5, and 6 use the same New Relic instrumentation, the
`disable_active_record_4` and `disable_active_record_5` settings in NewRelic.yml are being
deprecated in favor of the new `disable_active_record_notifications`. This new
setting will affect the instrumentation of ActiveRecord 4, 5, and 6. The deprecated settings
will be removed in a future release.
* **Bugfix for `newrelic deployments` script**
For applications housed in the EU, the `newrelic deployments` script included with previous
versions of the agent would fail with the following message: `Deployment not recorded:
Application does not exist.` This is because the script would attempt to send the deployment
notification to the US region. The deployment script now sends deployments to the correct region.
* **Faster ActiveRecord connection resolution**
This version of the agent uses the faster ActiveRecord connection resolution that Rails 6.0 uses, even on previous versions of Rails.
Thanks to Callum Jones for the contribution!
* **Support non-ascii characters in hostnames**
Previous versions of the agent would frequently log warnings like: `log writing failed. "\xE2" from ASCII-8BIT to UTF-8` if the hostname contained a non-ascii character. This version of the agent will no longer log these warnings.
Thanks to Rafael Petry for the contribution!
## v6.2.0
* Bugfix for superfluous `Empty JSON response` error messages
Version 6.1.0 of the agent frequently logged error messages about an empty
JSON response, when no error had occurred. These logs no longer appear.
* Bugfix for `Unable to calculate elapsed transaction time` warning messages
Ruby Agent versions 5.4 through 6.1, when running in jruby without
ObjectSpace enabled, would occasionally log a warning indicating that the
agent was unable to calculate the elapsed transaction time. When this log
statement appeared, the affected transactions would not be included in the
data displayed on the capacity analysis page. These transactions are now
correctly recorded.
## v6.1.0
* Performance monitoring on Kubernetes
This release adds Transaction event attributes that provide
context between your Kubernetes cluster and services. For details
on the benefits, see this [blog
post](https://blog.newrelic.com/engineering/monitoring-application-performance-in-kubernetes/).
* Bugfix for Bunny instrumentation when popping empty queues
When a customer calls `Bunny::Queue#pop` on an empty queue, Bunny
returns a `nil` value. Previous Ruby Agent versions raised a
`NoMethodError` when trying to process this result. Now, the
agent correctly skips processing for `nil` values. Thanks to
Matt Campbell for the contribution.
## v6.0.0
* Tracer API for flexible custom instrumentation
With agent version 6.0, we are introducing the `Tracer` class, an
officially supported public API for more flexible custom
instrumentation. By calling its `in_transaction` method, you can
instrument an arbitrary section of Ruby code without needing to
juggle any explicit state. Behind the scenes, the agent will
make sure that the measured code results in an APM segment inside
a transaction.
The same API contains additional methods for creating
transactions and segments, and for interacting with the current
transaction. For more details, see the [custom instrumentation
documentation](https://docs.newrelic.com/docs/agents/ruby-agent/api-guides/ruby-custom-instrumentation).
If you were previously using any of the agent's private,
undocumented APIs, such as `Transaction.wrap` or
`Transaction.start/stop`, you will need to update your code to
use the Tracer API.
The full list of APIs that were removed or deprecated are:
* `External.start_segment`
* `Transaction.create_segment`
* `Transaction.start`
* `Transaction.stop`
* `Transaction.start_datastore_segment`
* `Transaction.start_segment`
* `Transaction.wrap`
* `TransactionState.current_transaction`
If are you using any of these APIs, please see the [upgrade guide](https://docs.newrelic.com/docs/agents/ruby-agent/troubleshooting/update-private-api-calls-public-tracer-api) for a list of replacements.
* Agent detects Rails 6.0
The agent properly detects Rails 6.0 and no longer logs an error when
started in a Rails 6.0 environment. This does not include full Rails 6.0
support, which will be coming in a future release. Thanks to Jacob Bednarz
for the contribution.
## v5.7.0
* Ruby 2.6 support
We have tested the agent with the official release of Ruby 2.6.0
made on December 25, 2018, and it looks great! Feel free to use
agent v5.7 to measure the performance of your Ruby 2.6
applications.
* Support for loading Sequel core standalone
Earlier versions of the agent required users of the Sequel data
mapping library to load the _entire_ library. The agent will now
enable Sequel instrumentation when an application loads Sequel's
core standalone; i.e., without the `Sequel::Model` class. Thanks
to Vasily Kolesnikov for the contribution!
* Grape 1.2 support
With agent versions 5.6 and earlier, Grape 1.2 apps reported
their transactions under the name `Proc#call` instead of the name
of the API endpoint. Starting with agent version 5.7, all
existing versions of Grape will report the correct transaction
name. Thanks to Masato Ohba for the contribution!
## v5.6.0
* Bugfix for transactions with `ActionController::Live`
Previously, transactions containing `ActionController::Live` resulted in
incorrect calculations of capacity analysis as well as error backtraces
appearing in agent logs in agent versions 5.4 and later. The agent now
correctly calculates capacity for transactions with `ActionController::Live`.
* Add ability to exclude attributes from span events and transaction
segments
Agent versions 5.5 and lower could selectively exclude attributes
from page views, error traces, transaction traces, and
transaction events. With agent version 5.6 and higher, you can
also exclude attributes from span events (via the
`span_events.include/exclude` options) and from transaction
segments (via the `transaction_segments.include/exclude` options).
As with other attribute destinations, these new options will
inherit values from the top-level `attributes.include/exclude`
settings. See the
[documentation](https://docs.newrelic.com/docs/agents/ruby-agent/attributes/enabling-disabling-attributes-ruby)
for more information.
* Increasing backoff sequence on failing to connect to New Relic
If the agent cannot reach New Relic, it will now wait for an
increasing amount of time after each failed attempt. We are also
starting with a shorter delay initially, which will help customer
apps bounce back more quickly from transient network errors.
* Truncation of long stack traces
Previous versions of the agent would truncate long stack traces to
50 frames. To give customers more flexibility, we have added the
`error_collector.max_backtrace_frames` configuration option.
Thanks to Patrick Tulskie for the contribution!
* Update link in documentation
The community forum link in `README.md` now goes to the updated
location. Thanks to Sam Killgallon for the contribution!
* Active Storage instrumentation
The agent now provides instrumentation for Active Storage, introduced in
Rails 5.2. Customers will see Active Storage operations represented as
segments within transaction traces.
## v5.5.0
* Bugfix for `perform` instrumentation with curb gem
Use of curb's `perform` method now no longer results in nil headers
getting returned.
* Bugfix for parsing Docker container IDs
The agent now parses Docker container IDs correctly regardless of the
cgroup parent.
* Use lazy load hooks for ActiveJob instrumentation
In some instances the ActiveJob instrumentation could trigger ActiveJob
to load before it was initialized by Rails. This could result in
configuration changes not being properly applied. The agent now uses lazy
load hooks which fixes this issue.
* Documentation improvement
The `config.dot` diagram of the agent's configuration settings no
longer includes the deleted `developer_mode` option. Thanks to
Yuichiro Kaneko for the contribution!
## v5.4.0
* Capacity analysis for multi-threaded dispatchers
Metrics around capacity analysis did not previously account for multi-threaded
dispatchers, and consequently could result in capacities of over 100% being
recorded. This version now properly accounts for multi-threaded dispatchers.
* `NewRelic::Agent.disable_transaction_tracing` deprecated
`NewRelic::Agent.disable_transaction_tracing` has been deprecated. Users
are encouraged to use `NewRelic::Agent.disable_all_tracing` or
`NewRelic::Agent.ignore_transaction` instead.
* Bugfix for SQL over-obfuscation
A bug, introduced in v5.3.0, where SQL could be over-obfuscated for some
database adapters has been fixed.
* Bugfix for span event data in Resque processes
A bug where span events would not be sent from Resque processes due to a
missing endpoint has been fixed.
## v5.3.0 ##
* Distributed Tracing
Distributed tracing lets you see the path that a request takes as
it travels through your distributed system. By showing the
distributed activity through a unified view, you can troubleshoot
and understand a complex system better than ever before.
Distributed tracing is available with an APM Pro or equivalent
subscription. To see a complete distributed trace, you need to
enable the feature on a set of neighboring services. Enabling
distributed tracing changes the behavior of some New Relic
features, so carefully consult the
[transition guide](https://docs.newrelic.com/docs/transition-guide-distributed-tracing)
before you enable this feature.
To enable distributed tracing, set the
`distributed_tracing.enabled` configuration option to `true`.
## v5.2.0 ##
* Use priority sampling for errors and custom events
Priority sampling replaces the older reservoir event sampling method.
With this change, the agent will maintain randomness across a given
time period while improving coordination among transactions, errors,
and custom events.
* Bugfix for wrapping datastore operations
The agent will now complete the process of wrapping datastore
operations even if an error occurs during execution of a callback.
* Span Events
Finished segments whose `sampled` property is `true` will now post
Span events to Insights.
## v5.1.0 ##
* Rails 5.2 support
The Ruby agent has been validated against the latest release of
Ruby on Rails!
* Support for newer libraries and frameworks
We have updated the multiverse suite to test the agent against
current versions of several frameworks.
* Add `custom_attributes.enabled` configuration option
This option is enabled by default. When it's disabled, custom
attributes will not be transmitted on transaction events or error
events.
* Fix Grape load order dependency
The agent will now choose the correct name for Grape transactions
even if the customer's app loads the agent before Grape. Thanks
to Daniel Doubrovkine for the contribution!
* Add `webpacker:compile` to blacklisted tasks
`webpacker:compile` is commonly used for compiling assets. It has
been added to `AUTOSTART_BLACKLISTED_RAKE_TASKS` in the default
configuration. Thanks to Claudio B. for the contribution!
* Make browser instrumentation W3C-compliant
`type="text/javascript"` is optional for the `