newrelic_rpm 4.8.0.341 → 6.13.1

data/.github/workflows/stale.yml

@@ -0,0 +1,21 @@
+name: "Close stale issues"
+on:
+  schedule:
+  - cron: "0 0 * * *"
+
+jobs:
+  stale:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/stale@v3
+      with:
+        repo-token: ${{ secrets.GITHUB_TOKEN }}
+        stale-issue-message: 'This has been marked stale after 30 days with no activity. It will be closed in 5 days if there is no activity.'
+        stale-pr-message: 'Stale pull request message'
+        days-before-stale: 30
+        days-before-close: 5
+        stale-issue-label: 'stale'
+        exempt-issue-labels: 'good first issue,help wanted,in progress,on hold,in review,roadmap'
+        stale-pr-label: 'stale'
+        exempt-pr-labels: 'on hold,in review'
+

data/.gitignore

@@ -1,4 +1,5 @@
 Gemfile.lock
+Guard*
 .DS\_Store
 .svn/
 *~
@@ -14,6 +15,7 @@ tags
 *.swp
 *.swo
 
+/doc/
 /log/
 /lerg/
 gems/newrelic_rpm.gemspec
@@ -24,4 +26,11 @@ lib/new_relic/build.rb
 .bundle
 .yardoc
 artifacts/
+test/performance/log/
 test/performance/script/log/
+infinite_tracing/log/
+infinite_tracing/test/new_relic/infinite_tracing/log
+test/fixtures/cross_agent_tests/*/README.md
+node_modules/
+yarn.lock
+errors.txt

data/.yardopts

@@ -2,6 +2,8 @@
 --api public
 lib/new_relic/agent.rb
 lib/new_relic/agent/method_tracer.rb
+lib/new_relic/agent/distributed_tracing.rb
+lib/new_relic/agent/distributed_trace_payload.rb
 lib/new_relic/agent/external.rb
 lib/new_relic/agent/instrumentation/controller_instrumentation.rb
 lib/new_relic/agent/instrumentation/rack.rb
@@ -10,6 +12,7 @@ lib/new_relic/agent/stats_engine/metric_stats.rb
 lib/new_relic/agent/datastores.rb
 lib/new_relic/agent/messaging.rb
 lib/new_relic/agent/sql_sampler.rb
+lib/new_relic/agent/tracer.rb
 lib/new_relic/agent/transaction.rb
 lib/new_relic/agent/transaction_sampler.rb
 lib/new_relic/rack/agent_hooks.rb
@@ -19,5 +22,5 @@ lib/new_relic/rack.rb
 lib/new_relic/agent/transaction/external_request_segment.rb
 -
 LICENSE
-CHANGELOG
+CHANGELOG.md
 CONTRIBUTING.md

data/CHANGELOG.md

@@ -1,6 +1,871 @@
 # New Relic Ruby Agent Release Notes #
 
-  ## v4.8.0 ##
+  ## 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 <a href="https://docs.newrelic.com/docs/understand-dependencies/distributed-tracing/get-started/introduction-distributed-tracing">distributed traces</a> 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.
+
+    <a href="https://docs.newrelic.com/docs/apm/distributed-tracing/ui-data/understand-use-distributed-tracing-data#rules-limits">Spans with error details are now highlighted red in the Distributed Tracing UI</a>, 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 <a href="https://docs.newrelic.com/docs/agents/manage-apm-agents/agent-data/manage-errors-apm-collect-ignore-or-mark-expected#ignore">ignored errors</a> and <a href="https://docs.newrelic.com/docs/agents/manage-apm-agents/agent-data/manage-errors-apm-collect-ignore-or-mark-expected#expected">expected errors</a>.
+
+  * **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 `<script>` tag under
+    W3C. The `type` attribute has now been removed from browser
+    instrumentation. Thanks to Spharian for the contribution!
+
+  * Deferred `add_method_tracer` calls
+
+    If a third-party library calls `add_method_tracer` before the
+    agent has finished starting, we now queue these calls and run them
+    when it's safe to do so (rather than skipping them and logging a
+    warning).
+
+  * Bugfix for Resque `around` / `before` hooks
+
+    In rare cases, the agent was not instrumenting Resque `around` and
+    `before` hooks. This version fixes the error.
+
+  * Truncation of long stack traces
+
+    Occasionally, long stack traces would cause complications sending
+    data to New Relic. This version truncates long traces to 50 frames
+    (split evenly between the top and bottom of the trace).
+
+## v5.0.0 ##
+
+  * SSL connections to New Relic are now mandatory
+
+    Prior to this version, using an SSL connection to New Relic was
+    the default behavior, but could be overridden. SSL connections are
+    now enforced (not overrideable).
+
+  * Additional security checking before trying to explain
+    multi-statement SQL queries
+
+    Customer applications might submit SQL queries containing multiple
+    statements (e.g., SELECT * FROM table; SELECT * FROM table).  For
+    security reasons, we should not generate explain plans in this
+    situation.
+
+    Although the agent correctly skipped explain plans for these
+    queries during testing, we have added extra checks for this
+    scenario.
+
+  * Bugfix for RabbitMQ exchange names that are symbols
+
+    The agent no longer raises a TypeError when a RabbitMQ exchange
+    name is a Ruby symbol instead of a string.
+
+  * Bugfix for audit logging to stdout
+
+    Previous agents configured to log to stdout would correctly send
+    regular agent logs to stdout, but would incorrectly send audit
+    logs to a text file named "stdout".  This release corrects the
+    error.
+
+  * Bugfix for Capistrano deployment notifications on v3.7 and beyond
+
+    Starting with version 3.7, Capistrano uses a different technique
+    to determine a project's version control system.  The agent now
+    works correctly with this new behavior. Thanks to Jimmy Zhang for
+    the contribution.
+
+## v4.8.0 ##
 
   * Initialize New Relic Agent before config initializers
 
@@ -22,7 +887,7 @@
   It is now an agent attribute that can be controlled via the attributes config.
   For more information on agent attributes [see here](https://docs.newrelic.com/docs/agents/manage-apm-agents/agent-data/agent-attributes).
 
-  ## 4.7.1 ##
+## 4.7.1 ##
 
   * Bugfix for Manual Browser Instrumentation
 
@@ -32,7 +897,7 @@
   instrumentation. Those changes have been reverted. We will revisit this issue
   in an upcoming release.
 
-  ## v4.7.0 ##
+## v4.7.0 ##
 
   * Expected Error API